diff --git a/plugins/modules/xattr.py b/plugins/modules/xattr.py index 11b036ff66b..fe48ce2eef2 100644 --- a/plugins/modules/xattr.py +++ b/plugins/modules/xattr.py @@ -13,7 +13,8 @@ short_description: Manage user defined extended attributes description: - Manages filesystem user defined extended attributes. - - Requires that extended attributes are enabled on the target filesystem and that the C(setfattr)/C(getfattr) utilities are present. + - Requires that extended attributes are enabled on the target filesystem and that the C(setfattr)/C(getfattr) utilities + are present. extends_documentation_fragment: - community.general.attributes attributes: diff --git a/plugins/modules/xbps.py b/plugins/modules/xbps.py index 9f6cb59d985..3087e4d79d4 100644 --- a/plugins/modules/xbps.py +++ b/plugins/modules/xbps.py @@ -40,13 +40,14 @@ type: str recurse: description: - - When removing a package, also remove its dependencies, provided that they are not required by other packages and were not explicitly installed - by a user. + - When removing a package, also remove its dependencies, provided that they are not required by other packages and were + not explicitly installed by a user. type: bool default: false update_cache: description: - - Whether or not to refresh the master package lists. This can be run as part of a package installation or as a separate step. + - Whether or not to refresh the master package lists. This can be run as part of a package installation or as a separate + step. type: bool default: true upgrade: @@ -56,8 +57,9 @@ default: false upgrade_xbps: description: - - Whether or not to upgrade the xbps package when necessary. Before installing new packages, xbps requires the user to update the xbps package - itself. Thus when this option is set to V(false), upgrades and installations will fail when xbps is not up to date. + - Whether or not to upgrade the C(xbps) package when necessary. Before installing new packages, C(xbps) requires the + user to update itself. Thus when this option is set to V(false), upgrades and installations fail when C(xbps) is not + up to date. type: bool default: true version_added: '0.2.0' @@ -68,8 +70,8 @@ version_added: '10.2.0' repositories: description: - - Repository URL(s) to prepend to the repository list for the package installation. The URL can be a URL to a repository for remote repositories - or a path for local repositories. + - Repository URL(s) to prepend to the repository list for the package installation. The URL can be remote repositories + or paths for local repositories. type: list elements: str version_added: '10.2.0' diff --git a/plugins/modules/xcc_redfish_command.py b/plugins/modules/xcc_redfish_command.py index d6d1857c4c1..509c70e4e96 100644 --- a/plugins/modules/xcc_redfish_command.py +++ b/plugins/modules/xcc_redfish_command.py @@ -13,8 +13,8 @@ short_description: Manages Lenovo Out-Of-Band controllers using Redfish APIs version_added: 2.4.0 description: - - Builds Redfish URIs locally and sends them to remote OOB controllers to perform an action or get information back or update a configuration - attribute. + - Builds Redfish URIs locally and sends them to remote OOB controllers to perform an action or get information back or update + a configuration attribute. - Manages virtual media. - Supports getting information back using GET method. - Supports updating a configuration attribute using PATCH method. @@ -110,7 +110,7 @@ resource_uri: required: false description: - - The resource uri to get or patch or post. + - The resource URI to get or patch or post. type: str request_body: required: false diff --git a/plugins/modules/xenserver_guest.py b/plugins/modules/xenserver_guest.py index 2f6a19be4d3..da1f5439d04 100644 --- a/plugins/modules/xenserver_guest.py +++ b/plugins/modules/xenserver_guest.py @@ -12,34 +12,35 @@ module: xenserver_guest short_description: Manages virtual machines running on Citrix Hypervisor/XenServer host or pool description: >- - This module can be used to create new virtual machines from templates or other virtual machines, modify various virtual machine components like - network and disk, rename a virtual machine and remove a virtual machine with associated components. + This module can be used to create new virtual machines from templates or other virtual machines, modify various virtual + machine components like network and disk, rename a virtual machine and remove a virtual machine with associated components. author: - Bojan Vitnik (@bvitnik) notes: - Minimal supported version of XenServer is 5.6. - Module was tested with XenServer 6.5, 7.1, 7.2, 7.6, Citrix Hypervisor 8.0, XCP-ng 7.6 and 8.0. - - 'To acquire XenAPI Python library, just run C(pip install XenAPI) on your Ansible Control Node. The library can also be found inside Citrix - Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the C(XenAPI.py) file from the SDK to your Python site-packages on your Ansible - Control Node to use it. Latest version of the library can also be acquired from GitHub: - U(https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py).' - - 'If no scheme is specified in O(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 O(hostname) you have to either import host certificate to your OS certificate store or use O(validate_certs=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 parameters O(networks[].type), O(networks[].ip), O(networks[].gateway) and so on, 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 detect if such support is available and utilize it, else it will use a custom method of configuration using xenstore. Since XenServer Guest - agent only support None and Static types of network configuration, where None means DHCP configured interface, O(networks[].type) and O(networks[].type6) - values V(none) and V(dhcp) have same effect. More info here: - U(https://www.citrix.com/community/citrix-developer/citrix-hypervisor-developer/citrix-hypervisor-developing-products/citrix-hypervisor-staticip.html).' - - 'On platforms without official support for network configuration inside a guest OS, network parameters will be written to xenstore - C(vm-data/networks/) key. Parameters can be inspected by using C(xenstore ls) and C(xenstore read) tools on \*nix guests or through WMI - interface on Windows guests. - They can also be found in VM facts C(instance.xenstore_data) key as returned by the module. It is up to the user to implement a boot time - scripts or custom agent that will read the parameters from xenstore and configure network with given parameters. Take note that for xenstore - data to become available inside a guest, a VM restart is needed hence module will require VM restart if any parameter is changed. This is - a limitation of XenAPI and xenstore. Considering these limitations, network configuration through xenstore is most useful for bootstrapping + - 'To acquire XenAPI Python library, just run C(pip install XenAPI) on your Ansible Control Node. The library can also be + found inside Citrix Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the C(XenAPI.py) file from the SDK + to your Python site-packages on your Ansible Control Node to use it. Latest version of the library can also be acquired + from GitHub: U(https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py).' + - If no scheme is specified in O(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 O(hostname) you have to either import host certificate to your OS certificate store or use + O(validate_certs=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 parameters O(networks[].type), O(networks[].ip), O(networks[].gateway) + and so on, is supported on XenServer 7.0 or newer for Windows guests by using official XenServer Guest agent support for + network configuration. The module tries to detect if such support is available and utilize it, else it uses a custom method + of configuration using xenstore. Since XenServer Guest agent only support None and Static types of network configuration, + where None means DHCP configured interface, O(networks[].type) and O(networks[].type6) values V(none) and V(dhcp) have + same effect. More info here: + U(https://web.archive.org/web/20180218110151/https://xenserver.org/blog/entry/set-windows-guest-vm-static-ip-address-in-xenserver.html).' + - 'On platforms without official support for network configuration inside a guest OS, network parameters are written to + xenstore C(vm-data/networks/) key. Parameters can be inspected by using C(xenstore ls) and C(xenstore read) + tools on \*nix guests or through WMI interface on Windows guests. They can also be found in VM facts C(instance.xenstore_data) + key as returned by the module. It is up to the user to implement a boot time scripts or custom agent that reads the parameters + from xenstore and configure network with given parameters. Take note that for xenstore data to become available inside + a guest, a VM restart is needed hence module requires VM restart if any parameter is changed. This is a limitation of + XenAPI and xenstore. Considering these limitations, network configuration through xenstore is most useful for bootstrapping newly deployed VMs, much less for reconfiguring existing ones. More info here: U(https://support.citrix.com/article/CTX226713).' requirements: - XenAPI @@ -55,14 +56,16 @@ - If O(state) is set to V(present) and VM exists, ensure the VM configuration conforms to given parameters. - If O(state) is set to V(present) and VM does not exist, then VM is deployed with given parameters. - If O(state) is set to V(absent) and VM exists, then VM is removed with its associated components. - - If O(state) is set to V(poweredon) and VM does not exist, then VM is deployed with given parameters and powered on automatically. + - If O(state) is set to V(poweredon) and VM does not exist, then VM is deployed with given parameters and powered on + automatically. type: str default: present choices: [present, absent, poweredon] name: description: - Name of the VM to work with. - - VMs running on XenServer do not necessarily have unique names. The module will fail if multiple VMs with same name are found. + - VMs running on XenServer do not necessarily have unique names. The module fails if multiple VMs with same name are + found. - In case of multiple VMs with same name, use O(uuid) to uniquely specify VM to manage. - This parameter is case sensitive. type: str @@ -75,15 +78,15 @@ description: - UUID of the VM to manage if known. This is XenServer's unique identifier. - It is required if name is not unique. - - Please note that a supplied UUID will be ignored on VM creation, as XenServer creates the UUID internally. + - Please note that a supplied UUID is ignored on VM creation, as XenServer creates the UUID internally. type: str template: description: - Name of a template, an existing VM (must be shut down) or a snapshot that should be used to create VM. - - Templates/VMs/snapshots on XenServer do not necessarily have unique names. The module will fail if multiple templates with same name are - found. + - Templates/VMs/snapshots on XenServer do not necessarily have unique names. The module fails if multiple templates + with same name are found. - In case of multiple templates/VMs/snapshots with same name, use O(template_uuid) to uniquely specify source template. - - If VM already exists, this setting will be ignored. + - If VM already exists, this setting is ignored. - This parameter is case sensitive. type: str aliases: [template_src] @@ -101,8 +104,7 @@ description: - Destination folder for VM. - This parameter is case sensitive. - - 'Example:' - - ' folder: /folder1/folder2' + - 'Example: O(folder=/folder1/folder2).' type: str hardware: description: @@ -126,7 +128,8 @@ - A list of disks to add to VM. - All parameters are case sensitive. - Removing or detaching existing disks of VM is not supported. - - New disks are required to have either a O(disks[].size) or one of O(ignore:disks[].size_[tb,gb,mb,kb,b]) parameters specified. + - New disks are required to have either a O(disks[].size) or one of O(ignore:disks[].size_[tb,gb,mb,kb,b]) parameters + specified. - VM needs to be shut down to reconfigure disk size. type: list elements: dict @@ -134,7 +137,8 @@ suboptions: size: description: - - 'Disk size with unit. Unit must be: V(b), V(kb), V(mb), V(gb), V(tb). VM needs to be shut down to reconfigure this parameter.' + - 'Disk size with unit. Unit must be: V(b), V(kb), V(mb), V(gb), V(tb). VM needs to be shut down to reconfigure + this parameter.' - If no unit is specified, size is assumed to be in bytes. type: str size_b: @@ -168,7 +172,8 @@ type: str sr: description: - - Storage Repository to create disk on. If not specified, will use default SR. Cannot be used for moving disk to other SR. + - Storage Repository to create disk on. If not specified, it uses default SR. Cannot be used for moving disk to + other SR. type: str sr_uuid: description: @@ -182,12 +187,12 @@ suboptions: type: description: - - The type of CD-ROM. With V(none) the CD-ROM device will be present but empty. + - The type of CD-ROM. When V(none) the CD-ROM device is present but empty. type: str choices: [none, iso] iso_name: description: - - 'The file name of an ISO image from one of the XenServer ISO Libraries (implies O(cdrom.type=iso)).' + - The file name of an ISO image from one of the XenServer ISO Libraries (implies O(cdrom.type=iso)). - Required if O(cdrom.type) is set to V(iso). type: str networks: @@ -211,13 +216,14 @@ type: description: - Type of IPv4 assignment. Value V(none) means whatever is default for OS. - - On some operating systems it could be DHCP configured (for example Windows) or unconfigured interface (for example Linux). + - On some operating systems it could be DHCP configured (for example Windows) or unconfigured interface (for example + Linux). type: str choices: [none, dhcp, static] ip: description: - - Static IPv4 address (implies O(networks[].type=static)). Can include prefix in format C(/) instead of using - C(netmask). + - Static IPv4 address (implies O(networks[].type=static)). Can include prefix in format C(/) + instead of using C(netmask). type: str netmask: description: @@ -234,7 +240,7 @@ choices: [none, dhcp, static] ip6: description: - - 'Static IPv6 address (implies O(networks[].type6=static)) with prefix in format C(/).' + - Static IPv6 address (implies O(networks[].type6=static)) with prefix in format C(/). type: str gateway6: description: @@ -242,7 +248,7 @@ type: str home_server: description: - - Name of a XenServer host that will be a Home Server for the VM. + - Name of a XenServer host that is a Home Server for the VM. - This parameter is case sensitive. type: str custom_params: @@ -271,14 +277,15 @@ default: false state_change_timeout: description: - - 'By default, module will wait indefinitely for VM to acquire an IP address if O(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. + - By default, the module waits indefinitely for VM to acquire an IP address if O(wait_for_ip_address=true). + - If this parameter is set to a positive value, the module instead waits the specified number of seconds for the state + change. + - In case of timeout, module generates an error message. type: int default: 0 linked_clone: description: - - Whether to create a Linked Clone from the template, existing VM or snapshot. If no, will create a full copy. + - Whether to create a Linked Clone from the template, existing VM or snapshot. If V(false), it creates a full copy. - This is equivalent to C(Use storage-level fast disk clone) option in XenCenter. type: bool default: false diff --git a/plugins/modules/xenserver_guest_info.py b/plugins/modules/xenserver_guest_info.py index 10cd11839c1..44cc6e054a8 100644 --- a/plugins/modules/xenserver_guest_info.py +++ b/plugins/modules/xenserver_guest_info.py @@ -17,21 +17,22 @@ notes: - Minimal supported version of XenServer is 5.6. - Module was tested with XenServer 6.5, 7.1, 7.2, 7.6, Citrix Hypervisor 8.0, XCP-ng 7.6 and 8.0. - - 'To acquire XenAPI Python library, just run C(pip install XenAPI) on your Ansible Control Node. The library can also be found inside Citrix - Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the C(XenAPI.py) file from the SDK to your Python site-packages on your Ansible - Control Node to use it. Latest version of the library can also be acquired from GitHub: - U(https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py)' - - 'If no scheme is specified in C(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 C(hostname) you have to either import host certificate to your OS certificate store or use O(validate_certs=no) which - requires XenAPI library from XenServer 7.2 SDK or newer and Python 2.7.9 or newer.' + - 'To acquire XenAPI Python library, just run C(pip install XenAPI) on your Ansible Control Node. The library can also be + found inside Citrix Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the C(XenAPI.py) file from the SDK + to your Python site-packages on your Ansible Control Node to use it. Latest version of the library can also be acquired + from GitHub: U(https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py).' + - If no scheme is specified in C(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 C(hostname) you have to either import host certificate to your OS certificate store or use + O(validate_certs=no) which requires XenAPI library from XenServer 7.2 SDK or newer and Python 2.7.9 or newer. requirements: - XenAPI options: name: description: - Name of the VM to gather facts from. - - VMs running on XenServer do not necessarily have unique names. The module will fail if multiple VMs with same name are found. + - VMs running on XenServer do not necessarily have unique names. The module fails if multiple VMs with same name are + found. - In case of multiple VMs with same name, use O(uuid) to uniquely specify VM to manage. - This parameter is case sensitive. type: str diff --git a/plugins/modules/xenserver_guest_powerstate.py b/plugins/modules/xenserver_guest_powerstate.py index 86a21b56dc8..cbba33920fd 100644 --- a/plugins/modules/xenserver_guest_powerstate.py +++ b/plugins/modules/xenserver_guest_powerstate.py @@ -11,20 +11,21 @@ DOCUMENTATION = r""" module: xenserver_guest_powerstate short_description: Manages power states of virtual machines running on Citrix Hypervisor/XenServer host or pool -description: This module can be used to power on, power off, restart or suspend virtual machine and gracefully reboot or shutdown guest OS of virtual machine. +description: This module can be used to power on, power off, restart or suspend virtual machine and gracefully reboot or shutdown + guest OS of virtual machine. author: - Bojan Vitnik (@bvitnik) notes: - Minimal supported version of XenServer is 5.6. - Module was tested with XenServer 6.5, 7.1, 7.2, 7.6, Citrix Hypervisor 8.0, XCP-ng 7.6 and 8.0. - - 'To acquire XenAPI Python library, just run C(pip install XenAPI) on your Ansible Control Node. The library can also be found inside Citrix - Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the C(XenAPI.py) file from the SDK to your Python site-packages on your Ansible - Control Node to use it. Latest version of the library can also be acquired from GitHub: - U(https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py).' - - 'If no scheme is specified in C(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 C(hostname) you have to either import host certificate to your OS certificate store or use C(validate_certs: - no) which requires XenAPI library from XenServer 7.2 SDK or newer and Python 2.7.9 or newer.' + - 'To acquire XenAPI Python library, just run C(pip install XenAPI) on your Ansible Control Node. The library can also be + found inside Citrix Hypervisor/XenServer SDK (downloadable from Citrix website). Copy the C(XenAPI.py) file from the SDK + to your Python site-packages on your Ansible Control Node to use it. Latest version of the library can also be acquired + from GitHub: U(https://raw.githubusercontent.com/xapi-project/xen-api/master/scripts/examples/python/XenAPI/XenAPI.py).' + - If no scheme is specified in C(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 C(hostname) you have to either import host certificate to your OS certificate store or + use C(validate_certs: no) which requires XenAPI library from XenServer 7.2 SDK or newer and Python 2.7.9 or newer.' requirements: - XenAPI attributes: @@ -44,7 +45,8 @@ name: description: - Name of the VM to manage. - - VMs running on XenServer do not necessarily have unique names. The module will fail if multiple VMs with same name are found. + - VMs running on XenServer do not necessarily have unique names. The module fails if multiple VMs with same name are + found. - In case of multiple VMs with same name, use O(uuid) to uniquely specify VM to manage. - This parameter is case sensitive. type: str @@ -62,9 +64,9 @@ default: false state_change_timeout: description: - - 'By default, module will wait indefinitely for VM to change state or acquire an IP address if O(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. + - By default, module waits indefinitely for VM to change state or acquire an IP address if O(wait_for_ip_address=true). + - If this parameter is set to positive value, the module instead waits specified number of seconds for the state change. + - In case of timeout, module generates an error message. type: int default: 0 extends_documentation_fragment: diff --git a/plugins/modules/xfconf.py b/plugins/modules/xfconf.py index c13f7b7f45c..003d1bfdfa8 100644 --- a/plugins/modules/xfconf.py +++ b/plugins/modules/xfconf.py @@ -37,28 +37,30 @@ options: channel: description: - - A Xfconf preference channel is a top-level tree key, inside of the Xfconf repository that corresponds to the location for which all application - properties/keys are stored. See man xfconf-query(1). + - A Xfconf preference channel is a top-level tree key, inside of the Xfconf repository that corresponds to the location + for which all application properties/keys are stored. See man xfconf-query(1). required: true type: str property: description: - - A Xfce preference key is an element in the Xfconf repository that corresponds to an application preference. See man xfconf-query(1). + - A Xfce preference key is an element in the Xfconf repository that corresponds to an application preference. See man + xfconf-query(1). required: true type: str value: description: - - Preference properties typically have simple values such as strings, integers, or lists of strings and integers. See man xfconf-query(1). + - Preference properties typically have simple values such as strings, integers, or lists of strings and integers. See + man xfconf-query(1). type: list elements: raw value_type: description: - The type of value being set. - When providing more than one O(value_type), the length of the list must be equal to the length of O(value). - - If only one O(value_type) is provided, but O(value) contains more than on element, that O(value_type) will be applied to all elements - of O(value). - - If the O(property) being set is an array and it can possibly have only one element in the array, then O(force_array=true) must be used - to ensure that C(xfconf-query) will interpret the value as an array rather than a scalar. + - If only one O(value_type) is provided, but O(value) contains more than on element, that O(value_type) is applied to + all elements of O(value). + - If the O(property) being set is an array and it can possibly have only one element in the array, then O(force_array=true) + must be used to ensure that C(xfconf-query) interprets the value as an array rather than a scalar. - Support for V(uchar), V(char), V(uint64), and V(int64) has been added in community.general 4.8.0. type: list elements: str @@ -67,7 +69,8 @@ type: str description: - The action to take upon the property/value. - - The state V(get) has been removed in community.general 5.0.0. Please use the module M(community.general.xfconf_info) instead. + - The state V(get) has been removed in community.general 5.0.0. Please use the module M(community.general.xfconf_info) + instead. choices: [present, absent] default: "present" force_array: @@ -116,21 +119,24 @@ sample: "/Xft/DPI" value_type: description: - - The type of the value that was changed (V(none) for O(state=reset)). Either a single string value or a list of strings for array types. + - The type of the value that was changed (V(none) for O(state=reset)). Either a single string value or a list of strings + for array types. - This is a string or a list of strings. returned: success type: any sample: '"int" or ["str", "str", "str"]' value: description: - - The value of the preference key after executing the module. Either a single string value or a list of strings for array types. + - The value of the preference key after executing the module. Either a single string value or a list of strings for array + types. - This is a string or a list of strings. returned: success type: any sample: "'192' or ['orange', 'yellow', 'violet']" previous_value: description: - - The value of the preference key before executing the module. Either a single string value or a list of strings for array types. + - The value of the preference key before executing the module. Either a single string value or a list of strings for array + types. - This is a string or a list of strings. returned: success type: any diff --git a/plugins/modules/xfconf_info.py b/plugins/modules/xfconf_info.py index 36de7daecc8..90457eeaa12 100644 --- a/plugins/modules/xfconf_info.py +++ b/plugins/modules/xfconf_info.py @@ -25,15 +25,15 @@ options: channel: description: - - "A Xfconf preference channel is a top-level tree key, inside of the Xfconf repository that corresponds to the location for which all application - properties/keys are stored." - - If not provided, the module will list all available channels. + - A Xfconf preference channel is a top-level tree key, inside of the Xfconf repository that corresponds to the location + for which all application properties/keys are stored. + - If not provided, the module lists all available channels. type: str property: description: - - "A Xfce preference key is an element in the Xfconf repository that corresponds to an application preference." + - A Xfce preference key is an element in the Xfconf repository that corresponds to an application preference. - If provided, then O(channel) is required. - - If not provided and a O(channel) is provided, then the module will list all available properties in that O(channel). + - If not provided and a O(channel) is provided, then the module lists all available properties in that O(channel). type: str notes: - See man xfconf-query(1) for more details. diff --git a/plugins/modules/xml.py b/plugins/modules/xml.py index a28e5dcefc7..eb579e07113 100644 --- a/plugins/modules/xml.py +++ b/plugins/modules/xml.py @@ -69,8 +69,8 @@ add_children: description: - Add additional child-element(s) to a selected element for a given O(xpath). - - Child elements must be given in a list and each item may be either a string (for example C(children=ansible) to add an empty C() - child element), or a hash where the key is an element name and the value is the element value. + - Child elements must be given in a list and each item may be either a string (for example C(children=ansible) to add + an empty C() child element), or a hash where the key is an element name and the value is the element value. - This parameter requires O(xpath) to be set. type: list elements: raw @@ -113,7 +113,8 @@ default: yaml backup: description: - - Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. + - Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered + it incorrectly. type: bool default: false strip_cdata_tags: @@ -125,16 +126,16 @@ insertbefore: description: - Add additional child-element(s) before the first selected element for a given O(xpath). - - Child elements must be given in a list and each item may be either a string (for example C(children=ansible) to add an empty C() - child element), or a hash where the key is an element name and the value is the element value. + - Child elements must be given in a list and each item may be either a string (for example C(children=ansible) to add + an empty C() child element), or a hash where the key is an element name and the value is the element value. - This parameter requires O(xpath) to be set. type: bool default: false insertafter: description: - Add additional child-element(s) after the last selected element for a given O(xpath). - - Child elements must be given in a list and each item may be either a string (for example C(children=ansible) to add an empty C() - child element), or a hash where the key is an element name and the value is the element value. + - Child elements must be given in a list and each item may be either a string (for example C(children=ansible) to add + an empty C() child element), or a hash where the key is an element name and the value is the element value. - This parameter requires O(xpath) to be set. type: bool default: false @@ -145,7 +146,8 @@ - The diff output is automatically pretty-printed, so may not reflect the actual file content, only the file structure. - This module does not handle complicated xpath expressions, so limit xpath selectors to simple expressions. - Beware that in case your XML elements are namespaced, you need to use the O(namespaces) parameter, see the examples. - - Namespaces prefix should be used for all children of an element where namespace is defined, unless another namespace is defined for them. + - Namespaces prefix should be used for all children of an element where namespace is defined, unless another namespace is + defined for them. seealso: - name: XML module development community wiki (archived) description: More information related to the development of this xml module. @@ -296,10 +298,10 @@ xpath: /business add_children: - building: - # Attributes +# Attributes name: Scumm bar location: Monkey island - # Subnodes +# Subnodes _: - floor: Pirate hall - floor: Grog storage diff --git a/plugins/modules/yarn.py b/plugins/modules/yarn.py index 7109145ce84..969b199834c 100644 --- a/plugins/modules/yarn.py +++ b/plugins/modules/yarn.py @@ -37,7 +37,7 @@ path: type: path description: - - The base path where Node.js libraries will be installed. + - The base path where Node.js installs libraries. - This is where the C(node_modules) folder lives. required: false version: @@ -66,7 +66,7 @@ production: description: - Install dependencies in production mode. - - Yarn will ignore any dependencies under devDependencies in C(package.json). + - C(yarn) ignores any dependencies under devDependencies in C(package.json). required: false type: bool default: false @@ -130,8 +130,8 @@ description: Output generated from Yarn. returned: always type: str - sample: "yarn add v0.16.1[1/4] Resolving packages...[2/4] Fetching packages...[3/4] Linking dependencies...[4/4] Building fresh packages...success - Saved lockfile.success Saved 1 new dependency..left-pad@1.1.3 Done in 0.59s." + sample: "yarn add v0.16.1[1/4] Resolving packages...[2/4] Fetching packages...[3/4] Linking dependencies...[4/4] Building + fresh packages...success Saved lockfile.success Saved 1 new dependency..left-pad@1.1.3 Done in 0.59s." """ import os diff --git a/plugins/modules/yum_versionlock.py b/plugins/modules/yum_versionlock.py index 4a618a9d173..9982700928a 100644 --- a/plugins/modules/yum_versionlock.py +++ b/plugins/modules/yum_versionlock.py @@ -31,8 +31,8 @@ elements: str state: description: - - If state is V(present), package(s) will be added to yum versionlock list. - - If state is V(absent), package(s) will be removed from yum versionlock list. + - If state is V(present), package(s) is/are added to yum versionlock list. + - If state is V(absent), package(s) is/are removed from yum versionlock list. choices: ['absent', 'present'] type: str default: present diff --git a/plugins/modules/zfs.py b/plugins/modules/zfs.py index 1b00010d8a9..55bba5b968b 100644 --- a/plugins/modules/zfs.py +++ b/plugins/modules/zfs.py @@ -20,9 +20,9 @@ check_mode: support: partial details: - - In certain situations it may report a task as changed that will not be reported as changed when C(check_mode) is disabled. - - For example, this might occur when the zpool C(altroot) option is set or when a size is written using human-readable notation, such as - V(1M) or V(1024K), instead of as an unqualified byte count, such as V(1048576). + - In certain situations it may report a task as changed that is not reported as changed when C(check_mode) is disabled. + - For example, this might occur when the zpool C(altroot) option is set or when a size is written using human-readable + notation, such as V(1M) or V(1024K), instead of as an unqualified byte count, such as V(1048576). diff_mode: support: full options: @@ -33,8 +33,8 @@ type: str state: description: - - Whether to create (V(present)), or remove (V(absent)) a file system, snapshot or volume. All parents/children will be created/destroyed - as needed to reach the desired state. + - Whether to create (V(present)), or remove (V(absent)) a file system, snapshot or volume. All parents/children are + created/destroyed as needed to reach the desired state. choices: [absent, present] required: true type: str diff --git a/plugins/modules/zfs_delegate_admin.py b/plugins/modules/zfs_delegate_admin.py index 796cbd45955..7158c7638f9 100644 --- a/plugins/modules/zfs_delegate_admin.py +++ b/plugins/modules/zfs_delegate_admin.py @@ -12,13 +12,13 @@ module: zfs_delegate_admin short_description: Manage ZFS delegated administration (user admin privileges) description: - - Manages ZFS file system delegated administration permissions, which allow unprivileged users to perform ZFS operations normally restricted - to the superuser. + - Manages ZFS file system delegated administration permissions, which allow unprivileged users to perform ZFS operations + normally restricted to the superuser. - See the C(zfs allow) section of V(zfs(1M\)) for detailed explanations of options. - This module attempts to adhere to the behavior of the command line tool as much as possible. requirements: - - "A ZFS/OpenZFS implementation that supports delegation with C(zfs allow), including: Solaris >= 10, illumos (all versions), FreeBSD >= 8.0R, - ZFS on Linux >= 0.7.0." + - "A ZFS/OpenZFS implementation that supports delegation with C(zfs allow), including: Solaris >= 10, illumos (all versions), + FreeBSD >= 8.0R, ZFS on Linux >= 0.7.0." extends_documentation_fragment: - community.general.attributes attributes: @@ -36,7 +36,8 @@ description: - Whether to allow (V(present)), or unallow (V(absent)) a permission. - When set to V(present), at least one "entity" param of O(users), O(groups), or O(everyone) are required. - - When set to V(absent), removes permissions from the specified entities, or removes all permissions if no entity params are specified. + - When set to V(absent), removes permissions from the specified entities, or removes all permissions if no entity params + are specified. choices: [absent, present] default: present type: str diff --git a/plugins/modules/zfs_facts.py b/plugins/modules/zfs_facts.py index 115e8e3e7aa..10f826b728f 100644 --- a/plugins/modules/zfs_facts.py +++ b/plugins/modules/zfs_facts.py @@ -38,8 +38,8 @@ default: false properties: description: - - Specifies which dataset properties should be queried in comma-separated format. For more information about dataset properties, check zfs(1M) - man page. + - Specifies which dataset properties should be queried in comma-separated format. For more information about dataset + properties, check zfs(1M) man page. default: all type: str type: @@ -92,14 +92,15 @@ returned: always type: str sample: {"aclinherit": "restricted", "aclmode": "discard", "atime": "on", "available": "43.8G", "canmount": "on", "casesensitivity": "sensitive", - "checksum": "on", "compression": "off", "compressratio": "1.00x", "copies": "1", "creation": "Thu Jun 16 11:37 2016", "dedup": "off", "devices": "on", - "exec": "on", "filesystem_count": "none", "filesystem_limit": "none", "logbias": "latency", "logicalreferenced": "18.5K", "logicalused": "3.45G", - "mlslabel": "none", "mounted": "yes", "mountpoint": "/rpool", "name": "rpool", "nbmand": "off", "normalization": "none", "org.openindiana.caiman:install": - "ready", "primarycache": "all", "quota": "none", "readonly": "off", "recordsize": "128K", "redundant_metadata": "all", "refcompressratio": "1.00x", - "referenced": "29.5K", "refquota": "none", "refreservation": "none", "reservation": "none", "secondarycache": "all", "setuid": "on", "sharenfs": "off", - "sharesmb": "off", "snapdir": "hidden", "snapshot_count": "none", "snapshot_limit": "none", "sync": "standard", "type": "filesystem", "used": "4.41G", - "usedbychildren": "4.41G", "usedbydataset": "29.5K", "usedbyrefreservation": "0", "usedbysnapshots": "0", "utf8only": "off", "version": "5", - "vscan": "off", "written": "29.5K", "xattr": "on", "zoned": "off"} + "checksum": "on", "compression": "off", "compressratio": "1.00x", "copies": "1", "creation": "Thu Jun 16 11:37 2016", + "dedup": "off", "devices": "on", "exec": "on", "filesystem_count": "none", "filesystem_limit": "none", "logbias": "latency", + "logicalreferenced": "18.5K", "logicalused": "3.45G", "mlslabel": "none", "mounted": "yes", "mountpoint": "/rpool", "name": "rpool", + "nbmand": "off", "normalization": "none", "org.openindiana.caiman:install": "ready", "primarycache": "all", "quota": "none", + "readonly": "off", "recordsize": "128K", "redundant_metadata": "all", "refcompressratio": "1.00x", "referenced": "29.5K", + "refquota": "none", "refreservation": "none", "reservation": "none", "secondarycache": "all", "setuid": "on", "sharenfs": "off", + "sharesmb": "off", "snapdir": "hidden", "snapshot_count": "none", "snapshot_limit": "none", "sync": "standard", "type": "filesystem", + "used": "4.41G", "usedbychildren": "4.41G", "usedbydataset": "29.5K", "usedbyrefreservation": "0", "usedbysnapshots": "0", + "utf8only": "off", "version": "5", "vscan": "off", "written": "29.5K", "xattr": "on", "zoned": "off"} """ from collections import defaultdict diff --git a/plugins/modules/znode.py b/plugins/modules/znode.py index ca59704d127..8e3da6de5e6 100644 --- a/plugins/modules/znode.py +++ b/plugins/modules/znode.py @@ -57,7 +57,7 @@ default: false auth_scheme: description: - - 'Authentication scheme.' + - Authentication scheme. choices: [digest, sasl] type: str default: "digest" diff --git a/plugins/modules/zpool_facts.py b/plugins/modules/zpool_facts.py index e0b87b570c1..28c4644d87f 100644 --- a/plugins/modules/zpool_facts.py +++ b/plugins/modules/zpool_facts.py @@ -34,8 +34,8 @@ required: false properties: description: - - Specifies which dataset properties should be queried in comma-separated format. For more information about dataset properties, check zpool(1M) - man page. + - Specifies which dataset properties should be queried in comma-separated format. For more information about dataset + properties, check zpool(1M) man page. type: str default: all required: false @@ -64,14 +64,14 @@ description: ZFS pool facts. returned: always type: str - sample: {"allocated": "3.46G", "altroot": "-", "autoexpand": "off", "autoreplace": "off", "bootfs": "rpool/ROOT/openindiana", "cachefile": "-", - "capacity": "6%", "comment": "-", "dedupditto": "0", "dedupratio": "1.00x", "delegation": "on", "expandsize": "-", "failmode": "wait", - "feature@async_destroy": "enabled", "feature@bookmarks": "enabled", "feature@edonr": "enabled", "feature@embedded_data": "active", - "feature@empty_bpobj": "active", "feature@enabled_txg": "active", "feature@extensible_dataset": "enabled", "feature@filesystem_limits": "enabled", - "feature@hole_birth": "active", "feature@large_blocks": "enabled", "feature@lz4_compress": "active", "feature@multi_vdev_crash_dump": "enabled", - "feature@sha512": "enabled", "feature@skein": "enabled", "feature@spacemap_histogram": "active", "fragmentation": "3%", "free": "46.3G", - "freeing": "0", "guid": "15729052870819522408", "health": "ONLINE", "leaked": "0", "listsnapshots": "off", "name": "rpool", "readonly": "off", - "size": "49.8G", "version": "-"} + sample: {"allocated": "3.46G", "altroot": "-", "autoexpand": "off", "autoreplace": "off", "bootfs": "rpool/ROOT/openindiana", + "cachefile": "-", "capacity": "6%", "comment": "-", "dedupditto": "0", "dedupratio": "1.00x", "delegation": "on", + "expandsize": "-", "failmode": "wait", "feature@async_destroy": "enabled", "feature@bookmarks": "enabled", "feature@edonr": "enabled", + "feature@embedded_data": "active", "feature@empty_bpobj": "active", "feature@enabled_txg": "active", "feature@extensible_dataset": "enabled", + "feature@filesystem_limits": "enabled", "feature@hole_birth": "active", "feature@large_blocks": "enabled", "feature@lz4_compress": "active", + "feature@multi_vdev_crash_dump": "enabled", "feature@sha512": "enabled", "feature@skein": "enabled", "feature@spacemap_histogram": "active", + "fragmentation": "3%", "free": "46.3G", "freeing": "0", "guid": "15729052870819522408", "health": "ONLINE", "leaked": "0", + "listsnapshots": "off", "name": "rpool", "readonly": "off", "size": "49.8G", "version": "-"} name: description: ZFS pool name. returned: always diff --git a/plugins/modules/zypper.py b/plugins/modules/zypper.py index 5bc6c766a0f..fb3be3a5d02 100644 --- a/plugins/modules/zypper.py +++ b/plugins/modules/zypper.py @@ -29,7 +29,8 @@ short_description: Manage packages on SUSE and openSUSE description: - Manage packages on SUSE and openSUSE using the zypper and rpm tools. - - Also supports transactional updates, by running zypper inside C(/sbin/transactional-update --continue --drop-if-no-change --quiet run). + - Also supports transactional updates, by running zypper inside C(/sbin/transactional-update --continue --drop-if-no-change + --quiet run). extends_documentation_fragment: - community.general.attributes - community.general.attributes @@ -42,9 +43,9 @@ name: description: - Package name V(name) or package specifier or a list of either. - - Can include a version like V(name=1.0), V(name>3.4) or V(name<=2.7). If a version is given, V(oldpackage) is implied and zypper is allowed - to update the package within the version range given. - - You can also pass a url or a local path to a rpm file. + - Can include a version like V(name=1.0), V(name>3.4) or V(name<=2.7). If a version is given, V(oldpackage) is implied + and zypper is allowed to update the package within the version range given. + - You can also pass a URL or a local path to a rpm file. - When using O(state=latest), this can be V(*), which updates all installed packages. required: true aliases: ['pkg'] @@ -52,10 +53,10 @@ elements: str state: description: - - V(present) will make sure the package is installed. - - V(latest) will make sure the latest version of the package is installed. - - V(absent) will make sure the specified package is not installed. - - V(dist-upgrade) will make sure the latest version of all installed packages from all enabled repositories is installed. + - V(present) makes sure the package is installed. + - V(latest) makes sure the latest version of the package is installed. + - V(absent) makes sure the specified package is not installed. + - V(dist-upgrade) makes sure the latest version of all installed packages from all enabled repositories is installed. - When using V(dist-upgrade), O(name) should be V(*). required: false choices: [present, latest, absent, dist-upgrade, installed, removed] @@ -76,15 +77,15 @@ type: str disable_gpg_check: description: - - Whether to disable to GPG signature checking of the package signature being installed. Has an effect only if O(state) is V(present) or - V(latest). + - Whether to disable to GPG signature checking of the package signature being installed. Has an effect only if O(state) + is V(present) or V(latest). required: false default: false type: bool disable_recommends: description: - - Corresponds to the C(--no-recommends) option for I(zypper). Default behavior (V(true)) modifies zypper's default behavior; V(false) does - install recommended packages. + - Corresponds to the C(--no-recommends) option for I(zypper). Default behavior (V(true)) modifies zypper's default behavior; + V(false) does install recommended packages. required: false default: true type: bool @@ -96,7 +97,8 @@ type: bool force_resolution: description: - - Adds C(--force-resolution) option to I(zypper). Allows to (un)install packages with conflicting requirements (resolver will choose a solution). + - Adds C(--force-resolution) option to I(zypper). Allows to (un)install packages with conflicting requirements (resolver + chooses a solution). required: false default: false type: bool @@ -110,8 +112,8 @@ aliases: ["refresh"] oldpackage: description: - - Adds C(--oldpackage) option to I(zypper). Allows to downgrade packages with less side-effects than force. This is implied as soon as a - version is specified as part of the package name. + - Adds C(--oldpackage) option to I(zypper). Allows to downgrade packages with less side-effects than force. This is + implied as soon as a version is specified as part of the package name. required: false default: false type: bool @@ -157,9 +159,8 @@ - Adds C(--quiet) option to I(zypper) install/update command. version_added: '10.2.0' notes: - - When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly to the O(name) - option. -# informational: requirements for nodes + - When used with a C(loop:) each package is processed individually, it is much more efficient to pass the list directly + to the O(name) option. requirements: - "zypper >= 1.0 # included in openSUSE >= 11.1 or SUSE Linux Enterprise Server/Desktop >= 11.0" - python-xml diff --git a/plugins/modules/zypper_repository.py b/plugins/modules/zypper_repository.py index 18f9ff0824f..37aa36c601a 100644 --- a/plugins/modules/zypper_repository.py +++ b/plugins/modules/zypper_repository.py @@ -58,7 +58,7 @@ aliases: ["refresh"] priority: description: - - Set priority of repository. Packages will always be installed from the repository with the smallest priority number. + - Set priority of repository. Packages are always installed from the repository with the smallest priority number. - Needs C(zypper) version >= 1.12.25. type: int overwrite_multiple: @@ -69,7 +69,8 @@ auto_import_keys: description: - Automatically import the gpg signing key of the new or changed repository. - - Has an effect only if O(state=present). Has no effect on existing (unchanged) repositories or in combination with O(state=absent). + - Has an effect only if O(state=present). Has no effect on existing (unchanged) repositories or in combination with + O(state=absent). - Implies O(runrefresh). - Only works with C(.repo) files if O(name) is given explicitly. type: bool diff --git a/plugins/modules/zypper_repository_info.py b/plugins/modules/zypper_repository_info.py index 9512d32eed2..d3f20883c6b 100644 --- a/plugins/modules/zypper_repository_info.py +++ b/plugins/modules/zypper_repository_info.py @@ -25,7 +25,7 @@ - "zypper >= 1.0 (included in openSUSE >= 11.1 or SUSE Linux Enterprise Server/Desktop >= 11.0)" - python-xml notes: - - "For info about packages, use the module M(ansible.builtin.package_facts)." + - For info about packages, use the module M(ansible.builtin.package_facts). """ EXAMPLES = r"""