diff options
Diffstat (limited to 'ansible_collections/community/libvirt/plugins/doc_fragments')
3 files changed, 81 insertions, 0 deletions
diff --git a/ansible_collections/community/libvirt/plugins/doc_fragments/__init__.py b/ansible_collections/community/libvirt/plugins/doc_fragments/__init__.py new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/ansible_collections/community/libvirt/plugins/doc_fragments/__init__.py diff --git a/ansible_collections/community/libvirt/plugins/doc_fragments/requirements.py b/ansible_collections/community/libvirt/plugins/doc_fragments/requirements.py new file mode 100644 index 000000000..a181ed68b --- /dev/null +++ b/ansible_collections/community/libvirt/plugins/doc_fragments/requirements.py @@ -0,0 +1,14 @@ +# -*- coding: utf-8 -*- + +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + + +class ModuleDocFragment(object): + DOCUMENTATION = r""" +options: {} +requirements: + - python >= 2.6 + - libvirt python bindings + """ diff --git a/ansible_collections/community/libvirt/plugins/doc_fragments/virt.py b/ansible_collections/community/libvirt/plugins/doc_fragments/virt.py new file mode 100644 index 000000000..a607299bf --- /dev/null +++ b/ansible_collections/community/libvirt/plugins/doc_fragments/virt.py @@ -0,0 +1,67 @@ +# -*- coding: utf-8 -*- + +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + + +class ModuleDocFragment(object): + OPTIONS_GUEST = r""" +options: + name: + description: + - name of the guest VM being managed. Note that VM must be previously + defined with xml. + - This option is required unless I(command) is C(list_vms) or C(info). + type: str + aliases: + - guest + """ + + OPTIONS_STATE = r""" +options: + state: + description: + - Note that there may be some lag for state requests like C(shutdown) + since these refer only to VM states. After starting a guest, it may not + be immediately accessible. + state and command are mutually exclusive except when command=list_vms. In + this case all VMs in specified state will be listed. + choices: [ destroyed, paused, running, shutdown ] + type: str + """ + + OPTIONS_COMMAND = r""" +options: + command: + description: + - In addition to state management, various non-idempotent commands are available. + choices: [ create, define, destroy, freemem, get_xml, info, list_vms, nodeinfo, pause, shutdown, start, status, stop, undefine, unpause, virttype ] + type: str + """ + + OPTIONS_AUTOSTART = r""" +options: + autostart: + description: + - Start VM at host startup. + type: bool + """ + + OPTIONS_URI = r""" +options: + uri: + description: + - Libvirt connection uri. + default: qemu:///system + type: str + """ + + OPTIONS_XML = r""" +options: + xml: + description: + - XML document used with the define command. + - Must be raw XML content using C(lookup). XML cannot be reference to a file. + type: str + """ |