doc style adjustments: modules o*

This commit is contained in:
Alexei Znamensky 2025-07-24 00:46:23 +12:00
commit 5f6545e717
28 changed files with 180 additions and 159 deletions

View file

@ -17,7 +17,7 @@ description:
U(https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference#connector-card-for-microsoft-365-groups). 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 you run the same task twice then you create two Connector Cards.
extends_documentation_fragment: extends_documentation_fragment:
- community.general.attributes - community.general.attributes
attributes: attributes:
@ -35,7 +35,7 @@ options:
type: str type: str
description: description:
- A string used for summarizing card content. - A string used for summarizing card content.
- This will be shown as the message subject. - This is the message subject.
- This is required if the text parameter is not populated. - This is required if the text parameter is not populated.
color: color:
type: str type: str
@ -49,13 +49,13 @@ options:
type: str type: str
description: description:
- The main text of the card. - The main text of the card.
- This will be rendered below the sender information and optional title, - This is rendered below the sender information and optional title,
- And above any sections or actions present. - And above any sections or actions present.
actions: actions:
type: list type: list
elements: dict elements: dict
description: description:
- This array of objects will power the action links found at the bottom of the card. - This array of objects is used to power the action links found at the bottom of the card.
sections: sections:
type: list type: list
elements: dict elements: dict

View file

@ -36,8 +36,8 @@ options:
state: state:
description: description:
- Takes the host to the desired lifecycle state. - Takes the host to the desired lifecycle state.
- If V(absent) the host will be deleted from the cluster. - If V(absent) the host is deleted from the cluster.
- If V(present) the host will be created in the cluster (includes V(enabled), V(disabled) and V(offline) states). - If V(present) the host is created in the cluster (includes V(enabled), V(disabled) and V(offline) states).
- If V(enabled) the host is fully operational. - If V(enabled) the host is fully operational.
- V(disabled), for example to perform maintenance operations. - V(disabled), for example to perform maintenance operations.
- V(offline), host is totally offline. - V(offline), host is totally offline.

View file

@ -48,8 +48,8 @@ options:
type: bool type: bool
new_name: new_name:
description: description:
- A name that will be assigned to the existing or new image. - A name that is assigned to the existing or new image.
- In the case of cloning, by default O(new_name) will take the name of the origin image with the prefix 'Copy of'. - In the case of cloning, by default O(new_name) is set to the name of the origin image with the prefix 'Copy of'.
type: str type: str
persistent: persistent:
description: description:
@ -325,7 +325,7 @@ datastore:
returned: when O(state=present), O(state=cloned), or O(state=renamed) returned: when O(state=present), O(state=cloned), or O(state=renamed)
version_added: 9.5.0 version_added: 9.5.0
vms: vms:
description: The image's list of vm ID's. description: The image's list of VM ID's.
type: list type: list
elements: int elements: 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)

View file

@ -29,10 +29,10 @@ options:
elements: str elements: str
name: name:
description: description:
- A O(name) of the image whose facts will be gathered. - A O(name) of the image whose facts is gathered.
- If the O(name) begins with V(~) the O(name) will be used as regex pattern, which restricts the list of images (whose - If the O(name) begins with V(~) the O(name) is used as regex pattern, which restricts the list of images (whose facts
facts will be returned) whose names match specified regex. is 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 is performed.
- See examples for more details. - See examples for more details.
type: str type: str
author: author:
@ -231,7 +231,7 @@ images:
sample: image_datastore sample: image_datastore
version_added: 9.5.0 version_added: 9.5.0
vms: vms:
description: The image's list of vm ID's. description: The image's list of VM ID's.
type: list type: list
elements: int elements: int
version_added: 9.5.0 version_added: 9.5.0

View file

@ -55,7 +55,7 @@ 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) - Setting O(unique=true) ensures that there is only one service instance running with a name set with O(service_name)
when instantiating 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
@ -73,11 +73,11 @@ options:
type: str type: str
owner_id: owner_id:
description: description:
- ID of the user which will be set as the owner of the service. - ID of the user which is set as the owner of the service.
type: int type: int
group_id: group_id:
description: description:
- ID of the group which will be set as the group of the service. - ID of the group which is set as the group of the service.
type: int type: int
wait: wait:
description: description:
@ -91,7 +91,7 @@ options:
type: int type: int
custom_attrs: custom_attrs:
description: description:
- Dictionary of key/value custom attributes which will be used when instantiating a new service. - Dictionary of key/value custom attributes which is used when instantiating a new service.
default: {} default: {}
type: dict type: dict
role: role:

View file

@ -33,12 +33,12 @@ attributes:
options: options:
id: id:
description: description:
- A O(id) of the template you would like to manage. If not set then a new template will be created with the given O(name). - A O(id) of the template you would like to manage. If not set then a new template is created with the given O(name).
type: int type: int
name: name:
description: description:
- 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, - A O(name) of the template you would like to manage. If a template with the given name does not exist it is created,
otherwise it will be managed by this module. otherwise it is managed by this module.
type: str type: str
template: template:
description: description:

View file

@ -39,7 +39,7 @@ options:
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 - 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. if both O(api_username) or O(api_password) are not set, then it will try authenticate with ONE auth variable is used. if both O(api_username) or O(api_password) are not set, then it tries to authenticate with ONE auth
file. Default path is C(~/.one/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
@ -53,7 +53,7 @@ options:
type: int type: int
vm_start_on_hold: vm_start_on_hold:
description: description:
- Set to true to put vm on hold while creating. - Set to true to put VM on hold while creating.
default: false default: false
type: bool type: bool
instance_ids: instance_ids:
@ -80,7 +80,7 @@ options:
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 - 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 it does not mean that you will be able to SSH on that machine only that boot process have started be in running state it does not mean that you are able to SSH on that machine only that boot process have started
on that instance. See the example using the M(ansible.builtin.wait_for) module 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
@ -94,9 +94,9 @@ options:
- A dictionary of key/value attributes to add to new instances, or for setting C(state) of instances with these attributes. - A dictionary of key/value attributes to add to new instances, or for setting C(state) of instances with these attributes.
- Keys are case insensitive and OpenNebula automatically converts them to upper case. - Keys are case insensitive and OpenNebula automatically converts them to upper case.
- Be aware V(NAME) is a special attribute which sets the name of the VM when it is deployed. - Be aware V(NAME) is a special attribute which sets the name of the VM when it is deployed.
- C(#) character(s) can be appended to the C(NAME) and the module will automatically add indexes to the names of VMs. - C(#) character(s) can be appended to the C(NAME) and the module automatically adds indexes to the names of VMs.
- 'For example: V(NAME: foo-###) would create VMs with names V(foo-000), V(foo-001),...' - 'For example: V(NAME: foo-###) would create VMs with names V(foo-000), V(foo-001),...'
- When used with O(count_attributes) and O(exact_count) the module will match the base name without the index part. - When used with O(count_attributes) and O(exact_count) the module matches the base name without the index part.
default: {} default: {}
type: dict type: dict
labels: labels:
@ -126,7 +126,7 @@ options:
description: description:
- Indicates how many instances that match O(count_attributes) and O(count_labels) parameters should be deployed. Instances - Indicates how many instances that match O(count_attributes) and O(count_labels) parameters should be deployed. Instances
are either created 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 are terminated first.
type: int type: int
mode: mode:
description: description:
@ -135,11 +135,11 @@ options:
type: str type: str
owner_id: owner_id:
description: description:
- ID of the user which will be set as the owner of the instance. - ID of the user which is set as the owner of the instance.
type: int type: int
group_id: group_id:
description: description:
- ID of the group which will be set as the group of the instance. - ID of the group which is set as the group of the instance.
type: int type: int
memory: memory:
description: description:
@ -157,7 +157,7 @@ options:
type: float type: float
vcpu: vcpu:
description: description:
- Number of CPUs (cores) new VM will have. - Number of CPUs (cores) new VM is set to have.
type: int type: int
networks: networks:
description: description:
@ -170,9 +170,9 @@ 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 - B(NOTE:) This operation is only performed on the first VM (if more than one VM ID is passed) and the VM has to be
be in the C(poweredoff) state. in the C(poweredoff) state.
- Also this operation will fail if an image with specified C(name) already exists. - Also this operation fails if an image with specified C(name) already exists.
type: dict type: dict
persistent: persistent:
description: description:
@ -195,14 +195,16 @@ options:
- When O(instance_ids) is provided, updates running VMs with the C(updateconf) API call. - When O(instance_ids) is provided, updates running VMs with the C(updateconf) API call.
- When new VMs are being created, emulates the C(updateconf) API call using direct template merge. - When new VMs are being created, emulates the C(updateconf) API call using direct template merge.
- Allows for complete modifications of the C(CONTEXT) attribute. - Allows for complete modifications of the C(CONTEXT) attribute.
- "Supported attributes include:" - 'Supported attributes include:'
- B(BACKUP_CONFIG:) V(BACKUP_VOLATILE), V(FS_FREEZE), V(INCREMENT_MODE), V(KEEP_LAST), V(MODE); - B(BACKUP_CONFIG:) V(BACKUP_VOLATILE), V(FS_FREEZE), V(INCREMENT_MODE), V(KEEP_LAST), V(MODE);
- B(CONTEXT:) (Any value, except V(ETH*). Variable substitution will be made); - B(CONTEXT:) (Any value, except V(ETH*). Variable substitutions are made);
- B(CPU_MODEL:) V(FEATURES), V(MODEL); - B(CPU_MODEL:) V(FEATURES), V(MODEL);
- B(FEATURES:) V(ACPI), V(APIC), V(GUEST_AGENT), V(HYPERV), V(IOTHREADS), V(LOCALTIME), V(PAE), V(VIRTIO_BLK_QUEUES), V(VIRTIO_SCSI_QUEUES); - B(FEATURES:) V(ACPI), V(APIC), V(GUEST_AGENT), V(HYPERV), V(IOTHREADS), V(LOCALTIME), V(PAE), V(VIRTIO_BLK_QUEUES),
V(VIRTIO_SCSI_QUEUES);
- B(GRAPHICS:) V(COMMAND), V(KEYMAP), V(LISTEN), V(PASSWD), V(PORT), V(TYPE); - B(GRAPHICS:) V(COMMAND), V(KEYMAP), V(LISTEN), V(PASSWD), V(PORT), V(TYPE);
- B(INPUT:) V(BUS), V(TYPE); - B(INPUT:) V(BUS), V(TYPE);
- B(OS:) V(ARCH), V(BOOT), V(BOOTLOADER), V(FIRMWARE), V(INITRD), V(KERNEL), V(KERNEL_CMD), V(MACHINE), V(ROOT), V(SD_DISK_BUS), V(UUID); - B(OS:) V(ARCH), V(BOOT), V(BOOTLOADER), V(FIRMWARE), V(INITRD), V(KERNEL), V(KERNEL_CMD), V(MACHINE), V(ROOT), V(SD_DISK_BUS),
V(UUID);
- B(RAW:) V(DATA), V(DATA_VMX), V(TYPE), V(VALIDATE); - B(RAW:) V(DATA), V(DATA_VMX), V(TYPE), V(VALIDATE);
- B(VIDEO:) V(ATS), V(IOMMU), V(RESOLUTION), V(TYPE), V(VRAM). - B(VIDEO:) V(ATS), V(IOMMU), V(RESOLUTION), V(TYPE), V(VRAM).
type: dict type: dict
@ -453,35 +455,35 @@ 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:
description: Vm name. description: VM name.
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:
description: Vm's group name. description: VM's group name.
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:
description: Vm's owner name. description: VM's owner name.
type: str type: str
sample: app-user sample: app-user
mode: mode:
description: Vm's mode. description: VM's mode.
type: str type: str
returned: success returned: success
sample: 660 sample: 660
@ -512,20 +514,21 @@ instances:
networks: networks:
description: A list of dictionaries with info about IP, NAME, MAC, SECURITY_GROUPS for each NIC. description: A list of dictionaries with info about IP, NAME, MAC, SECURITY_GROUPS for each NIC.
type: list type: list
sample: [ sample:
{ [
"ip": "10.120.5.33", {
"mac": "02:00:0a:78:05:21", "ip": "10.120.5.33",
"name": "default-test-private", "mac": "02:00:0a:78:05:21",
"security_groups": "0,10" "name": "default-test-private",
}, "security_groups": "0,10"
{ },
"ip": "10.120.5.34", {
"mac": "02:00:0a:78:05:22", "ip": "10.120.5.34",
"name": "default-test-private", "mac": "02:00:0a:78:05:22",
"security_groups": "0" "name": "default-test-private",
} "security_groups": "0"
] }
]
uptime_h: uptime_h:
description: Uptime of the instance in hours. description: Uptime of the instance in hours.
type: int type: int
@ -537,23 +540,27 @@ instances:
attributes: attributes:
description: A dictionary of key/values attributes that are associated with the instance. description: A dictionary of key/values attributes that are associated with the instance.
type: dict type: dict
sample: { sample:
"HYPERVISOR": "kvm", {
"LOGO": "images/logos/centos.png", "HYPERVISOR": "kvm",
"TE_GALAXY": "bar", "LOGO": "images/logos/centos.png",
"USER_INPUTS": null "TE_GALAXY": "bar",
} "USER_INPUTS": null
}
updateconf: updateconf:
description: A dictionary of key/values attributes that are set with the updateconf API call. description: A dictionary of key/values attributes that are set with the updateconf API call.
type: dict type: dict
version_added: 6.3.0 version_added: 6.3.0
sample: { sample:
"OS": { "ARCH": "x86_64" }, {
"CONTEXT": { "OS": {
"START_SCRIPT": "ip r r 169.254.16.86/32 dev eth0", "ARCH": "x86_64"
"SSH_PUBLIC_KEY": "ssh-rsa ...\\nssh-ed25519 ..." },
"CONTEXT": {
"START_SCRIPT": "ip r r 169.254.16.86/32 dev eth0",
"SSH_PUBLIC_KEY": "ssh-rsa ...\\nssh-ed25519 ..."
}
} }
}
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 - A list of instances info based on a specific attributes and/or labels that are specified with O(count_attributes) and
@ -562,35 +569,35 @@ tagged_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:
description: Vm name. description: VM name.
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:
description: Vm's group name. description: VM's group name.
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:
description: Vm's user name. description: VM's user name.
type: str type: str
sample: app-user sample: app-user
mode: mode:
description: Vm's mode. description: VM's mode.
type: str type: str
returned: success returned: success
sample: 660 sample: 660
@ -621,20 +628,21 @@ tagged_instances:
networks: networks:
description: A list of dictionaries with info about IP, NAME, MAC, SECURITY_GROUPS for each NIC. description: A list of dictionaries with info about IP, NAME, MAC, SECURITY_GROUPS for each NIC.
type: list type: list
sample: [ sample:
{ [
"ip": "10.120.5.33", {
"mac": "02:00:0a:78:05:21", "ip": "10.120.5.33",
"name": "default-test-private", "mac": "02:00:0a:78:05:21",
"security_groups": "0,10" "name": "default-test-private",
}, "security_groups": "0,10"
{ },
"ip": "10.120.5.34", {
"mac": "02:00:0a:78:05:22", "ip": "10.120.5.34",
"name": "default-test-private", "mac": "02:00:0a:78:05:22",
"security_groups": "0" "name": "default-test-private",
} "security_groups": "0"
] }
]
uptime_h: uptime_h:
description: Uptime of the instance in hours. description: Uptime of the instance in hours.
type: int type: int
@ -646,12 +654,27 @@ tagged_instances:
attributes: attributes:
description: A dictionary of key/values attributes that are associated with the instance. description: A dictionary of key/values attributes that are associated with the instance.
type: dict type: dict
sample: {"HYPERVISOR": "kvm", "LOGO": "images/logos/centos.png", "TE_GALAXY": "bar", "USER_INPUTS": null} sample:
{
"HYPERVISOR": "kvm",
"LOGO": "images/logos/centos.png",
"TE_GALAXY": "bar",
"USER_INPUTS": null
}
updateconf: updateconf:
description: A dictionary of key/values attributes that are set with the updateconf API call. description: A dictionary of key/values attributes that are set with the updateconf API call.
type: dict type: dict
version_added: 6.3.0 version_added: 6.3.0
sample: {"OS": {"ARCH": "x86_64"}, "CONTEXT": {"START_SCRIPT": "ip r r 169.254.16.86/32 dev eth0", "SSH_PUBLIC_KEY": "ssh-rsa ...\\nssh-ed25519 ..."}} sample:
{
"OS": {
"ARCH": "x86_64"
},
"CONTEXT": {
"START_SCRIPT": "ip r r 169.254.16.86/32 dev eth0",
"SSH_PUBLIC_KEY": "ssh-rsa ...\\nssh-ed25519 ..."
}
}
""" """
try: try:

View file

@ -30,12 +30,12 @@ options:
id: id:
description: description:
- A O(id) of the network you would like to manage. - A O(id) of the network you would like to manage.
- If not set then a new network will be created with the given O(name). - If not set then a new network is created with the given O(name).
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, - A O(name) of the network you would like to manage. If a network with the given name does not exist it, then is created,
otherwise it will be managed by this module. otherwise it is managed by this module.
type: str type: str
template: template:
description: description:

View file

@ -46,14 +46,14 @@ 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 - List of rules that are set for the firewall policy. Each rule must contain protocol parameter, in addition to three
three optional parameters (port_from, port_to, and source). optional parameters (port_from, port_to, and source).
type: list type: list
elements: dict elements: dict
default: [] default: []
add_server_ips: add_server_ips:
description: description:
- A list of server identifiers (id or name) to be assigned to a firewall policy. Used in combination with update state. - A list of server identifiers (ID or name) to be assigned to a firewall policy. Used in combination with update state.
type: list type: list
elements: str elements: str
required: false required: false
@ -67,15 +67,15 @@ options:
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 - List of rules that are added to an existing firewall policy. It is syntax is the same as the one used for rules parameter.
parameter. Used in combination with update state. 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. - List of rule IDs that are removed from an existing firewall policy. Used in combination with update state.
type: list type: list
elements: str elements: str
required: false required: false
@ -194,7 +194,7 @@ RETURN = r"""
firewall_policy: firewall_policy:
description: Information about the firewall policy that was processed. description: Information about the firewall policy that was processed.
type: dict type: dict
sample: '{"id": "92B74394A397ECC3359825C1656D67A6", "name": "Default Policy"}' sample: {"id": "92B74394A397ECC3359825C1656D67A6", "name": "Default Policy"}
returned: always returned: always
""" """

View file

@ -78,15 +78,15 @@ options:
choices: ["ROUND_ROBIN", "LEAST_CONNECTIONS"] choices: ["ROUND_ROBIN", "LEAST_CONNECTIONS"]
datacenter: datacenter:
description: description:
- ID or country code of the datacenter where the load balancer will be created. - ID or country code of the datacenter where the load balancer is created.
- If not specified, it defaults to V(US). - If not specified, it defaults to V(US).
type: str type: str
choices: ["US", "ES", "DE", "GB"] choices: ["US", "ES", "DE", "GB"]
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 - A list of rule objects that are set for the load balancer. Each rule must contain protocol, port_balancer, and port_server
port_server parameters, in addition to source parameter, which is optional. parameters, in addition to source parameter, which is optional.
type: list type: list
elements: dict elements: dict
default: [] default: []
@ -111,15 +111,15 @@ options:
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 - A list of rules that are added to an existing load balancer. It is syntax is the same as the one used for rules parameter.
parameter. Used in combination with O(state=update). 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 O(state=update). - A list of rule IDs that are 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
@ -245,7 +245,7 @@ RETURN = r"""
load_balancer: load_balancer:
description: Information about the load balancer that was processed. description: Information about the load balancer that was processed.
type: dict type: dict
sample: '{"id": "92B74394A397ECC3359825C1656D67A6", "name": "Default Balancer"}' sample: {"id": "92B74394A397ECC3359825C1656D67A6", "name": "Default Balancer"}
returned: always returned: always
""" """

View file

@ -89,7 +89,7 @@ options:
required: true required: true
ports: ports:
description: description:
- Array of ports that will be monitoring. - Array of ports that are to be monitored.
type: list type: list
elements: dict elements: dict
default: [] default: []
@ -114,7 +114,7 @@ options:
required: true required: true
processes: processes:
description: description:
- Array of processes that will be monitoring. - Array of processes that are to be monitored.
type: list type: list
elements: dict elements: dict
default: [] default: []
@ -413,7 +413,7 @@ RETURN = r"""
monitoring_policy: monitoring_policy:
description: Information about the monitoring policy that was processed. description: Information about the monitoring policy that was processed.
type: dict type: dict
sample: '{"id": "92B74394A397ECC3359825C1656D67A6", "name": "Default Policy"}' sample: {"id": "92B74394A397ECC3359825C1656D67A6", "name": "Default Policy"}
returned: always returned: always
""" """

View file

@ -50,7 +50,7 @@ options:
type: str type: str
datacenter: datacenter:
description: description:
- The identifier of the datacenter where the private network will be created. - The identifier of the datacenter where the private network is created.
type: str type: str
choices: [US, ES, DE, GB] choices: [US, ES, DE, GB]
network_address: network_address:
@ -143,7 +143,7 @@ RETURN = r"""
private_network: private_network:
description: Information about the private network. description: Information about the private network.
type: dict type: dict
sample: '{"name": "backup_network", "id": "55726DEDA20C99CF6F2AF8F18CAC9963"}' sample: {"name": "backup_network", "id": "55726DEDA20C99CF6F2AF8F18CAC9963"}
returned: always returned: always
""" """

View file

@ -43,7 +43,7 @@ options:
required: false required: false
datacenter: datacenter:
description: description:
- ID of the datacenter where the IP will be created (only for unassigned IPs). - ID of the datacenter where the IP is created (only for unassigned IPs).
type: str type: str
choices: [US, ES, DE, GB] choices: [US, ES, DE, GB]
default: US default: US
@ -110,7 +110,7 @@ RETURN = r"""
public_ip: public_ip:
description: Information about the public IP that was processed. description: Information about the public IP that was processed.
type: dict type: dict
sample: '{"id": "F77CC589EBC120905B4F4719217BFF6D", "ip": "10.5.132.106"}' sample: {"id": "F77CC589EBC120905B4F4719217BFF6D", "ip": "10.5.132.106"}
returned: always returned: always
""" """

View file

@ -73,8 +73,8 @@ options:
type: float type: float
hdds: hdds:
description: description:
- 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), - A list of hard disks with nested O(ignore:hdds[].size) and O(ignore:hdds[].is_main) properties. It must be provided
O(cores_per_processor), and O(ram) parameters. with O(vcore), O(cores_per_processor), and O(ram) parameters.
type: list type: list
elements: dict elements: dict
private_network: private_network:

View file

@ -51,7 +51,7 @@ options:
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 - The name of a section within this item containing the specified field (optional, it searches all sections if not
specified). specified).
vault: vault:
type: str type: str
@ -62,8 +62,7 @@ options:
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 - A dictionary containing authentication details. If this is set, the module attempts to sign in to 1Password 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 - It is B(highly) recommended to store 1Password credentials in an Ansible Vault. Ensure that the key used to encrypt
the Ansible Vault 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.
@ -72,7 +71,7 @@ options:
type: str type: str
description: description:
- 1Password subdomain name (V(subdomain).1password.com). - 1Password subdomain name (V(subdomain).1password.com).
- If this is not specified, the most recent subdomain will be used. - If this is not specified, the most recent subdomain is used.
username: username:
type: str type: str
description: description:

View file

@ -27,9 +27,9 @@ options:
state: state:
description: description:
- Indicates the desired state for the Ethernet Network resource. - Indicates the desired state for the Ethernet Network resource.
- V(present) will ensure data properties are compliant with OneView. - V(present) ensures data properties are compliant with OneView.
- V(absent) will remove the resource from OneView, if it exists. - V(absent) removes the resource from OneView, if it exists.
- V(default_bandwidth_reset) will reset the network connection template to the default. - V(default_bandwidth_reset) resets the network connection template to the default.
type: str type: str
default: present default: present
choices: [present, absent, default_bandwidth_reset] choices: [present, absent, default_bandwidth_reset]

View file

@ -24,8 +24,8 @@ options:
state: state:
description: description:
- Indicates the desired state for the Fibre Channel Network resource. - Indicates the desired state for the Fibre Channel Network resource.
- V(present) will ensure data properties are compliant with OneView. - V(present) ensures data properties are compliant with OneView.
- V(absent) will remove the resource from OneView, if it exists. - V(absent) removes the resource from OneView, if it exists.
type: str type: str
choices: ['present', 'absent'] choices: ['present', 'absent']
required: true required: true

View file

@ -25,8 +25,8 @@ options:
state: state:
description: description:
- Indicates the desired state for the FCoE Network resource. - Indicates the desired state for the FCoE Network resource.
- V(present) will ensure data properties are compliant with OneView. - V(present) ensures data properties are compliant with OneView.
- V(absent) will remove the resource from OneView, if it exists. - V(absent) removes the resource from OneView, if it exists.
type: str type: str
default: present default: present
choices: ['present', 'absent'] choices: ['present', 'absent']

View file

@ -28,8 +28,8 @@ options:
state: state:
description: description:
- Indicates the desired state for the Logical Interconnect Group resource. - Indicates the desired state for the Logical Interconnect Group resource.
- V(absent) will remove the resource from OneView, if it exists. - V(absent) removes the resource from OneView, if it exists.
- V(present) will ensure data properties are compliant with OneView. - V(present) ensures data properties are compliant with OneView.
type: str type: str
choices: [absent, present] choices: [absent, present]
default: present default: present
@ -63,7 +63,7 @@ EXAMPLES = r"""
- relativeValue: 1 - relativeValue: 1
type: Enclosure type: Enclosure
permittedInterconnectTypeName: HP VC Flex-10/10D Module permittedInterconnectTypeName: HP VC Flex-10/10D Module
# Alternatively you can inform permittedInterconnectTypeUri # Alternatively you can inform permittedInterconnectTypeUri
delegate_to: localhost delegate_to: localhost
- name: Ensure that the Logical Interconnect Group has the specified scopes - name: Ensure that the Logical Interconnect Group has the specified scopes

View file

@ -27,8 +27,8 @@ options:
state: state:
description: description:
- Indicates the desired state for the Network Set resource. - Indicates the desired state for the Network Set resource.
- V(present) will ensure data properties are compliant with OneView. - V(present) ensures data properties are compliant with OneView.
- V(absent) will remove the resource from OneView, if it exists. - V(absent) removes the resource from OneView, if it exists.
type: str type: str
default: present default: present
choices: ['present', 'absent'] choices: ['present', 'absent']

View file

@ -41,7 +41,7 @@ online_server_info:
type: list type: list
elements: dict elements: dict
sample: sample:
"online_server_info": [ [
{ {
"abuse": "abuse@example.com", "abuse": "abuse@example.com",
"anti_ddos": false, "anti_ddos": false,

View file

@ -37,7 +37,7 @@ online_user_info:
returned: success returned: success
type: dict type: dict
sample: sample:
"online_user_info": { {
"company": "foobar LLC", "company": "foobar LLC",
"email": "foobar@example.com", "email": "foobar@example.com",
"first_name": "foo", "first_name": "foo",

View file

@ -44,7 +44,7 @@ options:
login: login:
description: description:
- Whether the target node should be connected. - Whether the target node should be connected.
- When O(target) is omitted, will login to all available. - When O(target) is omitted, it logins to all available.
type: bool type: bool
aliases: [state] aliases: [state]
node_auth: node_auth:
@ -84,7 +84,7 @@ options:
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 - Keep in mind that C(iscsiadm) discovery resets configuration, like C(node.startup) to manual, hence combined with
O(auto_node_startup=true) will always return a changed state. O(auto_node_startup=true) always returns a changed state.
type: bool type: bool
default: false default: false
show_nodes: show_nodes:
@ -95,7 +95,7 @@ options:
rescan: rescan:
description: description:
- Rescan an established session for discovering new targets. - Rescan an established session for discovering new targets.
- When O(target) is omitted, will rescan all sessions. - When O(target) is omitted, it rescans all sessions.
type: bool type: bool
default: false default: false
version_added: 4.1.0 version_added: 4.1.0

View file

@ -36,9 +36,9 @@ options:
elements: str elements: str
state: state:
description: description:
- V(present) will make sure the package is installed. - V(present) ensures the package is installed.
- V(latest) will make sure the latest version of the package is installed. - V(latest) ensures the latest version of the package is installed.
- V(absent) will make sure the specified package is not installed. - V(absent) ensures the specified package is not installed.
choices: [absent, latest, present, installed, removed] choices: [absent, latest, present, installed, removed]
default: present default: present
type: str type: str
@ -73,7 +73,7 @@ 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 - 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. to the O(name) option.
""" """

View file

@ -10,10 +10,10 @@ __metaclass__ = type
DOCUMENTATION = r""" DOCUMENTATION = r"""
module: opendj_backendprop module: opendj_backendprop
short_description: Will update the backend configuration of OpenDJ using the dsconfig set-backend-prop command short_description: Update the backend configuration of OpenDJ using the dsconfig set-backend-prop command
description: description:
- This module will update settings for OpenDJ with the command set-backend-prop. - This module updates settings for OpenDJ with the command C(set-backend-prop).
- It will check first using de get-backend-prop if configuration needs to be applied. - It checks first using C(get-backend-prop) if configuration needs to be applied.
author: author:
- Werner Dijkerman (@dj-wasabi) - Werner Dijkerman (@dj-wasabi)
extends_documentation_fragment: extends_documentation_fragment:

View file

@ -32,20 +32,19 @@ options:
state: state:
type: str type: str
description: description:
- V(started)/V(stopped) are idempotent actions that will not run commands unless necessary. - V(started)/V(stopped) are idempotent actions that do not run commands unless necessary.
- V(restarted) will always bounce the service. - V(restarted) always bounces the service.
- V(reloaded) will always reload. - V(reloaded) always reloads.
choices: ['started', 'stopped', 'restarted', 'reloaded'] choices: ['started', 'stopped', 'restarted', 'reloaded']
enabled: enabled:
description: description:
- Whether the service should start on boot. B(At least one of state and enabled are required). - Whether the service should start on boot. B(At least one of O(state) and O(enabled) are required).
type: bool type: bool
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 - If the service does not respond to the C(running) command, name a substring to look for as would be found in the output
of the C(ps) command as a stand-in for a 'running' result. If the string is found, the service will be assumed to of the C(ps) command as a stand-in for a C(running) result. If the string is found, the service is assumed to be running.
be running.
notes: notes:
- One option other than O(name) is required. - One option other than O(name) is required.
requirements: requirements:

View file

@ -69,7 +69,7 @@ options:
state: state:
description: description:
- The state of the user defaults. - The state of the user defaults.
- If set to V(list) will query the given parameter specified by O(key). Returns V(null) is nothing found or mis-spelled. - If set to V(list) it queries the given parameter specified by O(key). Returns V(null) is nothing found or misspelled.
type: str type: str
choices: [absent, list, present] choices: [absent, list, present]
default: present default: present

View file

@ -49,13 +49,13 @@ 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 - If V(true), the module waits for the IP address to be moved. If false, exit without waiting. The C(taskId) is returned
in module output. 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 - If not V(0), the module waits for this task ID to be completed. Use O(wait_task_completion) if you want to wait for
completion of a previously executed task with O(wait_completion=false). You can execute this module repeatedly on completion of a previously executed task with O(wait_completion=false). You can execute this module repeatedly on
a list of failover IPs using O(wait_completion=false) (see examples). a list of failover IPs using O(wait_completion=false) (see examples).
type: int type: int