mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-21 09:51:27 -07:00
[PR #9351/4b23e5ec backport][stable-9] s[o-y]*: normalize docs (#9368)
s[o-y]*: normalize docs (#9351)
* s[o-y]*: normalize docs
* Apply suggestions from code review
Co-authored-by: Felix Fontein <felix@fontein.de>
* Update plugins/modules/spectrum_model_attrs.py
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 4b23e5ecff
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
e120c64a21
commit
595c105a29
20 changed files with 994 additions and 1174 deletions
|
@ -8,8 +8,7 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: solaris_zone
|
||||
short_description: Manage Solaris zones
|
||||
description:
|
||||
|
@ -31,16 +30,15 @@ options:
|
|||
description:
|
||||
- V(present), configure and install the zone.
|
||||
- V(installed), synonym for V(present).
|
||||
- V(running), if the zone already exists, boot it, otherwise, configure and install
|
||||
the zone first, then boot it.
|
||||
- V(running), if the zone already exists, boot it, otherwise, configure and install the zone first, then boot it.
|
||||
- V(started), synonym for V(running).
|
||||
- V(stopped), shutdown a zone.
|
||||
- V(absent), destroy the zone.
|
||||
- V(configured), configure the ready so that it's to be attached.
|
||||
- V(attached), attach a zone, but do not boot it.
|
||||
- V(detached), shutdown and detach a zone
|
||||
- V(detached), shutdown and detach a zone.
|
||||
type: str
|
||||
choices: [ absent, attached, configured, detached, installed, present, running, started, stopped ]
|
||||
choices: [absent, attached, configured, detached, installed, present, running, started, stopped]
|
||||
default: present
|
||||
name:
|
||||
description:
|
||||
|
@ -53,8 +51,7 @@ options:
|
|||
required: true
|
||||
path:
|
||||
description:
|
||||
- The path where the zone will be created. This is required when the zone is created, but not
|
||||
used otherwise.
|
||||
- The path where the zone will be created. This is required when the zone is created, but not used otherwise.
|
||||
type: str
|
||||
sparse:
|
||||
description:
|
||||
|
@ -63,32 +60,29 @@ options:
|
|||
default: false
|
||||
root_password:
|
||||
description:
|
||||
- The password hash for the root account. If not specified, the zone's root account
|
||||
will not have a password.
|
||||
- The password hash for the root account. If not specified, the zone's root account will not have a password.
|
||||
type: str
|
||||
config:
|
||||
description:
|
||||
- 'The zonecfg configuration commands for this zone. See zonecfg(1M) for the valid options
|
||||
and syntax. Typically this is a list of options separated by semi-colons or new lines, e.g.
|
||||
"set auto-boot=true;add net;set physical=bge0;set address=10.1.1.1;end"'
|
||||
- The C(zonecfg) configuration commands for this zone. See zonecfg(1M) for the valid options and syntax. Typically this is a list of options
|
||||
separated by semi-colons or new lines, for example V(set auto-boot=true;add net;set physical=bge0;set address=10.1.1.1;end).
|
||||
type: str
|
||||
default: ''
|
||||
create_options:
|
||||
description:
|
||||
- 'Extra options to the zonecfg(1M) create command.'
|
||||
- Extra options to the zonecfg(1M) create command.
|
||||
type: str
|
||||
default: ''
|
||||
install_options:
|
||||
description:
|
||||
- 'Extra options to the zoneadm(1M) install command. To automate Solaris 11 zone creation,
|
||||
use this to specify the profile XML file, e.g. install_options="-c sc_profile.xml"'
|
||||
- Extra options to the zoneadm(1M) install command. To automate Solaris 11 zone creation, use this to specify the profile XML file, for example
|
||||
O(install_options=-c sc_profile.xml).
|
||||
type: str
|
||||
default: ''
|
||||
attach_options:
|
||||
description:
|
||||
- 'Extra options to the zoneadm attach command. For example, this can be used to specify
|
||||
whether a minimum or full update of packages is required and if any packages need to
|
||||
be deleted. For valid values, see zoneadm(1M)'
|
||||
- Extra options to the zoneadm attach command. For example, this can be used to specify whether a minimum or full update of packages is
|
||||
required and if any packages need to be deleted. For valid values, see zoneadm(1M).
|
||||
type: str
|
||||
default: ''
|
||||
timeout:
|
||||
|
@ -96,9 +90,9 @@ options:
|
|||
- Timeout, in seconds, for zone to boot.
|
||||
type: int
|
||||
default: 600
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Create and install a zone, but don't boot it
|
||||
community.general.solaris_zone:
|
||||
name: zone1
|
||||
|
@ -149,7 +143,7 @@ EXAMPLES = '''
|
|||
name: zone1
|
||||
state: attached
|
||||
attach_options: -u
|
||||
'''
|
||||
"""
|
||||
|
||||
import os
|
||||
import platform
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue