internet/kubevirt.core
3
0
Fork 0
mirror of https://github.com/kubevirt/kubevirt.core.git synced 2026-07-28 10:24:39 +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-04-25 12:07:33 +00:00
parent 8241b38925
commit f512550b49
5 changed files with 143 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
main/_sources/plugins/kubevirt_vm_info.rst.txt
View File

@@ -417,6 +417,28 @@ Parameters
</tr>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-running"></div>
<p class="ansible-option-title"><strong>running</strong></p>
<a class="ansibleOptionLink" href="#parameter-running" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">boolean</span>
</p>
<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>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 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>
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">true</code></p></li>
</ul>
</div></td>
</tr>
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-username"></div>
<p class="ansible-option-title"><strong>username</strong></p>
@@ -430,7 +452,7 @@ Parameters
<p>Please note that this only works with clusters configured to use HTTP Basic Auth. If your cluster has a different form of authentication (e.g. OAuth2 in OpenShift), this option will not work as expected and you should look into the <a href='../../community/okd/k8s_auth_module.html' class='module'>community.okd.k8s_auth</a> module, as that might do what you need.</p>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div>
<div class="ansibleOptionAnchor" id="parameter-verify_ssl"></div>
@@ -451,7 +473,7 @@ Parameters
</div></td>
</tr>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-wait"></div>
<p class="ansible-option-title"><strong>wait</strong></p>
@@ -462,15 +484,17 @@ Parameters
</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 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>
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">false</code></p></li>
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">true</code></p></li>
</ul>
</div></td>
</tr>
<tr class="row-odd">
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-wait_sleep"></div>
<p class="ansible-option-title"><strong>wait_sleep</strong></p>
@@ -485,7 +509,7 @@ Parameters
<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>
<tr class="row-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-wait_timeout"></div>
<p class="ansible-option-title"><strong>wait_timeout</strong></p>
@@ -547,12 +571,19 @@ Examples
label_selectors:
- app=test
- name: Wait until the VirtualMachine is Ready
- name: Wait until the VirtualMachine is running
kubevirt.core.kubevirt_vm_info:
name: testvm
namespace: default
wait: true
- name: Wait until the VirtualMachine is stopped
kubevirt.core.kubevirt_vm_info:
name: testvm
namespace: default
running: false
wait: true
@@ -599,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 exists</p>
<p>The VirtualMachine(s) that exist(s)</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
</div></td>
</tr>