mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 12:21:26 -07:00
cloudstack: streamline modules doc (#52509)
* cloudstack: streamline modules doc (first 5) * Remove the "local_action" style from the examples
This commit is contained in:
parent
924f5b5467
commit
5abeb9659b
6 changed files with 173 additions and 187 deletions
|
@ -19,78 +19,85 @@ description:
|
|||
- Create and delete disk offerings for guest VMs.
|
||||
- Update display_text or display_offering of existing disk offering.
|
||||
short_description: Manages disk offerings on Apache CloudStack based clouds.
|
||||
version_added: "2.7"
|
||||
version_added: '2.7'
|
||||
author:
|
||||
- "David Passante (@dpassante)"
|
||||
- "René Moser (@resmo)"
|
||||
- David Passante (@dpassante)
|
||||
- René Moser (@resmo)
|
||||
options:
|
||||
disk_size:
|
||||
description:
|
||||
- Size of the disk offering in GB (1GB = 1,073,741,824 bytes).
|
||||
type: int
|
||||
bytes_read_rate:
|
||||
description:
|
||||
- Bytes read rate of the disk offering.
|
||||
type: int
|
||||
bytes_write_rate:
|
||||
description:
|
||||
- Bytes write rate of the disk offering.
|
||||
type: int
|
||||
display_text:
|
||||
description:
|
||||
- Display text of the disk offering.
|
||||
- If not set, C(name) will be used as C(display_text) while creating.
|
||||
type: str
|
||||
domain:
|
||||
description:
|
||||
- Domain the disk offering is related to.
|
||||
- Public for all domains and subdomains if not set.
|
||||
type: str
|
||||
hypervisor_snapshot_reserve:
|
||||
description:
|
||||
- Hypervisor snapshot reserve space as a percent of a volume.
|
||||
- Only for managed storage using Xen or VMware.
|
||||
type: int
|
||||
customized:
|
||||
description:
|
||||
- Whether disk offering iops is custom or not.
|
||||
type: bool
|
||||
default: false
|
||||
default: no
|
||||
iops_read_rate:
|
||||
description:
|
||||
- IO requests read rate of the disk offering.
|
||||
type: int
|
||||
iops_write_rate:
|
||||
description:
|
||||
- IO requests write rate of the disk offering.
|
||||
type: int
|
||||
iops_max:
|
||||
description:
|
||||
- Max. iops of the disk offering.
|
||||
type: int
|
||||
iops_min:
|
||||
description:
|
||||
- Min. iops of the disk offering.
|
||||
type: int
|
||||
name:
|
||||
description:
|
||||
- Name of the disk offering.
|
||||
type: str
|
||||
required: true
|
||||
provisioning_type:
|
||||
description:
|
||||
- Provisioning type used to create volumes.
|
||||
choices:
|
||||
- thin
|
||||
- sparse
|
||||
- fat
|
||||
type: str
|
||||
choices: [ thin, sparse, fat ]
|
||||
state:
|
||||
description:
|
||||
- State of the disk offering.
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
type: str
|
||||
choices: [ present, absent ]
|
||||
default: present
|
||||
storage_type:
|
||||
description:
|
||||
- The storage type of the disk offering.
|
||||
choices:
|
||||
- local
|
||||
- shared
|
||||
type: str
|
||||
choices: [ local, shared ]
|
||||
storage_tags:
|
||||
description:
|
||||
- The storage tags for this disk offering.
|
||||
aliases:
|
||||
- storage_tag
|
||||
type: list
|
||||
aliases: [ storage_tag ]
|
||||
display_offering:
|
||||
description:
|
||||
- An optional field, whether to display the offering to the end user or not.
|
||||
|
@ -100,27 +107,27 @@ extends_documentation_fragment: cloudstack
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Create a disk offering with local storage
|
||||
local_action:
|
||||
module: cs_disk_offering
|
||||
cs_disk_offering:
|
||||
name: small
|
||||
display_text: Small 10GB
|
||||
disk_size: 10
|
||||
storage_type: local
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Create or update a disk offering with shared storage
|
||||
local_action:
|
||||
module: cs_disk_offering
|
||||
cs_disk_offering:
|
||||
name: small
|
||||
display_text: Small 10GB
|
||||
disk_size: 10
|
||||
storage_type: shared
|
||||
storage_tags: SAN01
|
||||
delegate_to: localhost
|
||||
|
||||
- name: Remove a disk offering
|
||||
local_action:
|
||||
module: cs_disk_offering
|
||||
cs_disk_offering:
|
||||
name: small
|
||||
state: absent
|
||||
delegate_to: localhost
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue