Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

get_xml missing from return values in documentation for community.libvirt.virt #175

Open
tsgsh opened this issue Jul 17, 2024 · 0 comments

Comments

@tsgsh
Copy link

tsgsh commented Jul 17, 2024

SUMMARY

https://docs.ansible.com/ansible/latest/collections/community/libvirt/virt_module.html

Should include 'get_xml' under Return Values , as (for example) community.general.xml with 'xmlstring'

For example, it should include (pardon any mistakes in the HTML)

<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="return-get_xml"></div><p class="ansible-option-title" id="ansible-collections-community-libvirt-virt-module-return-get_xml"><strong>get_xml</strong></p>
<a class="ansibleOptionLink" href="[#return-get_xml](view-source:https://docs.ansible.com/ansible/latest/collections/community/libvirt/virt.html#return-get_xml)" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>An XML string of the virtual machine definition.</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="[#ansible-collections-community-libvirt-virt-module-parameter-command](view-source:https://docs.ansible.com/ansible/latest/collections/community/libvirt/virt_module.html#ansible-collections-community-libvirt-virt-module-parameter-command)"><span class="std std-ref"><span class="pre">command=get_xml</span></p>
</div></td>
</tr>

<!--- HINT: Did you know the documentation has an "Edit on GitHub" link on every page ? -->

That doesn't seem to be the case

ISSUE TYPE
  • Documentation Report
COMPONENT NAME

community.libvirt.virt

ANSIBLE VERSION
ansible [core 2.16.6]
  config file = /etc/ansible/ansible.cfg
  configured module search path = ['/home/steve/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3.12/site-packages/ansible
  ansible collection location = /home/steve/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/bin/ansible
  python version = 3.12.3 (main, Apr 17 2024, 00:00:00) [GCC 14.0.1 20240411 (Red Hat 14.0.1-0)] (/usr/bin/python3)
  jinja version = 3.1.4
  libyaml = True
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant