internet/kubevirt.core
3
0
Fork 0
mirror of https://github.com/kubevirt/kubevirt.core.git synced 2026-05-06 13:22: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

129
main/CHANGELOG.html
View File

@@ -68,36 +68,36 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-3-1">v1.3.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id5">Release Summary</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id6">Release Summary</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-3-0">v1.3.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id6">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id9">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id7">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id10">Bugfixes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-3">v1.2.3</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id13">Release Summary</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-2">v1.2.2</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id14">Release Summary</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-1">v1.2.1</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-2">v1.2.2</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id15">Release Summary</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-0">v1.2.0</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-1">v1.2.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id16">Release Summary</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-2-0">v1.2.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id17">Release Summary</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-1-0">v1.1.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id17">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id18">Minor Changes</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-0">v1.0.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id18">Release Summary</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id19">Release Summary</a></li>
</ul>
</li>
</ul>
@@ -129,58 +129,58 @@
<div itemprop="articleBody">
<section id="kubevirt-collection-for-ansible-release-notes">
<h1><a class="toc-backref" href="#id19" role="doc-backlink">KubeVirt Collection for Ansible Release Notes</a><a class="headerlink" href="#kubevirt-collection-for-ansible-release-notes" title="Link to this heading"></a></h1>
<h1><a class="toc-backref" href="#id20" role="doc-backlink">KubeVirt Collection for Ansible Release Notes</a><a class="headerlink" href="#kubevirt-collection-for-ansible-release-notes" title="Link to this heading"></a></h1>
<nav class="contents" id="topics">
<p class="topic-title">Topics</p>
<ul class="simple">
<li><p><a class="reference internal" href="#kubevirt-collection-for-ansible-release-notes" id="id19">KubeVirt Collection for Ansible Release Notes</a></p>
<li><p><a class="reference internal" href="#kubevirt-collection-for-ansible-release-notes" id="id20">KubeVirt Collection for Ansible Release Notes</a></p>
<ul>
<li><p><a class="reference internal" href="#v1-3-2" id="id20">v1.3.2</a></p>
<li><p><a class="reference internal" href="#v1-3-2" id="id21">v1.3.2</a></p>
<ul>
<li><p><a class="reference internal" href="#release-summary" id="id21">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#minor-changes" id="id22">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id23">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#release-summary" id="id22">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#minor-changes" id="id23">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id24">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-3-1" id="id24">v1.3.1</a></p>
<li><p><a class="reference internal" href="#v1-3-1" id="id25">v1.3.1</a></p>
<ul>
<li><p><a class="reference internal" href="#id5" id="id25">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id6" id="id26">Release Summary</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-3-0" id="id26">v1.3.0</a></p>
<li><p><a class="reference internal" href="#v1-3-0" id="id27">v1.3.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id6" id="id27">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id9" id="id28">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id7" id="id28">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id10" id="id29">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-3" id="id29">v1.2.3</a></p>
<li><p><a class="reference internal" href="#v1-2-3" id="id30">v1.2.3</a></p>
<ul>
<li><p><a class="reference internal" href="#id13" id="id30">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id14" id="id31">Release Summary</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-2" id="id31">v1.2.2</a></p>
<li><p><a class="reference internal" href="#v1-2-2" id="id32">v1.2.2</a></p>
<ul>
<li><p><a class="reference internal" href="#id14" id="id32">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id15" id="id33">Release Summary</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-1" id="id33">v1.2.1</a></p>
<li><p><a class="reference internal" href="#v1-2-1" id="id34">v1.2.1</a></p>
<ul>
<li><p><a class="reference internal" href="#id15" id="id34">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id16" id="id35">Release Summary</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-0" id="id35">v1.2.0</a></p>
<li><p><a class="reference internal" href="#v1-2-0" id="id36">v1.2.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id16" id="id36">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id17" id="id37">Release Summary</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-1-0" id="id37">v1.1.0</a></p>
<li><p><a class="reference internal" href="#v1-1-0" id="id38">v1.1.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id17" id="id38">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id18" id="id39">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-0" id="id39">v1.0.0</a></p>
<li><p><a class="reference internal" href="#v1-0-0" id="id40">v1.0.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id18" id="id40">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id19" id="id41">Release Summary</a></p></li>
</ul>
</li>
</ul>
@@ -189,44 +189,45 @@
</nav>
<p>This changelog describes changes after version 1.0.0.</p>
<section id="v1-3-2">
<h2><a class="toc-backref" href="#id20" role="doc-backlink">v1.3.2</a><a class="headerlink" href="#v1-3-2" title="Link to this heading"></a></h2>
<h2><a class="toc-backref" href="#id21" role="doc-backlink">v1.3.2</a><a class="headerlink" href="#v1-3-2" title="Link to this heading"></a></h2>
<section id="release-summary">
<h3><a class="toc-backref" href="#id21" role="doc-backlink">Release Summary</a><a class="headerlink" href="#release-summary" title="Link to this heading"></a></h3>
<h3><a class="toc-backref" href="#id22" role="doc-backlink">Release Summary</a><a class="headerlink" href="#release-summary" title="Link to this heading"></a></h3>
<p>No functional changes, hotfix release to retrigger the downstream build and to keep in sync with Ansible Automation Hub.</p>
</section>
<section id="minor-changes">
<h3><a class="toc-backref" href="#id22" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Link to this heading"></a></h3>
<h3><a class="toc-backref" href="#id23" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Provide links for docsite and improve docs by adding markup <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/95">#95</a></p></li>
<li><p>cleanup: Cleanup YAML passed to k8s module <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/88">#88</a></p></li>
<li><p>docs: Use proper type for connections parameter <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/90">#90</a></p></li>
<li><p>feat(kubevirt_vm_info): Set wait_condition based on running <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/91">#91</a></p></li>
</ul>
</section>
<section id="bugfixes">
<h3><a class="toc-backref" href="#id23" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Link to this heading"></a></h3>
<h3><a class="toc-backref" href="#id24" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>fix(kubevirt_vm): Set wait_condition based on running <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/89">#89</a></p></li>
</ul>
</section>
</section>
<section id="v1-3-1">
<h2><a class="toc-backref" href="#id24" role="doc-backlink">v1.3.1</a><a class="headerlink" href="#v1-3-1" title="Link to this heading"></a></h2>
<section id="id5">
<h3><a class="toc-backref" href="#id25" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id5" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id25" role="doc-backlink">v1.3.1</a><a class="headerlink" href="#v1-3-1" title="Link to this heading"></a></h2>
<section id="id6">
<h3><a class="toc-backref" href="#id26" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id6" title="Link to this heading"></a></h3>
<p>No functional changes, only updates to the shipped documentation.</p>
</section>
</section>
<section id="v1-3-0">
<h2><a class="toc-backref" href="#id26" role="doc-backlink">v1.3.0</a><a class="headerlink" href="#v1-3-0" title="Link to this heading"></a></h2>
<section id="id6">
<h3><a class="toc-backref" href="#id27" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id6" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id27" role="doc-backlink">v1.3.0</a><a class="headerlink" href="#v1-3-0" title="Link to this heading"></a></h2>
<section id="id7">
<h3><a class="toc-backref" href="#id28" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id7" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>feat: Add append_base_domain option to connections <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/72">#72</a></p></li>
<li><p>feat: Give secondary interfaces a higher priority over services <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/76">#76</a></p></li>
</ul>
</section>
<section id="id9">
<h3><a class="toc-backref" href="#id28" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id9" title="Link to this heading"></a></h3>
<section id="id10">
<h3><a class="toc-backref" href="#id29" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id10" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>feat: Set ansible_connection to winrm for Windows hosts <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/75">#75</a></p></li>
<li><p>fix: Explicity set ansible_port <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/70">#70</a></p></li>
@@ -235,37 +236,37 @@
</section>
</section>
<section id="v1-2-3">
<h2><a class="toc-backref" href="#id29" role="doc-backlink">v1.2.3</a><a class="headerlink" href="#v1-2-3" title="Link to this heading"></a></h2>
<section id="id13">
<h3><a class="toc-backref" href="#id30" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id13" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id30" role="doc-backlink">v1.2.3</a><a class="headerlink" href="#v1-2-3" title="Link to this heading"></a></h2>
<section id="id14">
<h3><a class="toc-backref" href="#id31" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id14" title="Link to this heading"></a></h3>
<p>No functional changes, hotfix release to retrigger the downstream build and to keep in sync with Ansible Automation Hub.</p>
</section>
</section>
<section id="v1-2-2">
<h2><a class="toc-backref" href="#id31" role="doc-backlink">v1.2.2</a><a class="headerlink" href="#v1-2-2" title="Link to this heading"></a></h2>
<section id="id14">
<h3><a class="toc-backref" href="#id32" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id14" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id32" role="doc-backlink">v1.2.2</a><a class="headerlink" href="#v1-2-2" title="Link to this heading"></a></h2>
<section id="id15">
<h3><a class="toc-backref" href="#id33" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id15" title="Link to this heading"></a></h3>
<p>No functional changes, only cleanup of files included in the release tarball and vendoring of documentation fragments.</p>
</section>
</section>
<section id="v1-2-1">
<h2><a class="toc-backref" href="#id33" role="doc-backlink">v1.2.1</a><a class="headerlink" href="#v1-2-1" title="Link to this heading"></a></h2>
<section id="id15">
<h3><a class="toc-backref" href="#id34" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id15" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id34" role="doc-backlink">v1.2.1</a><a class="headerlink" href="#v1-2-1" title="Link to this heading"></a></h2>
<section id="id16">
<h3><a class="toc-backref" href="#id35" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id16" title="Link to this heading"></a></h3>
<p>Mostly code cleanups and dependency updates to ensure compatibility with KubeVirt &gt;= 1.1.0</p>
</section>
</section>
<section id="v1-2-0">
<h2><a class="toc-backref" href="#id35" role="doc-backlink">v1.2.0</a><a class="headerlink" href="#v1-2-0" title="Link to this heading"></a></h2>
<section id="id16">
<h3><a class="toc-backref" href="#id36" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id16" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id36" role="doc-backlink">v1.2.0</a><a class="headerlink" href="#v1-2-0" title="Link to this heading"></a></h2>
<section id="id17">
<h3><a class="toc-backref" href="#id37" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id17" title="Link to this heading"></a></h3>
<p>Not released due to issues in the release process</p>
</section>
</section>
<section id="v1-1-0">
<h2><a class="toc-backref" href="#id37" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Link to this heading"></a></h2>
<section id="id17">
<h3><a class="toc-backref" href="#id38" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id17" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id38" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Link to this heading"></a></h2>
<section id="id18">
<h3><a class="toc-backref" href="#id39" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id18" title="Link to this heading"></a></h3>
<ul class="simple">
<li><p>Add kubevirt_vm_info module to describe existing VirtualMachines</p></li>
<li><p>inventory: Allow to control creation of additional groups</p></li>
@@ -274,9 +275,9 @@
</section>
</section>
<section id="v1-0-0">
<h2><a class="toc-backref" href="#id39" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Link to this heading"></a></h2>
<section id="id18">
<h3><a class="toc-backref" href="#id40" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id18" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id40" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Link to this heading"></a></h2>
<section id="id19">
<h3><a class="toc-backref" href="#id41" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id19" title="Link to this heading"></a></h3>
<p>Initial release</p>
</section>
</section>

1
main/_sources/CHANGELOG.rst.txt
View File

@@ -17,6 +17,7 @@ No functional changes, hotfix release to retrigger the downstream build and to k
Minor Changes
-------------
- Provide links for docsite and improve docs by adding markup `#95 <https://github.com/kubevirt/kubevirt.core/pull/95>`_
- cleanup: Cleanup YAML passed to k8s module `#88 <https://github.com/kubevirt/kubevirt.core/pull/88>`_
- docs: Use proper type for connections parameter `#90 <https://github.com/kubevirt/kubevirt.core/pull/90>`_
- feat(kubevirt_vm_info): Set wait_condition based on running `#91 <https://github.com/kubevirt/kubevirt.core/pull/91>`_

50
main/_sources/plugins/kubevirt.rst.txt
View File

@@ -49,10 +49,10 @@ Synopsis
.. Description
- Fetch running VirtualMachineInstances for one or more namespaces with an optional label selector.
- Groups by namespace, namespace\_vmis and labels.
- Uses the kubectl connection plugin to access the Kubernetes cluster.
- Uses \*.kubevirt.(yml|yaml) YAML configuration file to set parameter values.
- Fetch running \ :literal:`VirtualMachineInstances`\ for one or more namespaces with an optional label selector.
- Groups by cluster name, namespace and labels.
- Uses the \ :ref:`kubernetes.core.kubectl <ansible_collections.kubernetes.core.kubectl_module>`\ connection plugin to access the Kubernetes cluster.
- Uses \ :ansval:`\*.kubevirt.[yml|yaml]`\ YAML configuration file to set parameter values.
.. Aliases
@@ -303,7 +303,7 @@ Parameters
</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">
@@ -332,7 +332,7 @@ Parameters
</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>
@@ -352,7 +352,7 @@ Parameters
</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">
@@ -368,7 +368,7 @@ Parameters
</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">
@@ -384,7 +384,7 @@ Parameters
</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">
@@ -400,7 +400,7 @@ Parameters
</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">
@@ -414,7 +414,7 @@ Parameters
</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">
@@ -428,7 +428,7 @@ Parameters
</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>
@@ -448,7 +448,7 @@ Parameters
</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">
@@ -462,7 +462,7 @@ Parameters
</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>
@@ -482,7 +482,7 @@ Parameters
</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">
@@ -496,7 +496,7 @@ Parameters
</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">
@@ -524,7 +524,7 @@ Parameters
</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">
@@ -540,7 +540,7 @@ Parameters
</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">
@@ -554,7 +554,7 @@ Parameters
</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">
@@ -568,8 +568,8 @@ Parameters
</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>
@@ -589,7 +589,7 @@ Parameters
</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">
@@ -605,7 +605,7 @@ Parameters
</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>
@@ -641,7 +641,7 @@ Parameters
</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>
@@ -796,7 +796,7 @@ Parameters
</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/_sources/plugins/kubevirt_vm.rst.txt
View File

@@ -102,8 +102,8 @@ Parameters
</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">
@@ -202,8 +202,8 @@ Parameters
</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">
@@ -327,9 +327,9 @@ Parameters
</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">
@@ -386,8 +386,8 @@ Parameters
</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">
@@ -415,7 +415,7 @@ Parameters
</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">
@@ -428,9 +428,9 @@ Parameters
</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">
@@ -444,7 +444,7 @@ Parameters
</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">
@@ -511,8 +511,8 @@ Parameters
</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">
@@ -597,7 +597,7 @@ Parameters
</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>
@@ -616,8 +616,8 @@ Parameters
</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">
@@ -684,7 +684,7 @@ Parameters
</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>
@@ -704,7 +704,7 @@ Parameters
</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>
@@ -718,8 +718,8 @@ Parameters
</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>
@@ -879,7 +879,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
</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>
@@ -894,8 +894,8 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
</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/_sources/plugins/kubevirt_vm_info.rst.txt
View File

@@ -49,8 +49,8 @@ Synopsis
.. Description
- Use the Kubernetes Python client to perform read operations on KubeVirt VirtualMachines.
- Pass options to find VirtualMachines as module arguments.
- Use the Kubernetes Python client to perform read operations on KubeVirt \ :literal:`VirtualMachines`\ .
- Pass options to find \ :literal:`VirtualMachines`\ as module arguments.
- Authenticate using either a config file, certificates, password or token.
- Supports check mode.
@@ -186,7 +186,7 @@ Parameters
</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>
@@ -260,7 +260,7 @@ Parameters
</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>
@@ -274,7 +274,7 @@ Parameters
</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">
@@ -287,7 +287,7 @@ Parameters
</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">
@@ -427,9 +427,9 @@ Parameters
<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>
@@ -483,9 +483,9 @@ Parameters
</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>
@@ -505,7 +505,7 @@ Parameters
</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>
@@ -519,8 +519,8 @@ Parameters
</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>
@@ -616,7 +616,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
</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>
@@ -630,7 +630,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
</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>
@@ -658,7 +658,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
</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>
@@ -686,7 +686,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
</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>
@@ -700,7 +700,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
</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>

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>

2
main/searchindex.js
View File

File diff suppressed because one or more lines are too long