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

Adjust booleans in cloud modules. (#5155)

Browse source
This commit is contained in:
Felix Fontein 2022-08-24 20:16:25 +02:00 committed by GitHub
parent 19ce50f6b9
commit 3a08903e1c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
51 changed files with 177 additions and 177 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
plugins/modules/cloud/atomic/atomic_image.py
View file

@ -44,7 +44,7 @@ options:
description:
- Start or Stop the container.
type: bool
default: 'yes'
default: true
'''
EXAMPLES = r'''

2
plugins/modules/cloud/centurylink/clc_modify_server.py
View file

@ -59,7 +59,7 @@ options:
description:
- Whether to wait for the provisioning tasks to finish before returning.
type: bool
default: 'yes'
default: true
requirements:
- python = 2.7
- requests >= 2.5.0

2
plugins/modules/cloud/centurylink/clc_publicip.py
View file

@ -43,7 +43,7 @@ options:
description:
- Whether to wait for the tasks to finish before returning.
type: bool
default: 'yes'
default: true
requirements:
- python = 2.7
- requests >= 2.5.0

8
plugins/modules/cloud/centurylink/clc_server.py
View file

@ -25,7 +25,7 @@ options:
description:
- Whether to add a public ip to the server
type: bool
default: 'no'
default: false
alias:
description:
- The account alias to provision the servers under.
@ -96,8 +96,8 @@ options:
description:
- Whether to create the server as 'Managed' or not.
type: bool
default: 'no'
required: False
default: false
required: false
memory:
description:
- Memory in GB.
@ -194,7 +194,7 @@ options:
description:
- Whether to wait for the provisioning tasks to finish before returning.
type: bool
default: 'yes'
default: true
requirements:
- python = 2.7
- requests >= 2.5.0

8
plugins/modules/cloud/dimensiondata/dimensiondata_vlan.py
View file

@ -58,7 +58,7 @@ options:
- If C(False), the module will fail under these conditions.
- This is intended to prevent accidental expansion of a VLAN's network (since this operation is not reversible).
type: bool
default: 'no'
default: false
'''
EXAMPLES = '''
@ -72,7 +72,7 @@ EXAMPLES = '''
private_ipv4_base_address: 192.168.23.0
private_ipv4_prefix_size: 24
state: present
wait: yes
wait: true
- name: Read / get VLAN details
community.general.dimensiondata_vlan:
@ -81,7 +81,7 @@ EXAMPLES = '''
network_domain: test_network
name: my_vlan1
state: readonly
wait: yes
wait: true
- name: Delete a VLAN
community.general.dimensiondata_vlan:
@ -90,7 +90,7 @@ EXAMPLES = '''
network_domain: test_network
name: my_vlan_1
state: absent
wait: yes
wait: true
'''
RETURN = '''

2
plugins/modules/cloud/heroku/heroku_collaborator.py
View file

@ -36,7 +36,7 @@ options:
description:
- Suppress email invitation when creating collaborator
type: bool
default: "no"
default: false
user:
type: str
description:

12
plugins/modules/cloud/linode/linode.py
View file

@ -26,7 +26,7 @@ options:
- Linode API key.
- C(LINODE_API_KEY) env variable can be used instead.
type: str
required: yes
required: true
name:
description:
- Name to give the instance (alphanumeric, dashes, underscore).
@ -185,10 +185,10 @@ EXAMPLES = '''
datacenter: 2
distribution: 99
password: 'superSecureRootPassword'
private_ip: yes
private_ip: true
ssh_pub_key: 'ssh-rsa qwerty'
swap: 768
wait: yes
wait: true
wait_timeout: 600
state: present
delegate_to: localhost
@ -203,10 +203,10 @@ EXAMPLES = '''
distribution: 99
kernel_id: 138
password: 'superSecureRootPassword'
private_ip: yes
private_ip: true
ssh_pub_key: 'ssh-rsa qwerty'
swap: 768
wait: yes
wait: true
wait_timeout: 600
state: present
alert_bwquota_enabled: True
@ -239,7 +239,7 @@ EXAMPLES = '''
password: 'superSecureRootPassword'
ssh_pub_key: 'ssh-rsa qwerty'
swap: 768
wait: yes
wait: true
wait_timeout: 600
state: present
delegate_to: localhost

6
plugins/modules/cloud/lxc/lxc_container.py
View file

@ -91,7 +91,7 @@ options:
description:
- Enable a container log for host actions to the container.
type: bool
default: 'no'
default: false
container_log_level:
choices:
- Info
@ -119,13 +119,13 @@ options:
- This is not supported by all container storage backends.
- Enabling this may fail if the backing store does not support snapshots.
type: bool
default: 'no'
default: false
archive:
description:
- Create an archive of a container.
- This will create a tarball of the running container.
type: bool
default: 'no'
default: false
archive_path:
description:
- Path the save the archived container.

10
plugins/modules/cloud/misc/proxmox.py
View file

@ -86,7 +86,7 @@ options:
onboot:
description:
- specifies whether a VM will be started during system bootup
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(no).
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(false).
type: bool
storage:
description:
@ -118,7 +118,7 @@ options:
- with C(state=present) force option allow to overwrite existing container
- with states C(stopped) , C(restarted) allow to force stop instance
type: bool
default: 'no'
default: false
purge:
description:
- Remove container from all related configurations.
@ -142,7 +142,7 @@ options:
description:
- Indicate if the container should be unprivileged
type: bool
default: 'no'
default: false
description:
description:
- Specify the description for the container. Only used on the configuration web interface.
@ -239,7 +239,7 @@ EXAMPLES = r'''
password: 123456
hostname: example.org
ostemplate: 'local:vztmpl/ubuntu-14.04-x86_64.tar.gz'
force: yes
force: true
- name: Create new container with minimal options use environment PROXMOX_PASSWORD variable(you should export it before)
community.general.proxmox:
@ -369,7 +369,7 @@ EXAMPLES = r'''
api_user: root@pam
api_password: 1q2w3e
api_host: node1
force: yes
force: true
state: stopped
- name: Restart container(stopped or mounted container you can't restart)

32
plugins/modules/cloud/misc/proxmox_kvm.py
View file

@ -20,7 +20,7 @@ options:
acpi:
description:
- Specify if ACPI should be enabled/disabled.
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(yes).
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(true).
type: bool
agent:
description:
@ -38,7 +38,7 @@ options:
autostart:
description:
- Specify if the VM should be automatically restarted after crash (currently ignored in PVE API).
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(no).
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(false).
type: bool
balloon:
description:
@ -160,7 +160,7 @@ options:
description:
- Allow to force stop VM.
- Can be used with states C(stopped), C(restarted) and C(absent).
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(no).
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(false).
type: bool
format:
description:
@ -184,7 +184,7 @@ options:
- For VM templates, we try to create a linked clone by default.
- Used only with clone
type: bool
default: 'yes'
default: true
hostpci:
description:
- Specify a hash/dictionary of map host pci devices into guest. C(hostpci='{"key":"value", "key":"value"}').
@ -238,7 +238,7 @@ options:
kvm:
description:
- Enable/disable KVM hardware virtualization.
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(yes).
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(true).
type: bool
localtime:
description:
@ -314,7 +314,7 @@ options:
onboot:
description:
- Specifies whether a VM will be started during system bootup.
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(yes).
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(true).
type: bool
ostype:
description:
@ -335,7 +335,7 @@ options:
type: bool
reboot:
description:
- Allow reboot. If set to C(yes), the VM exit on reboot.
- Allow reboot. If set to C(true), the VM exit on reboot.
type: bool
revert:
description:
@ -437,7 +437,7 @@ options:
tablet:
description:
- Enables/disables the USB tablet device.
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(no).
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(false).
type: bool
tags:
description:
@ -459,7 +459,7 @@ options:
template:
description:
- Enables/disables the template.
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(no).
- This option has no default unless I(proxmox_default_behavior) is set to C(compatiblity); then the default is C(false).
type: bool
timeout:
description:
@ -468,12 +468,12 @@ options:
default: 30
update:
description:
- If C(yes), the VM will be updated with new value.
- If C(true), the VM will be updated with new value.
- Cause of the operations of the API and security reasons, I have disabled the update of the following parameters
- C(net, virtio, ide, sata, scsi). Per example updating C(net) update the MAC address and C(virtio) create always new disk...
- Update of C(pool) is disabled. It needs an additional API endpoint not covered by this module.
type: bool
default: 'no'
default: false
vcpus:
description:
- Sets number of hotplugged vcpus.
@ -625,7 +625,7 @@ EXAMPLES = '''
name: zavala
node: sabrewulf
storage: VMs
full: no
full: false
format: unspecified
timeout: 500
@ -659,7 +659,7 @@ EXAMPLES = '''
api_host: helldorado
name: spynal
node: sabrewulf
protection: yes
protection: true
- name: Create new VM using cloud-init with a username and password
community.general.proxmox_kvm:
@ -724,7 +724,7 @@ EXAMPLES = '''
name: spynal
node: sabrewulf
state: stopped
force: yes
force: true
- name: Restart VM
community.general.proxmox_kvm:
@ -762,7 +762,7 @@ EXAMPLES = '''
node: sabrewulf
cores: 8
memory: 16384
update: yes
update: true
- name: Delete QEMU parameters
community.general.proxmox_kvm:
@ -1394,7 +1394,7 @@ def main():
if module.params['force']:
proxmox.stop_vm(vm, True)
else:
module.exit_json(changed=False, vmid=vmid, msg="VM %s is running. Stop it before deletion or use force=yes." % vmid)
module.exit_json(changed=False, vmid=vmid, msg="VM %s is running. Stop it before deletion or use force=true." % vmid)
taskid = proxmox_node.qemu.delete(vmid)
if not proxmox.wait_for_task(vm['node'], taskid):
module.fail_json(msg='Reached timeout while waiting for removing VM. Last line in task before timeout: %s' %

8
plugins/modules/cloud/misc/proxmox_snap.py
View file

@ -36,12 +36,12 @@ options:
force:
description:
- For removal from config file, even if removing disk snapshot fails.
default: no
default: false
type: bool
vmstate:
description:
- Snapshot includes RAM.
default: no
default: false
type: bool
description:
description:
@ -175,8 +175,8 @@ def main():
state=dict(default='present', choices=['present', 'absent', 'rollback']),
description=dict(type='str'),
snapname=dict(type='str', default='ansible_snap'),
force=dict(type='bool', default='no'),
vmstate=dict(type='bool', default='no'),
force=dict(type='bool', default=False),
vmstate=dict(type='bool', default=False),
)
module_args.update(snap_args)

4
plugins/modules/cloud/misc/proxmox_template.py
View file

@ -52,7 +52,7 @@ options:
description:
- can be used only with C(state=present), exists template will be overwritten
type: bool
default: 'no'
default: false
state:
description:
- Indicate desired state of the template
@ -92,7 +92,7 @@ EXAMPLES = '''
storage: local
content_type: vztmpl
src: ~/ubuntu-14.04-x86_64.tar.gz
force: yes
force: true
- name: Delete template with minimal options
community.general.proxmox_template:

8
plugins/modules/cloud/misc/rhevm.py
View file

@ -45,7 +45,7 @@ options:
description:
- A boolean switch to make a secure or insecure connection to the server.
type: bool
default: no
default: false
name:
description:
- The name of the VM.
@ -108,7 +108,7 @@ options:
description:
- To make your VM High Available.
type: bool
default: yes
default: true
disks:
description:
- This option uses complex arguments and is a list of disks with the options name, size and domain.
@ -130,7 +130,7 @@ options:
description:
- This option sets the delete protection checkbox.
type: bool
default: yes
default: true
cd_drive:
description:
- The CD you wish to have mounted on the VM when I(state = 'CD').
@ -309,7 +309,7 @@ EXAMPLES = r'''
network: rhevm
ip: 172.31.222.200
netmask: 255.255.255.0
management: yes
management: true
- name: bond0.36
network: vlan36
ip: 10.2.36.200

6
plugins/modules/cloud/misc/serverless.py
View file

@ -46,17 +46,17 @@ options:
- When this option is C(false) all the functions will be built, but no stack update will be run to send them out.
- This is mostly useful for generating artifacts to be stored/deployed elsewhere.
type: bool
default: yes
default: true
force:
description:
- Whether or not to force full deployment, equivalent to serverless C(--force) option.
type: bool
default: no
default: false
verbose:
description:
- Shows all stack events during deployment, and display any Stack Output.
type: bool
default: no
default: false
notes:
- Currently, the C(serverless) command must be in the path of the node executing the task.
In the future this may be a flag.

2
plugins/modules/cloud/oneandone/oneandone_firewall_policy.py
View file

@ -83,7 +83,7 @@ options:
description:
- wait for the instance to be in state 'running' before returning
required: false
default: "yes"
default: true
type: bool
wait_timeout:
description:

2
plugins/modules/cloud/oneandone/oneandone_load_balancer.py
View file

@ -121,7 +121,7 @@ options:
description:
- wait for the instance to be in state 'running' before returning
required: false
default: "yes"
default: true
type: bool
wait_timeout:
description:

2
plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py
View file

@ -174,7 +174,7 @@ options:
description:
- wait for the instance to be in state 'running' before returning
required: false
default: "yes"
default: true
type: bool
wait_timeout:
description:

2
plugins/modules/cloud/oneandone/oneandone_private_network.py
View file

@ -71,7 +71,7 @@ options:
description:
- wait for the instance to be in state 'running' before returning
required: false
default: "yes"
default: true
type: bool
wait_timeout:
description:

2
plugins/modules/cloud/oneandone/oneandone_public_ip.py
View file

@ -59,7 +59,7 @@ options:
description:
- wait for the instance to be in state 'running' before returning
required: false
default: "yes"
default: true
type: bool
wait_timeout:
description:

6
plugins/modules/cloud/oneandone/oneandone_server.py
View file

@ -120,7 +120,7 @@ options:
for each individual server to be deleted before moving on with
other tasks.)
type: bool
default: 'yes'
default: true
wait_timeout:
description:
- how long before wait gives up, in seconds
@ -137,7 +137,7 @@ options:
hostnames by appending a count after them or substituting the count
where there is a %02d or %03d in the hostname string.
type: bool
default: 'yes'
default: true
requirements:
- "1and1"
@ -173,7 +173,7 @@ EXAMPLES = '''
datacenter: ES
appliance: C5A349786169F140BCBC335675014C08
count: 3
wait: yes
wait: true
wait_timeout: 600
wait_interval: 10
ssh_key: SSH_PUBLIC_KEY

4
plugins/modules/cloud/opennebula/one_image.py
View file

@ -102,12 +102,12 @@ EXAMPLES = '''
- name: Disable the IMAGE by id
community.general.one_image:
id: 37
enabled: no
enabled: false
- name: Enable the IMAGE by name
community.general.one_image:
name: bar-image
enabled: yes
enabled: true
- name: Clone the IMAGE by name
community.general.one_image:

14
plugins/modules/cloud/opennebula/one_service.py
View file

@ -66,10 +66,10 @@ options:
type: str
unique:
description:
- Setting C(unique=yes) will make sure that there is only one service instance running with a name set with C(service_name) when
- Setting C(unique=true) will make sure that there is only one service instance running with a name set with C(service_name) when
- instantiating a service from a template specified with C(template_id)/C(template_name). Check examples below.
type: bool
default: no
default: false
state:
description:
- C(present) - instantiate a service from a template specified with C(template_id)/C(template_name).
@ -93,7 +93,7 @@ options:
description:
- Wait for the instance to reach RUNNING state after DEPLOYING or COOLDOWN state after SCALING
type: bool
default: no
default: false
wait_timeout:
description:
- How long before wait gives up, in seconds
@ -116,7 +116,7 @@ options:
description:
- Force the new cardinality even if it is outside the limits
type: bool
default: no
default: false
author:
- "Milan Ilic (@ilicmilan)"
'''
@ -149,7 +149,7 @@ EXAMPLES = '''
community.general.one_service:
template_id: 53
service_name: 'foo'
unique: yes
unique: true
- name: Delete a service by ID
community.general.one_service:
@ -176,7 +176,7 @@ EXAMPLES = '''
- name: Wait service to become RUNNING
community.general.one_service:
service_id: 112
wait: yes
wait: true
- name: Change role cardinality
community.general.one_service:
@ -189,7 +189,7 @@ EXAMPLES = '''
service_id: 112
role: foo
cardinality: 7
wait: yes
wait: true
'''
RETURN = '''

8
plugins/modules/cloud/opennebula/one_vm.py
View file

@ -89,7 +89,7 @@ options:
hard:
description:
- Reboot, power-off or terminate instances C(hard)
default: no
default: false
type: bool
wait:
description:
@ -98,7 +98,7 @@ options:
- doesn't mean that you will be able to SSH on that machine only that
- boot process have started on that instance, see 'wait_for' example for
- details.
default: yes
default: true
type: bool
wait_timeout:
description:
@ -202,7 +202,7 @@ options:
persistent:
description:
- Create a private persistent copy of the template plus any image defined in DISK, and instantiate that copy.
default: NO
default: false
type: bool
version_added: '0.2.0'
datastore_id:
@ -251,7 +251,7 @@ EXAMPLES = '''
- name: Deploy a new VM as persistent
community.general.one_vm:
template_id: 90
persistent: yes
persistent: true
- name: Change VM's permissions to 640
community.general.one_vm:

8
plugins/modules/cloud/profitbricks/profitbricks.py
View file

@ -20,7 +20,7 @@ options:
description:
- Whether or not to increment a single number in the name for created virtual machines.
type: bool
default: 'yes'
default: true
name:
description:
- The name of the virtual machine.
@ -89,7 +89,7 @@ options:
description:
- This will assign the machine to the public LAN. If no LAN exists with public Internet access it is created.
type: bool
default: 'no'
default: false
lan:
description:
- The ID of the LAN you wish to add the servers to.
@ -107,7 +107,7 @@ options:
description:
- wait for the instance to be in state 'running' before returning
type: bool
default: 'yes'
default: true
wait_timeout:
description:
- how long before wait gives up, in seconds
@ -117,7 +117,7 @@ options:
description:
- remove the bootVolume of the virtual machine you're destroying.
type: bool
default: 'yes'
default: true
state:
description:
- create or terminate instances

2
plugins/modules/cloud/profitbricks/profitbricks_datacenter.py
View file

@ -46,7 +46,7 @@ options:
description:
- wait for the datacenter to be created before returning
required: false
default: "yes"
default: true
type: bool
wait_timeout:
description:

2
plugins/modules/cloud/profitbricks/profitbricks_nic.py
View file

@ -48,7 +48,7 @@ options:
description:
- wait for the operation to complete before returning
required: false
default: "yes"
default: true
type: bool
wait_timeout:
description:

6
plugins/modules/cloud/profitbricks/profitbricks_volume.py
View file

@ -74,7 +74,7 @@ options:
auto_increment:
description:
- Whether or not to increment a single number in the name for created virtual machines.
default: yes
default: true
type: bool
instance_ids:
description:
@ -96,7 +96,7 @@ options:
description:
- wait for the datacenter to be created before returning
required: false
default: "yes"
default: true
type: bool
wait_timeout:
description:
@ -125,7 +125,7 @@ EXAMPLES = '''
datacenter: Tardis One
name: vol%02d
count: 5
auto_increment: yes
auto_increment: true
wait_timeout: 500
state: present

2
plugins/modules/cloud/profitbricks/profitbricks_volume_attachments.py
View file

@ -41,7 +41,7 @@ options:
description:
- wait for the operation to complete before returning
required: false
default: "yes"
default: true
type: bool
wait_timeout:
description:

22
plugins/modules/cloud/rackspace/rax.py
View file

@ -22,15 +22,15 @@ options:
created servers. Only applicable when used with the I(group) attribute
or meta key.
type: bool
default: 'yes'
default: true
boot_from_volume:
description:
- Whether or not to boot the instance from a Cloud Block Storage volume.
If C(yes) and I(image) is specified a new volume will be created at
If C(true) and I(image) is specified a new volume will be created at
boot time. I(boot_volume_size) is required with I(image) to create a
new volume at boot time.
type: bool
default: 'no'
default: false
boot_volume:
type: str
description:
@ -47,12 +47,12 @@ options:
- Whether the I(boot_volume) or newly created volume from I(image) will
be terminated when the server is terminated
type: bool
default: 'no'
default: false
config_drive:
description:
- Attach read-only configuration drive to server as label config-2
type: bool
default: 'no'
default: false
count:
type: int
description:
@ -74,12 +74,12 @@ options:
exact_count:
description:
- Explicitly ensure an exact count of instances, used with
state=active/present. If specified as C(yes) and I(count) is less than
state=active/present. If specified as C(true) and I(count) is less than
the servers matched, servers will be deleted to match the count. If
the number of matched servers is fewer than specified in I(count)
additional servers will be added.
type: bool
default: 'no'
default: false
extra_client_args:
type: dict
description:
@ -157,7 +157,7 @@ options:
description:
- wait for the instance to be in state 'running' before returning
type: bool
default: 'no'
default: false
wait_timeout:
type: int
description:
@ -191,7 +191,7 @@ EXAMPLES = '''
key_name: my_rackspace_key
files:
/root/test.txt: /home/localuser/test.txt
wait: yes
wait: true
state: present
networks:
- private
@ -212,9 +212,9 @@ EXAMPLES = '''
state: present
count: 10
count_offset: 10
exact_count: yes
exact_count: true
group: test
wait: yes
wait: true
register: rax
'''

4
plugins/modules/cloud/rackspace/rax_cbs.py
View file

@ -62,7 +62,7 @@ options:
description:
- wait for the volume to be in state 'available' before returning
type: bool
default: 'no'
default: false
wait_timeout:
type: int
description:
@ -91,7 +91,7 @@ EXAMPLES = '''
volume_type: SSD
size: 150
region: DFW
wait: yes
wait: true
state: present
meta:
app: my-cool-app

4
plugins/modules/cloud/rackspace/rax_cbs_attachments.py
View file

@ -42,7 +42,7 @@ options:
description:
- wait for the volume to be in 'in-use'/'available' state before returning
type: bool
default: 'no'
default: false
wait_timeout:
type: int
description:
@ -70,7 +70,7 @@ EXAMPLES = '''
server: my-server
device: /dev/xvdd
region: DFW
wait: yes
wait: true
state: present
register: my_volume
'''

6
plugins/modules/cloud/rackspace/rax_cdb.py
View file

@ -21,7 +21,7 @@ options:
type: str
description:
- Name of the databases server instance
required: yes
required: true
flavor:
type: int
description:
@ -55,7 +55,7 @@ options:
description:
- wait for the instance to be in state 'running' before returning
type: bool
default: 'no'
default: false
wait_timeout:
type: int
description:
@ -82,7 +82,7 @@ EXAMPLES = '''
volume: 2
cdb_type: MySQL
cdb_version: 5.6
wait: yes
wait: true
state: present
register: rax_db_server
'''

4
plugins/modules/cloud/rackspace/rax_cdb_database.py
View file

@ -18,12 +18,12 @@ options:
type: str
description:
- The databases server UUID
required: yes
required: true
name:
type: str
description:
- Name to give to the database
required: yes
required: true
character_set:
type: str
description:

6
plugins/modules/cloud/rackspace/rax_cdb_user.py
View file

@ -19,17 +19,17 @@ options:
type: str
description:
- The databases server UUID
required: yes
required: true
db_username:
type: str
description:
- Name of the database user
required: yes
required: true
db_password:
type: str
description:
- Database user password
required: yes
required: true
databases:
type: list
elements: str

6
plugins/modules/cloud/rackspace/rax_clb.py
View file

@ -34,7 +34,7 @@ options:
type: str
description:
- Name to give the load balancer
required: yes
required: true
port:
type: int
description:
@ -94,7 +94,7 @@ options:
description:
- wait for the balancer to be in state 'running' before returning
type: bool
default: 'no'
default: false
wait_timeout:
type: int
description:
@ -125,7 +125,7 @@ EXAMPLES = '''
type: SERVICENET
timeout: 30
region: DFW
wait: yes
wait: true
state: present
meta:
app: my-cool-app

8
plugins/modules/cloud/rackspace/rax_clb_nodes.py
View file

@ -64,7 +64,7 @@ options:
- Type of node
wait:
required: false
default: "no"
default: false
type: bool
description:
- Wait for the load balancer to become active before returning
@ -99,7 +99,7 @@ EXAMPLES = '''
port: 80
condition: enabled
type: primary
wait: yes
wait: true
credentials: /path/to/credentials
- name: Drain connections from a node
@ -108,7 +108,7 @@ EXAMPLES = '''
load_balancer_id: 71
node_id: 410
condition: draining
wait: yes
wait: true
credentials: /path/to/credentials
- name: Remove a node from the load balancer
@ -117,7 +117,7 @@ EXAMPLES = '''
load_balancer_id: 71
node_id: 410
state: absent
wait: yes
wait: true
credentials: /path/to/credentials
'''

12
plugins/modules/cloud/rackspace/rax_files.py
View file

@ -20,7 +20,7 @@ options:
- Optionally clear existing metadata when applying metadata to existing containers.
Selecting this option is only appropriate when setting type=meta
type: bool
default: "no"
default: false
container:
type: str
description:
@ -82,7 +82,7 @@ extends_documentation_fragment:
EXAMPLES = '''
- name: "Test Cloud Files Containers"
hosts: local
gather_facts: no
gather_facts: false
tasks:
- name: "List all containers"
community.general.rax_files:
@ -112,22 +112,22 @@ EXAMPLES = '''
- name: "Make container public"
community.general.rax_files:
container: mycontainer
public: yes
public: true
- name: "Make container public with a 24 hour TTL"
community.general.rax_files:
container: mycontainer
public: yes
public: true
ttl: 86400
- name: "Make container private"
community.general.rax_files:
container: mycontainer
private: yes
private: true
- name: "Test Cloud Files Containers Metadata Storage"
hosts: local
gather_facts: no
gather_facts: false
tasks:
- name: "Get mycontainer2 metadata"
community.general.rax_files:

6
plugins/modules/cloud/rackspace/rax_files_objects.py
View file

@ -63,7 +63,7 @@ options:
from Cloud Files. Setting to false downloads the contents of a container to a single,
flat directory
type: bool
default: 'yes'
default: true
type:
type: str
description:
@ -153,14 +153,14 @@ EXAMPLES = '''
method: get
src: FileThatDoesNotExist.jpg
dest: ~/Downloads/testcont
ignore_errors: yes
ignore_errors: true
- name: "Attempt to delete remote object that does not exist"
community.general.rax_files_objects:
container: testcont
method: delete
dest: FileThatDoesNotExist.jpg
ignore_errors: yes
ignore_errors: true
- name: "Test Cloud Files Objects Metadata"
hosts: local

2
plugins/modules/cloud/rackspace/rax_mon_check.py
View file

@ -93,7 +93,7 @@ options:
256 items.
disabled:
description:
- If "yes", ensure the check is created, but don't actually use it yet.
- If C(true), ensure the check is created, but don't actually use it yet.
type: bool
default: false
metadata:

2
plugins/modules/cloud/rackspace/rax_network.py
View file

@ -27,7 +27,7 @@ options:
type: str
description:
- Label (name) to give the network
required: yes
required: true
cidr:
type: str
description:

4
plugins/modules/cloud/rackspace/rax_scaling_group.py
View file

@ -19,7 +19,7 @@ options:
description:
- Attach read-only configuration drive to server as label config-2
type: bool
default: 'no'
default: false
cooldown:
type: int
description:
@ -112,7 +112,7 @@ options:
- wait for the scaling group to finish provisioning the minimum amount of
servers
type: bool
default: 'no'
default: false
wait_timeout:
type: int
description:

2
plugins/modules/cloud/scaleway/scaleway_compute.py
View file

@ -110,7 +110,7 @@ options:
description:
- Wait for the instance to reach its desired state before returning.
type: bool
default: 'no'
default: false
wait_timeout:
type: int

2
plugins/modules/cloud/scaleway/scaleway_lb.py
View file

@ -73,7 +73,7 @@ options:
description:
- Wait for the load-balancer to reach its desired state before returning.
type: bool
default: 'no'
default: false
wait_timeout:
type: int

4
plugins/modules/cloud/smartos/nictagadm.py
View file

@ -32,7 +32,7 @@ options:
- Specifies that the nic tag will be attached to a created I(etherstub).
- Parameter I(etherstub) is mutually exclusive with both I(mtu), and I(mac).
type: bool
default: no
default: false
mtu:
description:
- Specifies the size of the I(mtu) of the desired nic tag.
@ -42,7 +42,7 @@ options:
description:
- When I(state) is absent set this switch will use the C(-f) parameter and delete the nic tag regardless of existing VMs.
type: bool
default: no
default: false
state:
description:
- Create or delete a SmartOS nic tag.

4
plugins/modules/cloud/smartos/vmadm.py
View file

@ -358,8 +358,8 @@ EXAMPLES = '''
state: present
alias: fw_zone
image_uuid: 95f265b8-96b2-11e6-9597-972f3af4b6d5
firewall_enabled: yes
indestructible_zoneroot: yes
firewall_enabled: true
indestructible_zoneroot: true
nics:
- nic_tag: admin
ip: dhcp

44
plugins/modules/cloud/softlayer/sl_vm.py
View file

@ -80,22 +80,22 @@ options:
description:
- Flag to determine if the instance should be hourly billed.
type: bool
default: 'yes'
default: true
private:
description:
- Flag to determine if the instance should be private only.
type: bool
default: 'no'
default: false
dedicated:
description:
- Flag to determine if the instance should be deployed in dedicated space.
type: bool
default: 'no'
default: false
local_disk:
description:
- Flag to determine if local disk should be used for the new instance.
type: bool
default: 'yes'
default: true
cpus:
description:
- Count of cpus to be assigned to new virtual instance.
@ -158,7 +158,7 @@ options:
description:
- Flag used to wait for active status before returning.
type: bool
default: 'yes'
default: true
wait_time:
description:
- Time in seconds before wait returns.
@ -174,7 +174,7 @@ author:
EXAMPLES = '''
- name: Build instance
hosts: localhost
gather_facts: no
gather_facts: false
tasks:
- name: Build instance request
community.general.sl_vm:
@ -182,19 +182,19 @@ EXAMPLES = '''
domain: anydomain.com
datacenter: dal09
tags: ansible-module-test
hourly: yes
private: no
dedicated: no
local_disk: yes
hourly: true
private: false
dedicated: false
local_disk: true
cpus: 1
memory: 1024
disks: [25]
os_code: UBUNTU_LATEST
wait: no
wait: false
- name: Build additional instances
hosts: localhost
gather_facts: no
gather_facts: false
tasks:
- name: Build instances request
community.general.sl_vm:
@ -219,10 +219,10 @@ EXAMPLES = '''
tags:
- ansible-module-test
- ansible-module-test-replicas
hourly: yes
private: no
dedicated: no
local_disk: yes
hourly: true
private: false
dedicated: false
local_disk: true
cpus: 1
memory: 1024
disks:
@ -237,10 +237,10 @@ EXAMPLES = '''
tags:
- ansible-module-test
- ansible-module-test-replicas
hourly: yes
private: no
dedicated: no
local_disk: yes
hourly: true
private: false
dedicated: false
local_disk: true
cpus: 1
memory: 1024
disks:
@ -248,11 +248,11 @@ EXAMPLES = '''
- 100
os_code: UBUNTU_LATEST
ssh_keys: []
wait: yes
wait: true
- name: Cancel instances
hosts: localhost
gather_facts: no
gather_facts: false
tasks:
- name: Cancel by tag
community.general.sl_vm:

4
plugins/modules/cloud/univention/udm_user.py
View file

@ -149,13 +149,13 @@ options:
type: str
overridePWHistory:
type: bool
default: 'no'
default: false
description:
- Override password history
aliases: [ override_pw_history ]
overridePWLength:
type: bool
default: 'no'
default: false
description:
- Override password check
aliases: [ override_pw_length ]

4
plugins/modules/cloud/webfaction/webfaction_app.py
View file

@ -55,7 +55,7 @@ options:
description:
- Whether the app should restart with an C(autostart.cgi) script
type: bool
default: 'no'
default: false
extra_info:
description:
@ -67,7 +67,7 @@ options:
description:
- IF the port should be opened
type: bool
default: 'no'
default: false
login_name:
description:

4
plugins/modules/cloud/webfaction/webfaction_site.py
View file

@ -53,7 +53,7 @@ options:
description:
- Whether or not to use HTTPS
type: bool
default: 'no'
default: false
site_apps:
description:
@ -92,7 +92,7 @@ EXAMPLES = '''
- 'testsite1.my_domain.org'
site_apps:
- ['testapp1', '/']
https: no
https: false
login_name: "{{webfaction_user}}"
login_password: "{{webfaction_passwd}}"
'''

24
plugins/modules/cloud/xenserver/xenserver_guest.py
View file

@ -27,7 +27,7 @@ notes:
U(https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py)'
- 'If no scheme is specified in I(hostname), module defaults to C(http://) because C(https://) is problematic in most setups. Make sure you are
accessing XenServer host in trusted environment or use C(https://) scheme explicitly.'
- 'To use C(https://) scheme for I(hostname) you have to either import host certificate to your OS certificate store or use I(validate_certs): C(no)
- 'To use C(https://) scheme for I(hostname) you have to either import host certificate to your OS certificate store or use I(validate_certs): C(false)
which requires XenAPI library from XenServer 7.2 SDK or newer and Python 2.7.9 or newer.'
- 'Network configuration inside a guest OS, by using I(networks.type), I(networks.ip), I(networks.gateway) etc. parameters, is supported on
XenServer 7.0 or newer for Windows guests by using official XenServer Guest agent support for network configuration. The module will try to
@ -93,7 +93,7 @@ options:
description:
- Convert VM to template.
type: bool
default: no
default: false
folder:
description:
- Destination folder for VM.
@ -253,21 +253,21 @@ options:
description:
- VM param name.
type: str
required: yes
required: true
value:
description:
- VM param value.
type: raw
required: yes
required: true
wait_for_ip_address:
description:
- Wait until XenServer detects an IP address for the VM. If I(state) is set to C(absent), this parameter is ignored.
- This requires XenServer Tools to be preinstalled on the VM to work properly.
type: bool
default: no
default: false
state_change_timeout:
description:
- 'By default, module will wait indefinitely for VM to accquire an IP address if I(wait_for_ip_address): C(yes).'
- 'By default, module will wait indefinitely for VM to accquire an IP address if I(wait_for_ip_address): C(true).'
- If this parameter is set to positive value, the module will instead wait specified number of seconds for the state change.
- In case of timeout, module will generate an error message.
type: int
@ -277,13 +277,13 @@ options:
- Whether to create a Linked Clone from the template, existing VM or snapshot. If no, will create a full copy.
- This is equivalent to C(Use storage-level fast disk clone) option in XenCenter.
type: bool
default: no
default: false
force:
description:
- Ignore warnings and complete the actions.
- This parameter is useful for removing VM in running state or reconfiguring VM params that require VM to be shut down.
type: bool
default: no
default: false
extends_documentation_fragment:
- community.general.xenserver.documentation
@ -295,7 +295,7 @@ EXAMPLES = r'''
hostname: "{{ xenserver_hostname }}"
username: "{{ xenserver_username }}"
password: "{{ xenserver_password }}"
validate_certs: no
validate_certs: false
folder: /testvms
name: testvm_2
state: poweredon
@ -313,7 +313,7 @@ EXAMPLES = r'''
networks:
- name: VM Network
mac: aa:bb:dd:aa:00:14
wait_for_ip_address: yes
wait_for_ip_address: true
delegate_to: localhost
register: deploy
@ -322,10 +322,10 @@ EXAMPLES = r'''
hostname: "{{ xenserver_hostname }}"
username: "{{ xenserver_username }}"
password: "{{ xenserver_password }}"
validate_certs: no
validate_certs: false
folder: /testvms
name: testvm_6
is_template: yes
is_template: true
disk:
- size_gb: 10
sr: my_sr

4
plugins/modules/cloud/xenserver/xenserver_guest_powerstate.py
View file

@ -57,10 +57,10 @@ options:
- Wait until XenServer detects an IP address for the VM.
- This requires XenServer Tools to be preinstalled on the VM to work properly.
type: bool
default: no
default: false
state_change_timeout:
description:
- 'By default, module will wait indefinitely for VM to change state or acquire an IP address if C(wait_for_ip_address: yes).'
- 'By default, module will wait indefinitely for VM to change state or acquire an IP address if C(wait_for_ip_address: true).'
- If this parameter is set to positive value, the module will instead wait specified number of seconds for the state change.
- In case of timeout, module will generate an error message.
type: int