internet/kubevirt.core
3
0
Fork 0
mirror of https://github.com/kubevirt/kubevirt.core.git synced 2026-05-07 05:42:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for main

Browse Source 
Signed-off-by: kubevirt-bot <kubevirtbot@redhat.com>
This commit is contained in:
kubevirt-bot
2024-05-17 09:27:36 +00:00
parent 58d812b228
commit d7cde70601
9 changed files with 207 additions and 205 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
main/plugins/kubevirt.html
View File

@@ -127,10 +127,10 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>Fetch running VirtualMachineInstances for one or more namespaces with an optional label selector.</p></li>
<li><p>Groups by namespace, namespace_vmis and labels.</p></li>
<li><p>Uses the kubectl connection plugin to access the Kubernetes cluster.</p></li>
<li><p>Uses *.kubevirt.(yml|yaml) YAML configuration file to set parameter values.</p></li>
<li><p>Fetch running <code class="docutils literal notranslate"><span class="pre">VirtualMachineInstances</span></code> for one or more namespaces with an optional label selector.</p></li>
<li><p>Groups by cluster name, namespace and labels.</p></li>
<li><p>Uses the <span class="xref std std-ref">kubernetes.core.kubectl</span> connection plugin to access the Kubernetes cluster.</p></li>
<li><p>Uses <code class="ansible-value docutils literal notranslate"><span class="pre">*.kubevirt.[yml|yaml]</span></code> YAML configuration file to set parameter values.</p></li>
</ul>
</section>
<section id="requirements">
@@ -365,7 +365,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.</p>
<p>Token used to authenticate with the API. Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_API_KEY</code> environment variable.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -394,7 +394,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Append the base domain of the cluster to host names constructed from SSH services of type NodePort.</p>
<p>Append the base domain of the cluster to host names constructed from SSH <code class='docutils literal notranslate'>Services</code> of type <code class='docutils literal notranslate'>NodePort</code>.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>false</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
@@ -414,7 +414,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Override the base domain used to construct host names of VirtualMachines. Used in case of kubesecondarydns or services of type NodePort if append_base_domain is set.</p>
<p>Override the base domain used to construct host names of <code class='docutils literal notranslate'>VirtualMachines</code>. Used in case of <code class='docutils literal notranslate'>kubesecondarydns</code> or <code class='docutils literal notranslate'>Services</code> of type <code class='docutils literal notranslate'>NodePort</code> if <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-connections/append_base_domain"><span class="std std-ref"><span class="pre">connections.append_base_domain</span></span></a></strong></code> is set.</p>
</div></td>
</tr>
<tr class="row-odd">
@@ -430,7 +430,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Path to a CA certificate used to authenticate with the API. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.</p>
<p>Path to a CA certificate used to authenticate with the API. Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_SSL_CA_CERT</code> environment variable.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -446,7 +446,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.</p>
<p>Path to a certificate used to authenticate with the API. Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_CERT_FILE</code> environment variable.</p>
</div></td>
</tr>
<tr class="row-odd">
@@ -462,7 +462,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.</p>
<p>Path to a key file used to authenticate with the API. Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_KEY_FILE</code> environment variable.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -476,7 +476,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.</p>
<p>The name of a context found in the config file. Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_CONTEXT</code> environment variable.</p>
</div></td>
</tr>
<tr class="row-odd">
@@ -490,7 +490,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Enable the creation of groups from labels on VirtualMachines.</p>
<p>Enable the creation of groups from labels on <code class='docutils literal notranslate'>VirtualMachines</code>.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>false</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
@@ -510,7 +510,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.</p>
<p>Provide a URL for accessing the API. Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_HOST</code> environment variable.</p>
</div></td>
</tr>
<tr class="row-odd">
@@ -524,7 +524,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Enable kubesecondarydns derived host names when using a secondary network interface.</p>
<p>Enable <code class='docutils literal notranslate'>kubesecondarydns</code> derived host names when using a secondary network interface.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>false</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
@@ -544,7 +544,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the Kubernetes client will attempt to load the default configuration file from <em>~/.kube/config</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</p>
<p>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the Kubernetes client will attempt to load the default configuration file from <em>~/.kube/config</em>. Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_KUBECONFIG</code> environment variable.</p>
</div></td>
</tr>
<tr class="row-odd">
@@ -558,7 +558,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Define a label selector to select a subset of the fetched VirtualMachineInstances.</p>
<p>Define a label selector to select a subset of the fetched <code class='docutils literal notranslate'>VirtualMachineInstances</code>.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -586,7 +586,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>List of namespaces. If not specified, will fetch all VirtualMachineInstances for all namespaces the user is authorized to access.</p>
<p>List of namespaces. If not specified, will fetch all <code class='docutils literal notranslate'>VirtualMachineInstances</code> for all namespaces the user is authorized to access.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -602,7 +602,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>In case multiple networks are attached to a VirtualMachineInstance, define which interface should be returned as primary IP address.</p>
<p>In case multiple networks are attached to a <code class='docutils literal notranslate'>VirtualMachineInstance</code>, define which interface should be returned as primary IP address.</p>
</div></td>
</tr>
<tr class="row-odd">
@@ -616,7 +616,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.</p>
<p>Provide a password for authenticating with the API. Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_PASSWORD</code> environment variable.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -630,8 +630,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Enable the use of services to establish an SSH connection to the VirtualMachine.</p>
<p>Services are only used if no network_name was provided.</p>
<p>Enable the use of <code class='docutils literal notranslate'>Services</code> to establish an SSH connection to the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
<p>Services are only used if no <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-connections/network_name"><span class="std std-ref"><span class="pre">connections.network_name</span></span></a></strong></code> was provided.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">false</code></p></li>
@@ -651,7 +651,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.</p>
<p>Provide a username for authenticating with the API. Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_USERNAME</code> environment variable.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -667,7 +667,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Whether or not to verify the API server&#x27;s SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.</p>
<p>Whether or not to verify the API server&#x27;s SSL certificates. Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_VERIFY_SSL</code> environment variable.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">false</code></p></li>
@@ -703,7 +703,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-cell">
<p>Specify the format of the host in the inventory group. Available specifiers: name, namespace, uid.</p>
<p>Specify the format of the host in the inventory group. Available specifiers: <code class="ansible-value literal notranslate">name</code>, <code class="ansible-value literal notranslate">namespace</code> and <code class="ansible-value literal notranslate">uid</code>.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">&#34;{namespace}-{name}&#34;</code></p>
</div></td>
</tr>
@@ -858,7 +858,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-cell">
<p>Token that ensures this is a source file for the "kubevirt" plugin.</p>
<p>Token that ensures this is a source file for the <a href='../../kubevirt/core/kubevirt_inventory.html' class='module'>kubevirt.core.kubevirt</a> plugin.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">&#34;kubevirt&#34;</code></p></li>

52
main/plugins/kubevirt_vm.html
View File

@@ -168,8 +168,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Specify annotations to set on the VirtualMachine.</p>
<p>Only used when <em>state=present</em>.</p>
<p>Specify annotations to set on the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
<p>Only used when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></code>.</p>
</div></td>
</tr>
<tr class="row-odd">
@@ -268,8 +268,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Specify the DataVolume templates of the VirtualMachine.</p>
<p>See: https://kubevirt.io/api-reference/main/definitions.html#_v1_datavolumetemplatespec</p>
<p>Specify the <code class='docutils literal notranslate'>DataVolume</code> templates of the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
<p>See <a href='https://kubevirt.io/api-reference/main/definitions.html#_v1_datavolumetemplatespec'>https://kubevirt.io/api-reference/main/definitions.html#_v1_datavolumetemplatespec</a></p>
</div></td>
</tr>
<tr class="row-even">
@@ -393,9 +393,9 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Specify the basis of the VirtualMachine name and random characters will be added automatically on server to generate a unique name.</p>
<p>Only used when <em>state=present</em>.</p>
<p>mutually exclusive with <code class='docutils literal notranslate'>name</code>.</p>
<p>Specify the basis of the <code class='docutils literal notranslate'>VirtualMachine</code> name and random characters will be added automatically on the cluster to generate a unique name.</p>
<p>Only used when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></code>.</p>
<p>Mutually exclusive with <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-name"><span class="std std-ref"><span class="pre">name</span></span></a></strong></code>.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -452,8 +452,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Specify the instancetype matcher of the VirtualMachine.</p>
<p>Only used when <em>state=present</em>.</p>
<p>Specify the <code class='docutils literal notranslate'>Instancetype</code> matcher of the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
<p>Only used when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></code>.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -481,7 +481,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Specify labels to set on the VirtualMachine.</p>
<p>Specify labels to set on the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -494,9 +494,9 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Specify the name of the VirtualMachine.</p>
<p>This option is ignored when <em>state</em> is not set to <code class='docutils literal notranslate'>present</code>.</p>
<p>mutually exclusive with <code class='docutils literal notranslate'>generate_name</code>.</p>
<p>Specify the name of the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
<p>This option is ignored when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></code> is not set.</p>
<p>Mutually exclusive with <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-generate_name"><span class="std std-ref"><span class="pre">generate_name</span></span></a></strong></code>.</p>
</div></td>
</tr>
<tr class="row-odd">
@@ -510,7 +510,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Specify the namespace of the VirtualMachine.</p>
<p>Specify the namespace of the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -577,8 +577,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Specify the preference matcher of the VirtualMachine.</p>
<p>Only used when <em>state=present</em>.</p>
<p>Specify the <code class='docutils literal notranslate'>Preference</code> matcher of the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
<p>Only used when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></code>.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -663,7 +663,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Specify whether the VirtualMachine should be running.</p>
<p>Specify whether the <code class='docutils literal notranslate'>VirtualMachine</code> should be running or not.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">false</code></p></li>
@@ -682,8 +682,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Specify the template spec of the VirtualMachine.</p>
<p>See: https://kubevirt.io/api-reference/main/definitions.html#_v1_virtualmachineinstancespec</p>
<p>Specify the template spec of the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
<p>See <a href='https://kubevirt.io/api-reference/main/definitions.html#_v1_virtualmachineinstancespec'>https://kubevirt.io/api-reference/main/definitions.html#_v1_virtualmachineinstancespec</a></p>
</div></td>
</tr>
<tr class="row-odd">
@@ -750,7 +750,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Whether to wait for the VirtualMachine to end up in the ready state.</p>
<p>Whether to wait for the <code class='docutils literal notranslate'>VirtualMachine</code> to end up in the ready state.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>false</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
@@ -770,7 +770,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-cell">
<p>Number of seconds to sleep between checks.</p>
<p>Ignored if <code class='docutils literal notranslate'>wait</code> is not set.</p>
<p>Ignored if <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-wait"><span class="std std-ref"><span class="pre">wait</span></span></a></strong></code> is not set.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">5</code></p>
</div></td>
</tr>
@@ -784,8 +784,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>How long in seconds to wait for the resource to end up in the desired state.</p>
<p>Ignored if <code class='docutils literal notranslate'>wait</code> is not set.</p>
<p>How long in seconds to wait for the resource to end up in the ready state.</p>
<p>Ignored if <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-wait"><span class="std std-ref"><span class="pre">wait</span></span></a></strong></code> is not set.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">120</code></p>
</div></td>
</tr>
@@ -922,7 +922,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Whether the VirtualMachine was changed</p>
<p>Whether the <code class='docutils literal notranslate'>VirtualMachine</code> was changed or not.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-value literal notranslate ansible-option-sample">true</code></p>
</div></td>
@@ -937,8 +937,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>elapsed time of task in seconds</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class='docutils literal notranslate'>wait</code> is true</p>
<p>Elapsed time of the task in seconds.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> When <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-wait"><span class="std std-ref"><span class="pre">wait=true</span></span></a></code>.</p>
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-value literal notranslate ansible-option-sample">48</code></p>
</div></td>
</tr>

38
main/plugins/kubevirt_vm_info.html
View File

@@ -131,8 +131,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<section id="synopsis">
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>Use the Kubernetes Python client to perform read operations on KubeVirt VirtualMachines.</p></li>
<li><p>Pass options to find VirtualMachines as module arguments.</p></li>
<li><p>Use the Kubernetes Python client to perform read operations on KubeVirt <code class="docutils literal notranslate"><span class="pre">VirtualMachines</span></code>.</p></li>
<li><p>Pass options to find <code class="docutils literal notranslate"><span class="pre">VirtualMachines</span></code> as module arguments.</p></li>
<li><p>Authenticate using either a config file, certificates, password or token.</p></li>
<li><p>Supports check mode.</p></li>
</ul>
@@ -252,7 +252,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>List of field selectors to use to filter results</p>
<p>List of field selectors to use to filter results.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">[]</code></p>
</div></td>
</tr>
@@ -326,7 +326,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>List of label selectors to use to filter results</p>
<p>List of label selectors to use to filter results.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">[]</code></p>
</div></td>
</tr>
@@ -340,7 +340,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Specify the name of the VirtualMachine.</p>
<p>Specify the name of the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
</div></td>
</tr>
<tr class="row-odd">
@@ -353,7 +353,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Specify the namespace of VirtualMachines.</p>
<p>Specify the namespace of <code class='docutils literal notranslate'>VirtualMachines</code>.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -493,9 +493,9 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<p><em class="ansible-option-versionadded">added in kubevirt.core 1.4.0</em></p>
</div></td>
<td><div class="ansible-option-cell">
<p>Specify whether the VirtualMachine should be running.</p>
<p>Specify whether the <code class='docutils literal notranslate'>VirtualMachine</code> should be running or not.</p>
<p>This affects the ready condition to wait for.</p>
<p>This requires <code class='docutils literal notranslate'>wait</code> and is only used when <em>wait=yes</em>.</p>
<p>This requires <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-wait"><span class="std std-ref"><span class="pre">wait=yes</span></span></a></code>.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">false</code></p></li>
@@ -549,9 +549,9 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Whether to wait for the VirtualMachine to end up in the ready state.</p>
<p>By default this is waiting for the VirtualMachine to be up and running.</p>
<p>Modify this behavior by setting <code class='docutils literal notranslate'>running</code>.</p>
<p>Whether to wait for the <code class='docutils literal notranslate'>VirtualMachine</code> to end up in the ready state.</p>
<p>By default this is waiting for the <code class='docutils literal notranslate'>VirtualMachine</code> to be up and running.</p>
<p>Modify this behavior by setting <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-running"><span class="std std-ref"><span class="pre">running</span></span></a></strong></code>.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">false</code></p></li>
@@ -571,7 +571,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-cell">
<p>Number of seconds to sleep between checks.</p>
<p>Ignored if <code class='docutils literal notranslate'>wait</code> is not set.</p>
<p>Ignored if <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-wait"><span class="std std-ref"><span class="pre">wait</span></span></a></strong></code> is not set.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">5</code></p>
</div></td>
</tr>
@@ -585,8 +585,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>How long in seconds to wait for the resource to end up in the desired state.</p>
<p>Ignored if <code class='docutils literal notranslate'>wait</code> is not set.</p>
<p>How long in seconds to wait for the resource to end up in the ready state.</p>
<p>Ignored if <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-wait"><span class="std std-ref"><span class="pre">wait</span></span></a></strong></code> is not set.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">120</code></p>
</div></td>
</tr>
@@ -659,7 +659,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>Whether the specified api_version and VirtualMachine kind were successfully mapped to an existing API on the targeted cluster.</p>
<p>Whether the specified <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-api_version"><span class="std std-ref"><span class="pre">api_version</span></span></a></strong></code> and <code class='docutils literal notranslate'>VirtualMachine</code> <code class='docutils literal notranslate'>Kind</code> were successfully mapped to an existing API on the target cluster.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
</div></td>
</tr>
@@ -673,7 +673,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>The VirtualMachine(s) that exist(s)</p>
<p>The <code class='docutils literal notranslate'>VirtualMachines</code> that exist.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
</div></td>
</tr>
@@ -701,7 +701,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Represents the REST resource this object represents.</p>
<p>Represents the <code class='docutils literal notranslate'>REST</code> resource this object represents.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
</div></td>
</tr>
@@ -729,7 +729,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Specific attributes of the VirtualMachine. Can vary based on the <em>api_version</em>.</p>
<p>Specific attributes of the <code class='docutils literal notranslate'>VirtualMachine</code>. Can vary based on the <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-api_version"><span class="std std-ref"><span class="pre">api_version</span></span></a></strong></code>.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
</div></td>
</tr>
@@ -743,7 +743,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Current status details for the VirtualMachine.</p>
<p>Current status details for the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
</div></td>
</tr>