diff --git a/plugins/modules/udm_dns_record.py b/plugins/modules/udm_dns_record.py index c5bab67b97..989757f10c 100644 --- a/plugins/modules/udm_dns_record.py +++ b/plugins/modules/udm_dns_record.py @@ -16,8 +16,8 @@ author: - Tobias Rüetschi (@keachi) short_description: Manage DNS entries on a univention corporate server description: - - This module allows to manage DNS records on a univention corporate server (UCS). It uses the Python API of the UCS to create a new object - or edit it. + - This module allows to manage DNS records on a univention corporate server (UCS). It uses the Python API of the UCS to + create a new object or edit it. requirements: - Univention - ipaddress (for O(type=ptr_record)) @@ -51,8 +51,8 @@ options: type: str required: true description: - - Define the record type. V(host_record) is a A or AAAA record, V(alias) is a CNAME, V(ptr_record) is a PTR record, V(srv_record) is a SRV - record and V(txt_record) is a TXT record. + - Define the record type. V(host_record) is a A or AAAA record, V(alias) is a CNAME, V(ptr_record) is a PTR record, + V(srv_record) is a SRV record and V(txt_record) is a TXT record. - 'The available choices are: V(host_record), V(alias), V(ptr_record), V(srv_record), V(txt_record).' data: type: dict diff --git a/plugins/modules/udm_dns_zone.py b/plugins/modules/udm_dns_zone.py index 7aa5711a9b..9031ac0c25 100644 --- a/plugins/modules/udm_dns_zone.py +++ b/plugins/modules/udm_dns_zone.py @@ -16,8 +16,8 @@ author: - Tobias Rüetschi (@keachi) short_description: Manage DNS zones on a univention corporate server description: - - This module allows to manage DNS zones on a univention corporate server (UCS). It uses the Python API of the UCS to create a new object or - edit it. + - This module allows to manage DNS zones on a univention corporate server (UCS). It uses the Python API of the UCS to create + a new object or edit it. extends_documentation_fragment: - community.general.attributes attributes: diff --git a/plugins/modules/udm_group.py b/plugins/modules/udm_group.py index 238b0182ed..5564ad0e00 100644 --- a/plugins/modules/udm_group.py +++ b/plugins/modules/udm_group.py @@ -16,8 +16,8 @@ author: - Tobias Rüetschi (@keachi) short_description: Manage of the posix group description: - - This module allows to manage user groups on a univention corporate server (UCS). It uses the Python API of the UCS to create a new object - or edit it. + - This module allows to manage user groups on a univention corporate server (UCS). It uses the Python API of the UCS to + create a new object or edit it. extends_documentation_fragment: - community.general.attributes attributes: diff --git a/plugins/modules/udm_share.py b/plugins/modules/udm_share.py index 689181d83e..4b2d29b2b0 100644 --- a/plugins/modules/udm_share.py +++ b/plugins/modules/udm_share.py @@ -16,8 +16,8 @@ author: - Tobias Rüetschi (@keachi) short_description: Manage samba shares on a univention corporate server description: - - This module allows to manage samba shares on a univention corporate server (UCS). It uses the Python API of the UCS to create a new object - or edit it. + - This module allows to manage samba shares on a univention corporate server (UCS). It uses the Python API of the UCS to + create a new object or edit it. extends_documentation_fragment: - community.general.attributes attributes: diff --git a/plugins/modules/udm_user.py b/plugins/modules/udm_user.py index bb431ca75f..08327101f5 100644 --- a/plugins/modules/udm_user.py +++ b/plugins/modules/udm_user.py @@ -16,11 +16,11 @@ author: - Tobias Rüetschi (@keachi) short_description: Manage posix users on a univention corporate server description: - - This module allows to manage posix users on a univention corporate server (UCS). It uses the Python API of the UCS to create a new object - or edit it. + - This module allows to manage posix users on a univention corporate server (UCS). It uses the Python API of the UCS to + create a new object or edit it. notes: - - This module requires the deprecated L(crypt Python module, https://docs.python.org/3.12/library/crypt.html) library which was removed from - Python 3.13. For Python 3.13 or newer, you need to install L(legacycrypt, https://pypi.org/project/legacycrypt/). + - This module requires the deprecated L(crypt Python module, https://docs.python.org/3.12/library/crypt.html) library which + was removed from Python 3.13. For Python 3.13 or newer, you need to install L(legacycrypt, https://pypi.org/project/legacycrypt/). requirements: - legacycrypt (on Python 3.13 or newer) extends_documentation_fragment: @@ -104,7 +104,7 @@ options: groups: default: [] description: - - 'POSIX groups, the LDAP DNs of the groups will be found with the LDAP filter for each group as $GROUP: V((&(objectClass=posixGroup\)(cn=$GROUP\)\)).' + - 'POSIX groups, the LDAP DNs of the groups is found with the LDAP filter for each group as $GROUP: V((&(objectClass=posixGroup\)(cn=$GROUP\)\)).' type: list elements: str home_share: @@ -273,7 +273,8 @@ options: default: always choices: [always, on_create] description: - - V(always) will update passwords if they differ. V(on_create) will only set the password for newly created users. + - V(always) updates passwords if they differ. + - V(on_create) only sets the password for newly created users. type: str ou: default: '' diff --git a/plugins/modules/ufw.py b/plugins/modules/ufw.py index e0d765eeac..bfb432a4eb 100644 --- a/plugins/modules/ufw.py +++ b/plugins/modules/ufw.py @@ -22,9 +22,9 @@ author: - Ahti Kitsik (@ahtik) notes: - See C(man ufw) for more examples. - - "B(Warning:) Whilst the module itself can be run using concurrent strategies, C(ufw) does not support concurrency, as firewall rules are meant - to be ordered and parallel executions do not guarantee order. B(Do not use concurrency:) The results are unpredictable and the module may - fail silently if you do." + - B(Warning:) Whilst the module itself can be run using concurrent strategies, C(ufw) does not support concurrency, as firewall + rules are meant to be ordered and parallel executions do not guarantee order. B(Do not use concurrency:) The results are + unpredictable and the module may fail silently if you do. requirements: - C(ufw) package extends_documentation_fragment: @@ -69,14 +69,14 @@ options: description: - Allows to interpret the index in O(insert) relative to a position. - V(zero) interprets the rule number as an absolute index (that is, 1 is the first rule). - - V(first-ipv4) interprets the rule number relative to the index of the first IPv4 rule, or relative to the position where the first IPv4 - rule would be if there is currently none. - - V(last-ipv4) interprets the rule number relative to the index of the last IPv4 rule, or relative to the position where the last IPv4 rule - would be if there is currently none. - - V(first-ipv6) interprets the rule number relative to the index of the first IPv6 rule, or relative to the position where the first IPv6 - rule would be if there is currently none. - - V(last-ipv6) interprets the rule number relative to the index of the last IPv6 rule, or relative to the position where the last IPv6 rule - would be if there is currently none. + - V(first-ipv4) interprets the rule number relative to the index of the first IPv4 rule, or relative to the position + where the first IPv4 rule would be if there is currently none. + - V(last-ipv4) interprets the rule number relative to the index of the last IPv4 rule, or relative to the position where + the last IPv4 rule would be if there is currently none. + - V(first-ipv6) interprets the rule number relative to the index of the first IPv6 rule, or relative to the position + where the first IPv6 rule would be if there is currently none. + - V(last-ipv6) interprets the rule number relative to the index of the last IPv6 rule, or relative to the position where + the last IPv6 rule would be if there is currently none. type: str choices: [first-ipv4, first-ipv6, last-ipv4, last-ipv6, zero] default: zero @@ -130,22 +130,22 @@ options: default: false interface: description: - - Specify interface for the rule. The direction (in or out) used for the interface depends on the value of O(direction). See O(interface_in) - and O(interface_out) for routed rules that needs to supply both an input and output interface. Mutually exclusive with O(interface_in) - and O(interface_out). + - Specify interface for the rule. The direction (in or out) used for the interface depends on the value of O(direction). + See O(interface_in) and O(interface_out) for routed rules that needs to supply both an input and output interface. + Mutually exclusive with O(interface_in) and O(interface_out). type: str aliases: [if] interface_in: description: - - Specify input interface for the rule. This is mutually exclusive with O(direction) and O(interface). However, it is compatible with O(interface_out) - for routed rules. + - Specify input interface for the rule. This is mutually exclusive with O(direction) and O(interface). However, it is + compatible with O(interface_out) for routed rules. type: str aliases: [if_in] version_added: '0.2.0' interface_out: description: - - Specify output interface for the rule. This is mutually exclusive with O(direction) and O(interface). However, it is compatible with O(interface_in) - for routed rules. + - Specify output interface for the rule. This is mutually exclusive with O(direction) and O(interface). However, it + is compatible with O(interface_in) for routed rules. type: str aliases: [if_out] version_added: '0.2.0' diff --git a/plugins/modules/uptimerobot.py b/plugins/modules/uptimerobot.py index ed6b6431f1..62f92ee0d0 100644 --- a/plugins/modules/uptimerobot.py +++ b/plugins/modules/uptimerobot.py @@ -12,7 +12,7 @@ DOCUMENTATION = r""" module: uptimerobot short_description: Pause and start Uptime Robot monitoring description: - - This module will let you start and pause Uptime Robot Monitoring. + - This module lets you start and pause Uptime Robot Monitoring. author: "Nate Kingsley (@nate-kingsley)" requirements: - Valid Uptime Robot API Key diff --git a/plugins/modules/urpmi.py b/plugins/modules/urpmi.py index 9c08a22c21..5760a4829f 100644 --- a/plugins/modules/urpmi.py +++ b/plugins/modules/urpmi.py @@ -54,7 +54,8 @@ options: default: true root: description: - - Specifies an alternative install root, relative to which all packages will be installed. Corresponds to the C(--root) option for C(urpmi). + - Specifies an alternative install root, relative to which all packages are installed. Corresponds to the C(--root) + option for C(urpmi). aliases: [installroot] type: str author: diff --git a/plugins/modules/utm_aaa_group_info.py b/plugins/modules/utm_aaa_group_info.py index 4f073176f2..91fe8ce930 100644 --- a/plugins/modules/utm_aaa_group_info.py +++ b/plugins/modules/utm_aaa_group_info.py @@ -77,7 +77,7 @@ result: description: The comment string. type: str dynamic: - description: Whether the group match is ipsec_dn or directory_group. + description: Whether the group match is V(ipsec_dn) or V(directory_group). type: str edirectory_groups: description: List of eDirectory Groups. diff --git a/plugins/modules/utm_dns_host.py b/plugins/modules/utm_dns_host.py index 3e0613a9cd..2eb404b38c 100644 --- a/plugins/modules/utm_dns_host.py +++ b/plugins/modules/utm_dns_host.py @@ -53,7 +53,7 @@ options: interface: type: str description: - - The reference name of the interface to use. If not provided the default interface will be used. + - The reference name of the interface to use. If not provided the default interface is used. default: '' resolved: description: diff --git a/plugins/modules/utm_proxy_frontend.py b/plugins/modules/utm_proxy_frontend.py index 1c3489f493..09f0cdd4bc 100644 --- a/plugins/modules/utm_proxy_frontend.py +++ b/plugins/modules/utm_proxy_frontend.py @@ -207,7 +207,7 @@ result: description: State of html rewrite. type: bool htmlrewrite_cookies: - description: Whether the html rewrite cookie will be set. + description: Whether the HTML rewrite cookie is set. type: bool implicitredirect: description: Whether to use implicit redirection. diff --git a/plugins/modules/utm_proxy_frontend_info.py b/plugins/modules/utm_proxy_frontend_info.py index 0709cad01e..722e2621a2 100644 --- a/plugins/modules/utm_proxy_frontend_info.py +++ b/plugins/modules/utm_proxy_frontend_info.py @@ -93,7 +93,7 @@ result: description: State of html rewrite. type: bool htmlrewrite_cookies: - description: Whether the html rewrite cookie will be set. + description: Whether the HTML rewrite cookie is set. type: bool implicitredirect: description: Whether to use implicit redirection. diff --git a/plugins/modules/utm_proxy_location.py b/plugins/modules/utm_proxy_location.py index 944050bfb6..95ee210e97 100644 --- a/plugins/modules/utm_proxy_location.py +++ b/plugins/modules/utm_proxy_location.py @@ -92,7 +92,7 @@ options: stickysession_id: type: str description: - - The stickysession id. + - The stickysession ID. default: ROUTEID stickysession_status: description: @@ -182,7 +182,7 @@ result: description: Whether to use stickysession or not. type: bool websocket_passthrough: - description: Whether websocket passthrough will be used or not. + description: Whether websocket passthrough is used or not. type: bool """ diff --git a/plugins/modules/utm_proxy_location_info.py b/plugins/modules/utm_proxy_location_info.py index a7ea37ea79..0512d4be15 100644 --- a/plugins/modules/utm_proxy_location_info.py +++ b/plugins/modules/utm_proxy_location_info.py @@ -101,7 +101,7 @@ result: description: Whether to use stickysession or not. type: bool websocket_passthrough: - description: Whether websocket passthrough will be used or not. + description: Whether websocket passthrough is used or not. type: bool """ diff --git a/plugins/modules/vdo.py b/plugins/modules/vdo.py index 55706da56a..39eef9fb66 100644 --- a/plugins/modules/vdo.py +++ b/plugins/modules/vdo.py @@ -19,8 +19,8 @@ short_description: Module to control VDO description: - This module controls the VDO dedupe and compression device. - - VDO, or Virtual Data Optimizer, is a device-mapper target that provides inline block-level deduplication, compression, and thin provisioning - capabilities to primary storage. + - VDO, or Virtual Data Optimizer, is a device-mapper target that provides inline block-level deduplication, compression, + and thin provisioning capabilities to primary storage. extends_documentation_fragment: - community.general.attributes @@ -38,19 +38,21 @@ options: required: true state: description: - - Whether this VDO volume should be V(present) or V(absent). If a V(present) VDO volume does not exist, it will be created. If a V(present) - VDO volume already exists, it will be modified, by updating the configuration, which will take effect when the VDO volume is restarted. - Not all parameters of an existing VDO volume can be modified; the C(statusparamkeys) list in the code contains the parameters that can - be modified after creation. If an V(absent) VDO volume does not exist, it will not be removed. + - Whether this VDO volume should be V(present) or V(absent). If a V(present) VDO volume does not exist, it is created. + If a V(present) VDO volume already exists, it is modified by updating the configuration, which takes effect when the + VDO volume is restarted. Not all parameters of an existing VDO volume can be modified; the C(statusparamkeys) list + in the code contains the parameters that can be modified after creation. If an V(absent) VDO volume does not exist, + it is not removed. type: str choices: [absent, present] default: present activated: description: - - The C(activate) status for a VDO volume. If this is set to V(false), the VDO volume cannot be started, and it will not start on system - startup. However, on initial creation, a VDO volume with "activated" set to "off" will be running, until stopped. This is the default - behavior of the C(vdo create) command; it provides the user an opportunity to write a base amount of metadata (filesystem, LVM headers, - and so on) to the VDO volume prior to stopping the volume, and leaving it deactivated until ready to use. + - The C(activate) status for a VDO volume. If this is set to V(false), the VDO volume cannot be started, and it will + not start on system startup. However, on initial creation, a VDO volume with "activated" set to "off" will be running, + until stopped. This is the default behavior of the C(vdo create) command; it provides the user an opportunity to write + a base amount of metadata (filesystem, LVM headers, and so on) to the VDO volume prior to stopping the volume, and + leaving it deactivated until ready to use. type: bool running: description: @@ -64,131 +66,135 @@ options: type: str logicalsize: description: - - The logical size of the VDO volume (in megabytes, or LVM suffix format). If not specified for a new volume, this defaults to the same - size as the underlying storage device, which is specified in the O(device) parameter. Existing volumes will maintain their size if the - logicalsize parameter is not specified, or is smaller than or identical to the current size. If the specified size is larger than the - current size, a C(growlogical) operation will be performed. + - The logical size of the VDO volume (in megabytes, or LVM suffix format). If not specified for a new volume, this defaults + to the same size as the underlying storage device, which is specified in the O(device) parameter. Existing volumes + maintain their size if the O(logicalsize) parameter is not specified, or is smaller than or identical to the current + size. If the specified size is larger than the current size, a C(growlogical) operation is performed. type: str deduplication: description: - - Configures whether deduplication is enabled. The default for a created volume is V(enabled). Existing volumes will maintain their previously - configured setting unless a different value is specified in the playbook. + - Configures whether deduplication is enabled. The default for a created volume is V(enabled). Existing volumes maintain + their previously configured setting unless a different value is specified in the playbook. type: str choices: [disabled, enabled] compression: description: - - Configures whether compression is enabled. The default for a created volume is V(enabled). Existing volumes will maintain their previously - configured setting unless a different value is specified in the playbook. + - Configures whether compression is enabled. The default for a created volume is V(enabled). Existing volumes maintain + their previously configured setting unless a different value is specified in the playbook. type: str choices: [disabled, enabled] blockmapcachesize: description: - - The amount of memory allocated for caching block map pages, in megabytes (or may be issued with an LVM-style suffix of K, M, G, or T). - The default (and minimum) value is V(128M). The value specifies the size of the cache; there is a 15% memory usage overhead. Each 1.25G - of block map covers 1T of logical blocks, therefore a small amount of block map cache memory can cache a significantly large amount of - block map data. - - Existing volumes will maintain their previously configured setting unless a different value is specified in the playbook. + - The amount of memory allocated for caching block map pages, in megabytes (or may be issued with an LVM-style suffix + of K, M, G, or T). The default (and minimum) value is V(128M). The value specifies the size of the cache; there is + a 15% memory usage overhead. Each 1.25G of block map covers 1T of logical blocks, therefore a small amount of block + map cache memory can cache a significantly large amount of block map data. + - Existing volumes maintain their previously configured setting unless a different value is specified in the playbook. type: str readcache: description: - - Enables or disables the read cache. The default is V(disabled). Choosing V(enabled) enables a read cache which may improve performance - for workloads of high deduplication, read workloads with a high level of compression, or on hard disk storage. Existing volumes will maintain - their previously configured setting unless a different value is specified in the playbook. + - Enables or disables the read cache. The default is V(disabled). Choosing V(enabled) enables a read cache which may + improve performance for workloads of high deduplication, read workloads with a high level of compression, or on hard + disk storage. Existing volumes maintain their previously configured setting unless a different value is specified + in the playbook. - The read cache feature is available in VDO 6.1 and older. type: str choices: [disabled, enabled] readcachesize: description: - - Specifies the extra VDO device read cache size in megabytes. This is in addition to a system-defined minimum. Using a value with a suffix - of K, M, G, or T is optional. The default value is V(0). 1.125 MB of memory per bio thread will be used per 1 MB of read cache specified - (for example, a VDO volume configured with 4 bio threads will have a read cache memory usage overhead of 4.5 MB per 1 MB of read cache - specified). Existing volumes will maintain their previously configured setting unless a different value is specified in the playbook. + - Specifies the extra VDO device read cache size in megabytes. This is in addition to a system-defined minimum. Using + a value with a suffix of K, M, G, or T is optional. The default value is V(0). 1.125 MB of memory per bio thread is + used per 1 MB of read cache specified (for example, a VDO volume configured with 4 bio threads has a read cache memory + usage overhead of 4.5 MB per 1 MB of read cache specified). Existing volumes maintain their previously configured + setting unless a different value is specified in the playbook. - The read cache feature is available in VDO 6.1 and older. type: str emulate512: description: - - Enables 512-byte emulation mode, allowing drivers or filesystems to access the VDO volume at 512-byte granularity, instead of the default - 4096-byte granularity. + - Enables 512-byte emulation mode, allowing drivers or filesystems to access the VDO volume at 512-byte granularity, + instead of the default 4096-byte granularity. - Only recommended when a driver or filesystem requires 512-byte sector level access to a device. - This option is only available when creating a new volume, and cannot be changed for an existing volume. type: bool default: false growphysical: description: - - Specifies whether to attempt to execute a C(growphysical) operation, if there is enough unused space on the device. A C(growphysical) - operation will be executed if there is at least 64 GB of free space, relative to the previous physical size of the affected VDO volume. + - Specifies whether to attempt to execute a C(growphysical) operation, if there is enough unused space on the device. + A C(growphysical) operation is executed if there is at least 64 GB of free space, relative to the previous physical + size of the affected VDO volume. type: bool default: false slabsize: description: - - The size of the increment by which the physical size of a VDO volume is grown, in megabytes (or may be issued with an LVM-style suffix - of K, M, G, or T). Must be a power of two between 128M and 32G. The default is V(2G), which supports volumes having a physical size up - to 16T. The maximum, V(32G), supports a physical size of up to 256T. This option is only available when creating a new volume, and cannot - be changed for an existing volume. + - The size of the increment by which the physical size of a VDO volume is grown, in megabytes (or may be issued with + an LVM-style suffix of K, M, G, or T). Must be a power of two between 128M and 32G. The default is V(2G), which supports + volumes having a physical size up to 16T. The maximum, V(32G), supports a physical size of up to 256T. This option + is only available when creating a new volume, and cannot be changed for an existing volume. type: str writepolicy: description: - Specifies the write policy of the VDO volume. - The V(sync) mode acknowledges writes only after data is on stable storage. - The V(async) mode acknowledges writes when data has been cached for writing to stable storage. - - The default (and highly recommended) V(auto) mode checks the storage device to determine whether it supports flushes. Devices that support - flushes will result in a VDO volume in V(async) mode, while devices that do not support flushes will run in V(sync) mode. - - Existing volumes will maintain their previously configured setting unless a different value is specified in the playbook. + - The default (and highly recommended) V(auto) mode checks the storage device to determine whether it supports flushes. + Devices that support flushes result in a VDO volume in V(async) mode, while devices that do not support flushes run + in V(sync) mode. + - Existing volumes maintain their previously configured setting unless a different value is specified in the playbook. type: str choices: [async, auto, sync] indexmem: description: - - Specifies the amount of index memory in gigabytes. The default is V(0.25). The special decimal values V(0.25), V(0.5), and V(0.75) can - be used, as can any positive integer. This option is only available when creating a new volume, and cannot be changed for an existing - volume. + - Specifies the amount of index memory in gigabytes. The default is V(0.25). The special decimal values V(0.25), V(0.5), + and V(0.75) can be used, as can any positive integer. This option is only available when creating a new volume, and + cannot be changed for an existing volume. type: str indexmode: description: - Specifies the index mode of the Albireo index. - - The default is V(dense), which has a deduplication window of 1 GB of index memory per 1 TB of incoming data, requiring 10 GB of index - data on persistent storage. - - The V(sparse) mode has a deduplication window of 1 GB of index memory per 10 TB of incoming data, but requires 100 GB of index data on - persistent storage. + - The default is V(dense), which has a deduplication window of 1 GB of index memory per 1 TB of incoming data, requiring + 10 GB of index data on persistent storage. + - The V(sparse) mode has a deduplication window of 1 GB of index memory per 10 TB of incoming data, but requires 100 + GB of index data on persistent storage. - This option is only available when creating a new volume, and cannot be changed for an existing volume. type: str choices: [dense, sparse] ackthreads: description: - - Specifies the number of threads to use for acknowledging completion of requested VDO I/O operations. Valid values are integer values from - V(1) to V(100) (lower numbers are preferable due to overhead). The default is V(1). Existing volumes will maintain their previously configured - setting unless a different value is specified in the playbook. + - Specifies the number of threads to use for acknowledging completion of requested VDO I/O operations. Valid values + are integer values from V(1) to V(100) (lower numbers are preferable due to overhead). The default is V(1). Existing + volumes maintain their previously configured setting unless a different value is specified in the playbook. type: str biothreads: description: - - Specifies the number of threads to use for submitting I/O operations to the storage device. Valid values are integer values from V(1) - to V(100) (lower numbers are preferable due to overhead). The default is V(4). Existing volumes will maintain their previously configured - setting unless a different value is specified in the playbook. + - Specifies the number of threads to use for submitting I/O operations to the storage device. Valid values are integer + values from V(1) to V(100) (lower numbers are preferable due to overhead). The default is V(4). Existing volumes maintain + their previously configured setting unless a different value is specified in the playbook. type: str cputhreads: description: - - Specifies the number of threads to use for CPU-intensive work such as hashing or compression. Valid values are integer values from V(1) - to V(100) (lower numbers are preferable due to overhead). The default is V(2). Existing volumes will maintain their previously configured - setting unless a different value is specified in the playbook. + - Specifies the number of threads to use for CPU-intensive work such as hashing or compression. Valid values are integer + values from V(1) to V(100) (lower numbers are preferable due to overhead). The default is V(2). Existing volumes maintain + their previously configured setting unless a different value is specified in the playbook. type: str logicalthreads: description: - - Specifies the number of threads across which to subdivide parts of the VDO processing based on logical block addresses. Valid values are - integer values from V(1) to V(100) (lower numbers are preferable due to overhead). The default is V(1). Existing volumes will maintain - their previously configured setting unless a different value is specified in the playbook. + - Specifies the number of threads across which to subdivide parts of the VDO processing based on logical block addresses. + Valid values are integer values from V(1) to V(100) (lower numbers are preferable due to overhead). The default is + V(1). Existing volumes maintain their previously configured setting unless a different value is specified in the playbook. type: str physicalthreads: description: - - Specifies the number of threads across which to subdivide parts of the VDO processing based on physical block addresses. Valid values - are integer values from V(1) to V(16) (lower numbers are preferable due to overhead). The physical space used by the VDO volume must be - larger than (O(slabsize) * O(physicalthreads)). The default is V(1). Existing volumes will maintain their previously configured setting - unless a different value is specified in the playbook. + - Specifies the number of threads across which to subdivide parts of the VDO processing based on physical block addresses. + Valid values are integer values from V(1) to V(16) (lower numbers are preferable due to overhead). The physical space + used by the VDO volume must be larger than (O(slabsize) * O(physicalthreads)). The default is V(1). Existing volumes + maintain their previously configured setting unless a different value is specified in the playbook. type: str force: description: - - When creating a volume, ignores any existing file system or VDO signature already present in the storage device. When stopping or removing - a VDO volume, first unmounts the file system stored on the device if mounted. - - B(Warning:) Since this parameter removes all safety checks it is important to make sure that all parameters provided are accurate and - intentional. + - When creating a volume, ignores any existing file system or VDO signature already present in the storage device. When + stopping or removing a VDO volume, first unmounts the file system stored on the device if mounted. + - B(Warning:) Since this parameter removes all safety checks it is important to make sure that all parameters provided + are accurate and intentional. type: bool default: false version_added: 2.4.0 diff --git a/plugins/modules/vertica_configuration.py b/plugins/modules/vertica_configuration.py index 9ce2e42d15..39ed27dc2d 100644 --- a/plugins/modules/vertica_configuration.py +++ b/plugins/modules/vertica_configuration.py @@ -56,11 +56,11 @@ options: type: str notes: - The default authentication assumes that you are either logging in as or sudo'ing to the C(dbadmin) account on the host. - - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure that C(unixODBC) and C(pyodbc) is installed on the host and properly - configured. - - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) to be added to the C(Vertica) section of either - C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16) to - be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). + - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure that C(unixODBC) and C(pyodbc) is installed + on the host and properly configured. + - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) to be added to the C(Vertica) + section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) and both C(ErrorMessagesPath = /opt/vertica/lib64) and + C(DriverManagerEncoding = UTF-16) to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). requirements: ['unixODBC', 'pyodbc'] author: "Dariusz Owczarek (@dareko)" """ diff --git a/plugins/modules/vertica_info.py b/plugins/modules/vertica_info.py index bfb99552a0..29f8669c27 100644 --- a/plugins/modules/vertica_info.py +++ b/plugins/modules/vertica_info.py @@ -42,11 +42,11 @@ options: type: str notes: - The default authentication assumes that you are either logging in as or sudo'ing to the C(dbadmin) account on the host. - - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure that C(unixODBC) and C(pyodbc) are installed on the host and properly - configured. - - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) to be added to the C(Vertica) section of either - C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16) to - be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). + - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure that C(unixODBC) and C(pyodbc) are installed + on the host and properly configured. + - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) to be added to the C(Vertica) + section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) and both C(ErrorMessagesPath = /opt/vertica/lib64) and + C(DriverManagerEncoding = UTF-16) to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). requirements: ['unixODBC', 'pyodbc'] author: "Dariusz Owczarek (@dareko)" """ diff --git a/plugins/modules/vertica_role.py b/plugins/modules/vertica_role.py index c3e15b4b95..d814aca273 100644 --- a/plugins/modules/vertica_role.py +++ b/plugins/modules/vertica_role.py @@ -64,11 +64,11 @@ options: type: str notes: - The default authentication assumes that you are either logging in as or sudo'ing to the C(dbadmin) account on the host. - - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure that C(unixODBC) and C(pyodbc) is installed on the host and properly - configured. - - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) to be added to the C(Vertica) section of either - C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16) to - be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). + - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure that C(unixODBC) and C(pyodbc) is installed + on the host and properly configured. + - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) to be added to the C(Vertica) + section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) and both C(ErrorMessagesPath = /opt/vertica/lib64) and + C(DriverManagerEncoding = UTF-16) to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). requirements: ['unixODBC', 'pyodbc'] author: "Dariusz Owczarek (@dareko)" """ diff --git a/plugins/modules/vertica_schema.py b/plugins/modules/vertica_schema.py index b9e243ec7b..11a7f9c77c 100644 --- a/plugins/modules/vertica_schema.py +++ b/plugins/modules/vertica_schema.py @@ -14,8 +14,9 @@ module: vertica_schema short_description: Adds or removes Vertica database schema and roles description: - Adds or removes Vertica database schema and, optionally, roles with schema access privileges. - - A schema will not be removed until all the objects have been dropped. - - In such a situation, if the module tries to remove the schema it will fail and only remove roles created for the schema if they have no dependencies. + - A schema is not removed until all the objects have been dropped. + - In such a situation, if the module tries to remove the schema it fails and only remove roles created for the schema if + they have no dependencies. extends_documentation_fragment: - community.general.attributes attributes: @@ -75,11 +76,11 @@ options: type: str notes: - The default authentication assumes that you are either logging in as or sudo'ing to the C(dbadmin) account on the host. - - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure that C(unixODBC) and C(pyodbc) is installed on the host and properly - configured. - - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) to be added to the C(Vertica) section of either - C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16) to - be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). + - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure that C(unixODBC) and C(pyodbc) is installed + on the host and properly configured. + - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) to be added to the C(Vertica) + section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) and both C(ErrorMessagesPath = /opt/vertica/lib64) and + C(DriverManagerEncoding = UTF-16) to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). requirements: ['unixODBC', 'pyodbc'] author: "Dariusz Owczarek (@dareko)" """ @@ -92,7 +93,8 @@ EXAMPLES = r""" community.general.vertica_schema: name=schema_name owner=dbowner db=db_name state=present - name: Creating a new schema with roles - community.general.vertica_schema: name=schema_name create_roles=schema_name_all usage_roles=schema_name_ro,schema_name_rw db=db_name state=present + community.general.vertica_schema: name=schema_name create_roles=schema_name_all usage_roles=schema_name_ro,schema_name_rw + db=db_name state=present """ import traceback diff --git a/plugins/modules/vertica_user.py b/plugins/modules/vertica_user.py index 74ac784c1b..e3a4292aec 100644 --- a/plugins/modules/vertica_user.py +++ b/plugins/modules/vertica_user.py @@ -13,8 +13,8 @@ module: vertica_user short_description: Adds or removes Vertica database users and assigns roles description: - Adds or removes Vertica database user and, optionally, assigns roles. - - A user will not be removed until all the dependencies have been dropped. - - In such a situation, if the module tries to remove the user it will fail and only remove roles granted to the user. + - A user is not removed until all the dependencies have been dropped. + - In such a situation, if the module tries to remove the user it fails and only remove roles granted to the user. extends_documentation_fragment: - community.general.attributes attributes: @@ -40,8 +40,8 @@ options: password: description: - The user's password encrypted by the MD5 algorithm. - - The password must be generated with the format C("md5" + md5[password + username]), resulting in a total of 35 characters. An easy way - to do this is by querying the Vertica database with select V('md5'||md5(''\)). + - The password must be generated with the format C("md5" + md5[password + username]), resulting in a total of 35 characters. + An easy way to do this is by querying the Vertica database with select V('md5'|| md5(''\)). type: str expired: description: @@ -50,7 +50,7 @@ options: ldap: description: - Set to V(true) if users are authenticated using LDAP. - - The user will be created with password expired and set to V($ldap$). + - The user is created with password expired and set to V($ldap$). type: bool roles: description: @@ -88,11 +88,11 @@ options: type: str notes: - The default authentication assumes that you are either logging in as or sudo'ing to the C(dbadmin) account on the host. - - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure that C(unixODBC) and C(pyodbc) is installed on the host and properly - configured. - - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) to be added to the C(Vertica) section of either - C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16) to - be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). + - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure that C(unixODBC) and C(pyodbc) is installed + on the host and properly configured. + - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) to be added to the C(Vertica) + section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) and both C(ErrorMessagesPath = /opt/vertica/lib64) and + C(DriverManagerEncoding = UTF-16) to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). requirements: ['unixODBC', 'pyodbc'] author: "Dariusz Owczarek (@dareko)" """ diff --git a/plugins/modules/vexata_eg.py b/plugins/modules/vexata_eg.py index f7184d68b0..27bd9f129e 100644 --- a/plugins/modules/vexata_eg.py +++ b/plugins/modules/vexata_eg.py @@ -14,8 +14,8 @@ module: vexata_eg short_description: Manage export groups on Vexata VX100 storage arrays description: - Create or delete export groups on a Vexata VX100 array. - - An export group is a tuple of a volume group, initiator group and port group that allows a set of volumes to be exposed to one or more hosts - through specific array ports. + - An export group is a tuple of a volume group, initiator group and port group that allows a set of volumes to be exposed + to one or more hosts through specific array ports. author: - Sandeep Kasargod (@vexata) attributes: diff --git a/plugins/modules/vmadm.py b/plugins/modules/vmadm.py index 4b21ead77e..51d7e96cba 100644 --- a/plugins/modules/vmadm.py +++ b/plugins/modules/vmadm.py @@ -26,7 +26,7 @@ options: archive_on_delete: required: false description: - - When enabled, the zone dataset will be mounted on C(/zones/archive) upon removal. + - When enabled, the zone dataset is mounted on C(/zones/archive) upon removal. type: bool autoboot: required: false @@ -52,7 +52,8 @@ options: cpu_shares: required: false description: - - Sets a limit on the number of fair share scheduler (FSS) CPU shares for a VM. This limit is relative to all other VMs on the system. + - Sets a limit on the number of fair share scheduler (FSS) CPU shares for a VM. This limit is relative to all other + VMs on the system. type: int cpu_type: required: false @@ -141,7 +142,8 @@ options: internal_metadata_namespace: required: false description: - - List of namespaces to be set as C(internal_metadata-only); these namespaces will come from O(internal_metadata) rather than O(customer_metadata). + - List of namespaces to be set as C(internal_metadata-only); these namespaces come from O(internal_metadata) rather + than O(customer_metadata). type: str kernel_version: required: false @@ -156,7 +158,7 @@ options: maintain_resolvers: required: false description: - - Resolvers in C(/etc/resolv.conf) will be updated when updating the O(resolvers) property. + - Resolvers in C(/etc/resolv.conf) are updated when updating the O(resolvers) property. type: bool max_locked_memory: required: false @@ -208,7 +210,8 @@ options: qemu_opts: required: false description: - - Additional qemu arguments for KVM guests. This overwrites the default arguments provided by vmadm(1M) and should only be used for debugging. + - Additional qemu arguments for KVM guests. This overwrites the default arguments provided by vmadm(1M) and should only + be used for debugging. type: str qemu_extra_opts: required: false @@ -234,7 +237,7 @@ options: routes: required: false description: - - Dictionary that maps destinations to gateways, these will be set as static routes in the VM. + - Dictionary that maps destinations to gateways, these are set as static routes in the VM. type: dict spice_opts: required: false @@ -244,20 +247,22 @@ options: spice_password: required: false description: - - Password required to connect to SPICE. By default no password is set. Please note this can be read from the Global Zone. + - Password required to connect to SPICE. By default no password is set. Please note this can be read from the Global + Zone. type: str state: choices: [present, running, absent, deleted, stopped, created, restarted, rebooted] default: running description: - - States for the VM to be in. Please note that V(present), V(stopped) and V(restarted) operate on a VM that is currently provisioned. V(present) - means that the VM will be created if it was absent, and that it will be in a running state. V(absent) will shutdown the zone before removing - it. V(stopped) means the zone will be created if it does not exist already, before shutting it down. + - States for the VM to be in. Please note that V(present), V(stopped) and V(restarted) operate on a VM that is currently + provisioned. V(present) means that the VM is created if it was absent, and that it is in a running state. V(absent) + shutdowns the zone before removing it. V(stopped) means the zone is created if it does not exist already, before shutting + it down. type: str tmpfs: required: false description: - - Amount of memory (in MiBs) that will be available in the VM for the C(/tmp) filesystem. + - Amount of memory (in MiBs) that is available in the VM for the C(/tmp) filesystem. type: int uuid: required: false @@ -332,7 +337,7 @@ options: zpool: required: false description: - - ZFS pool the VM's zone dataset will be created in. + - ZFS pool the VM's zone dataset is created in. type: str """