ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-03-31 17:36:21 +00:00
Code Activity

Adjust booleans in cloud modules. (#5155) (#5176)

Browse source 
(cherry picked from commit 3a08903e1c)

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot] 2022-08-24 20:22:10 +02:00 • committed by GitHub
parent eb1f0c28a9
commit 43dc6ba533
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
51 changed files with 177 additions and 177 deletions
Download patch file Download diff file Expand all files Collapse all files

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.