mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-06 13:22:48 +00: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:
@@ -40,65 +40,48 @@ options:
|
||||
description:
|
||||
- Username of the user to be created if account did not exist.
|
||||
- Required on C(state=present).
|
||||
required: false
|
||||
default: null
|
||||
password:
|
||||
description:
|
||||
- Password of the user to be created if account did not exist.
|
||||
- Required on C(state=present).
|
||||
required: false
|
||||
default: null
|
||||
first_name:
|
||||
description:
|
||||
- First name of the user to be created if account did not exist.
|
||||
- Required on C(state=present).
|
||||
required: false
|
||||
default: null
|
||||
last_name:
|
||||
description:
|
||||
- Last name of the user to be created if account did not exist.
|
||||
- Required on C(state=present).
|
||||
required: false
|
||||
default: null
|
||||
email:
|
||||
description:
|
||||
- Email of the user to be created if account did not exist.
|
||||
- Required on C(state=present).
|
||||
required: false
|
||||
default: null
|
||||
timezone:
|
||||
description:
|
||||
- Timezone of the user to be created if account did not exist.
|
||||
required: false
|
||||
default: null
|
||||
network_domain:
|
||||
description:
|
||||
- Network domain of the account.
|
||||
required: false
|
||||
default: null
|
||||
account_type:
|
||||
description:
|
||||
- Type of the account.
|
||||
required: false
|
||||
default: 'user'
|
||||
choices: [ 'user', 'root_admin', 'domain_admin' ]
|
||||
domain:
|
||||
description:
|
||||
- Domain the account is related to.
|
||||
required: false
|
||||
default: 'ROOT'
|
||||
state:
|
||||
description:
|
||||
- State of the account.
|
||||
- C(unlocked) is an alias for C(enabled).
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent', 'enabled', 'disabled', 'locked', 'unlocked' ]
|
||||
poll_async:
|
||||
description:
|
||||
- Poll async jobs until job has finished.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
@@ -39,40 +39,29 @@ options:
|
||||
affinity_type:
|
||||
description:
|
||||
- Type of the affinity group. If not specified, first found affinity type is used.
|
||||
required: false
|
||||
default: null
|
||||
aliases: [ affinty_type ]
|
||||
description:
|
||||
description:
|
||||
- Description of the affinity group.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- State of the affinity group.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent' ]
|
||||
domain:
|
||||
description:
|
||||
- Domain the affinity group is related to.
|
||||
required: false
|
||||
default: null
|
||||
account:
|
||||
description:
|
||||
- Account the affinity group is related to.
|
||||
required: false
|
||||
default: null
|
||||
project:
|
||||
description:
|
||||
- Name of the project the affinity group is related to.
|
||||
required: false
|
||||
default: null
|
||||
poll_async:
|
||||
description:
|
||||
- Poll async jobs until job has finished.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
@@ -40,102 +40,67 @@ options:
|
||||
description:
|
||||
- Name of the zone in which the cluster belongs to.
|
||||
- If not set, default zone is used.
|
||||
required: false
|
||||
default: null
|
||||
pod:
|
||||
description:
|
||||
- Name of the pod in which the cluster belongs to.
|
||||
required: false
|
||||
default: null
|
||||
cluster_type:
|
||||
description:
|
||||
- Type of the cluster.
|
||||
- Required if C(state=present)
|
||||
required: false
|
||||
default: null
|
||||
choices: [ 'CloudManaged', 'ExternalManaged' ]
|
||||
hypervisor:
|
||||
description:
|
||||
- Name the hypervisor to be used.
|
||||
- Required if C(state=present).
|
||||
required: false
|
||||
default: none
|
||||
choices: [ 'KVM', 'VMware', 'BareMetal', 'XenServer', 'LXC', 'HyperV', 'UCS', 'OVM' ]
|
||||
url:
|
||||
description:
|
||||
- URL for the cluster
|
||||
required: false
|
||||
default: null
|
||||
username:
|
||||
description:
|
||||
- Username for the cluster.
|
||||
required: false
|
||||
default: null
|
||||
password:
|
||||
description:
|
||||
- Password for the cluster.
|
||||
required: false
|
||||
default: null
|
||||
guest_vswitch_name:
|
||||
description:
|
||||
- Name of virtual switch used for guest traffic in the cluster.
|
||||
- This would override zone wide traffic label setting.
|
||||
required: false
|
||||
default: null
|
||||
guest_vswitch_type:
|
||||
description:
|
||||
- Type of virtual switch used for guest traffic in the cluster.
|
||||
- Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)
|
||||
required: false
|
||||
default: null
|
||||
choices: [ 'vmwaresvs', 'vmwaredvs' ]
|
||||
public_vswitch_name:
|
||||
description:
|
||||
- Name of virtual switch used for public traffic in the cluster.
|
||||
- This would override zone wide traffic label setting.
|
||||
required: false
|
||||
default: null
|
||||
public_vswitch_type:
|
||||
description:
|
||||
- Type of virtual switch used for public traffic in the cluster.
|
||||
- Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)
|
||||
required: false
|
||||
default: null
|
||||
choices: [ 'vmwaresvs', 'vmwaredvs' ]
|
||||
vms_ip_address:
|
||||
description:
|
||||
- IP address of the VSM associated with this cluster.
|
||||
required: false
|
||||
default: null
|
||||
vms_username:
|
||||
description:
|
||||
- Username for the VSM associated with this cluster.
|
||||
required: false
|
||||
default: null
|
||||
vms_password:
|
||||
description:
|
||||
- Password for the VSM associated with this cluster.
|
||||
required: false
|
||||
default: null
|
||||
ovm3_cluster:
|
||||
description:
|
||||
- Ovm3 native OCFS2 clustering enabled for cluster.
|
||||
required: false
|
||||
default: null
|
||||
ovm3_pool:
|
||||
description:
|
||||
- Ovm3 native pooling enabled for cluster.
|
||||
required: false
|
||||
default: null
|
||||
ovm3_vip:
|
||||
description:
|
||||
- Ovm3 vip to use for pool (and cluster).
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- State of the cluster.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent', 'disabled', 'enabled' ]
|
||||
extends_documentation_fragment: cloudstack
|
||||
|
||||
@@ -43,29 +43,20 @@ options:
|
||||
account:
|
||||
description:
|
||||
- Ensure the value for corresponding account.
|
||||
required: false
|
||||
default: null
|
||||
domain:
|
||||
description:
|
||||
- Domain the account is related to.
|
||||
- Only considered if C(account) is used.
|
||||
required: false
|
||||
default: ROOT
|
||||
zone:
|
||||
description:
|
||||
- Ensure the value for corresponding zone.
|
||||
required: false
|
||||
default: null
|
||||
storage:
|
||||
description:
|
||||
- Ensure the value for corresponding storage pool.
|
||||
required: false
|
||||
default: null
|
||||
cluster:
|
||||
description:
|
||||
- Ensure the value for corresponding cluster.
|
||||
required: false
|
||||
default: null
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
@@ -47,45 +47,32 @@ options:
|
||||
ip_address:
|
||||
description:
|
||||
- IP address to be used for the nic.
|
||||
required: false
|
||||
default: null
|
||||
vpc:
|
||||
description:
|
||||
- Name of the VPC the C(vm) is related to.
|
||||
required: false
|
||||
default: null
|
||||
domain:
|
||||
description:
|
||||
- Domain the instance is related to.
|
||||
required: false
|
||||
default: null
|
||||
account:
|
||||
description:
|
||||
- Account the instance is related to.
|
||||
required: false
|
||||
default: null
|
||||
project:
|
||||
description:
|
||||
- Name of the project the instance is deployed in.
|
||||
required: false
|
||||
default: null
|
||||
zone:
|
||||
description:
|
||||
- Name of the zone in which the instance is deployed in.
|
||||
- If not set, default zone is used.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- State of the nic.
|
||||
required: false
|
||||
default: "present"
|
||||
choices: [ 'present', 'absent' ]
|
||||
poll_async:
|
||||
description:
|
||||
- Poll async jobs until job has finished.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
@@ -39,22 +39,15 @@ options:
|
||||
domain:
|
||||
description:
|
||||
- Domain the instance group is related to.
|
||||
required: false
|
||||
default: null
|
||||
account:
|
||||
description:
|
||||
- Account the instance group is related to.
|
||||
required: false
|
||||
default: null
|
||||
project:
|
||||
description:
|
||||
- Project the instance group is related to.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- State of the instance group.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent' ]
|
||||
extends_documentation_fragment: cloudstack
|
||||
|
||||
@@ -55,8 +55,8 @@ options:
|
||||
poll_async:
|
||||
description:
|
||||
- Poll async jobs until job has finished.
|
||||
default: yes
|
||||
type: bool
|
||||
default: 'yes'
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
@@ -40,102 +40,74 @@ options:
|
||||
description:
|
||||
- Display text of the ISO.
|
||||
- If not specified, C(name) will be used.
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.4"
|
||||
url:
|
||||
description:
|
||||
- URL where the ISO can be downloaded from. Required if C(state) is present.
|
||||
required: false
|
||||
default: null
|
||||
os_type:
|
||||
description:
|
||||
- Name of the OS that best represents the OS of this ISO. If the iso is bootable this parameter needs to be passed. Required if C(state) is present.
|
||||
required: false
|
||||
default: null
|
||||
is_ready:
|
||||
description:
|
||||
- This flag is used for searching existing ISOs. If set to C(true), it will only list ISO ready for deployment e.g.
|
||||
successfully downloaded and installed. Recommended to set it to C(false).
|
||||
required: false
|
||||
default: false
|
||||
- This flag is used for searching existing ISOs. If set to C(yes), it will only list ISO ready for deployment e.g.
|
||||
successfully downloaded and installed. Recommended to set it to C(no).
|
||||
type: bool
|
||||
default: no
|
||||
is_public:
|
||||
description:
|
||||
- Register the ISO to be publicly available to all users. Only used if C(state) is present.
|
||||
required: false
|
||||
default: null
|
||||
is_featured:
|
||||
description:
|
||||
- Register the ISO to be featured. Only used if C(state) is present.
|
||||
required: false
|
||||
default: null
|
||||
is_dynamically_scalable:
|
||||
description:
|
||||
- Register the ISO having XS/VMWare tools installed inorder to support dynamic scaling of VM cpu/memory. Only used if C(state) is present.
|
||||
required: false
|
||||
default: null
|
||||
checksum:
|
||||
description:
|
||||
- The MD5 checksum value of this ISO. If set, we search by checksum instead of name.
|
||||
required: false
|
||||
default: null
|
||||
bootable:
|
||||
description:
|
||||
- Register the ISO to be bootable. Only used if C(state) is present.
|
||||
required: false
|
||||
default: null
|
||||
domain:
|
||||
description:
|
||||
- Domain the ISO is related to.
|
||||
required: false
|
||||
default: null
|
||||
account:
|
||||
description:
|
||||
- Account the ISO is related to.
|
||||
required: false
|
||||
default: null
|
||||
project:
|
||||
description:
|
||||
- Name of the project the ISO to be registered in.
|
||||
required: false
|
||||
default: null
|
||||
zone:
|
||||
description:
|
||||
- Name of the zone you wish the ISO to be registered or deleted from.
|
||||
- If not specified, first zone found will be used.
|
||||
required: false
|
||||
default: null
|
||||
cross_zones:
|
||||
description:
|
||||
- Whether the ISO should be synced or removed across zones.
|
||||
- Mutually exclusive with C(zone).
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.4"
|
||||
iso_filter:
|
||||
description:
|
||||
- Name of the filter used to search for the ISO.
|
||||
required: false
|
||||
default: 'self'
|
||||
choices: [ 'featured', 'self', 'selfexecutable','sharedexecutable','executable', 'community' ]
|
||||
state:
|
||||
description:
|
||||
- State of the ISO.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent' ]
|
||||
poll_async:
|
||||
description:
|
||||
- Poll async jobs until job has finished.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
version_added: "2.3"
|
||||
tags:
|
||||
description:
|
||||
- List of tags. Tags are a list of dictionaries having keys C(key) and C(value).
|
||||
- "To delete all tags, set a empty list e.g. C(tags: [])."
|
||||
required: false
|
||||
default: null
|
||||
aliases: [ 'tag' ]
|
||||
version_added: "2.4"
|
||||
extends_documentation_fragment: cloudstack
|
||||
|
||||
@@ -42,13 +42,10 @@ options:
|
||||
description:
|
||||
description:
|
||||
- The description of the load balancer rule.
|
||||
required: false
|
||||
default: null
|
||||
algorithm:
|
||||
description:
|
||||
- Load balancer algorithm
|
||||
- Required when using C(state=present).
|
||||
required: false
|
||||
choices: [ 'source', 'roundrobin', 'leastconn' ]
|
||||
default: 'source'
|
||||
private_port:
|
||||
@@ -56,15 +53,12 @@ options:
|
||||
- The private port of the private ip address/virtual machine where the network traffic will be load balanced to.
|
||||
- Required when using C(state=present).
|
||||
- Can not be changed once the rule exists due API limitation.
|
||||
required: false
|
||||
default: null
|
||||
public_port:
|
||||
description:
|
||||
- The public port from where the network traffic will be load balanced from.
|
||||
- Required when using C(state=present).
|
||||
- Can not be changed once the rule exists due API limitation.
|
||||
required: true
|
||||
default: null
|
||||
ip_address:
|
||||
description:
|
||||
- Public IP address from where the network traffic will be load balanced from.
|
||||
@@ -74,45 +68,32 @@ options:
|
||||
description:
|
||||
- Whether the firewall rule for public port should be created, while creating the new rule.
|
||||
- Use M(cs_firewall) for managing firewall rules.
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
cidr:
|
||||
description:
|
||||
- CIDR (full notation) to be used for firewall rule if required.
|
||||
required: false
|
||||
default: null
|
||||
protocol:
|
||||
description:
|
||||
- The protocol to be used on the load balancer
|
||||
required: false
|
||||
default: null
|
||||
project:
|
||||
description:
|
||||
- Name of the project the load balancer IP address is related to.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- State of the rule.
|
||||
required: true
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent' ]
|
||||
domain:
|
||||
description:
|
||||
- Domain the rule is related to.
|
||||
required: false
|
||||
default: null
|
||||
account:
|
||||
description:
|
||||
- Account the rule is related to.
|
||||
required: false
|
||||
default: null
|
||||
zone:
|
||||
description:
|
||||
- Name of the zone in which the rule should be created.
|
||||
- If not set, default zone is used.
|
||||
required: false
|
||||
default: null
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
@@ -43,8 +43,6 @@ options:
|
||||
description:
|
||||
- Public IP address from where the network traffic will be load balanced from.
|
||||
- Only needed to find the rule if C(name) is not unique.
|
||||
required: false
|
||||
default: null
|
||||
aliases: [ 'public_ip' ]
|
||||
vms:
|
||||
description:
|
||||
@@ -54,30 +52,21 @@ options:
|
||||
state:
|
||||
description:
|
||||
- Should the VMs be present or absent from the rule.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent' ]
|
||||
project:
|
||||
description:
|
||||
- Name of the project the firewall rule is related to.
|
||||
required: false
|
||||
default: null
|
||||
domain:
|
||||
description:
|
||||
- Domain the rule is related to.
|
||||
required: false
|
||||
default: null
|
||||
account:
|
||||
description:
|
||||
- Account the rule is related to.
|
||||
required: false
|
||||
default: null
|
||||
zone:
|
||||
description:
|
||||
- Name of the zone in which the rule should be located.
|
||||
- If not set, default zone is used.
|
||||
required: false
|
||||
default: null
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
@@ -39,8 +39,6 @@ options:
|
||||
description:
|
||||
- Description of the network ACL.
|
||||
- If not set, identical to C(name).
|
||||
required: false
|
||||
default: null
|
||||
vpc:
|
||||
description:
|
||||
- VPC the network ACL is related to.
|
||||
@@ -48,35 +46,26 @@ options:
|
||||
state:
|
||||
description:
|
||||
- State of the network ACL.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent' ]
|
||||
domain:
|
||||
description:
|
||||
- Domain the network ACL rule is related to.
|
||||
required: false
|
||||
default: null
|
||||
account:
|
||||
description:
|
||||
- Account the network ACL rule is related to.
|
||||
required: false
|
||||
default: null
|
||||
project:
|
||||
description:
|
||||
- Name of the project the network ACL is related to.
|
||||
required: false
|
||||
default: null
|
||||
zone:
|
||||
description:
|
||||
- Name of the zone the VPC is related to.
|
||||
- If not set, default zone is used.
|
||||
required: false
|
||||
default: null
|
||||
poll_async:
|
||||
description:
|
||||
- Poll async jobs until job has finished.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
@@ -39,7 +39,6 @@ options:
|
||||
cidr:
|
||||
description:
|
||||
- CIDR of the rule.
|
||||
required: false
|
||||
default: '0.0.0.0/0'
|
||||
rule_position:
|
||||
description:
|
||||
@@ -50,39 +49,28 @@ options:
|
||||
description:
|
||||
- Protocol of the rule
|
||||
choices: [ tcp, udp, icmp, all, by_number ]
|
||||
required: false
|
||||
default: tcp
|
||||
protocol_number:
|
||||
description:
|
||||
- Protocol number from 1 to 256 required if C(protocol=by_number).
|
||||
required: false
|
||||
default: null
|
||||
start_port:
|
||||
description:
|
||||
- Start port for this rule.
|
||||
- Considered if C(protocol=tcp) or C(protocol=udp).
|
||||
required: false
|
||||
default: null
|
||||
aliases: [ port ]
|
||||
end_port:
|
||||
description:
|
||||
- End port for this rule.
|
||||
- Considered if C(protocol=tcp) or C(protocol=udp).
|
||||
- If not specified, equal C(start_port).
|
||||
required: false
|
||||
default: null
|
||||
icmp_type:
|
||||
description:
|
||||
- Type of the icmp message being sent.
|
||||
- Considered if C(protocol=icmp).
|
||||
required: false
|
||||
default: null
|
||||
icmp_code:
|
||||
description:
|
||||
- Error code for this icmp message.
|
||||
- Considered if C(protocol=icmp).
|
||||
required: false
|
||||
default: null
|
||||
vpc:
|
||||
description:
|
||||
- VPC the network ACL is related to.
|
||||
@@ -90,14 +78,12 @@ options:
|
||||
traffic_type:
|
||||
description:
|
||||
- Traffic type of the rule.
|
||||
required: false
|
||||
choices: [ ingress, egress ]
|
||||
default: ingress
|
||||
aliases: [ type ]
|
||||
action_policy:
|
||||
description:
|
||||
- Action policy of the rule.
|
||||
required: false
|
||||
choices: [ allow, deny ]
|
||||
default: ingress
|
||||
aliases: [ action ]
|
||||
@@ -105,41 +91,30 @@ options:
|
||||
description:
|
||||
- List of tags. Tags are a list of dictionaries having keys C(key) and C(value).
|
||||
- "If you want to delete all tags, set a empty list e.g. C(tags: [])."
|
||||
required: false
|
||||
default: null
|
||||
aliases: [ tag ]
|
||||
domain:
|
||||
description:
|
||||
- Domain the VPC is related to.
|
||||
required: false
|
||||
default: null
|
||||
account:
|
||||
description:
|
||||
- Account the VPC is related to.
|
||||
required: false
|
||||
default: null
|
||||
project:
|
||||
description:
|
||||
- Name of the project the VPC is related to.
|
||||
required: false
|
||||
default: null
|
||||
zone:
|
||||
description:
|
||||
- Name of the zone the VPC related to.
|
||||
- If not set, default zone is used.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- State of the network ACL rule.
|
||||
required: false
|
||||
default: present
|
||||
choices: [ present, absent ]
|
||||
poll_async:
|
||||
description:
|
||||
- Poll async jobs until job has finished.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
@@ -39,41 +39,28 @@ options:
|
||||
id:
|
||||
description:
|
||||
- uuid of the existing pod.
|
||||
default: null
|
||||
required: false
|
||||
start_ip:
|
||||
description:
|
||||
- Starting IP address for the Pod.
|
||||
- Required on C(state=present)
|
||||
default: null
|
||||
required: false
|
||||
end_ip:
|
||||
description:
|
||||
- Ending IP address for the Pod.
|
||||
default: null
|
||||
required: false
|
||||
netmask:
|
||||
description:
|
||||
- Netmask for the Pod.
|
||||
- Required on C(state=present)
|
||||
default: null
|
||||
required: false
|
||||
gateway:
|
||||
description:
|
||||
- Gateway for the Pod.
|
||||
- Required on C(state=present)
|
||||
default: null
|
||||
required: false
|
||||
zone:
|
||||
description:
|
||||
- Name of the zone in which the pod belongs to.
|
||||
- If not set, default zone is used.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- State of the pod.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'enabled', 'disabled', 'absent' ]
|
||||
extends_documentation_fragment: cloudstack
|
||||
|
||||
@@ -40,36 +40,27 @@ options:
|
||||
description:
|
||||
- Display text of the project.
|
||||
- If not specified, C(name) will be used as C(display_text).
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- State of the project.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent', 'active', 'suspended' ]
|
||||
domain:
|
||||
description:
|
||||
- Domain the project is related to.
|
||||
required: false
|
||||
default: null
|
||||
account:
|
||||
description:
|
||||
- Account the project is related to.
|
||||
required: false
|
||||
default: null
|
||||
tags:
|
||||
description:
|
||||
- List of tags. Tags are a list of dictionaries having keys C(key) and C(value).
|
||||
- "If you want to delete all tags, set a empty list e.g. C(tags: [])."
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.2"
|
||||
poll_async:
|
||||
description:
|
||||
- Poll async jobs until job has finished.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
@@ -41,18 +41,13 @@ options:
|
||||
description:
|
||||
- Name of the region.
|
||||
- Required if C(state=present)
|
||||
required: false
|
||||
default: null
|
||||
endpoint:
|
||||
description:
|
||||
- Endpoint URL of the region.
|
||||
- Required if C(state=present)
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- State of the region.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent' ]
|
||||
extends_documentation_fragment: cloudstack
|
||||
|
||||
@@ -53,24 +53,17 @@ options:
|
||||
description:
|
||||
- Maximum number of the resource.
|
||||
- Default is unlimited C(-1).
|
||||
required: false
|
||||
default: -1
|
||||
aliases: [ 'max' ]
|
||||
domain:
|
||||
description:
|
||||
- Domain the resource is related to.
|
||||
required: false
|
||||
default: null
|
||||
account:
|
||||
description:
|
||||
- Account the resource is related to.
|
||||
required: false
|
||||
default: null
|
||||
project:
|
||||
description:
|
||||
- Name of the project the resource is related to.
|
||||
required: false
|
||||
default: null
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
@@ -40,25 +40,19 @@ options:
|
||||
description:
|
||||
- ID of the role.
|
||||
- If provided, C(id) is used as key.
|
||||
required: false
|
||||
default: null
|
||||
aliases: [ 'uuid' ]
|
||||
role_type:
|
||||
description:
|
||||
- Type of the role.
|
||||
- Only considered for creation.
|
||||
required: false
|
||||
default: User
|
||||
choices: [ 'User', 'DomainAdmin', 'ResourceAdmin', 'Admin' ]
|
||||
description:
|
||||
description:
|
||||
- Description of the role.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- State of the role.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent' ]
|
||||
extends_documentation_fragment: cloudstack
|
||||
|
||||
@@ -40,34 +40,23 @@ options:
|
||||
service_offering:
|
||||
description:
|
||||
- Name or id of the service offering of the router.
|
||||
required: false
|
||||
default: null
|
||||
domain:
|
||||
description:
|
||||
- Domain the router is related to.
|
||||
required: false
|
||||
default: null
|
||||
account:
|
||||
description:
|
||||
- Account the router is related to.
|
||||
required: false
|
||||
default: null
|
||||
project:
|
||||
description:
|
||||
- Name of the project the router is related to.
|
||||
required: false
|
||||
default: null
|
||||
zone:
|
||||
description:
|
||||
- Name of the zone the router is deployed in.
|
||||
- If not set, all zones are used.
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.4"
|
||||
state:
|
||||
description:
|
||||
- State of the router.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent', 'started', 'stopped', 'restarted' ]
|
||||
poll_async:
|
||||
|
||||
@@ -41,29 +41,20 @@ options:
|
||||
domain:
|
||||
description:
|
||||
- Domain the public key is related to.
|
||||
required: false
|
||||
default: null
|
||||
account:
|
||||
description:
|
||||
- Account the public key is related to.
|
||||
required: false
|
||||
default: null
|
||||
project:
|
||||
description:
|
||||
- Name of the project the public key to be registered in.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- State of the public key.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent' ]
|
||||
public_key:
|
||||
description:
|
||||
- String of the public key.
|
||||
required: false
|
||||
default: null
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
@@ -40,57 +40,42 @@ options:
|
||||
description:
|
||||
- Name of virtual machine which we make the static NAT for.
|
||||
- Required if C(state=present).
|
||||
required: false
|
||||
default: null
|
||||
vm_guest_ip:
|
||||
description:
|
||||
- VM guest NIC secondary IP address for the static NAT.
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
network:
|
||||
description:
|
||||
- Network the IP address is related to.
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.2"
|
||||
vpc:
|
||||
description:
|
||||
- VPC the network related to.
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.3"
|
||||
state:
|
||||
description:
|
||||
- State of the static NAT.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent' ]
|
||||
domain:
|
||||
description:
|
||||
- Domain the static NAT is related to.
|
||||
required: false
|
||||
default: null
|
||||
account:
|
||||
description:
|
||||
- Account the static NAT is related to.
|
||||
required: false
|
||||
default: null
|
||||
project:
|
||||
description:
|
||||
- Name of the project the static NAT is related to.
|
||||
required: false
|
||||
default: null
|
||||
zone:
|
||||
description:
|
||||
- Name of the zone in which the virtual machine is in.
|
||||
- If not set, default zone is used.
|
||||
required: false
|
||||
default: null
|
||||
poll_async:
|
||||
description:
|
||||
- Poll async jobs until job has finished.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
@@ -40,62 +40,46 @@ options:
|
||||
description:
|
||||
- Account the user will be created under.
|
||||
- Required on C(state=present).
|
||||
required: false
|
||||
default: null
|
||||
password:
|
||||
description:
|
||||
- Password of the user to be created.
|
||||
- Required on C(state=present).
|
||||
- Only considered on creation and will not be updated if user exists.
|
||||
required: false
|
||||
default: null
|
||||
first_name:
|
||||
description:
|
||||
- First name of the user.
|
||||
- Required on C(state=present).
|
||||
required: false
|
||||
default: null
|
||||
last_name:
|
||||
description:
|
||||
- Last name of the user.
|
||||
- Required on C(state=present).
|
||||
required: false
|
||||
default: null
|
||||
email:
|
||||
description:
|
||||
- Email of the user.
|
||||
- Required on C(state=present).
|
||||
required: false
|
||||
default: null
|
||||
timezone:
|
||||
description:
|
||||
- Timezone of the user.
|
||||
required: false
|
||||
default: null
|
||||
keys_registered:
|
||||
description:
|
||||
- If API keys of the user should be generated.
|
||||
- "Note: Keys can not be removed by the API again."
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.4"
|
||||
domain:
|
||||
description:
|
||||
- Domain the user is related to.
|
||||
required: false
|
||||
default: 'ROOT'
|
||||
state:
|
||||
description:
|
||||
- State of the user.
|
||||
- C(unlocked) is an alias for C(enabled).
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'absent', 'enabled', 'disabled', 'locked', 'unlocked' ]
|
||||
poll_async:
|
||||
description:
|
||||
- Poll async jobs until job has finished.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
@@ -39,35 +39,26 @@ options:
|
||||
state:
|
||||
description:
|
||||
- State of the VPN gateway.
|
||||
required: false
|
||||
default: "present"
|
||||
choices: [ 'present', 'absent' ]
|
||||
domain:
|
||||
description:
|
||||
- Domain the VPN gateway is related to.
|
||||
required: false
|
||||
default: null
|
||||
account:
|
||||
description:
|
||||
- Account the VPN gateway is related to.
|
||||
required: false
|
||||
default: null
|
||||
project:
|
||||
description:
|
||||
- Name of the project the VPN gateway is related to.
|
||||
required: false
|
||||
default: null
|
||||
zone:
|
||||
description:
|
||||
- Name of the zone the VPC is related to.
|
||||
- If not set, default zone is used.
|
||||
required: false
|
||||
default: null
|
||||
poll_async:
|
||||
description:
|
||||
- Poll async jobs until job has finished.
|
||||
required: false
|
||||
default: true
|
||||
type: bool
|
||||
default: 'yes'
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
@@ -39,73 +39,49 @@ options:
|
||||
id:
|
||||
description:
|
||||
- uuid of the existing zone.
|
||||
default: null
|
||||
required: false
|
||||
state:
|
||||
description:
|
||||
- State of the zone.
|
||||
required: false
|
||||
default: 'present'
|
||||
choices: [ 'present', 'enabled', 'disabled', 'absent' ]
|
||||
domain:
|
||||
description:
|
||||
- Domain the zone is related to.
|
||||
- Zone is a public zone if not set.
|
||||
required: false
|
||||
default: null
|
||||
network_domain:
|
||||
description:
|
||||
- Network domain for the zone.
|
||||
required: false
|
||||
default: null
|
||||
network_type:
|
||||
description:
|
||||
- Network type of the zone.
|
||||
required: false
|
||||
default: basic
|
||||
choices: [ 'basic', 'advanced' ]
|
||||
dns1:
|
||||
description:
|
||||
- First DNS for the zone.
|
||||
- Required if C(state=present)
|
||||
required: false
|
||||
default: null
|
||||
dns2:
|
||||
description:
|
||||
- Second DNS for the zone.
|
||||
required: false
|
||||
default: null
|
||||
internal_dns1:
|
||||
description:
|
||||
- First internal DNS for the zone.
|
||||
- If not set C(dns1) will be used on C(state=present).
|
||||
required: false
|
||||
default: null
|
||||
internal_dns2:
|
||||
description:
|
||||
- Second internal DNS for the zone.
|
||||
required: false
|
||||
default: null
|
||||
dns1_ipv6:
|
||||
description:
|
||||
- First DNS for IPv6 for the zone.
|
||||
required: false
|
||||
default: null
|
||||
dns2_ipv6:
|
||||
description:
|
||||
- Second DNS for IPv6 for the zone.
|
||||
required: false
|
||||
default: null
|
||||
guest_cidr_address:
|
||||
description:
|
||||
- Guest CIDR address for the zone.
|
||||
required: false
|
||||
default: null
|
||||
dhcp_provider:
|
||||
description:
|
||||
- DHCP provider for the Zone.
|
||||
required: false
|
||||
default: null
|
||||
extends_documentation_fragment: cloudstack
|
||||
'''
|
||||
|
||||
|
||||
Reference in New Issue
Block a user