mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-24 05:40:23 -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
|
@ -27,43 +27,30 @@ options:
|
|||
name:
|
||||
description:
|
||||
- The name of the alert policy. This is mutually exclusive with id
|
||||
required: False
|
||||
default: None
|
||||
id:
|
||||
description:
|
||||
- The alert policy id. This is mutually exclusive with name
|
||||
required: False
|
||||
default: None
|
||||
alert_recipients:
|
||||
description:
|
||||
- A list of recipient email ids to notify the alert.
|
||||
This is required for state 'present'
|
||||
required: False
|
||||
default: None
|
||||
metric:
|
||||
description:
|
||||
- The metric on which to measure the condition that will trigger the alert.
|
||||
This is required for state 'present'
|
||||
required: False
|
||||
default: None
|
||||
choices: ['cpu','memory','disk']
|
||||
duration:
|
||||
description:
|
||||
- The length of time in minutes that the condition must exceed the threshold.
|
||||
This is required for state 'present'
|
||||
required: False
|
||||
default: None
|
||||
threshold:
|
||||
description:
|
||||
- The threshold that will trigger the alert when the metric equals or exceeds it.
|
||||
This is required for state 'present'
|
||||
This number represents a percentage and must be a value between 5.0 - 95.0 that is a multiple of 5.0
|
||||
required: False
|
||||
default: None
|
||||
state:
|
||||
description:
|
||||
- Whether to create or delete the policy.
|
||||
required: False
|
||||
default: present
|
||||
choices: ['present','absent']
|
||||
requirements:
|
||||
|
|
|
@ -27,32 +27,23 @@ options:
|
|||
description:
|
||||
- Whether to create or delete the firewall policy
|
||||
default: present
|
||||
required: False
|
||||
choices: ['present', 'absent']
|
||||
source:
|
||||
description:
|
||||
- The list of source addresses for traffic on the originating firewall.
|
||||
This is required when state is 'present"
|
||||
default: None
|
||||
required: False
|
||||
This is required when state is 'present'
|
||||
destination:
|
||||
description:
|
||||
- The list of destination addresses for traffic on the terminating firewall.
|
||||
This is required when state is 'present'
|
||||
default: None
|
||||
required: False
|
||||
ports:
|
||||
description:
|
||||
- The list of ports associated with the policy.
|
||||
TCP and UDP can take in single ports or port ranges.
|
||||
default: None
|
||||
required: False
|
||||
choices: ['any', 'icmp', 'TCP/123', 'UDP/123', 'TCP/123-456', 'UDP/123-456']
|
||||
firewall_policy_id:
|
||||
description:
|
||||
- Id of the firewall policy. This is required to update or delete an existing firewall policy
|
||||
default: None
|
||||
required: False
|
||||
source_account_alias:
|
||||
description:
|
||||
- CLC alias for the source account
|
||||
|
@ -60,20 +51,16 @@ options:
|
|||
destination_account_alias:
|
||||
description:
|
||||
- CLC alias for the destination account
|
||||
default: None
|
||||
required: False
|
||||
wait:
|
||||
description:
|
||||
- Whether to wait for the provisioning tasks to finish before returning.
|
||||
default: True
|
||||
required: False
|
||||
choices: [True, False]
|
||||
type: bool
|
||||
default: 'yes'
|
||||
enabled:
|
||||
description:
|
||||
- Whether the firewall policy is enabled or disabled
|
||||
default: True
|
||||
required: False
|
||||
choices: [True, False]
|
||||
type: bool
|
||||
default: 'yes'
|
||||
requirements:
|
||||
- python = 2.7
|
||||
- requests >= 2.5.0
|
||||
|
|
|
@ -27,8 +27,6 @@ options:
|
|||
description:
|
||||
description:
|
||||
- A description for the loadbalancer
|
||||
required: False
|
||||
default: None
|
||||
alias:
|
||||
description:
|
||||
- The alias of your CLC Account
|
||||
|
@ -40,36 +38,27 @@ options:
|
|||
method:
|
||||
description:
|
||||
-The balancing method for the load balancer pool
|
||||
required: False
|
||||
default: None
|
||||
choices: ['leastConnection', 'roundRobin']
|
||||
persistence:
|
||||
description:
|
||||
- The persistence method for the load balancer
|
||||
required: False
|
||||
default: None
|
||||
choices: ['standard', 'sticky']
|
||||
port:
|
||||
description:
|
||||
- Port to configure on the public-facing side of the load balancer pool
|
||||
required: False
|
||||
default: None
|
||||
choices: [80, 443]
|
||||
nodes:
|
||||
description:
|
||||
- A list of nodes that needs to be added to the load balancer pool
|
||||
required: False
|
||||
default: []
|
||||
status:
|
||||
description:
|
||||
- The status of the loadbalancer
|
||||
required: False
|
||||
default: enabled
|
||||
choices: ['enabled', 'disabled']
|
||||
state:
|
||||
description:
|
||||
- Whether to create or delete the load balancer pool
|
||||
required: False
|
||||
default: present
|
||||
choices: ['present', 'absent', 'port_absent', 'nodes_present', 'nodes_absent']
|
||||
requirements:
|
||||
|
|
|
@ -26,49 +26,35 @@ options:
|
|||
cpu:
|
||||
description:
|
||||
- How many CPUs to update on the server
|
||||
required: False
|
||||
default: None
|
||||
memory:
|
||||
description:
|
||||
- Memory (in GB) to set to the server.
|
||||
required: False
|
||||
default: None
|
||||
anti_affinity_policy_id:
|
||||
description:
|
||||
- The anti affinity policy id to be set for a hyper scale server.
|
||||
This is mutually exclusive with 'anti_affinity_policy_name'
|
||||
required: False
|
||||
default: None
|
||||
anti_affinity_policy_name:
|
||||
description:
|
||||
- The anti affinity policy name to be set for a hyper scale server.
|
||||
This is mutually exclusive with 'anti_affinity_policy_id'
|
||||
required: False
|
||||
default: None
|
||||
alert_policy_id:
|
||||
description:
|
||||
- The alert policy id to be associated to the server.
|
||||
This is mutually exclusive with 'alert_policy_name'
|
||||
required: False
|
||||
default: None
|
||||
alert_policy_name:
|
||||
description:
|
||||
- The alert policy name to be associated to the server.
|
||||
This is mutually exclusive with 'alert_policy_id'
|
||||
required: False
|
||||
default: None
|
||||
state:
|
||||
description:
|
||||
- The state to insure that the provided resources are in.
|
||||
default: 'present'
|
||||
required: False
|
||||
choices: ['present', 'absent']
|
||||
wait:
|
||||
description:
|
||||
- Whether to wait for the provisioning tasks to finish before returning.
|
||||
default: True
|
||||
required: False
|
||||
choices: [ True, False]
|
||||
type: bool
|
||||
default: 'yes'
|
||||
requirements:
|
||||
- python = 2.7
|
||||
- requests >= 2.5.0
|
||||
|
|
|
@ -24,12 +24,9 @@ options:
|
|||
- The protocol that the public IP will listen for.
|
||||
default: TCP
|
||||
choices: ['TCP', 'UDP', 'ICMP']
|
||||
required: False
|
||||
ports:
|
||||
description:
|
||||
- A list of ports to expose. This is required when state is 'present'
|
||||
required: False
|
||||
default: None
|
||||
server_ids:
|
||||
description:
|
||||
- A list of servers to create public ips on.
|
||||
|
@ -40,13 +37,11 @@ options:
|
|||
already exists.
|
||||
default: present
|
||||
choices: ['present', 'absent']
|
||||
required: False
|
||||
wait:
|
||||
description:
|
||||
- Whether to wait for the tasks to finish before returning.
|
||||
choices: [ True, False ]
|
||||
default: True
|
||||
required: False
|
||||
type: bool
|
||||
default: 'yes'
|
||||
requirements:
|
||||
- python = 2.7
|
||||
- requests >= 2.5.0
|
||||
|
|
|
@ -22,201 +22,144 @@ options:
|
|||
additional_disks:
|
||||
description:
|
||||
- The list of additional disks for the server
|
||||
required: False
|
||||
default: []
|
||||
add_public_ip:
|
||||
description:
|
||||
- Whether to add a public ip to the server
|
||||
required: False
|
||||
default: False
|
||||
choices: [False, True]
|
||||
type: bool
|
||||
default: 'no'
|
||||
alias:
|
||||
description:
|
||||
- The account alias to provision the servers under.
|
||||
required: False
|
||||
default: None
|
||||
anti_affinity_policy_id:
|
||||
description:
|
||||
- The anti-affinity policy to assign to the server. This is mutually exclusive with 'anti_affinity_policy_name'.
|
||||
required: False
|
||||
default: None
|
||||
anti_affinity_policy_name:
|
||||
description:
|
||||
- The anti-affinity policy to assign to the server. This is mutually exclusive with 'anti_affinity_policy_id'.
|
||||
required: False
|
||||
default: None
|
||||
alert_policy_id:
|
||||
description:
|
||||
- The alert policy to assign to the server. This is mutually exclusive with 'alert_policy_name'.
|
||||
required: False
|
||||
default: None
|
||||
alert_policy_name:
|
||||
description:
|
||||
- The alert policy to assign to the server. This is mutually exclusive with 'alert_policy_id'.
|
||||
required: False
|
||||
default: None
|
||||
count:
|
||||
description:
|
||||
- The number of servers to build (mutually exclusive with exact_count)
|
||||
required: False
|
||||
default: 1
|
||||
count_group:
|
||||
description:
|
||||
- Required when exact_count is specified. The Server Group use to determine how many severs to deploy.
|
||||
required: False
|
||||
default: None
|
||||
cpu:
|
||||
description:
|
||||
- How many CPUs to provision on the server
|
||||
default: 1
|
||||
required: False
|
||||
cpu_autoscale_policy_id:
|
||||
description:
|
||||
- The autoscale policy to assign to the server.
|
||||
default: None
|
||||
required: False
|
||||
custom_fields:
|
||||
description:
|
||||
- The list of custom fields to set on the server.
|
||||
default: []
|
||||
required: False
|
||||
description:
|
||||
description:
|
||||
- The description to set for the server.
|
||||
default: None
|
||||
required: False
|
||||
exact_count:
|
||||
description:
|
||||
- Run in idempotent mode. Will insure that this exact number of servers are running in the provided group,
|
||||
creating and deleting them to reach that count. Requires count_group to be set.
|
||||
default: None
|
||||
required: False
|
||||
group:
|
||||
description:
|
||||
- The Server Group to create servers under.
|
||||
default: 'Default Group'
|
||||
required: False
|
||||
ip_address:
|
||||
description:
|
||||
- The IP Address for the server. One is assigned if not provided.
|
||||
default: None
|
||||
required: False
|
||||
location:
|
||||
description:
|
||||
- The Datacenter to create servers in.
|
||||
default: None
|
||||
required: False
|
||||
managed_os:
|
||||
description:
|
||||
- Whether to create the server as 'Managed' or not.
|
||||
default: False
|
||||
type: bool
|
||||
default: 'no'
|
||||
required: False
|
||||
choices: [True, False]
|
||||
memory:
|
||||
description:
|
||||
- Memory in GB.
|
||||
default: 1
|
||||
required: False
|
||||
name:
|
||||
description:
|
||||
- A 1 to 6 character identifier to use for the server. This is required when state is 'present'
|
||||
default: None
|
||||
required: False
|
||||
network_id:
|
||||
description:
|
||||
- The network UUID on which to create servers.
|
||||
default: None
|
||||
required: False
|
||||
packages:
|
||||
description:
|
||||
- The list of blue print packages to run on the server after its created.
|
||||
default: []
|
||||
required: False
|
||||
password:
|
||||
description:
|
||||
- Password for the administrator / root user
|
||||
default: None
|
||||
required: False
|
||||
primary_dns:
|
||||
description:
|
||||
- Primary DNS used by the server.
|
||||
default: None
|
||||
required: False
|
||||
public_ip_protocol:
|
||||
description:
|
||||
- The protocol to use for the public ip if add_public_ip is set to True.
|
||||
default: 'TCP'
|
||||
choices: ['TCP', 'UDP', 'ICMP']
|
||||
required: False
|
||||
public_ip_ports:
|
||||
description:
|
||||
- A list of ports to allow on the firewall to the servers public ip, if add_public_ip is set to True.
|
||||
default: []
|
||||
required: False
|
||||
secondary_dns:
|
||||
description:
|
||||
- Secondary DNS used by the server.
|
||||
default: None
|
||||
required: False
|
||||
server_ids:
|
||||
description:
|
||||
- Required for started, stopped, and absent states.
|
||||
A list of server Ids to insure are started, stopped, or absent.
|
||||
default: []
|
||||
required: False
|
||||
source_server_password:
|
||||
description:
|
||||
- The password for the source server if a clone is specified.
|
||||
default: None
|
||||
required: False
|
||||
state:
|
||||
description:
|
||||
- The state to insure that the provided resources are in.
|
||||
default: 'present'
|
||||
required: False
|
||||
choices: ['present', 'absent', 'started', 'stopped']
|
||||
storage_type:
|
||||
description:
|
||||
- The type of storage to attach to the server.
|
||||
default: 'standard'
|
||||
required: False
|
||||
choices: ['standard', 'hyperscale']
|
||||
template:
|
||||
description:
|
||||
- The template to use for server creation. Will search for a template if a partial string is provided.
|
||||
This is required when state is 'present'
|
||||
default: None
|
||||
required: False
|
||||
ttl:
|
||||
description:
|
||||
- The time to live for the server in seconds. The server will be deleted when this time expires.
|
||||
default: None
|
||||
required: False
|
||||
type:
|
||||
description:
|
||||
- The type of server to create.
|
||||
default: 'standard'
|
||||
required: False
|
||||
choices: ['standard', 'hyperscale', 'bareMetal']
|
||||
configuration_id:
|
||||
description:
|
||||
- Only required for bare metal servers.
|
||||
Specifies the identifier for the specific configuration type of bare metal server to deploy.
|
||||
default: None
|
||||
required: False
|
||||
os_type:
|
||||
description:
|
||||
- Only required for bare metal servers.
|
||||
Specifies the OS to provision with the bare metal server.
|
||||
default: None
|
||||
required: False
|
||||
choices: ['redHat6_64Bit', 'centOS6_64Bit', 'windows2012R2Standard_64Bit', 'ubuntu14_64Bit']
|
||||
wait:
|
||||
description:
|
||||
- Whether to wait for the provisioning tasks to finish before returning.
|
||||
default: True
|
||||
required: False
|
||||
choices: [True, False]
|
||||
type: bool
|
||||
default: 'yes'
|
||||
requirements:
|
||||
- python = 2.7
|
||||
- requests >= 2.5.0
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue