mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-05-28 20:09:08 -07:00
multiple modules 2: fixed markups in doc (#5237)
* multiple modules 2: fixed markups in doc * Update plugins/modules/cloud/misc/proxmox_template.py 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
6e011f00f4
commit
999fc475a2
9 changed files with 86 additions and 86 deletions
|
|
@ -22,45 +22,45 @@ options:
|
|||
type: str
|
||||
src:
|
||||
description:
|
||||
- path to uploaded file
|
||||
- required only for C(state=present)
|
||||
- Path to uploaded file.
|
||||
- Required only for I(state=present).
|
||||
type: path
|
||||
template:
|
||||
description:
|
||||
- the template name
|
||||
- Required for state C(absent) to delete a template.
|
||||
- Required for state C(present) to download an appliance container template (pveam).
|
||||
- The template name.
|
||||
- Required for I(state=absent) to delete a template.
|
||||
- Required for I(state=present) to download an appliance container template (pveam).
|
||||
type: str
|
||||
content_type:
|
||||
description:
|
||||
- content type
|
||||
- required only for C(state=present)
|
||||
- Content type.
|
||||
- Required only for I(state=present).
|
||||
type: str
|
||||
default: 'vztmpl'
|
||||
choices: ['vztmpl', 'iso']
|
||||
storage:
|
||||
description:
|
||||
- target storage
|
||||
- Target storage.
|
||||
type: str
|
||||
default: 'local'
|
||||
timeout:
|
||||
description:
|
||||
- timeout for operations
|
||||
- Timeout for operations.
|
||||
type: int
|
||||
default: 30
|
||||
force:
|
||||
description:
|
||||
- can be used only with C(state=present), exists template will be overwritten
|
||||
- It can only be used with I(state=present), existing template will be overwritten.
|
||||
type: bool
|
||||
default: false
|
||||
state:
|
||||
description:
|
||||
- Indicate desired state of the template
|
||||
- Indicate desired state of the template.
|
||||
type: str
|
||||
choices: ['present', 'absent']
|
||||
default: present
|
||||
notes:
|
||||
- Requires proxmoxer and requests modules on host. This modules can be installed with pip.
|
||||
- Requires C(proxmoxer) and C(requests) modules on host. This modules can be installed with M(ansible.builtin.pip).
|
||||
author: Sergei Antipov (@UnderGreen)
|
||||
extends_documentation_fragment: community.general.proxmox.documentation
|
||||
'''
|
||||
|
|
|
|||
|
|
@ -50,30 +50,30 @@ options:
|
|||
type: str
|
||||
template_name:
|
||||
description:
|
||||
- Name of service template to use to create a new instance of a service
|
||||
- Name of service template to use to create a new instance of a service.
|
||||
type: str
|
||||
template_id:
|
||||
description:
|
||||
- ID of a service template to use to create a new instance of a service
|
||||
- ID of a service template to use to create a new instance of a service.
|
||||
type: int
|
||||
service_id:
|
||||
description:
|
||||
- ID of a service instance that you would like to manage
|
||||
- ID of a service instance that you would like to manage.
|
||||
type: int
|
||||
service_name:
|
||||
description:
|
||||
- Name of a service instance that you would like to manage
|
||||
- Name of a service instance that you would like to manage.
|
||||
type: str
|
||||
unique:
|
||||
description:
|
||||
- Setting C(unique=true) will make sure that there is only one service instance running with a name set with C(service_name) when
|
||||
- instantiating a service from a template specified with C(template_id)/C(template_name). Check examples below.
|
||||
- Setting I(unique=true) will make sure that there is only one service instance running with a name set with C(service_name) when
|
||||
instantiating a service from a template specified with I(template_id) or I(template_name). Check examples below.
|
||||
type: bool
|
||||
default: false
|
||||
state:
|
||||
description:
|
||||
- C(present) - instantiate a service from a template specified with C(template_id)/C(template_name).
|
||||
- C(absent) - terminate an instance of a service specified with C(service_id)/C(service_name).
|
||||
- C(present) - instantiate a service from a template specified with I(template_id) or I(template_name).
|
||||
- C(absent) - terminate an instance of a service specified with I(template_id) or I(template_name).
|
||||
choices: ["present", "absent"]
|
||||
default: present
|
||||
type: str
|
||||
|
|
@ -83,20 +83,20 @@ options:
|
|||
type: str
|
||||
owner_id:
|
||||
description:
|
||||
- ID of the user which will be set as the owner of the service
|
||||
- ID of the user which will be set as the owner of the service.
|
||||
type: int
|
||||
group_id:
|
||||
description:
|
||||
- ID of the group which will be set as the group of the service
|
||||
- ID of the group which will be set as the group of the service.
|
||||
type: int
|
||||
wait:
|
||||
description:
|
||||
- Wait for the instance to reach RUNNING state after DEPLOYING or COOLDOWN state after SCALING
|
||||
- Wait for the instance to reach RUNNING state after DEPLOYING or COOLDOWN state after SCALING.
|
||||
type: bool
|
||||
default: false
|
||||
wait_timeout:
|
||||
description:
|
||||
- How long before wait gives up, in seconds
|
||||
- How long before wait gives up, in seconds.
|
||||
default: 300
|
||||
type: int
|
||||
custom_attrs:
|
||||
|
|
@ -106,15 +106,15 @@ options:
|
|||
type: dict
|
||||
role:
|
||||
description:
|
||||
- Name of the role whose cardinality should be changed
|
||||
- Name of the role whose cardinality should be changed.
|
||||
type: str
|
||||
cardinality:
|
||||
description:
|
||||
- Number of VMs for the specified role
|
||||
- Number of VMs for the specified role.
|
||||
type: int
|
||||
force:
|
||||
description:
|
||||
- Force the new cardinality even if it is outside the limits
|
||||
- Force the new cardinality even if it is outside the limits.
|
||||
type: bool
|
||||
default: false
|
||||
author:
|
||||
|
|
|
|||
|
|
@ -18,34 +18,34 @@ options:
|
|||
description:
|
||||
type: str
|
||||
description:
|
||||
- Description to give the volume being created
|
||||
- Description to give the volume being created.
|
||||
image:
|
||||
type: str
|
||||
description:
|
||||
- image to use for bootable volumes. Can be an C(id), C(human_id) or
|
||||
C(name). This option requires C(pyrax>=1.9.3)
|
||||
- Image to use for bootable volumes. Can be an C(id), C(human_id) or
|
||||
C(name). This option requires C(pyrax>=1.9.3).
|
||||
meta:
|
||||
type: dict
|
||||
description:
|
||||
- A hash of metadata to associate with the volume
|
||||
- A hash of metadata to associate with the volume.
|
||||
name:
|
||||
type: str
|
||||
description:
|
||||
- Name to give the volume being created
|
||||
- Name to give the volume being created.
|
||||
required: true
|
||||
size:
|
||||
type: int
|
||||
description:
|
||||
- Size of the volume to create in Gigabytes
|
||||
- Size of the volume to create in Gigabytes.
|
||||
default: 100
|
||||
snapshot_id:
|
||||
type: str
|
||||
description:
|
||||
- The id of the snapshot to create the volume from
|
||||
- The id of the snapshot to create the volume from.
|
||||
state:
|
||||
type: str
|
||||
description:
|
||||
- Indicate desired state of the resource
|
||||
- Indicate desired state of the resource.
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
|
|
@ -53,20 +53,20 @@ options:
|
|||
volume_type:
|
||||
type: str
|
||||
description:
|
||||
- Type of the volume being created
|
||||
- Type of the volume being created.
|
||||
choices:
|
||||
- SATA
|
||||
- SSD
|
||||
default: SATA
|
||||
wait:
|
||||
description:
|
||||
- wait for the volume to be in state 'available' before returning
|
||||
- Wait for the volume to be in state C(available) before returning.
|
||||
type: bool
|
||||
default: false
|
||||
wait_timeout:
|
||||
type: int
|
||||
description:
|
||||
- how long before wait gives up, in seconds
|
||||
- how long before wait gives up, in seconds.
|
||||
default: 300
|
||||
author:
|
||||
- "Christopher H. Laco (@claco)"
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue