mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-02 06:30:19 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -31,94 +31,67 @@ options:
|
|||
the I(state) is not `absent` then the I(template_name) value must be
|
||||
provided. The I(template_name) must be previously uploaded to the
|
||||
catalog specified by I(catalog_name)
|
||||
required: no
|
||||
default: None
|
||||
network_name:
|
||||
description:
|
||||
- The name of the network that should be attached to the virtual machine
|
||||
in the vApp. The virtual network specified must already be created in
|
||||
the vCloud Air VDC. If the I(state) is not 'absent' then the
|
||||
I(network_name) argument must be provided.
|
||||
required: no
|
||||
default: None
|
||||
network_mode:
|
||||
description:
|
||||
- Configures the mode of the network connection.
|
||||
required: no
|
||||
default: pool
|
||||
choices: ['pool', 'dhcp', 'static']
|
||||
vm_name:
|
||||
description:
|
||||
- The name of the virtual machine instance in the vApp to manage.
|
||||
required: no
|
||||
default: None
|
||||
vm_cpus:
|
||||
description:
|
||||
- The number of vCPUs to configure for the VM in the vApp. If the
|
||||
I(vm_name) argument is provided, then this becomes a per VM setting
|
||||
otherwise it is applied to all VMs in the vApp.
|
||||
required: no
|
||||
default: None
|
||||
vm_memory:
|
||||
description:
|
||||
- The amount of memory in MB to allocate to VMs in the vApp. If the
|
||||
I(vm_name) argument is provided, then this becomes a per VM setting
|
||||
otherise it is applied to all VMs in the vApp.
|
||||
required: no
|
||||
default: None
|
||||
operation:
|
||||
description:
|
||||
- Specifies an operation to be performed on the vApp.
|
||||
required: no
|
||||
default: noop
|
||||
choices: ['noop', 'poweron', 'poweroff', 'suspend', 'shutdown', 'reboot', 'reset']
|
||||
state:
|
||||
description:
|
||||
- Configures the state of the vApp.
|
||||
required: no
|
||||
default: present
|
||||
choices: ['present', 'absent', 'deployed', 'undeployed']
|
||||
username:
|
||||
description:
|
||||
- The vCloud Air username to use during authentication
|
||||
required: false
|
||||
default: None
|
||||
password:
|
||||
description:
|
||||
- The vCloud Air password to use during authentication
|
||||
required: false
|
||||
default: None
|
||||
org:
|
||||
description:
|
||||
- The org to login to for creating vapp, mostly set when the service_type is vdc.
|
||||
required: false
|
||||
default: None
|
||||
instance_id:
|
||||
description:
|
||||
- The instance id in a vchs environment to be used for creating the vapp
|
||||
required: false
|
||||
default: None
|
||||
host:
|
||||
description:
|
||||
- The authentication host to be used when service type is vcd.
|
||||
required: false
|
||||
default: None
|
||||
api_version:
|
||||
description:
|
||||
- The api version to be used with the vca
|
||||
required: false
|
||||
default: "5.7"
|
||||
service_type:
|
||||
description:
|
||||
- The type of service we are authenticating against
|
||||
required: false
|
||||
default: vca
|
||||
choices: [ "vca", "vchs", "vcd" ]
|
||||
vdc_name:
|
||||
description:
|
||||
- The name of the virtual data center (VDC) where the vm should be created or contains the vAPP.
|
||||
required: false
|
||||
default: None
|
||||
extends_documentation_fragment: vca
|
||||
'''
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue