ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

More validate module fixes (#39097)

Browse source 
* Fix type bool DOCUMENTATION issues
This commit is contained in:
John R Barker 2018-04-24 18:05:50 +01:00 committed by GitHub
parent b533ebe20d
commit 7c4b91844d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
118 changed files with 187 additions and 398 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
lib/ansible/modules/cloud/amazon/aws_application_scaling_policy.py
View file

@ -70,7 +70,7 @@ options:
description: Whether or not to override values of minimum and/or maximum tasks if it's already set.
required: no
default: no
choices: [ 'yes', 'no' ]
type: bool
version_added: "2.6"
extends_documentation_fragment:
- aws

1
lib/ansible/modules/cloud/amazon/aws_direct_connect_connection.py
View file

@ -57,6 +57,7 @@ options:
description:
- To modify bandwidth or location the connection will need to be deleted and recreated.
By default this will not happen - this option must be set to True.
type: bool
"""
EXAMPLES = """

10
lib/ansible/modules/cloud/amazon/cloudfront_distribution.py
View file

@ -67,7 +67,7 @@ options:
specified. If no tags are specified, it removes all existing tags for the distribution. When I(purge_tags=no), existing tags are kept and I(tags)
are added, if specified.
default: 'no'
choices: ['yes', 'no']
type: bool
alias:
description:
@ -85,7 +85,7 @@ options:
- Specifies whether existing aliases will be removed before adding new aliases. When I(purge_aliases=yes), existing aliases are removed and I(aliases)
are added.
default: 'no'
choices: ['yes', 'no']
type: bool
default_root_object:
description:
@ -245,7 +245,7 @@ options:
description:
- A boolean value that specifies whether the distribution is enabled or disabled.
default: 'yes'
choices: ['yes', 'no']
type: bool
viewer_certificate:
description:
@ -280,13 +280,13 @@ options:
ipv6_enabled:
description:
- Determines whether IPv6 support is enabled or not.
choices: ['yes', 'no']
type: bool
default: 'no'
wait:
description:
- Specifies whether the module waits until the distribution has completed processing the creation or update.
choices: ['yes', 'no']
type: bool
default: 'no'
wait_timeout:

6
lib/ansible/modules/cloud/amazon/ec2_ami.py
View file

@ -44,7 +44,7 @@ options:
description:
- Wait for the AMI to be in state 'available' before returning.
default: "no"
choices: [ "yes", "no" ]
type: bool
wait_timeout:
description:
- How long before wait gives up, in seconds.
@ -62,7 +62,7 @@ options:
- Flag indicating that the bundling process should not attempt to shutdown the instance before bundling. If this flag is True, the
responsibility of maintaining file system integrity is left to the owner of the instance.
default: no
choices: [ "yes", "no" ]
type: bool
image_id:
description:
- Image ID to be deregistered.
@ -77,7 +77,7 @@ options:
description:
- Delete snapshots when deregistering the AMI.
default: "no"
choices: [ "yes", "no" ]
type: bool
tags:
description:
- A dictionary of tags to add to the new image; '{"key":"value"}' and '{"key":"value","key":"value"}'

2
lib/ansible/modules/cloud/amazon/ec2_ami_facts.py
View file

@ -39,7 +39,7 @@ options:
description:
- Describe attributes (like launchPermission) of the images found.
default: no
choices: ["yes", "no"]
type: bool
extends_documentation_fragment:
- aws

1
lib/ansible/modules/cloud/amazon/ec2_eni.py
View file

@ -64,6 +64,7 @@ options:
won't change
default: 'yes'
version_added: 2.2
type: bool
force_detach:
description:
- Force detachment of the interface. This applies either when explicitly detaching the interface by setting instance_id

2
lib/ansible/modules/cloud/amazon/ec2_group.py
View file

@ -100,7 +100,7 @@ options:
tags will not be modified.
required: false
default: yes
choices: [ 'yes', 'no' ]
type: bool
extends_documentation_fragment:
- aws

2
lib/ansible/modules/cloud/amazon/ec2_snapshot.py
View file

@ -43,7 +43,7 @@ options:
wait:
description:
- wait for the snapshot to be ready
choices: ['yes', 'no']
type: bool
required: false
default: yes
version_added: "1.5.1"

2
lib/ansible/modules/cloud/amazon/ec2_vpc_endpoint.py
View file

@ -62,7 +62,7 @@ options:
behaviour from AWS.
required: false
default: no
choices: ["yes", "no"]
type: bool
wait_timeout:
description:
- Used in conjunction with wait. Number of seconds to wait for status.

6
lib/ansible/modules/cloud/amazon/ec2_vpc_net.py
View file

@ -35,7 +35,7 @@ options:
description:
- Remove CIDRs that are associated with the VPC and are not specified in C(cidr_block).
default: no
choices: [ 'yes', 'no' ]
type: bool
version_added: '2.5'
tenancy:
description:
@ -46,12 +46,12 @@ options:
description:
- Whether to enable AWS DNS support.
default: yes
choices: [ 'yes', 'no' ]
type: bool
dns_hostnames:
description:
- Whether to enable AWS hostname support.
default: yes
choices: [ 'yes', 'no' ]
type: bool
dhcp_opts_id:
description:
- the id of the DHCP options to use for this vpc

4
lib/ansible/modules/cloud/amazon/ecs_service_facts.py
View file

@ -27,13 +27,13 @@ options:
- Set this to true if you want detailed information about the services.
required: false
default: 'false'
choices: ['true', 'false']
type: bool
events:
description:
- Whether to return ECS service events. Only has an effect if C(details) is true.
required: false
default: 'true'
choices: ['true', 'false']
type: bool
version_added: "2.6"
cluster:
description:

8
lib/ansible/modules/cloud/amazon/elb_application_lb.py
View file

@ -32,7 +32,7 @@ options:
description:
- "Whether or not to enable access logs. When true, I(access_logs_s3_bucket) must be set."
required: false
choices: [ 'yes', 'no' ]
type: bool
access_logs_s3_bucket:
description:
- The name of the S3 bucket for the access logs. This attribute is required if access logs in Amazon S3 are enabled. The bucket must exist in the same
@ -47,7 +47,7 @@ options:
- Indicates whether deletion protection for the ELB is enabled.
required: false
default: no
choices: [ 'yes', 'no' ]
type: bool
idle_timeout:
description:
- The number of seconds to wait before an idle connection is closed.
@ -68,14 +68,14 @@ options:
- If yes, existing listeners will be purged from the ELB to match exactly what is defined by I(listeners) parameter. If the I(listeners) parameter is
not set then listeners will not be modified
default: yes
choices: [ 'yes', 'no' ]
type: bool
purge_tags:
description:
- If yes, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. If the I(tags) parameter is not set then
tags will not be modified.
required: false
default: yes
choices: [ 'yes', 'no' ]
type: bool
subnets:
description:
- A list of the IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify subnets from

2
lib/ansible/modules/cloud/amazon/elb_target.py
View file

@ -19,7 +19,7 @@ options:
description:
- The default behaviour for targets that are unused is to leave them registered. If instead you would like to remove them
set I(deregister_unused) to yes.
choices: [ 'yes', 'no' ]
type: bool
target_az:
description:
- An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified

4
lib/ansible/modules/cloud/amazon/elb_target_group.py
View file

@ -78,7 +78,7 @@ options:
tags will not be modified.
required: false
default: yes
choices: [ 'yes', 'no' ]
type: bool
state:
description:
- Create or destroy the target group.
@ -87,7 +87,7 @@ options:
stickiness_enabled:
description:
- Indicates whether sticky sessions are enabled.
choices: [ 'yes', 'no' ]
type: bool
stickiness_lb_cookie_duration:
description:
- The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load

2
lib/ansible/modules/cloud/centurylink/clc_aa_policy.py
View file

@ -38,7 +38,7 @@ options:
- Whether to wait for the tasks to finish before returning.
default: True
required: False
choices: [True, False]
type: bool
requirements:
- python = 2.7
- requests >= 2.5.0

2
lib/ansible/modules/cloud/centurylink/clc_blueprint_package.py
View file

@ -41,7 +41,7 @@ options:
wait:
description:
- Whether to wait for the tasks to finish before returning.
choices: [ True, False ]
type: bool
default: True
required: False
requirements:

2
lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py
View file

@ -59,7 +59,7 @@ options:
enabled:
description:
- Whether the firewall policy is enabled or disabled
type: bool
choices: [True, False]
default: 'yes'
requirements:
- python = 2.7

2
lib/ansible/modules/cloud/centurylink/clc_group.py
View file

@ -45,7 +45,7 @@ options:
wait:
description:
- Whether to wait for the tasks to finish before returning.
choices: [ True, False ]
type: bool
default: True
required: False
requirements:

2
lib/ansible/modules/cloud/centurylink/clc_server_snapshot.py
View file

@ -39,7 +39,7 @@ options:
- Whether to wait for the provisioning tasks to finish before returning.
default: True
required: False
choices: [True, False]
type: bool
requirements:
- python = 2.7
- requests >= 2.5.0

8
lib/ansible/modules/cloud/cloudstack/cs_network_offering.py
View file

@ -50,7 +50,7 @@ options:
conserve_mode:
description:
- Whether the network offering has IP conserve mode enabled.
choices: [ yes, no ]
type: bool
details:
description:
- Network offering details in key/value pairs.
@ -69,7 +69,7 @@ options:
- If true keepalive will be turned on in the loadbalancer.
- At the time of writing this has only an effect on haproxy.
- the mode http and httpclose options are unset in the haproxy conf file.
choices: [ yes, no ]
type: bool
max_connections:
description:
- Maximum number of concurrent connections supported by the network offering.
@ -92,11 +92,11 @@ options:
description:
- Wheter the network offering supports specifying IP ranges.
- Defaulted to C(no) by the API if not specified.
choices: [ yes, no ]
type: bool
specify_vlan:
description:
- Whether the network offering supports vlans or not.
choices: [ yes, no ]
type: bool
extends_documentation_fragment: cloudstack
'''

8
lib/ansible/modules/cloud/cloudstack/cs_service_offering.py
View file

@ -36,7 +36,7 @@ options:
limit_cpu_usage:
description:
- Restrict the CPU usage to committed service offering.
choices: [ yes, no ]
type: bool
deployment_planner:
description:
- The deployment planner heuristics used to deploy a VM of this offering.
@ -77,13 +77,13 @@ options:
is_system:
description:
- Whether it is a system VM offering or not.
choices: [ yes, no ]
type: bool
default: no
is_volatile:
description:
- Whether the virtual machine needs to be volatile or not.
- Every reboot of VM the root disk is detached then destroyed and a fresh root disk is created and attached to VM.
choices: [ yes, no ]
type: bool
default: no
memory:
description:
@ -99,7 +99,7 @@ options:
offer_ha:
description:
- Whether HA is set for the service offering.
choices: [ yes, no ]
type: bool
default: no
provisioning_type:
description:

4
lib/ansible/modules/cloud/cloudstack/cs_vpn_customer_gateway.py
View file

@ -59,12 +59,12 @@ options:
description:
- Enable Dead Peer Detection.
- Disabled per default by the API on creation if not set.
choices: [ yes, no ]
type: bool
force_encap:
description:
- Force encapsulation for NAT traversal.
- Disabled per default by the API on creation if not set.
choices: [ yes, no ]
type: bool
state:
description:
- State of the VPN customer gateway.

2
lib/ansible/modules/cloud/misc/virt_net.py
View file

@ -49,7 +49,7 @@ options:
Modify was added in version 2.1
autostart:
required: false
choices: ["yes", "no"]
type: bool
description:
- Specify if a given network should be started automatically on system boot.
uri:

2
lib/ansible/modules/cloud/misc/virt_pool.py
View file

@ -49,7 +49,7 @@ options:
See examples.
autostart:
required: false
choices: ["yes", "no"]
type: bool
description:
- Specify if a given storage pool should be started automatically on system boot.
uri:

2
lib/ansible/modules/cloud/oneandone/oneandone_firewall_policy.py
View file

@ -87,7 +87,7 @@ options:
- wait for the instance to be in state 'running' before returning
required: false
default: "yes"
choices: [ "yes", "no" ]
type: bool
wait_timeout:
description:
- how long before wait gives up, in seconds

2
lib/ansible/modules/cloud/oneandone/oneandone_load_balancer.py
View file

@ -122,7 +122,7 @@ options:
- wait for the instance to be in state 'running' before returning
required: false
default: "yes"
choices: [ "yes", "no" ]
type: bool
wait_timeout:
description:
- how long before wait gives up, in seconds

2
lib/ansible/modules/cloud/oneandone/oneandone_monitoring_policy.py
View file

@ -168,7 +168,7 @@ options:
- wait for the instance to be in state 'running' before returning
required: false
default: "yes"
choices: [ "yes", "no" ]
type: bool
wait_timeout:
description:
- how long before wait gives up, in seconds

2
lib/ansible/modules/cloud/oneandone/oneandone_private_network.py
View file

@ -76,7 +76,7 @@ options:
- wait for the instance to be in state 'running' before returning
required: false
default: "yes"
choices: [ "yes", "no" ]
type: bool
wait_timeout:
description:
- how long before wait gives up, in seconds

2
lib/ansible/modules/cloud/oneandone/oneandone_public_ip.py
View file

@ -68,7 +68,7 @@ options:
- wait for the instance to be in state 'running' before returning
required: false
default: "yes"
choices: [ "yes", "no" ]
type: bool
wait_timeout:
description:
- how long before wait gives up, in seconds

2
lib/ansible/modules/cloud/profitbricks/profitbricks_datacenter.py
View file

@ -47,7 +47,7 @@ options:
- wait for the datacenter to be created before returning
required: false
default: "yes"
choices: [ "yes", "no" ]
type: bool
wait_timeout:
description:
- how long before wait gives up, in seconds

2
lib/ansible/modules/cloud/profitbricks/profitbricks_nic.py
View file

@ -48,7 +48,7 @@ options:
- wait for the operation to complete before returning
required: false
default: "yes"
choices: [ "yes", "no" ]
type: bool
wait_timeout:
description:
- how long before wait gives up, in seconds

4
lib/ansible/modules/cloud/profitbricks/profitbricks_volume.py
View file

@ -73,7 +73,7 @@ options:
description:
- Whether or not to increment a single number in the name for created virtual machines.
default: yes
choices: ["yes", "no"]
type: bool
instance_ids:
description:
- list of instance ids, currently only used when state='absent' to remove instances.
@ -91,7 +91,7 @@ options:
- wait for the datacenter to be created before returning
required: false
default: "yes"
choices: [ "yes", "no" ]
type: bool
wait_timeout:
description:
- how long before wait gives up, in seconds

2
lib/ansible/modules/cloud/profitbricks/profitbricks_volume_attachments.py
View file

@ -44,7 +44,7 @@ options:
- wait for the operation to complete before returning
required: false
default: "yes"
choices: [ "yes", "no" ]
type: bool
wait_timeout:
description:
- how long before wait gives up, in seconds

4
lib/ansible/modules/cloud/rackspace/rax_clb_nodes.py
View file

@ -62,9 +62,7 @@ options:
wait:
required: false
default: "no"
choices:
- "yes"
- "no"
type: bool
description:
- Wait for the load balancer to become active before returning
wait_timeout:

4
lib/ansible/modules/cloud/rackspace/rax_files.py
View file

@ -24,9 +24,7 @@ options:
description:
- Optionally clear existing metadata when applying metadata to existing containers.
Selecting this option is only appropriate when setting type=meta
choices:
- "yes"
- "no"
type: bool
default: "no"
container:
description:

2
lib/ansible/modules/cloud/rackspace/rax_mon_alarm.py
View file

@ -60,7 +60,7 @@ options:
description:
- If yes, create this alarm, but leave it in an inactive state. Defaults to
no.
choices: [ "yes", "no" ]
type: bool
metadata:
description:
- Arbitrary key/value pairs to accompany the alarm. Must be a hash of String

2
lib/ansible/modules/cloud/rackspace/rax_mon_check.py
View file

@ -88,7 +88,7 @@ options:
disabled:
description:
- If "yes", ensure the check is created, but don't actually use it yet.
choices: [ "yes", "no" ]
type: bool
metadata:
description:
- Hash of arbitrary key-value pairs to accompany this check if it fires.

2
lib/ansible/modules/cloud/smartos/imgadm.py
View file

@ -24,7 +24,7 @@ author: Jasper Lievisse Adriaanse (@jasperla)
options:
force:
required: false
choices: [ yes, no ]
type: bool
description:
- Force a given operation (where supported by imgadm(1M)).
pool:

4
lib/ansible/modules/cloud/vultr/vr_user.py
View file

@ -36,12 +36,12 @@ options:
description:
- Password will only be changed with enforcement.
default: no
choices: [ yes, no ]
type: bool
api_enabled:
description:
- Whether the API is enabled or not.
default: yes
choices: [ yes, no ]
type: bool
acls:
description:
- List of ACLs this users should have, see U(https://www.vultr.com/api/#user_user_list).

2
lib/ansible/modules/crypto/openssl_csr.py
View file

@ -54,7 +54,7 @@ options:
force:
required: false
default: False
choices: [ True, False ]
type: bool
description:
- Should the certificate signing request be forced regenerated by this ansible module
path:

2
lib/ansible/modules/crypto/openssl_dhparam.py
View file

@ -40,7 +40,7 @@ options:
force:
required: false
default: False
choices: [ True, False ]
type: bool
description:
- Should the parameters be regenerated even it it already exists
path:

2
lib/ansible/modules/crypto/openssl_privatekey.py
View file

@ -46,7 +46,7 @@ options:
force:
required: false
default: False
choices: [ True, False ]
type: bool
description:
- Should the key be regenerated even it it already exists
path:

2
lib/ansible/modules/crypto/openssl_publickey.py
View file

@ -35,7 +35,7 @@ options:
force:
required: false
default: False
choices: [ True, False ]
type: bool
description:
- Should the key be regenerated even it it already exists
format:

2
lib/ansible/modules/database/influxdb/influxdb_user.py
View file

@ -36,7 +36,7 @@ options:
description:
- Whether the user should be in the admin role or not.
default: no
choices: [ yes, no]
type: bool
state:
description:
- State of the user.

1
lib/ansible/modules/database/postgresql/postgresql_lang.py
View file

@ -41,7 +41,6 @@ options:
- make this language trusted for the selected db
type: bool
default: 'no'
choices: [ "yes", "no" ]
db:
description:
- name of database where the language will be added, removed or changed

6
lib/ansible/modules/files/patch.py
View file

@ -46,7 +46,7 @@ options:
description:
- If C(no), it will search for src at originating/master machine, if C(yes) it will
go to the remote/target machine for the C(src).
choices: [ 'no', 'yes' ]
type: bool
default: 'no'
strip:
description:
@ -59,7 +59,7 @@ options:
description:
- Passes C(--backup --version-control=numbered) to patch,
producing numbered backup copies.
choices: [ 'no', 'yes' ]
type: bool
default: 'no'
binary:
version_added: "2.0"
@ -67,7 +67,7 @@ options:
- Setting to C(yes) will disable patch's heuristic for transforming CRLF
line endings into LF. Line endings of src and dest must match. If set to
C(no), C(patch) will replace CRLF in C(src) files on POSIX.
choices: [ 'no', 'yes' ]
type: bool
default: 'no'
notes:
- This module requires GNU I(patch) utility to be installed on the remote host.

6
lib/ansible/modules/messaging/rabbitmq_exchange.py
View file

@ -64,7 +64,7 @@ options:
description:
- whether exchange is durable or not
required: false
choices: [ "yes", "no" ]
type: bool
default: yes
exchange_type:
description:
@ -77,13 +77,13 @@ options:
description:
- if the exchange should delete itself after all queues/exchanges unbound from it
required: false
choices: [ "yes", "no" ]
type: bool
default: no
internal:
description:
- exchange is available only for other exchanges
required: false
choices: [ "yes", "no" ]
type: bool
default: no
arguments:
description:

2
lib/ansible/modules/monitoring/airbrake_deployment.py
View file

@ -54,7 +54,7 @@ options:
on personally controlled sites using self-signed certificates.
required: false
default: 'yes'
choices: ['yes', 'no']
type: bool
requirements: []
'''

2
lib/ansible/modules/monitoring/bigpanda.py
View file

@ -68,7 +68,7 @@ options:
on personally controlled sites using self-signed certificates.
required: false
default: 'yes'
choices: ['yes', 'no']
type: bool
# informational: requirements for nodes
requirements: [ ]

2
lib/ansible/modules/monitoring/newrelic_deployment.py
View file

@ -64,7 +64,7 @@ options:
on personally controlled sites using self-signed certificates.
required: false
default: 'yes'
choices: ['yes', 'no']
type: bool
version_added: 1.5.1
requirements: []

2
lib/ansible/modules/monitoring/rollbar_deployment.py
View file

@ -59,7 +59,7 @@ options:
self-signed certificates.
required: false
default: 'yes'
choices: ['yes', 'no']
type: bool
'''
EXAMPLES = '''

2
lib/ansible/modules/monitoring/sensu_subscription.py
View file

@ -40,7 +40,7 @@ options:
description:
- Create a backup file (if yes), including the timestamp information so you
- can get the original file back if you somehow clobbered it incorrectly.
choices: [ 'yes', 'no' ]
type: bool
required: false
default: no
requirements: [ ]

2
lib/ansible/modules/monitoring/zabbix/zabbix_hostmacro.py
View file

@ -51,7 +51,7 @@ options:
description:
- Only updates an existing macro if set to C(yes).
default: 'yes'
choices: ['yes', 'no']
type: bool
version_added: 2.5
extends_documentation_fragment:

2
lib/ansible/modules/network/aos/_aos_device.py
View file

@ -65,7 +65,7 @@ options:
- The approve argument instruct the module to convert a device in quarantine
mode into approved mode.
default: "no"
choices: [ "yes", "no" ]
type: bool
location:
description:
- When approving a device using the I(approve) argument, it's possible

2
lib/ansible/modules/network/bigswitch/bcf_switch.py
View file

@ -52,7 +52,7 @@ options:
on personally controlled devices using self-signed certificates.
required: false
default: true
choices: [true, false]
type: bool
access_token:
description:
- Big Cloud Fabric access token. If this isn't set then the environment variable C(BIGSWITCH_ACCESS_TOKEN) is used.

2
lib/ansible/modules/network/bigswitch/bigmon_chain.py
View file

@ -42,7 +42,7 @@ options:
on personally controlled devices using self-signed certificates.
required: false
default: true
choices: [true, false]
type: bool
access_token:
description:
- Bigmon access token. If this isn't set, the environment variable C(BIGSWITCH_ACCESS_TOKEN) is used.

2
lib/ansible/modules/network/bigswitch/bigmon_policy.py
View file

@ -67,7 +67,7 @@ options:
on personally controlled devices using self-signed certificates.
required: false
default: true
choices: [true, false]
type: bool
access_token:
description:
- Bigmon access token. If this isn't set, the environment variable C(BIGSWITCH_ACCESS_TOKEN) is used.

4
lib/ansible/modules/network/f5/bigip_asm_policy.py
View file

@ -26,9 +26,7 @@ options:
deactivate existing active policy. Generally should be C(yes) only in cases where
you want to activate new or existing policy.
default: no
choices:
- yes
- no
type: bool
name:
description:
- The ASM policy to manage or create.

12
lib/ansible/modules/network/f5/bigip_configsync_action.py
View file

@ -32,26 +32,20 @@ options:
device to other members of the device group. In this case, the device
will do a "push" to all the other devices in the group. This option
is mutually exclusive with the C(sync_group_to_device) option.
choices:
- yes
- no
type: bool
sync_most_recent_to_device:
description:
- Specifies that the system synchronizes configuration data from the
device with the most recent configuration. In this case, the device
will do a "pull" from the most recently updated device. This option
is mutually exclusive with the C(sync_device_to_group) options.
choices:
- yes
- no
type: bool
overwrite_config:
description:
- Indicates that the sync operation overwrites the configuration on
the target.
default: no
choices:
- yes
- no
type: bool
notes:
- Requires the objectpath Python package on the host. This is as easy as
C(pip install objectpath).

4
lib/ansible/modules/network/f5/bigip_device_connectivity.py
View file

@ -50,9 +50,7 @@ options:
C(multicast_interface), C(multicast_address) and C(multicast_port) are
the defaults specified in each option's description. When C(no), ensures
that Failover Multicast configuration is disabled.
choices:
- yes
- no
type: bool
multicast_interface:
description:
- Interface over which the system sends multicast messages associated

6
lib/ansible/modules/network/f5/bigip_pool_member.py
View file

@ -91,11 +91,9 @@ options:
description:
- When state is absent and the pool member is no longer referenced
in other pools, the default behavior removes the unused node
o bject. Setting this to 'yes' disables this behavior.
object. Setting this to 'yes' disables this behavior.
default: no
choices:
- yes
- no
type: bool
version_added: 2.1
priority_group:
description:

12
lib/ansible/modules/network/fortios/fortios_ipv4_policy.py
View file

@ -53,7 +53,7 @@ options:
description:
- Negate source address param.
default: false
choices: ["true", "false"]
type: bool
dst_addr:
description:
- Specifies destination address (or group) object name(s). Required when I(state=present).
@ -61,7 +61,7 @@ options:
description:
- Negate destination address param.
default: false
choices: ["true", "false"]
type: bool
policy_action:
description:
- Specifies accept or deny action policy. Required when I(state=present).
@ -76,7 +76,7 @@ options:
description:
- Negate policy service(s) defined in service value.
default: false
choices: ["true", "false"]
type: bool
schedule:
description:
- defines policy schedule.
@ -85,12 +85,12 @@ options:
description:
- Enable or disable Nat.
default: false
choices: ["true", "false"]
type: bool
fixedport:
description:
- Use fixed port for nat.
default: false
choices: ["true", "false"]
type: bool
poolname:
description:
- Specifies NAT pool name.
@ -117,7 +117,7 @@ options:
description:
- Logs beginning of session as well.
default: false
choices: ["true", "false"]
type: bool
comment:
description:
- free text to describe policy.

2
lib/ansible/modules/network/illumos/dladm_etherstub.py
View file

@ -32,7 +32,7 @@ options:
do not persist across reboots.
required: false
default: false
choices: [ "true", "false" ]
type: bool
state:
description:
- Create or delete Solaris/illumos etherstub.

2
lib/ansible/modules/network/illumos/dladm_vnic.py
View file

@ -37,7 +37,7 @@ options:
do not persist across reboots.
required: false
default: false
choices: [ "true", "false" ]
type: bool
mac:
description:
- Sets the VNIC's MAC address. Must be valid unicast MAC address.

2
lib/ansible/modules/network/illumos/flowadm.py
View file

@ -75,7 +75,7 @@ options:
flows do not persist across reboots.
required: false
default: false
choices: [ "true", "false" ]
type: bool
state:
description:
- Create/delete/enable/disable an IP address on the network interface.

2
lib/ansible/modules/network/illumos/ipadm_if.py
View file

@ -33,7 +33,7 @@ options:
interfaces do not persist across reboots.
required: false
default: false
choices: [ "true", "false" ]
type: bool
state:
description:
- Create or delete Solaris/illumos IP interfaces.

2
lib/ansible/modules/network/illumos/ipadm_prop.py
View file

@ -40,7 +40,7 @@ options:
property values do not persist across reboots.
required: false
default: false
choices: [ "true", "false" ]
type: bool
state:
description:
- Set or reset the property value.

2
lib/ansible/modules/network/junos/junos_interface.py
View file

@ -83,7 +83,7 @@ options:
description:
- Specifies whether or not the configuration is active or deactivated
default: True
choices: [True, False]
type: bool
requirements:
- ncclient (>=v0.5.2)
notes:

2
lib/ansible/modules/network/junos/junos_l2_interface.py
View file

@ -62,7 +62,7 @@ options:
description:
- Specifies whether or not the configuration is active or deactivated
default: True
choices: [True, False]
type: bool
requirements:
- ncclient (>=v0.5.2)
notes:

2
lib/ansible/modules/network/junos/junos_l3_interface.py
View file

@ -47,7 +47,7 @@ options:
description:
- Specifies whether or not the configuration is active or deactivated
default: True
choices: [True, False]
type: bool
requirements:
- ncclient (>=v0.5.2)
notes:

2
lib/ansible/modules/network/junos/junos_linkagg.py
View file

@ -62,7 +62,7 @@ options:
description:
- Specifies whether or not the configuration is active or deactivated
default: True
choices: [True, False]
type: bool
requirements:
- ncclient (>=v0.5.2)
notes:

2
lib/ansible/modules/network/junos/junos_lldp.py
View file

@ -49,7 +49,7 @@ options:
description:
- Specifies whether or not the configuration is active or deactivated
default: True
choices: [True, False]
type: bool
requirements:
- ncclient (>=v0.5.2)
notes:

2
lib/ansible/modules/network/junos/junos_lldp_interface.py
View file

@ -38,7 +38,7 @@ options:
description:
- Specifies whether or not the configuration is active or deactivated
default: True
choices: [True, False]
type: bool
requirements:
- ncclient (>=v0.5.2)
notes:

2
lib/ansible/modules/network/junos/junos_logging.py
View file

@ -49,7 +49,7 @@ options:
description:
- Specifies whether or not the configuration is active or deactivated
default: True
choices: [True, False]
type: bool
rotate_frequency:
description:
- Rotate log frequency in minutes, this is applicable if value

2
lib/ansible/modules/network/junos/junos_static_route.py
View file

@ -54,7 +54,7 @@ options:
description:
- Specifies whether or not the configuration is active or deactivated
default: True
choices: [True, False]
type: bool
requirements:
- ncclient (>=v0.5.2)
notes:

2
lib/ansible/modules/network/junos/junos_system.py
View file

@ -59,7 +59,7 @@ options:
description:
- Specifies whether or not the configuration is active or deactivated
default: True
choices: [True, False]
type: bool
requirements:
- ncclient (>=v0.5.2)
notes:

2
lib/ansible/modules/network/junos/junos_vlan.py
View file

@ -48,7 +48,7 @@ options:
description:
- Specifies whether or not the configuration is active or deactivated
default: True
choices: [True, False]
type: bool
requirements:
- ncclient (>=v0.5.2)
notes:

3
lib/ansible/modules/network/junos/junos_vrf.py
View file

@ -54,6 +54,7 @@ options:
- Causes JUNOS to allocate a VPN label per VRF rather than per VPN FEC.
This allows for forwarding of traffic to directly connected subnets, COS
Egress filtering etc.
type: bool
aggregate:
description:
- The set of VRF definition objects to be configured on the remote
@ -73,7 +74,7 @@ options:
description:
- Specifies whether or not the configuration is active or deactivated
default: True
choices: [True, False]
type: bool
requirements:
- ncclient (>=v0.5.2)
notes:

2
lib/ansible/modules/network/nxos/nxos_evpn_global.py
View file

@ -36,7 +36,7 @@ options:
description:
- EVPN control plane.
required: true
choices: ['true', 'false']
type: bool
'''
EXAMPLES = '''

6
lib/ansible/modules/network/nxos/nxos_nxapi.py
View file

@ -51,7 +51,7 @@ options:
argument to False.
required: false
default: yes
choices: ['yes', 'no']
type: bool
aliases: ['enable_http']
https_port:
description:
@ -70,7 +70,7 @@ options:
argument to True.
required: false
default: no
choices: ['yes', 'no']
type: bool
aliases: ['enable_https']
sandbox:
description:
@ -82,7 +82,7 @@ options:
sandbox URL is unavailable. This is supported on NX-OS 7K series.
required: false
default: no
choices: ['yes', 'no']
type: bool
aliases: ['enable_sandbox']
state:
description:

4
lib/ansible/modules/network/onyx/onyx_config.py
View file

@ -87,7 +87,7 @@ options:
folder in the playbook root directory. If the directory does not
exist, it is created.
default: no
choices: ['yes', 'no']
type: bool
config:
description:
- The C(config) argument allows the playbook designer to supply
@ -100,7 +100,7 @@ options:
config to the startup-config at the conclusion of the module
running. If check mode is specified, this argument is ignored.
default: no
choices: ['yes', 'no']
type: bool
"""
EXAMPLES = """

3
lib/ansible/modules/notification/bearychat.py
View file

@ -47,8 +47,7 @@ options:
description:
- If C(yes), text will be parsed as markdown.
default: 'yes'
choices:
- 'yes'
type: bool
channel:
description:
- Channel to send the message to. If absent, the message goes to the

2
lib/ansible/modules/notification/flowdock.py
View file

@ -77,7 +77,7 @@ options:
on personally controlled sites using self-signed certificates.
required: false
default: 'yes'
choices: ['yes', 'no']
type: bool
version_added: 1.5.1
requirements: [ ]

3
lib/ansible/modules/notification/grove.py
View file

@ -47,9 +47,8 @@ options:
description:
- If C(no), SSL certificates will not be validated. This should only be used
on personally controlled sites using self-signed certificates.
required: false
default: 'yes'
choices: ['yes', 'no']
type: bool
version_added: 1.5.1
author: "Jonas Pfenniger (@zimbatm)"
'''

4
lib/ansible/modules/notification/mattermost.py
View file

@ -58,9 +58,7 @@ options:
- If C(no), SSL certificates will not be validated. This should only be used
on personally controlled sites using self-signed certificates.
default: yes
choices:
- 'yes'
- 'no'
type: bool
"""
EXAMPLES = """

5
lib/ansible/modules/notification/nexmo.py
View file

@ -46,11 +46,8 @@ options:
description:
- If C(no), SSL certificates will not be validated. This should only be used
on personally controlled sites using self-signed certificates.
required: false
type: bool
default: 'yes'
choices:
- 'yes'
- 'no'
extends_documentation_fragment:
- url
"""

16
lib/ansible/modules/packaging/language/composer.py
View file

@ -51,38 +51,38 @@ options:
version_added: "2.4"
description:
- Runs the specified command globally.
choices: [ true, false]
type: bool
default: false
aliases: [ global-command ]
prefer_source:
description:
- Forces installation from package sources when possible (see --prefer-source).
default: false
choices: [ true, false]
type: bool
aliases: [ prefer-source ]
prefer_dist:
description:
- Forces installation from package dist even for dev versions (see --prefer-dist).
default: false
choices: [ true, false]
type: bool
aliases: [ prefer-dist ]
no_dev:
description:
- Disables installation of require-dev packages (see --no-dev).
default: true
choices: [ true, false]
type: bool
aliases: [ no-dev ]
no_scripts:
description:
- Skips the execution of all scripts defined in composer.json (see --no-scripts).
default: false
choices: [ true, false]
type: bool
aliases: [ no-scripts ]
no_plugins:
description:
- Disables all plugins ( see --no-plugins ).
default: false
choices: [ true, false]
type: bool
aliases: [ no-plugins ]
optimize_autoloader:
description:
@ -90,14 +90,14 @@ options:
- Convert PSR-0/4 autoloading to classmap to get a faster autoloader.
- Recommended especially for production, but can take a bit of time to run.
default: true
choices: [ true, false]
type: bool
aliases: [ optimize-autoloader ]
ignore_platform_reqs:
version_added: "2.0"
description:
- Ignore php, hhvm, lib-* and ext-* requirements and force the installation even if the local machine does not fulfill these.
default: false
choices: [ true, false]
type: bool
aliases: [ ignore-platform-reqs ]
requirements:
- php

4
lib/ansible/modules/packaging/language/gem.py
View file

@ -39,7 +39,7 @@ options:
description:
- Whether to include dependencies or not.
required: false
choices: [ "yes", "no" ]
type: bool
default: "yes"
repository:
description:
@ -50,7 +50,7 @@ options:
description:
- Install gem in user's local gems cache or for all users
required: false
choices: ["yes", "no"]
type: bool
default: "yes"
version_added: "1.3"
executable:

8
lib/ansible/modules/packaging/language/npm.py
View file

@ -40,7 +40,7 @@ options:
- Install the node.js library globally
required: false
default: no
choices: [ "yes", "no" ]
type: bool
executable:
description:
- The executable location for npm.
@ -48,16 +48,16 @@ options:
required: false
ignore_scripts:
description:
- Use the --ignore-scripts flag when installing.
- Use the C(--ignore-scripts) flag when installing.
required: false
choices: [ "yes", "no" ]
type: bool
default: no
version_added: "1.8"
production:
description:
- Install dependencies in production mode, excluding devDependencies
required: false
choices: [ "yes", "no" ]
type: bool
default: no
registry:
description:

5
lib/ansible/modules/packaging/os/macports.py
View file

@ -33,15 +33,12 @@ options:
description:
- state of the package
choices: [ 'present', 'absent', 'active', 'inactive' ]
required: false
default: present
update_cache:
description:
- update the package db first
required: false
default: "no"
choices: [ "yes", "no" ]
notes: []
type: bool
'''
EXAMPLES = '''
- macports:

6
lib/ansible/modules/packaging/os/opkg.py
View file

@ -32,7 +32,6 @@ options:
description:
- state of the package
choices: [ 'present', 'absent' ]
required: false
default: present
force:
description:
@ -49,16 +48,13 @@ options:
- "remove"
- "checksum"
- "removal-of-dependent-packages"
required: false
default: absent
version_added: "2.0"
update_cache:
description:
- update the package db first
required: false
default: "no"
choices: [ "yes", "no" ]
notes: []
type: bool
requirements:
- opkg
- python

4
lib/ansible/modules/packaging/os/pkgng.py
View file

@ -39,7 +39,7 @@ options:
cached:
description:
- Use local package base instead of fetching an updated one.
choices: [ 'yes', 'no' ]
type: bool
required: false
default: no
annotation:
@ -81,7 +81,7 @@ options:
description:
- Remove automatically installed packages which are no longer needed.
required: false
choices: [ "yes", "no" ]
type: bool
default: no
author: "bleader (@bleader)"
notes:

2
lib/ansible/modules/packaging/os/portinstall.py
View file

@ -37,7 +37,7 @@ options:
use_packages:
description:
- use packages instead of ports whenever available
choices: [ 'yes', 'no' ]
type: bool
required: false
default: yes
author: "berenddeboer (@berenddeboer)"

2
lib/ansible/modules/packaging/os/slackpkg.py
View file

@ -45,7 +45,7 @@ options:
- update the package database first
required: false
default: false
choices: [ true, false ]
type: bool
author: Kim Nørgaard (@KimNorgaard)
requirements: [ "Slackware >= 12.2" ]

2
lib/ansible/modules/packaging/os/svr4pkg.py
View file

@ -64,7 +64,7 @@ options:
description:
- Install/Remove category instead of a single package.
required: false
choices: ["true", "false"]
type: bool
version_added: "1.6"
'''

3
lib/ansible/modules/packaging/os/yum.py
View file

@ -101,8 +101,7 @@ options:
- Has an effect only if state is I(latest)
required: false
default: "no"
choices: ["yes", "no"]
aliases: []
type: bool
version_added: "2.5"
installroot:

10
lib/ansible/modules/packaging/os/zypper.py
View file

@ -75,7 +75,7 @@ options:
I(present) or I(latest).
required: false
default: "no"
choices: [ "yes", "no" ]
type: bool
disable_recommends:
version_added: "1.8"
description:
@ -83,21 +83,21 @@ options:
install recommended packages.
required: false
default: "yes"
choices: [ "yes", "no" ]
type: bool
force:
version_added: "2.2"
description:
- Adds C(--force) option to I(zypper). Allows to downgrade packages and change vendor or architecture.
required: false
default: "no"
choices: [ "yes", "no" ]
type: bool
update_cache:
version_added: "2.2"
description:
- Run the equivalent of C(zypper refresh) before the operation. Disabled in check mode.
required: false
default: "no"
choices: [ "yes", "no" ]
type: bool
aliases: [ "refresh" ]
oldpackage:
version_added: "2.2"
@ -106,7 +106,7 @@ options:
version is specified as part of the package name.
required: false
default: "no"
choices: [ "yes", "no" ]
type: bool
extra_args:
version_added: "2.4"
required: false

2
lib/ansible/modules/remote_management/hpilo/hpilo_boot.py
View file

@ -64,7 +64,7 @@ options:
- Whether to force a reboot (even when the system is already booted).
- As a safeguard, without force, hpilo_boot will refuse to reboot a server that is already running.
default: no
choices: [ "yes", "no" ]
type: bool
ssl_version:
description:
- Change the ssl_version used.

2
lib/ansible/modules/source_control/github_hooks.py
View file

@ -50,7 +50,7 @@ options:
on personally controlled sites using self-signed certificates.
required: false
default: 'yes'
choices: ['yes', 'no']
type: bool
content_type:
description:
- Content type to use for requests made to the webhook

2
lib/ansible/modules/storage/infinidat/infini_export_client.py
View file

@ -43,7 +43,7 @@ options:
no_root_squash:
description:
- Don't squash root user to anonymous. Will be set to "no" on creation if not specified explicitly.
choices: [ "yes", "no" ]
type: bool
default: no
required: false
export:

Some files were not shown because too many files have changed in this diff Show more