internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-07 13:52:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean up module documentation (#36909)

Browse Source 
* 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:
Dag Wieers
2018-03-15 22:15:24 +01:00
committed by GitHub
parent 58eb2e849d
commit cdd21e2170
624 changed files with 1458 additions and 9114 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
lib/ansible/modules/cloud/misc/helm.py
View File

@@ -26,27 +26,21 @@ options:
host:
description:
- Tiller's server host
required: false
default: "localhost"
port:
description:
- Tiller's server port
required: false
default: 44134
namespace:
description:
- Kubernetes namespace where the chart should be installed
required: false
default: "default"
name:
description:
- Release name to manage
required: false
default: null
state:
description:
- Whether to install C(present), remove C(absent), or purge C(purged) a package.
required: false
choices: ['absent', 'purged', 'present']
default: "present"
chart:
@@ -58,18 +52,16 @@ options:
source:
type: repo
location: https://kubernetes-charts.storage.googleapis.com
required: false
default: {}
values:
description:
- A map of value options for the chart.
required: false
default: {}
disable_hooks:
description:
- Whether to disable hooks during the uninstall process
required: false
default: false
type: bool
default: 'no'
'''
RETURN = ''' # '''

47
lib/ansible/modules/cloud/misc/proxmox.py
View File

@@ -32,134 +32,100 @@ options:
description:
- the password to authenticate with
- you can use PROXMOX_PASSWORD environment variable
default: null
required: false
vmid:
description:
- the instance id
- if not set, the next available VM ID will be fetched from ProxmoxAPI.
- if not set, will be fetched from PromoxAPI based on the hostname
default: null
required: false
validate_certs:
description:
- enable / disable https certificate verification
default: false
required: false
type: bool
default: 'no'
node:
description:
- Proxmox VE node, when new VM will be created
- required only for C(state=present)
- for another states will be autodiscovered
default: null
required: false
pool:
description:
- Proxmox VE resource pool
default: null
required: false
version_added: "2.3"
password:
description:
- the instance root password
- required only for C(state=present)
default: null
required: false
hostname:
description:
- the instance hostname
- required only for C(state=present)
- must be unique if vmid is not passed
default: null
required: false
ostemplate:
description:
- the template for VM creating
- required only for C(state=present)
default: null
required: false
disk:
description:
- hard disk size in GB for instance
default: 3
required: false
cores:
description:
- Specify number of cores per socket.
required: false
default: 1
version_added: 2.4
cpus:
description:
- numbers of allocated cpus for instance
default: 1
required: false
memory:
description:
- memory size in MB for instance
default: 512
required: false
swap:
description:
- swap memory size in MB for instance
default: 0
required: false
netif:
description:
- specifies network interfaces for the container. As a hash/dictionary defining interfaces.
default: null
required: false
mounts:
description:
- specifies additional mounts (separate disks) for the container. As a hash/dictionary defining mount points
default: null
required: false
version_added: "2.2"
ip_address:
description:
- specifies the address the container will be assigned
default: null
required: false
onboot:
description:
- specifies whether a VM will be started during system bootup
default: false
required: false
type: bool
default: 'no'
storage:
description:
- target storage
default: 'local'
required: false
cpuunits:
description:
- CPU weight for a VM
default: 1000
required: false
nameserver:
description:
- sets DNS server IP address for a container
default: null
required: false
searchdomain:
description:
- sets DNS search domain for a container
default: null
required: false
timeout:
description:
- timeout for operations
default: 30
required: false
force:
description:
- forcing operations
- can be used only with states C(present), C(stopped), C(restarted)
- with C(state=present) force option allow to overwrite existing container
- with states C(stopped) , C(restarted) allow to force stop instance
default: false
required: false
type: bool
default: 'no'
state:
description:
- Indicate desired state of the instance
@@ -169,13 +135,12 @@ options:
description:
- Public key to add to /root/.ssh/authorized_keys. This was added on Proxmox 4.2, it is ignored for earlier versions
version_added: "2.3"
default: null
unprivileged:
version_added: "2.3"
description:
- Indicate if the container should be unprivileged
default: false
required: false
type: bool
default: 'no'
notes:
- Requires proxmoxer and requests modules on host. This modules can be installed with pip.

170
lib/ansible/modules/cloud/misc/proxmox_kvm.py
View File

@@ -25,21 +25,17 @@ options:
acpi:
description:
- Specify if ACPI should be enables/disabled.
required: false
default: "yes"
choices: [ "yes", "no" ]
type: bool
default: 'yes'
agent:
description:
- Specify if the QEMU GuestAgent should be enabled/disabled.
required: false
default: null
choices: [ "yes", "no" ]
type: bool
args:
description:
- Pass arbitrary arguments to kvm.
- This option is for experts only!
default: "-serial unix:/var/run/qemu-server/VMID.serial,server,nowait"
required: false
api_host:
description:
- Specify the target host of the Proxmox VE cluster.
@@ -52,109 +48,81 @@ options:
description:
- Specify the password to authenticate with.
- You can use C(PROXMOX_PASSWORD) environment variable.
default: null
required: false
autostart:
description:
- Specify, if the VM should be automatically restarted after crash (currently ignored in PVE API).
required: false
default: "no"
choices: [ "yes", "no" ]
type: bool
default: 'no'
balloon:
description:
- Specify the amount of RAM for the VM in MB.
- Using zero disables the balloon driver.
required: false
default: 0
bios:
description:
- Specify the BIOS implementation.
choices: ['seabios', 'ovmf']
required: false
default: null
boot:
description:
- Specify the boot order -> boot on floppy C(a), hard disk C(c), CD-ROM C(d), or network C(n).
- You can combine to set order.
required: false
default: cnd
bootdisk:
description:
- Enable booting from specified disk. C((ide|sata|scsi|virtio)\d+)
required: false
default: null
clone:
description:
- Name of VM to be cloned. If C(vmid) is setted, C(clone) can take arbitrary value but required for intiating the clone.
required: false
default: null
cores:
description:
- Specify number of cores per socket.
required: false
default: 1
cpu:
description:
- Specify emulated CPU type.
required: false
default: kvm64
cpulimit:
description:
- Specify if CPU usage will be limited. Value 0 indicates no CPU limit.
- If the computer has 2 CPUs, it has total of '2' CPU time
required: false
default: null
cpuunits:
description:
- Specify CPU weight for a VM.
- You can disable fair-scheduler configuration by setting this to 0
default: 1000
required: false
delete:
description:
- Specify a list of settings you want to delete.
required: false
default: null
description:
description:
- Specify the description for the VM. Only used on the configuration web interface.
- This is saved as comment inside the configuration file.
required: false
default: null
digest:
description:
- Specify if to prevent changes if current configuration file has different SHA1 digest.
- This can be used to prevent concurrent modifications.
required: false
default: null
force:
description:
- Allow to force stop VM.
- Can be used only with states C(stopped), C(restarted).
default: null
choices: [ "yes", "no" ]
required: false
type: bool
format:
description:
- Target drive's backing file's data format.
- Used only with clone
default: qcow2
choices: [ "cloop", "cow", "qcow", "qcow2", "qed", "raw", "vmdk" ]
required: false
freeze:
description:
- Specify if PVE should freeze CPU at startup (use 'c' monitor command to start execution).
required: false
default: null
choices: [ "yes", "no" ]
type: bool
full:
description:
- Create a full copy of all disk. This is always done when you clone a normal VM.
- For VM templates, we try to create a linked clone by default.
- Used only with clone
default: yes
choices: [ "yes", "no"]
required: false
type: bool
default: 'yes'
hostpci:
description:
- Specify a hash/dictionary of map host pci devices into guest. C(hostpci='{"key":"value", "key":"value"}').
@@ -165,21 +133,15 @@ options:
- C(rombar=boolean) I(default=1) Specify whether or not the device's ROM will be visible in the guest's memory map.
- C(x-vga=boolean) I(default=0) Enable vfio-vga device support.
- /!\ This option allows direct access to host hardware. So it is no longer possible to migrate such machines - use with special care.
required: false
default: null
hotplug:
description:
- Selectively enable hotplug features.
- This is a comma separated list of hotplug features C('network', 'disk', 'cpu', 'memory' and 'usb').
- Value 0 disables hotplug completely and value 1 is an alias for the default C('network,disk,usb').
required: false
default: null
hugepages:
description:
- Enable/disable hugepages memory.
choices: ['any', '2', '1024']
required: false
default: null
ide:
description:
- A hash/dictionary of volume used as IDE hard disk or CD-ROM. C(ide='{"key":"value", "key":"value"}').
@@ -188,60 +150,42 @@ options:
- C(storage) is the storage identifier where to create the disk.
- C(size) is the size of the disk in GB.
- C(format) is the drive's backing file's data format. C(qcow2|raw|subvol).
required: false
default: null
keyboard:
description:
- Sets the keyboard layout for VNC server.
required: false
default: null
kvm:
description:
- Enable/disable KVM hardware virtualization.
required: false
default: "yes"
choices: [ "yes", "no" ]
type: bool
default: 'yes'
localtime:
description:
- Sets the real time clock to local time.
- This is enabled by default if ostype indicates a Microsoft OS.
required: false
default: null
choices: [ "yes", "no" ]
type: bool
lock:
description:
- Lock/unlock the VM.
choices: ['migrate', 'backup', 'snapshot', 'rollback']
required: false
default: null
machine:
description:
- Specifies the Qemu machine type.
- type => C((pc|pc(-i440fx)?-\d+\.\d+(\.pxe)?|q35|pc-q35-\d+\.\d+(\.pxe)?))
required: false
default: null
memory:
description:
- Memory size in MB for instance.
required: false
default: 512
migrate_downtime:
description:
- Sets maximum tolerated downtime (in seconds) for migrations.
required: false
default: null
migrate_speed:
description:
- Sets maximum speed (in MB/s) for migrations.
- A value of 0 is no limit.
required: false
default: null
name:
description:
- Specifies the VM name. Only used on the configuration web interface.
- Required only for C(state=present).
default: null
required: false
net:
description:
- A hash/dictionary of network interfaces for the VM. C(net='{"key":"value", "key":"value"}').
@@ -252,21 +196,15 @@ options:
- The C(bridge) parameter can be used to automatically add the interface to a bridge device. The Proxmox VE standard bridge is called 'vmbr0'.
- Option C(rate) is used to limit traffic bandwidth from and to this interface. It is specified as floating point number, unit is 'Megabytes per second'.
- If you specify no bridge, we create a kvm 'user' (NATed) network device, which provides DHCP and DNS services.
default: null
required: false
newid:
description:
- VMID for the clone. Used only with clone.
- If newid is not set, the next available VM ID will be fetched from ProxmoxAPI.
default: null
required: false
node:
description:
- Proxmox VE node, where the new VM will be created.
- Only required for C(state=present).
- For other states, it will be autodiscovered.
default: null
required: false
numa:
description:
- A hash/dictionaries of NUMA topology. C(numa='{"key":"value", "key":"value"}').
@@ -276,50 +214,36 @@ options:
- C(hostnodes) Host NUMA nodes to use.
- C(memory) Amount of memory this NUMA node provides.
- C(policy) NUMA allocation policy.
default: null
required: false
onboot:
description:
- Specifies whether a VM will be started during system bootup.
default: "yes"
choices: [ "yes", "no" ]
required: false
type: bool
default: 'yes'
ostype:
description:
- Specifies guest operating system. This is used to enable special optimization/features for specific operating systems.
- The l26 is Linux 2.6/3.X Kernel.
choices: ['other', 'wxp', 'w2k', 'w2k3', 'w2k8', 'wvista', 'win7', 'win8', 'l24', 'l26', 'solaris']
default: l26
required: false
parallel:
description:
- A hash/dictionary of map host parallel devices. C(parallel='{"key":"value", "key":"value"}').
- Keys allowed are - (parallel[n]) where 0 ≤ n ≤ 2.
- Values allowed are - C("/dev/parport\d+|/dev/usb/lp\d+").
default: null
required: false
pool:
description:
- Add the new VM to the specified pool.
default: null
required: false
protection:
description:
- Enable/disable the protection flag of the VM. This will enable/disable the remove VM and remove disk operations.
default: null
choices: [ "yes", "no" ]
required: false
type: bool
reboot:
description:
- Allow reboot. If set to yes, the VM exit on reboot.
default: null
choices: [ "yes", "no" ]
required: false
- Allow reboot. If set to C(yes), the VM exit on reboot.
type: bool
revert:
description:
- Revert a pending change.
default: null
required: false
sata:
description:
- A hash/dictionary of volume used as sata hard disk or CD-ROM. C(sata='{"key":"value", "key":"value"}').
@@ -328,8 +252,6 @@ options:
- C(storage) is the storage identifier where to create the disk.
- C(size) is the size of the disk in GB.
- C(format) is the drive's backing file's data format. C(qcow2|raw|subvol).
default: null
required: false
scsi:
description:
- A hash/dictionary of volume used as SCSI hard disk or CD-ROM. C(scsi='{"key":"value", "key":"value"}').
@@ -338,129 +260,95 @@ options:
- C(storage) is the storage identifier where to create the disk.
- C(size) is the size of the disk in GB.
- C(format) is the drive's backing file's data format. C(qcow2|raw|subvol).
default: null
required: false
scsihw:
description:
- Specifies the SCSI controller model.
choices: ['lsi', 'lsi53c810', 'virtio-scsi-pci', 'virtio-scsi-single', 'megasas', 'pvscsi']
required: false
default: null
serial:
description:
- A hash/dictionary of serial device to create inside the VM. C('{"key":"value", "key":"value"}').
- Keys allowed are - serial[n](str; required) where 0 ≤ n ≤ 3.
- Values allowed are - C((/dev/.+|socket)).
- /!\ If you pass through a host serial device, it is no longer possible to migrate such machines - use with special care.
default: null
required: false
shares:
description:
- Rets amount of memory shares for auto-ballooning. (0 - 50000).
- The larger the number is, the more memory this VM gets.
- The number is relative to weights of all other running VMs.
- Using 0 disables auto-ballooning, this means no limit.
required: false
default: null
skiplock:
description:
- Ignore locks
- Only root is allowed to use this option.
required: false
default: null
smbios:
description:
- Specifies SMBIOS type 1 fields.
required: false
default: null
snapname:
description:
- The name of the snapshot. Used only with clone.
default: null
required: false
sockets:
description:
- Sets the number of CPU sockets. (1 - N).
required: false
default: 1
startdate:
description:
- Sets the initial date of the real time clock.
- Valid format for date are C('now') or C('2016-09-25T16:01:21') or C('2016-09-25').
required: false
default: null
startup:
description:
- Startup and shutdown behavior. C([[order=]\d+] [,up=\d+] [,down=\d+]).
- Order is a non-negative number defining the general startup order.
- Shutdown in done with reverse ordering.
required: false
default: null
state:
description:
- Indicates desired state of the instance.
- If C(current), the current state of the VM will be fecthed. You can access it with C(results.status)
choices: ['present', 'started', 'absent', 'stopped', 'restarted','current']
required: false
default: present
storage:
description:
- Target storage for full clone.
default: null
required: false
tablet:
description:
- Enables/disables the USB tablet device.
required: false
choices: [ "yes", "no" ]
default: "no"
type: bool
default: 'no'
target:
description:
- Target node. Only allowed if the original VM is on shared storage.
- Used only with clone
default: null
required: false
tdf:
description:
- Enables/disables time drift fix.
required: false
default: null
choices: [ "yes", "no" ]
type: bool
template:
description:
- Enables/disables the template.
required: false
default: "no"
choices: [ "yes", "no" ]
type: bool
default: 'no'
timeout:
description:
- Timeout for operations.
default: 30
required: false
update:
description:
- If C(yes), the VM will be update 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...
default: "no"
choices: [ "yes", "no" ]
required: false
type: bool
default: 'no'
validate_certs:
description:
- If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.
default: "no"
choices: [ "yes", "no" ]
required: false
type: bool
default: 'no'
vcpus:
description:
- Sets number of hotplugged vcpus.
required: false
default: null
vga:
description:
- Select VGA type. If you want to use high resolution modes (>= 1280x1024x16) then you should use option 'std' or 'vmware'.
choices: ['std', 'cirrus', 'vmware', 'qxl', 'serial0', 'serial1', 'serial2', 'serial3', 'qxl2', 'qxl3', 'qxl4']
required: false
default: std
virtio:
description:
@@ -470,19 +358,13 @@ options:
- C(storage) is the storage identifier where to create the disk.
- C(size) is the size of the disk in GB.
- C(format) is the drive's backing file's data format. C(qcow2|raw|subvol).
required: false
default: null
vmid:
description:
- Specifies the VM ID. Instead use I(name) parameter.
- If vmid is not set, the next available VM ID will be fetched from ProxmoxAPI.
default: null
required: false
watchdog:
description:
- Creates a virtual hardware watchdog device.
required: false
default: null
requirements: [ "proxmoxer", "requests" ]
'''

16
lib/ansible/modules/cloud/misc/proxmox_template.py
View File

@@ -33,55 +33,43 @@ options:
description:
- the password to authenticate with
- you can use PROXMOX_PASSWORD environment variable
default: null
required: false
validate_certs:
description:
- enable / disable https certificate verification
default: false
required: false
default: 'no'
type: bool
node:
description:
- Proxmox VE node, when you will operate with template
default: null
required: true
src:
description:
- path to uploaded file
- required only for C(state=present)
default: null
required: false
aliases: ['path']
template:
description:
- the template name
- required only for states C(absent), C(info)
default: null
required: false
content_type:
description:
- content type
- required only for C(state=present)
default: 'vztmpl'
required: false
choices: ['vztmpl', 'iso']
storage:
description:
- target storage
default: 'local'
required: false
timeout:
description:
- timeout for operations
default: 30
required: false
force:
description:
- can be used only with C(state=present), exists template will be overwritten
default: false
required: false
type: bool
default: 'no'
state:
description:
- Indicate desired state of the template

34
lib/ansible/modules/cloud/misc/rhevm.py
View File

@@ -28,117 +28,95 @@ options:
description:
- The user to authenticate with.
default: "admin@internal"
required: false
server:
description:
- The name/ip of your RHEV-m/oVirt instance.
default: "127.0.0.1"
required: false
port:
description:
- The port on which the API is reacheable.
default: "443"
required: false
insecure_api:
description:
- A boolean switch to make a secure or insecure connection to the server.
default: false
required: false
type: bool
default: 'no'
name:
description:
- The name of the VM.
cluster:
description:
- The rhev/ovirt cluster in which you want you VM to start.
required: false
datacenter:
description:
- The rhev/ovirt datacenter in which you want you VM to start.
required: false
default: "Default"
state:
description:
- This serves to create/remove/update or powermanage your VM.
default: "present"
required: false
choices: ['ping', 'present', 'absent', 'up', 'down', 'restarted', 'cd', 'info']
image:
description:
- The template to use for the VM.
default: null
required: false
type:
description:
- To define if the VM is a server or desktop.
default: server
required: false
choices: [ 'server', 'desktop', 'host' ]
vmhost:
description:
- The host you wish your VM to run on.
required: false
vmcpu:
description:
- The number of CPUs you want in your VM.
default: "2"
required: false
cpu_share:
description:
- This parameter is used to configure the cpu share.
default: "0"
required: false
vmmem:
description:
- The amount of memory you want your VM to use (in GB).
default: "1"
required: false
osver:
description:
- The operationsystem option in RHEV/oVirt.
default: "rhel_6x64"
required: false
mempol:
description:
- The minimum amount of memory you wish to reserve for this system.
default: "1"
required: false
vm_ha:
description:
- To make your VM High Available.
default: true
required: false
type: bool
default: 'yes'
disks:
description:
- This option uses complex arguments and is a list of disks with the options name, size and domain.
required: false
ifaces:
description:
- This option uses complex arguments and is a list of interfaces with the options name and vlan.
aliases: ['nics', 'interfaces']
required: false
boot_order:
description:
- This option uses complex arguments and is a list of items that specify the bootorder.
default: ["network","hd"]
required: false
del_prot:
description:
- This option sets the delete protection checkbox.
default: true
required: false
type: bool
default: yes
cd_drive:
description:
- The CD you wish to have mounted on the VM when I(state = 'CD').
default: null
required: false
timeout:
description:
- The timeout you wish to define for power actions.
- When I(state = 'up')
- When I(state = 'down')
- When I(state = 'restarted')
default: null
required: false
'''
RETURN = '''