mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-04 07:24:00 -07:00
doc style adjustments: modules [no]* (#10443)
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.16) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py2.7) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.11) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.6) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.16) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py2.7) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.11) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.6) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run
* doc style adjustments: modules n* * doc style adjustments: modules o* * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky
GitHub
parent
f1f7d9b038
commit
6d67546902
36 changed files with 252 additions and 229 deletions
|
|
@ -39,7 +39,7 @@ options:
|
|||
api_password:
|
||||
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. 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).
|
||||
- Set environment variable E(ONE_AUTH) to override this path.
|
||||
type: str
|
||||
|
|
@ -53,7 +53,7 @@ options:
|
|||
type: int
|
||||
vm_start_on_hold:
|
||||
description:
|
||||
- Set to true to put vm on hold while creating.
|
||||
- Set to true to put VM on hold while creating.
|
||||
default: false
|
||||
type: bool
|
||||
instance_ids:
|
||||
|
|
@ -80,7 +80,7 @@ options:
|
|||
wait:
|
||||
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 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.
|
||||
default: true
|
||||
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.
|
||||
- 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.
|
||||
- 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),...'
|
||||
- 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: {}
|
||||
type: dict
|
||||
labels:
|
||||
|
|
@ -126,7 +126,7 @@ options:
|
|||
description:
|
||||
- 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.
|
||||
- B(NOTE:) Instances with the least IDs will be terminated first.
|
||||
- B(NOTE:) Instances with the least IDs are terminated first.
|
||||
type: int
|
||||
mode:
|
||||
description:
|
||||
|
|
@ -135,11 +135,11 @@ options:
|
|||
type: str
|
||||
owner_id:
|
||||
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
|
||||
group_id:
|
||||
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
|
||||
memory:
|
||||
description:
|
||||
|
|
@ -157,7 +157,7 @@ options:
|
|||
type: float
|
||||
vcpu:
|
||||
description:
|
||||
- Number of CPUs (cores) new VM will have.
|
||||
- Number of CPUs (cores) the new VM uses.
|
||||
type: int
|
||||
networks:
|
||||
description:
|
||||
|
|
@ -170,9 +170,9 @@ options:
|
|||
- Creates an image from a VM disk.
|
||||
- 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.
|
||||
- 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) state.
|
||||
- Also this operation will fail if an image with specified C(name) already exists.
|
||||
- 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
|
||||
in the C(poweredoff) state.
|
||||
- Also this operation fails if an image with specified C(name) already exists.
|
||||
type: dict
|
||||
persistent:
|
||||
description:
|
||||
|
|
@ -195,14 +195,16 @@ options:
|
|||
- 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.
|
||||
- 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(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(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(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(VIDEO:) V(ATS), V(IOMMU), V(RESOLUTION), V(TYPE), V(VRAM).
|
||||
type: dict
|
||||
|
|
@ -453,35 +455,35 @@ instances:
|
|||
returned: success
|
||||
contains:
|
||||
vm_id:
|
||||
description: Vm ID.
|
||||
description: VM ID.
|
||||
type: int
|
||||
sample: 153
|
||||
vm_name:
|
||||
description: Vm name.
|
||||
description: VM name.
|
||||
type: str
|
||||
sample: foo
|
||||
template_id:
|
||||
description: Vm's template ID.
|
||||
description: VM's template ID.
|
||||
type: int
|
||||
sample: 153
|
||||
group_id:
|
||||
description: Vm's group ID.
|
||||
description: VM's group ID.
|
||||
type: int
|
||||
sample: 1
|
||||
group_name:
|
||||
description: Vm's group name.
|
||||
description: VM's group name.
|
||||
type: str
|
||||
sample: one-users
|
||||
owner_id:
|
||||
description: Vm's owner ID.
|
||||
description: VM's owner ID.
|
||||
type: int
|
||||
sample: 143
|
||||
owner_name:
|
||||
description: Vm's owner name.
|
||||
description: VM's owner name.
|
||||
type: str
|
||||
sample: app-user
|
||||
mode:
|
||||
description: Vm's mode.
|
||||
description: VM's mode.
|
||||
type: str
|
||||
returned: success
|
||||
sample: 660
|
||||
|
|
@ -512,20 +514,21 @@ instances:
|
|||
networks:
|
||||
description: A list of dictionaries with info about IP, NAME, MAC, SECURITY_GROUPS for each NIC.
|
||||
type: list
|
||||
sample: [
|
||||
{
|
||||
"ip": "10.120.5.33",
|
||||
"mac": "02:00:0a:78:05:21",
|
||||
"name": "default-test-private",
|
||||
"security_groups": "0,10"
|
||||
},
|
||||
{
|
||||
"ip": "10.120.5.34",
|
||||
"mac": "02:00:0a:78:05:22",
|
||||
"name": "default-test-private",
|
||||
"security_groups": "0"
|
||||
}
|
||||
]
|
||||
sample:
|
||||
[
|
||||
{
|
||||
"ip": "10.120.5.33",
|
||||
"mac": "02:00:0a:78:05:21",
|
||||
"name": "default-test-private",
|
||||
"security_groups": "0,10"
|
||||
},
|
||||
{
|
||||
"ip": "10.120.5.34",
|
||||
"mac": "02:00:0a:78:05:22",
|
||||
"name": "default-test-private",
|
||||
"security_groups": "0"
|
||||
}
|
||||
]
|
||||
uptime_h:
|
||||
description: Uptime of the instance in hours.
|
||||
type: int
|
||||
|
|
@ -537,23 +540,27 @@ instances:
|
|||
attributes:
|
||||
description: A dictionary of key/values attributes that are associated with the instance.
|
||||
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:
|
||||
description: A dictionary of key/values attributes that are set with the updateconf API call.
|
||||
type: dict
|
||||
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 ..."
|
||||
}
|
||||
}
|
||||
}
|
||||
tagged_instances:
|
||||
description:
|
||||
- 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
|
||||
contains:
|
||||
vm_id:
|
||||
description: Vm ID.
|
||||
description: VM ID.
|
||||
type: int
|
||||
sample: 153
|
||||
vm_name:
|
||||
description: Vm name.
|
||||
description: VM name.
|
||||
type: str
|
||||
sample: foo
|
||||
template_id:
|
||||
description: Vm's template ID.
|
||||
description: VM's template ID.
|
||||
type: int
|
||||
sample: 153
|
||||
group_id:
|
||||
description: Vm's group ID.
|
||||
description: VM's group ID.
|
||||
type: int
|
||||
sample: 1
|
||||
group_name:
|
||||
description: Vm's group name.
|
||||
description: VM's group name.
|
||||
type: str
|
||||
sample: one-users
|
||||
owner_id:
|
||||
description: Vm's user ID.
|
||||
description: VM's user ID.
|
||||
type: int
|
||||
sample: 143
|
||||
owner_name:
|
||||
description: Vm's user name.
|
||||
description: VM's user name.
|
||||
type: str
|
||||
sample: app-user
|
||||
mode:
|
||||
description: Vm's mode.
|
||||
description: VM's mode.
|
||||
type: str
|
||||
returned: success
|
||||
sample: 660
|
||||
|
|
@ -621,20 +628,21 @@ tagged_instances:
|
|||
networks:
|
||||
description: A list of dictionaries with info about IP, NAME, MAC, SECURITY_GROUPS for each NIC.
|
||||
type: list
|
||||
sample: [
|
||||
{
|
||||
"ip": "10.120.5.33",
|
||||
"mac": "02:00:0a:78:05:21",
|
||||
"name": "default-test-private",
|
||||
"security_groups": "0,10"
|
||||
},
|
||||
{
|
||||
"ip": "10.120.5.34",
|
||||
"mac": "02:00:0a:78:05:22",
|
||||
"name": "default-test-private",
|
||||
"security_groups": "0"
|
||||
}
|
||||
]
|
||||
sample:
|
||||
[
|
||||
{
|
||||
"ip": "10.120.5.33",
|
||||
"mac": "02:00:0a:78:05:21",
|
||||
"name": "default-test-private",
|
||||
"security_groups": "0,10"
|
||||
},
|
||||
{
|
||||
"ip": "10.120.5.34",
|
||||
"mac": "02:00:0a:78:05:22",
|
||||
"name": "default-test-private",
|
||||
"security_groups": "0"
|
||||
}
|
||||
]
|
||||
uptime_h:
|
||||
description: Uptime of the instance in hours.
|
||||
type: int
|
||||
|
|
@ -646,12 +654,27 @@ tagged_instances:
|
|||
attributes:
|
||||
description: A dictionary of key/values attributes that are associated with the instance.
|
||||
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:
|
||||
description: A dictionary of key/values attributes that are set with the updateconf API call.
|
||||
type: dict
|
||||
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:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue