a-c-m
/
community.general
mirror of https://github.com/ansible-collections/community.general.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

o*: style adjustments (#9526) 

* o*: style adjustments

* apply recommendations from review

* Update plugins/modules/one_vm.py

* fix example

* adjustment from review

* Update plugins/modules/one_vm.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
pull/9579/head
Alexei Znamensky 2025-01-13 01:03:26 +13:00 committed by GitHub
parent 3dcac2b030
commit d325cfc343
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
31 changed files with 196 additions and 173 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
plugins/modules/ocapi_command.py
View File

@ -154,7 +154,8 @@ msg:
sample: "Action was successful" sample: "Action was successful"
jobUri: jobUri:
description: URI to use to monitor status of the operation. Returned for async commands such as Firmware Update, Firmware Activate. description: URI to use to monitor status of the operation. Returned for async commands such as Firmware Update, Firmware
Activate.
returned: when supported returned: when supported
type: str type: str
sample: "https://ioma.wdc.com/Storage/Devices/openflex-data24-usalp03020qb0003/Jobs/FirmwareUpdate/" sample: "https://ioma.wdc.com/Storage/Devices/openflex-data24-usalp03020qb0003/Jobs/FirmwareUpdate/"

7
plugins/modules/ocapi_info.py
View File

@ -93,7 +93,8 @@ operationStatus:
sample: "Activate needed" sample: "Activate needed"
operationStatusId: operationStatusId:
description: Integer value of status (corresponds to operationStatus). Applies to O(command=JobStatus). See OCAPI documentation for details. description: Integer value of status (corresponds to operationStatus). Applies to O(command=JobStatus). See OCAPI documentation
for details.
returned: when supported returned: when supported
type: int type: int
sample: 65540 sample: 65540
@ -106,8 +107,8 @@ operationHealth:
operationHealthId: operationHealthId:
description: >- description: >-
Integer value for health of the operation (corresponds to RV(operationHealth)). Applies to O(command=JobStatus). See OCAPI documentation for Integer value for health of the operation (corresponds to RV(operationHealth)). Applies to O(command=JobStatus). See OCAPI
details. documentation for details.
returned: when supported returned: when supported
type: str type: str
sample: "OK" sample: "OK"

20
plugins/modules/oci_vcn.py
View File

@ -12,8 +12,8 @@ DOCUMENTATION = r"""
module: oci_vcn module: oci_vcn
short_description: Manage Virtual Cloud Networks(VCN) in OCI short_description: Manage Virtual Cloud Networks(VCN) in OCI
description: description:
- This module allows the user to create, delete and update virtual cloud networks(VCNs) in OCI. The complete Oracle Cloud Infrastructure Ansible - This module allows the user to create, delete and update virtual cloud networks(VCNs) in OCI. The complete Oracle Cloud
Modules can be downloaded from U(https://github.com/oracle/oci-ansible-modules/releases). Infrastructure Ansible Modules can be downloaded from U(https://github.com/oracle/oci-ansible-modules/releases).
attributes: attributes:
check_mode: check_mode:
support: none support: none
@ -25,18 +25,18 @@ options:
type: str type: str
required: false required: false
compartment_id: compartment_id:
description: The OCID of the compartment to contain the VCN. Required when creating a VCN with O(state=present). This option is mutually exclusive description: The OCID of the compartment to contain the VCN. Required when creating a VCN with O(state=present). This
with O(vcn_id). option is mutually exclusive with O(vcn_id).
type: str type: str
display_name: display_name:
description: A user-friendly name. Does not have to be unique, and it is changeable. description: A user-friendly name. Does not have to be unique, and it is changeable.
type: str type: str
aliases: ['name'] aliases: ['name']
dns_label: dns_label:
description: A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain description: A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully
name (FQDN) for each VNIC within this subnet (for example, V(bminstance-1.subnet123.vcn1.oraclevcn.com)). Not required to be unique, but it is qualified domain name (FQDN) for each VNIC within this subnet (for example, V(bminstance-1.subnet123.vcn1.oraclevcn.com)).
a best practice to set unique DNS labels for VCNs in your tenancy. Must be an alphanumeric string that begins with a letter. The value cannot Not required to be unique, but it is a best practice to set unique DNS labels for VCNs in your tenancy. Must be an alphanumeric
be changed. string that begins with a letter. The value cannot be changed.
type: str type: str
state: state:
description: Create or update a VCN with O(state=present). Use O(state=absent) to delete a VCN. description: Create or update a VCN with O(state=present). Use O(state=absent) to delete a VCN.
@ -44,8 +44,8 @@ options:
default: present default: present
choices: ['present', 'absent'] choices: ['present', 'absent']
vcn_id: vcn_id:
description: The OCID of the VCN. Required when deleting a VCN with O(state=absent) or updating a VCN with O(state=present). This option is description: The OCID of the VCN. Required when deleting a VCN with O(state=absent) or updating a VCN with O(state=present).
mutually exclusive with O(compartment_id). This option is mutually exclusive with O(compartment_id).
type: str type: str
aliases: ['id'] aliases: ['id']
author: "Rohit Chaware (@rohitChaware)" author: "Rohit Chaware (@rohitChaware)"

11
plugins/modules/office_365_connector_card.py
View File

@ -13,7 +13,8 @@ module: office_365_connector_card
short_description: Use webhooks to create Connector Card messages within an Office 365 group short_description: Use webhooks to create Connector Card messages within an Office 365 group
description: description:
- Creates Connector Card messages through Office 365 Connectors. - Creates Connector Card messages through Office 365 Connectors.
- See U(https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference#connector-card-for-microsoft-365-groups). - See
U(https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference#connector-card-for-microsoft-365-groups).
author: "Marc Sensenich (@marc-sensenich)" author: "Marc Sensenich (@marc-sensenich)"
notes: notes:
- This module is not idempotent, therefore if the same task is run twice there will be two Connector Cards created. - This module is not idempotent, therefore if the same task is run twice there will be two Connector Cards created.
@ -74,8 +75,8 @@ EXAMPLES = r"""
webhook: https://outlook.office.com/webhook/GUID/IncomingWebhook/GUID/GUID webhook: https://outlook.office.com/webhook/GUID/IncomingWebhook/GUID/GUID
summary: This is the summary property summary: This is the summary property
title: This is the **card's title** property title: This is the **card's title** property
text: This is the **card's text** property. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut text: This is the **card's text** property. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
labore et dolore magna aliqua. tempor incididunt ut labore et dolore magna aliqua.
color: E81123 color: E81123
sections: sections:
- title: This is the **section's title** property - title: This is the **section's title** property
@ -86,8 +87,8 @@ EXAMPLES = r"""
hero_image: hero_image:
image: http://connectorsdemo.azurewebsites.net/images/WIN12_Scene_01.jpg image: http://connectorsdemo.azurewebsites.net/images/WIN12_Scene_01.jpg
title: This is the image's alternate text title: This is the image's alternate text
text: This is the section's text property. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt text: This is the section's text property. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
ut labore et dolore magna aliqua. tempor incididunt ut labore et dolore magna aliqua.
facts: facts:
- name: This is a fact name - name: This is a fact name
value: This is a fact value value: This is a fact value

4
plugins/modules/ohai.py
View File

@ -13,8 +13,8 @@ DOCUMENTATION = r"""
module: ohai module: ohai
short_description: Returns inventory data from I(Ohai) short_description: Returns inventory data from I(Ohai)
description: description:
- Similar to the M(community.general.facter) module, this runs the I(Ohai) discovery program (U(https://docs.chef.io/ohai.html)) on the remote - Similar to the M(community.general.facter) module, this runs the I(Ohai) discovery program (U(https://docs.chef.io/ohai.html))
host and returns JSON inventory data. I(Ohai) data is a bit more verbose and nested than I(facter). on the remote host and returns JSON inventory data. I(Ohai) data is a bit more verbose and nested than I(facter).
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:

3
plugins/modules/one_host.py
View File

@ -56,7 +56,8 @@ options:
type: str type: str
vmm_mad_name: vmm_mad_name:
description: description:
- The name of the virtual machine manager mad name, this values are taken from the oned.conf with the tag name VM_MAD (name). - The name of the virtual machine manager mad name, this values are taken from the oned.conf with the tag name VM_MAD
(name).
default: kvm default: kvm
type: str type: str
cluster_id: cluster_id:

6
plugins/modules/one_image.py
View File

@ -157,7 +157,7 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
id: id:
description: Image id. description: Image ID.
type: int type: int
returned: when O(state=present), O(state=cloned), or O(state=renamed) returned: when O(state=present), O(state=cloned), or O(state=renamed)
sample: 153 sample: 153
@ -167,7 +167,7 @@ name:
returned: when O(state=present), O(state=cloned), or O(state=renamed) returned: when O(state=present), O(state=cloned), or O(state=renamed)
sample: app1 sample: app1
group_id: group_id:
description: Image's group id. description: Image's group ID.
type: int type: int
returned: when O(state=present), O(state=cloned), or O(state=renamed) returned: when O(state=present), O(state=cloned), or O(state=renamed)
sample: 1 sample: 1
@ -177,7 +177,7 @@ group_name:
returned: when O(state=present), O(state=cloned), or O(state=renamed) returned: when O(state=present), O(state=cloned), or O(state=renamed)
sample: one-users sample: one-users
owner_id: owner_id:
description: Image's owner id. description: Image's owner ID.
type: int type: int
returned: when O(state=present), O(state=cloned), or O(state=renamed) returned: when O(state=present), O(state=cloned), or O(state=renamed)
sample: 143 sample: 143

12
plugins/modules/one_image_info.py
View File

@ -22,7 +22,7 @@ extends_documentation_fragment:
options: options:
ids: ids:
description: description:
- A list of images ids whose facts you want to gather. - A list of images IDs whose facts you want to gather.
- Module can use integers too. - Module can use integers too.
aliases: ['id'] aliases: ['id']
type: list type: list
@ -30,8 +30,8 @@ options:
name: name:
description: description:
- A O(name) of the image whose facts will be gathered. - A O(name) of the image whose facts will be gathered.
- If the O(name) begins with V(~) the O(name) will be used as regex pattern, - If the O(name) begins with V(~) the O(name) will be used as regex pattern, which restricts the list of images (whose
which restricts the list of images (whose facts will be returned) whose names match specified regex. facts will be returned) whose names match specified regex.
- Also, if the O(name) begins with V(~*) case-insensitive matching will be performed. - Also, if the O(name) begins with V(~*) case-insensitive matching will be performed.
- See examples for more details. - See examples for more details.
type: str type: str
@ -84,7 +84,7 @@ images:
returned: success returned: success
contains: contains:
id: id:
description: The image's id. description: The image's ID.
type: int type: int
sample: 153 sample: 153
name: name:
@ -92,7 +92,7 @@ images:
type: str type: str
sample: app1 sample: app1
group_id: group_id:
description: The image's group id. description: The image's group ID.
type: int type: int
sample: 1 sample: 1
group_name: group_name:
@ -100,7 +100,7 @@ images:
type: str type: str
sample: one-users sample: one-users
owner_id: owner_id:
description: The image's owner id. description: The image's owner ID.
type: int type: int
sample: 143 sample: 143
owner_name: owner_name:

24
plugins/modules/one_service.py
View File

@ -29,13 +29,13 @@ options:
type: str type: str
api_username: api_username:
description: description:
- Name of the user to login into the OpenNebula OneFlow API server. If not set then the value of the E(ONEFLOW_USERNAME) environment variable - Name of the user to login into the OpenNebula OneFlow API server. If not set then the value of the E(ONEFLOW_USERNAME)
is used. environment variable is used.
type: str type: str
api_password: api_password:
description: description:
- Password of the user to login into OpenNebula OneFlow API server. If not set then the value of the E(ONEFLOW_PASSWORD) environment variable - Password of the user to login into OpenNebula OneFlow API server. If not set then the value of the E(ONEFLOW_PASSWORD)
is used. environment variable is used.
type: str type: str
template_name: template_name:
description: description:
@ -55,8 +55,8 @@ options:
type: str type: str
unique: unique:
description: description:
- Setting O(unique=true) will make sure that there is only one service instance running with a name set with O(service_name) when instantiating - Setting O(unique=true) will make sure that there is only one service instance running with a name set with O(service_name)
a service from a template specified with O(template_id) or O(template_name). Check examples below. when instantiating a service from a template specified with O(template_id) or O(template_name). Check examples below.
type: bool type: bool
default: false default: false
state: state:
@ -68,8 +68,8 @@ options:
type: str type: str
mode: mode:
description: description:
- Set permission mode of a service instance in octet format, for example V(0600) to give owner C(use) and C(manage) and nothing to group - Set permission mode of a service instance in octet format, for example V(0600) to give owner C(use) and C(manage)
and others. and nothing to group and others.
type: str type: str
owner_id: owner_id:
description: description:
@ -184,7 +184,7 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
service_id: service_id:
description: Service id. description: Service ID.
type: int type: int
returned: success returned: success
sample: 153 sample: 153
@ -194,7 +194,7 @@ service_name:
returned: success returned: success
sample: app1 sample: app1
group_id: group_id:
description: Service's group id. description: Service's group ID.
type: int type: int
returned: success returned: success
sample: 1 sample: 1
@ -204,7 +204,7 @@ group_name:
returned: success returned: success
sample: one-users sample: one-users
owner_id: owner_id:
description: Service's owner id. description: Service's owner ID.
type: int type: int
returned: success returned: success
sample: 143 sample: 143
@ -224,7 +224,7 @@ mode:
returned: success returned: success
sample: 660 sample: 660
roles: roles:
description: List of dictionaries of roles, each role is described by name, cardinality, state and nodes ids. description: List of dictionaries of roles, each role is described by name, cardinality, state and nodes IDs.
type: list type: list
returned: success returned: success
sample: sample:

13
plugins/modules/one_template.py
View File

@ -25,7 +25,8 @@ attributes:
check_mode: check_mode:
support: partial support: partial
details: details:
- Note that check mode always returns C(changed=true) for existing templates, even if the template would not actually change. - Note that check mode always returns C(changed=true) for existing templates, even if the template would not actually
change.
diff_mode: diff_mode:
support: none support: none
@ -36,8 +37,8 @@ options:
type: int type: int
name: name:
description: description:
- A O(name) of the template you would like to manage. - A O(name) of the template you would like to manage. If a template with the given name does not exist it will be created,
If a template with the given name does not exist it will be created, otherwise it will be managed by this module. otherwise it will be managed by this module.
type: str type: str
template: template:
description: description:
@ -110,7 +111,7 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
id: id:
description: Template id. description: Template ID.
type: int type: int
returned: when O(state=present) returned: when O(state=present)
sample: 153 sample: 153
@ -124,7 +125,7 @@ template:
type: dict type: dict
returned: when O(state=present) returned: when O(state=present)
group_id: group_id:
description: Template's group id. description: Template's group ID.
type: int type: int
returned: when O(state=present) returned: when O(state=present)
sample: 1 sample: 1
@ -134,7 +135,7 @@ group_name:
returned: when O(state=present) returned: when O(state=present)
sample: one-users sample: one-users
owner_id: owner_id:
description: Template's owner id. description: Template's owner ID.
type: int type: int
returned: when O(state=present) returned: when O(state=present)
sample: 143 sample: 143

62
plugins/modules/one_vm.py
View File

@ -32,12 +32,14 @@ options:
type: str type: str
api_username: api_username:
description: description:
- Name of the user to login into the OpenNebula RPC server. If not set then the value of the E(ONE_USERNAME) environment variable is used. - Name of the user to login into the OpenNebula RPC server. If not set then the value of the E(ONE_USERNAME) environment
variable is used.
type: str type: str
api_password: api_password:
description: description:
- Password of the user to login into OpenNebula RPC server. If not set then the value of the E(ONE_PASSWORD) environment variable is used. - Password of the user to login into OpenNebula RPC server. If not set then the value of the E(ONE_PASSWORD) environment
if both O(api_username) or O(api_password) are not set, then it will try authenticate with ONE auth file. Default path is "~/.one/one_auth". variable is used. if both O(api_username) or O(api_password) are not set, then it will try authenticate with ONE auth
file. Default path is C(~/.one/one_auth).
- Set environment variable E(ONE_AUTH) to override this path. - Set environment variable E(ONE_AUTH) to override this path.
type: str type: str
template_name: template_name:
@ -55,7 +57,7 @@ options:
type: bool type: bool
instance_ids: instance_ids:
description: description:
- 'A list of instance ids used for states: V(absent), V(running), V(rebooted), V(poweredoff).' - 'A list of instance IDs used for states: V(absent), V(running), V(rebooted), V(poweredoff).'
aliases: ['ids'] aliases: ['ids']
type: list type: list
elements: int elements: int
@ -76,9 +78,9 @@ options:
type: bool type: bool
wait: wait:
description: description:
- Wait for the instance to reach its desired state before returning. Keep in mind if you are waiting for instance to be in running state - Wait for the instance to reach its desired state before returning. Keep in mind if you are waiting for instance to
it does not mean that you will be able to SSH on that machine only that boot process have started on that instance, see 'wait_for' example be in running state it does not mean that you will be able to SSH on that machine only that boot process have started
for details. on that instance. See the example using the M(ansible.builtin.wait_for) module for details.
default: true default: true
type: bool type: bool
wait_timeout: wait_timeout:
@ -104,13 +106,14 @@ options:
elements: str elements: str
count_attributes: count_attributes:
description: description:
- A dictionary of key/value attributes that can only be used with O(exact_count) to determine how many nodes based on a specific attributes - A dictionary of key/value attributes that can only be used with O(exact_count) to determine how many nodes based on
criteria should be deployed. This can be expressed in multiple ways and is shown in the EXAMPLES section. a specific attributes criteria should be deployed. This can be expressed in multiple ways and is shown in the EXAMPLES
section.
type: dict type: dict
count_labels: count_labels:
description: description:
- A list of labels that can only be used with O(exact_count) to determine how many nodes based on a specific labels criteria should be deployed. - A list of labels that can only be used with O(exact_count) to determine how many nodes based on a specific labels
This can be expressed in multiple ways and is shown in the EXAMPLES section. criteria should be deployed. This can be expressed in multiple ways and is shown in the EXAMPLES section.
type: list type: list
elements: str elements: str
count: count:
@ -120,13 +123,14 @@ options:
type: int type: int
exact_count: exact_count:
description: description:
- Indicates how many instances that match O(count_attributes) and O(count_labels) parameters should be deployed. Instances are either created - Indicates how many instances that match O(count_attributes) and O(count_labels) parameters should be deployed. Instances
or terminated based on this value. are either created or terminated based on this value.
- B(NOTE:) Instances with the least IDs will be terminated first. - B(NOTE:) Instances with the least IDs will be terminated first.
type: int type: int
mode: mode:
description: description:
- Set permission mode of the instance in octet format, for example V(0600) to give owner C(use) and C(manage) and nothing to group and others. - Set permission mode of the instance in octet format, for example V(0600) to give owner C(use) and C(manage) and nothing
to group and others.
type: str type: str
owner_id: owner_id:
description: description:
@ -165,8 +169,8 @@ options:
- Creates an image from a VM disk. - Creates an image from a VM disk.
- It is a dictionary where you have to specify C(name) of the new image. - It is a dictionary where you have to specify C(name) of the new image.
- Optionally you can specify C(disk_id) of the disk you want to save. By default C(disk_id) is 0. - Optionally you can specify C(disk_id) of the disk you want to save. By default C(disk_id) is 0.
- B(NOTE:) This operation will only be performed on the first VM (if more than one VM ID is passed) and the VM has to be in the C(poweredoff) - B(NOTE:) This operation will only be performed on the first VM (if more than one VM ID is passed) and the VM has to
state. be in the C(poweredoff) state.
- Also this operation will fail if an image with specified C(name) already exists. - Also this operation will fail if an image with specified C(name) already exists.
type: dict type: dict
persistent: persistent:
@ -338,8 +342,9 @@ EXAMPLES = r"""
register: vm register: vm
- name: Wait for SSH to come up - name: Wait for SSH to come up
ansible.builtin.wait_for_connection: ansible.builtin.wait_for:
delegate_to: '{{ vm.instances[0].networks[0].ip }}' port: 22
host: '{{ vm.instances[0].networks[0].ip }}'
- name: Terminate VMs by ids - name: Terminate VMs by ids
community.general.one_vm: community.general.one_vm:
@ -427,7 +432,7 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
instances_ids: instances_ids:
description: A list of instances ids whose state is changed or which are fetched with O(instance_ids) option. description: A list of instances IDs whose state is changed or which are fetched with O(instance_ids) option.
type: list type: list
returned: success returned: success
sample: [1234, 1235] sample: [1234, 1235]
@ -437,7 +442,7 @@ instances:
returned: success returned: success
contains: contains:
vm_id: vm_id:
description: Vm id. description: Vm ID.
type: int type: int
sample: 153 sample: 153
vm_name: vm_name:
@ -445,11 +450,11 @@ instances:
type: str type: str
sample: foo sample: foo
template_id: template_id:
description: Vm's template id. description: Vm's template ID.
type: int type: int
sample: 153 sample: 153
group_id: group_id:
description: Vm's group id. description: Vm's group ID.
type: int type: int
sample: 1 sample: 1
group_name: group_name:
@ -457,7 +462,7 @@ instances:
type: str type: str
sample: one-users sample: one-users
owner_id: owner_id:
description: Vm's owner id. description: Vm's owner ID.
type: int type: int
sample: 143 sample: 143
owner_name: owner_name:
@ -540,12 +545,13 @@ instances:
} }
tagged_instances: tagged_instances:
description: description:
- A list of instances info based on a specific attributes and/or labels that are specified with O(count_attributes) and O(count_labels) options. - A list of instances info based on a specific attributes and/or labels that are specified with O(count_attributes) and
O(count_labels) options.
type: complex type: complex
returned: success returned: success
contains: contains:
vm_id: vm_id:
description: Vm id. description: Vm ID.
type: int type: int
sample: 153 sample: 153
vm_name: vm_name:
@ -553,11 +559,11 @@ tagged_instances:
type: str type: str
sample: foo sample: foo
template_id: template_id:
description: Vm's template id. description: Vm's template ID.
type: int type: int
sample: 153 sample: 153
group_id: group_id:
description: Vm's group id. description: Vm's group ID.
type: int type: int
sample: 1 sample: 1
group_name: group_name:
@ -565,7 +571,7 @@ tagged_instances:
type: str type: str
sample: one-users sample: one-users
owner_id: owner_id:
description: Vm's user id. description: Vm's user ID.
type: int type: int
sample: 143 sample: 143
owner_name: owner_name:

17
plugins/modules/one_vnet.py
View File

@ -22,7 +22,8 @@ attributes:
check_mode: check_mode:
support: partial support: partial
details: details:
- Note that check mode always returns C(changed=true) for existing networks, even if the network would not actually change. - Note that check mode always returns C(changed=true) for existing networks, even if the network would not actually
change.
diff_mode: diff_mode:
support: none support: none
options: options:
@ -33,8 +34,8 @@ options:
type: int type: int
name: name:
description: description:
- A O(name) of the network you would like to manage. If a network with the given name does not exist it will be created, otherwise it will - A O(name) of the network you would like to manage. If a network with the given name does not exist it will be created,
be managed by this module. otherwise it will be managed by this module.
type: str type: str
template: template:
description: description:
@ -89,7 +90,7 @@ EXAMPLES = r"""
RETURN = r""" RETURN = r"""
id: id:
description: The network id. description: The network ID.
type: int type: int
returned: when O(state=present) returned: when O(state=present)
sample: 153 sample: 153
@ -116,12 +117,12 @@ user_id:
returned: when O(state=present) returned: when O(state=present)
sample: 1 sample: 1
user_name: user_name:
description: The network's user id. description: The network's user ID.
type: str type: str
returned: when O(state=present) returned: when O(state=present)
sample: oneadmin sample: oneadmin
group_id: group_id:
description: The network's group id. description: The network's group ID.
type: int type: int
returned: when O(state=present) returned: when O(state=present)
sample: 1 sample: 1
@ -131,7 +132,7 @@ group_name:
returned: when O(state=present) returned: when O(state=present)
sample: one-users sample: one-users
owner_id: owner_id:
description: The network's owner id. description: The network's owner ID.
type: int type: int
returned: when O(state=present) returned: when O(state=present)
sample: 143 sample: 143
@ -207,7 +208,7 @@ bridge_type:
returned: when O(state=present) returned: when O(state=present)
sample: linux sample: linux
parent_network_id: parent_network_id:
description: The network's parent network id. description: The network's parent network ID.
type: int type: int
returned: when O(state=present) returned: when O(state=present)
sample: 1 sample: 1

12
plugins/modules/oneandone_firewall_policy.py
View File

@ -46,8 +46,8 @@ options:
type: str type: str
rules: rules:
description: description:
- A list of rules that will be set for the firewall policy. Each rule must contain protocol parameter, in addition to three optional parameters - A list of rules that will be set for the firewall policy. Each rule must contain protocol parameter, in addition to
(port_from, port_to, and source). three optional parameters (port_from, port_to, and source).
type: list type: list
elements: dict elements: dict
default: [] default: []
@ -60,22 +60,22 @@ options:
default: [] default: []
remove_server_ips: remove_server_ips:
description: description:
- A list of server IP ids to be unassigned from a firewall policy. Used in combination with update state. - A list of server IP IDs to be unassigned from a firewall policy. Used in combination with update state.
type: list type: list
elements: str elements: str
required: false required: false
default: [] default: []
add_rules: add_rules:
description: description:
- A list of rules that will be added to an existing firewall policy. It is syntax is the same as the one used for rules parameter. Used - A list of rules that will be added to an existing firewall policy. It is syntax is the same as the one used for rules
in combination with update state. parameter. Used in combination with update state.
type: list type: list
elements: dict elements: dict
required: false required: false
default: [] default: []
remove_rules: remove_rules:
description: description:
- A list of rule ids that will be removed from an existing firewall policy. Used in combination with update state. - A list of rule IDs that will be removed from an existing firewall policy. Used in combination with update state.
type: list type: list
elements: str elements: str
required: false required: false

18
plugins/modules/oneandone_load_balancer.py
View File

@ -42,7 +42,7 @@ options:
required: false required: false
name: name:
description: description:
- Load balancer name used with present state. Used as identifier (id or name) when used with absent state. maxLength=128. - Load balancer name used with present state. Used as identifier (ID or name) when used with absent state. maxLength=128.
type: str type: str
health_check_test: health_check_test:
description: description:
@ -55,7 +55,7 @@ options:
type: str type: str
health_check_path: health_check_path:
description: description:
- Url to call for checking. Required for HTTP health check. maxLength=1000. - URL to call for checking. Required for HTTP health check. maxLength=1000.
type: str type: str
required: false required: false
health_check_parse: health_check_parse:
@ -85,8 +85,8 @@ options:
required: false required: false
rules: rules:
description: description:
- A list of rule objects that will be set for the load balancer. Each rule must contain protocol, port_balancer, and port_server parameters, - A list of rule objects that will be set for the load balancer. Each rule must contain protocol, port_balancer, and
in addition to source parameter, which is optional. port_server parameters, in addition to source parameter, which is optional.
type: list type: list
elements: dict elements: dict
default: [] default: []
@ -97,29 +97,29 @@ options:
required: false required: false
add_server_ips: add_server_ips:
description: description:
- A list of server identifiers (id or name) to be assigned to a load balancer. Used in combination with update state. - A list of server identifiers (id or name) to be assigned to a load balancer. Used in combination with O(state=update).
type: list type: list
elements: str elements: str
required: false required: false
default: [] default: []
remove_server_ips: remove_server_ips:
description: description:
- A list of server IP ids to be unassigned from a load balancer. Used in combination with update state. - A list of server IP IDs to be unassigned from a load balancer. Used in combination with O(state=update).
type: list type: list
elements: str elements: str
required: false required: false
default: [] default: []
add_rules: add_rules:
description: description:
- A list of rules that will be added to an existing load balancer. It is syntax is the same as the one used for rules parameter. Used in - A list of rules that will be added to an existing load balancer. It is syntax is the same as the one used for rules
combination with update state. parameter. Used in combination with O(state=update).
type: list type: list
elements: dict elements: dict
required: false required: false
default: [] default: []
remove_rules: remove_rules:
description: description:
- A list of rule ids that will be removed from an existing load balancer. Used in combination with update state. - A list of rule IDs that will be removed from an existing load balancer. Used in combination with O(state=update).
type: list type: list
elements: str elements: str
required: false required: false

9
plugins/modules/oneandone_monitoring_policy.py
View File

@ -11,7 +11,8 @@ DOCUMENTATION = r"""
module: oneandone_monitoring_policy module: oneandone_monitoring_policy
short_description: Configure 1&1 monitoring policy short_description: Configure 1&1 monitoring policy
description: description:
- Create, remove, update monitoring policies (and add/remove ports, processes, and servers). This module has a dependency on 1and1 >= 1.0. - Create, remove, update monitoring policies (and add/remove ports, processes, and servers). This module has a dependency
on 1and1 >= 1.0.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:
@ -59,9 +60,9 @@ options:
required: false required: false
thresholds: thresholds:
description: description:
- Monitoring policy thresholds. Each of the suboptions have warning and critical, which both have alert and value suboptions. Warning is - Monitoring policy thresholds. Each of the suboptions have warning and critical, which both have alert and value suboptions.
used to set limits for warning alerts, critical is used to set critical alerts. alert enables alert, and value is used to advise when Warning is used to set limits for warning alerts, critical is used to set critical alerts. alert enables alert, and
the value is exceeded. value is used to advise when the value is exceeded.
type: list type: list
elements: dict elements: dict
default: [] default: []

25
plugins/modules/oneandone_server.py
View File

@ -11,8 +11,8 @@ DOCUMENTATION = r"""
module: oneandone_server module: oneandone_server
short_description: Create, destroy, start, stop, and reboot a 1&1 Host server short_description: Create, destroy, start, stop, and reboot a 1&1 Host server
description: description:
- Create, destroy, update, start, stop, and reboot a 1&1 Host server. When the server is created it can optionally wait for it to be 'running' - Create, destroy, update, start, stop, and reboot a 1&1 Host server. When the server is created it can optionally wait
before returning. for it to be 'running' before returning.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:
@ -55,25 +55,26 @@ options:
type: str type: str
fixed_instance_size: fixed_instance_size:
description: description:
- The instance size name or ID of the server. It is required only for 'present' state, and it is mutually exclusive with vcore, cores_per_processor, - The instance size name or ID of the server. It is required only for 'present' state, and it is mutually exclusive
ram, and hdds parameters. with vcore, cores_per_processor, ram, and hdds parameters.
- 'The available choices are: V(S), V(M), V(L), V(XL), V(XXL), V(3XL), V(4XL), V(5XL).' - 'The available choices are: V(S), V(M), V(L), V(XL), V(XXL), V(3XL), V(4XL), V(5XL).'
type: str type: str
vcore: vcore:
description: description:
- The total number of processors. It must be provided with cores_per_processor, ram, and hdds parameters. - The total number of processors. It must be provided with O(cores_per_processor), O(ram), and O(hdds) parameters.
type: int type: int
cores_per_processor: cores_per_processor:
description: description:
- The number of cores per processor. It must be provided with vcore, ram, and hdds parameters. - The number of cores per processor. It must be provided with O(vcore), O(ram), and O(hdds) parameters.
type: int type: int
ram: ram:
description: description:
- The amount of RAM memory. It must be provided with with vcore, cores_per_processor, and hdds parameters. - The amount of RAM memory. It must be provided with with O(vcore), O(cores_per_processor), and O(hdds) parameters.
type: float type: float
hdds: hdds:
description: description:
- A list of hard disks with nested "size" and "is_main" properties. It must be provided with vcore, cores_per_processor, and ram parameters. - A list of hard disks with nested O(ignore:hdds[].size) and O(ignore:hdds[].is_main) properties. It must be provided with O(vcore),
O(cores_per_processor), and O(ram) parameters.
type: list type: list
elements: dict elements: dict
private_network: private_network:
@ -113,8 +114,8 @@ options:
choices: ["cloud", "baremetal", "k8s_node"] choices: ["cloud", "baremetal", "k8s_node"]
wait: wait:
description: description:
- Wait for the server to be in state 'running' before returning. Also used for delete operation (set to V(false) if you do not want to wait - Wait for the server to be in state 'running' before returning. Also used for delete operation (set to V(false) if
for each individual server to be deleted before moving on with other tasks). you do not want to wait for each individual server to be deleted before moving on with other tasks).
type: bool type: bool
default: true default: true
wait_timeout: wait_timeout:
@ -129,8 +130,8 @@ options:
default: 5 default: 5
auto_increment: auto_increment:
description: description:
- When creating multiple servers at once, whether to differentiate hostnames by appending a count after them or substituting the count where - When creating multiple servers at once, whether to differentiate hostnames by appending a count after them or substituting
there is a %02d or %03d in the hostname string. the count where there is a %02d or %03d in the hostname string.
type: bool type: bool
default: true default: true

20
plugins/modules/onepassword_info.py
View File

@ -46,24 +46,27 @@ options:
field: field:
type: str type: str
description: description:
- The name of the field to search for within this item (optional, defaults to V(password), or V(document) if the item has an attachment). - The name of the field to search for within this item (optional, defaults to V(password), or V(document) if the
item has an attachment).
section: section:
type: str type: str
description: description:
- The name of a section within this item containing the specified field (optional, will search all sections if not specified). - The name of a section within this item containing the specified field (optional, will search all sections if not
specified).
vault: vault:
type: str type: str
description: description:
- The name of the particular 1Password vault to search, useful if your 1Password user has access to multiple vaults (optional). - The name of the particular 1Password vault to search, useful if your 1Password user has access to multiple vaults
(optional).
required: true required: true
auto_login: auto_login:
type: dict type: dict
description: description:
- A dictionary containing authentication details. If this is set, M(community.general.onepassword_info) will attempt to sign in to 1Password - A dictionary containing authentication details. If this is set, M(community.general.onepassword_info) will attempt
automatically. to sign in to 1Password automatically.
- Without this option, you must have already logged in using the 1Password CLI before running Ansible. - Without this option, you must have already logged in using the 1Password CLI before running Ansible.
- It is B(highly) recommended to store 1Password credentials in an Ansible Vault. Ensure that the key used to encrypt the Ansible Vault - It is B(highly) recommended to store 1Password credentials in an Ansible Vault. Ensure that the key used to encrypt
is equal to or greater in strength than the 1Password master password. the Ansible Vault is equal to or greater in strength than the 1Password master password.
suboptions: suboptions:
subdomain: subdomain:
type: str type: str
@ -141,7 +144,8 @@ RETURN = r"""
# One or more dictionaries for each matching item from 1Password, along with the appropriate fields. # One or more dictionaries for each matching item from 1Password, along with the appropriate fields.
# This shows the response you would expect to receive from the third example documented above. # This shows the response you would expect to receive from the third example documented above.
onepassword: onepassword:
description: Dictionary of each 1password item matching the given search terms, shows what would be returned from the third example above. description: Dictionary of each 1password item matching the given search terms, shows what would be returned from the third
example above.
returned: success returned: success
type: dict type: dict
sample: sample:

2
plugins/modules/oneview_datacenter_info.py
View File

@ -30,7 +30,7 @@ options:
type: str type: str
options: options:
description: description:
- "Retrieve additional information. Options available: V(visualContent)." - 'Retrieve additional information. Options available: V(visualContent).'
type: list type: list
elements: str elements: str

7
plugins/modules/oneview_enclosure_info.py
View File

@ -30,8 +30,8 @@ options:
type: str type: str
options: options:
description: description:
- 'List with options to gather additional information about an Enclosure and related resources. Options allowed: V(script), V(environmentalConfiguration), - 'List with options to gather additional information about an Enclosure and related resources. Options allowed: V(script),
and V(utilization). For the option V(utilization), you can provide specific parameters.' V(environmentalConfiguration), and V(utilization). For the option V(utilization), you can provide specific parameters.'
type: list type: list
elements: raw elements: raw
@ -122,7 +122,8 @@ EXAMPLES = r"""
ansible.builtin.debug: ansible.builtin.debug:
msg: "{{ result.enclosure_utilization }}" msg: "{{ result.enclosure_utilization }}"
- name: "Gather information about an Enclosure with temperature data at a resolution of one sample per day, between two specified dates" - name: "Gather information about an Enclosure with temperature data at a resolution of one sample per day, between two
specified dates"
community.general.oneview_enclosure_info: community.general.oneview_enclosure_info:
name: Test-Enclosure name: Test-Enclosure
options: options:

4
plugins/modules/oneview_ethernet_network_info.py
View File

@ -29,8 +29,8 @@ options:
type: str type: str
options: options:
description: description:
- 'List with options to gather additional information about an Ethernet Network and related resources. Options allowed: V(associatedProfiles) - 'List with options to gather additional information about an Ethernet Network and related resources. Options allowed:
and V(associatedUplinkGroups).' V(associatedProfiles) and V(associatedUplinkGroups).'
type: list type: list
elements: str elements: str
extends_documentation_fragment: extends_documentation_fragment:

4
plugins/modules/oneview_network_set_info.py
View File

@ -30,8 +30,8 @@ options:
options: options:
description: description:
- 'List with options to gather information about Network Set. Option allowed: V(withoutEthernet). The option V(withoutEthernet) retrieves - 'List with options to gather information about Network Set. Option allowed: V(withoutEthernet). The option V(withoutEthernet)
the list of network_sets excluding Ethernet networks.' retrieves the list of network_sets excluding Ethernet networks.'
type: list type: list
elements: str elements: str

3
plugins/modules/oneview_san_manager.py
View File

@ -29,8 +29,7 @@ options:
- Indicates the desired state for the Uplink Set resource. - Indicates the desired state for the Uplink Set resource.
- V(present) ensures data properties are compliant with OneView. - V(present) ensures data properties are compliant with OneView.
- V(absent) removes the resource from OneView, if it exists. - V(absent) removes the resource from OneView, if it exists.
- V(connection_information_set) updates the connection information for the SAN Manager. - V(connection_information_set) updates the connection information for the SAN Manager. This operation is non-idempotent.
This operation is non-idempotent.
type: str type: str
default: present default: present
choices: [present, absent, connection_information_set] choices: [present, absent, connection_information_set]

7
plugins/modules/open_iscsi.py
View File

@ -14,7 +14,8 @@ author:
- Serge van Ginderachter (@srvg) - Serge van Ginderachter (@srvg)
short_description: Manage iSCSI targets with Open-iSCSI short_description: Manage iSCSI targets with Open-iSCSI
description: description:
- Discover targets on given portal, (dis)connect targets, mark targets to manually or auto start, return device nodes of connected targets. - Discover targets on given portal, (dis)connect targets, mark targets to manually or auto start, return device nodes of
connected targets.
requirements: requirements:
- open_iscsi library and tools (iscsiadm) - open_iscsi library and tools (iscsiadm)
extends_documentation_fragment: extends_documentation_fragment:
@ -82,8 +83,8 @@ options:
discover: discover:
description: description:
- Whether the list of target nodes on the portal should be (re)discovered and added to the persistent iSCSI database. - Whether the list of target nodes on the portal should be (re)discovered and added to the persistent iSCSI database.
- Keep in mind that C(iscsiadm) discovery resets configuration, like C(node.startup) to manual, hence combined with O(auto_node_startup=true) - Keep in mind that C(iscsiadm) discovery resets configuration, like C(node.startup) to manual, hence combined with
will always return a changed state. O(auto_node_startup=true) will always return a changed state.
type: bool type: bool
default: false default: false
show_nodes: show_nodes:

12
plugins/modules/openbsd_pkg.py
View File

@ -44,8 +44,8 @@ options:
type: str type: str
build: build:
description: description:
- Build the package from source instead of downloading and installing a binary. Requires that the port source tree is already installed. - Build the package from source instead of downloading and installing a binary. Requires that the port source tree is
Automatically builds and installs the C(sqlports) package, if it is not already installed. already installed. Automatically builds and installs the C(sqlports) package, if it is not already installed.
- Mutually exclusive with O(snapshot). - Mutually exclusive with O(snapshot).
type: bool type: bool
default: false default: false
@ -63,8 +63,8 @@ options:
type: path type: path
clean: clean:
description: description:
- When updating or removing packages, delete the extra configuration file(s) in the old packages which are annotated with @extra in the - When updating or removing packages, delete the extra configuration file(s) in the old packages which are annotated
packaging-list. with C(@extra) in the packaging-list.
type: bool type: bool
default: false default: false
quick: quick:
@ -73,8 +73,8 @@ options:
type: bool type: bool
default: false default: false
notes: 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) - When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly
option. to the O(name) option.
""" """
EXAMPLES = r""" EXAMPLES = r"""

4
plugins/modules/opendj_backendprop.py
View File

@ -81,8 +81,8 @@ options:
type: str type: str
""" """
EXAMPLES = """ EXAMPLES = r"""
- name: Add or update OpenDJ backend properties - name: Add or update OpenDJ backend properties
opendj_backendprop: opendj_backendprop:
hostname: localhost hostname: localhost
port: 4444 port: 4444

5
plugins/modules/openwrt_init.py
View File

@ -43,8 +43,9 @@ options:
pattern: pattern:
type: str type: str
description: description:
- If the service does not respond to the 'running' command, name a substring to look for as would be found in the output of the C(ps) command - If the service does not respond to the 'running' command, name a substring to look for as would be found in the output
as a stand-in for a 'running' result. If the string is found, the service will be assumed to be running. of the C(ps) command as a stand-in for a 'running' result. If the string is found, the service will be assumed to
be running.
notes: notes:
- One option other than O(name) is required. - One option other than O(name) is required.
requirements: requirements:

7
plugins/modules/opkg.py
View File

@ -28,8 +28,8 @@ options:
name: name:
description: description:
- Name of package(s) to install/remove. - Name of package(s) to install/remove.
- C(NAME=VERSION) syntax is also supported to install a package in a certain version. See the examples. This only works on Yocto based Linux - V(NAME=VERSION) syntax is also supported to install a package in a certain version. See the examples. This only works
distributions (opkg>=0.3.2) and not for OpenWrt. This is supported since community.general 6.2.0. on Yocto based Linux distributions (opkg>=0.3.2) and not for OpenWrt. This is supported since community.general 6.2.0.
aliases: [pkg] aliases: [pkg]
required: true required: true
type: list type: list
@ -43,7 +43,8 @@ options:
force: force:
description: description:
- The C(opkg --force) parameter used. - The C(opkg --force) parameter used.
- State V("") is deprecated and will be removed in community.general 12.0.0. Please omit the parameter O(force) to obtain the same behavior. - State V("") is deprecated and will be removed in community.general 12.0.0. Please omit the parameter O(force) to obtain
the same behavior.
choices: choices:
- "" - ""
- "depends" - "depends"

5
plugins/modules/osx_defaults.py
View File

@ -18,8 +18,9 @@ author:
short_description: Manage macOS user defaults short_description: Manage macOS user defaults
description: description:
- This module allows users to read, write, and delete macOS user defaults from Ansible scripts. - This module allows users to read, write, and delete macOS user defaults from Ansible scripts.
- MacOS applications and other programs use the defaults system to record user preferences and other information that must be maintained when - MacOS applications and other programs use the defaults system to record user preferences and other information that must
the applications are not running (such as default font for new documents, or the position of an Info panel). be maintained when the applications are not running (such as default font for new documents, or the position of an Info
panel).
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:

17
plugins/modules/ovh_ip_failover.py
View File

@ -13,12 +13,12 @@ DOCUMENTATION = r"""
module: ovh_ip_failover module: ovh_ip_failover
short_description: Manage OVH IP failover address short_description: Manage OVH IP failover address
description: description:
- Manage OVH (French European hosting provider) IP Failover Address. For now, this module can only be used to move an IP failover (or failover - Manage OVH (French European hosting provider) IP Failover Address. For now, this module can only be used to move an IP
block) between services. failover (or failover block) between services.
author: "Pascal HERAUD (@pascalheraud)" author: "Pascal HERAUD (@pascalheraud)"
notes: notes:
- Uses the python OVH API U(https://github.com/ovh/python-ovh). You have to create an application (a key and secret) with a consumer key as - Uses the Python OVH API U(https://github.com/ovh/python-ovh). You have to create an application (a key and secret) with
described into U(https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/). a consumer key as described into U(https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/).
requirements: requirements:
- ovh >= 0.4.8 - ovh >= 0.4.8
extends_documentation_fragment: extends_documentation_fragment:
@ -49,14 +49,15 @@ options:
default: true default: true
type: bool type: bool
description: description:
- If true, the module will wait for the IP address to be moved. If false, exit without waiting. The taskId will be returned in module output. - If true, the module will wait for the IP address to be moved. If false, exit without waiting. The taskId will be returned
in module output.
wait_task_completion: wait_task_completion:
required: false required: false
default: 0 default: 0
description: description:
- If not 0, the module will wait for this task id to be completed. Use O(wait_task_completion) if you want to wait for completion of a previously - If not 0, the module will wait for this task ID to be completed. Use O(wait_task_completion) if you want to wait for
executed task with O(wait_completion=false). You can execute this module repeatedly on a list of failover IPs using O(wait_completion=false) completion of a previously executed task with O(wait_completion=false). You can execute this module repeatedly on
(see examples). a list of failover IPs using O(wait_completion=false) (see examples).
type: int type: int
application_key: application_key:
required: true required: true

4
plugins/modules/ovh_ip_loadbalancing_backend.py
View File

@ -16,8 +16,8 @@ description:
- Manage OVH (French European hosting provider) LoadBalancing IP backends. - Manage OVH (French European hosting provider) LoadBalancing IP backends.
author: Pascal Heraud (@pascalheraud) author: Pascal Heraud (@pascalheraud)
notes: notes:
- Uses the Python OVH API U(https://github.com/ovh/python-ovh). You have to create an application (a key and secret) with a consumer key as - Uses the Python OVH API U(https://github.com/ovh/python-ovh). You have to create an application (a key and secret) with
described into U(https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/). a consumer key as described into U(https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/).
requirements: requirements:
- ovh > 0.3.5 - ovh > 0.3.5
extends_documentation_fragment: extends_documentation_fragment: