mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Adjust booleans in misc modules. (#5160)
This commit is contained in:
parent
7533f9ac26
commit
403c4f7477
27 changed files with 110 additions and 110 deletions
|
@ -56,8 +56,8 @@ EXAMPLES = r'''
|
||||||
username: "{{influxdb_username}}"
|
username: "{{influxdb_username}}"
|
||||||
password: "{{influxdb_password}}"
|
password: "{{influxdb_password}}"
|
||||||
database_name: "{{influxdb_database_name}}"
|
database_name: "{{influxdb_database_name}}"
|
||||||
ssl: yes
|
ssl: true
|
||||||
validate_certs: yes
|
validate_certs: true
|
||||||
'''
|
'''
|
||||||
|
|
||||||
RETURN = r'''
|
RETURN = r'''
|
||||||
|
|
|
@ -77,8 +77,8 @@ EXAMPLES = r'''
|
||||||
policy_name: test
|
policy_name: test
|
||||||
duration: 1h
|
duration: 1h
|
||||||
replication: 1
|
replication: 1
|
||||||
ssl: yes
|
ssl: true
|
||||||
validate_certs: yes
|
validate_certs: true
|
||||||
state: present
|
state: present
|
||||||
|
|
||||||
- name: Create 1 day retention policy with 1 hour shard group duration
|
- name: Create 1 day retention policy with 1 hour shard group duration
|
||||||
|
@ -108,8 +108,8 @@ EXAMPLES = r'''
|
||||||
policy_name: test
|
policy_name: test
|
||||||
duration: INF
|
duration: INF
|
||||||
replication: 1
|
replication: 1
|
||||||
ssl: no
|
ssl: false
|
||||||
validate_certs: no
|
validate_certs: false
|
||||||
shard_group_duration: 1w
|
shard_group_duration: 1w
|
||||||
state: present
|
state: present
|
||||||
|
|
||||||
|
@ -120,8 +120,8 @@ EXAMPLES = r'''
|
||||||
policy_name: test
|
policy_name: test
|
||||||
duration: 5d1h30m
|
duration: 5d1h30m
|
||||||
replication: 1
|
replication: 1
|
||||||
ssl: no
|
ssl: false
|
||||||
validate_certs: no
|
validate_certs: false
|
||||||
shard_group_duration: 1d10h30m
|
shard_group_duration: 1d10h30m
|
||||||
state: present
|
state: present
|
||||||
|
|
||||||
|
|
|
@ -35,7 +35,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Whether the user should be in the admin role or not.
|
- Whether the user should be in the admin role or not.
|
||||||
- Since version 2.8, the role will also be updated.
|
- Since version 2.8, the role will also be updated.
|
||||||
default: no
|
default: false
|
||||||
type: bool
|
type: bool
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
|
@ -73,7 +73,7 @@ EXAMPLES = r'''
|
||||||
community.general.influxdb_user:
|
community.general.influxdb_user:
|
||||||
user_name: john
|
user_name: john
|
||||||
user_password: s3cr3t
|
user_password: s3cr3t
|
||||||
admin: yes
|
admin: true
|
||||||
hostname: "{{ influxdb_hostname }}"
|
hostname: "{{ influxdb_hostname }}"
|
||||||
login_username: "{{ influxdb_username }}"
|
login_username: "{{ influxdb_username }}"
|
||||||
login_password: "{{ influxdb_password }}"
|
login_password: "{{ influxdb_password }}"
|
||||||
|
|
|
@ -109,7 +109,7 @@ EXAMPLES = '''
|
||||||
community.general.elasticsearch_plugin:
|
community.general.elasticsearch_plugin:
|
||||||
name: ingest-geoip
|
name: ingest-geoip
|
||||||
state: present
|
state: present
|
||||||
force: yes
|
force: true
|
||||||
'''
|
'''
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|
|
@ -20,12 +20,12 @@ options:
|
||||||
dsn:
|
dsn:
|
||||||
description:
|
description:
|
||||||
- The connection string passed into ODBC.
|
- The connection string passed into ODBC.
|
||||||
required: yes
|
required: true
|
||||||
type: str
|
type: str
|
||||||
query:
|
query:
|
||||||
description:
|
description:
|
||||||
- The SQL query to perform.
|
- The SQL query to perform.
|
||||||
required: yes
|
required: true
|
||||||
type: str
|
type: str
|
||||||
params:
|
params:
|
||||||
description:
|
description:
|
||||||
|
@ -38,7 +38,7 @@ options:
|
||||||
- Some databases allow a commit after a select whereas others raise an exception.
|
- Some databases allow a commit after a select whereas others raise an exception.
|
||||||
- Default is C(true) to support legacy module behavior.
|
- Default is C(true) to support legacy module behavior.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
version_added: 1.3.0
|
version_added: 1.3.0
|
||||||
requirements:
|
requirements:
|
||||||
- "python >= 2.6"
|
- "python >= 2.6"
|
||||||
|
@ -58,7 +58,7 @@ EXAMPLES = '''
|
||||||
params:
|
params:
|
||||||
- "value1"
|
- "value1"
|
||||||
commit: false
|
commit: false
|
||||||
changed_when: no
|
changed_when: false
|
||||||
'''
|
'''
|
||||||
|
|
||||||
RETURN = '''
|
RETURN = '''
|
||||||
|
|
|
@ -57,10 +57,10 @@ options:
|
||||||
type: str
|
type: str
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(no), SSL certificates will not be validated. This should only be used
|
- If C(false), SSL certificates will not be validated. This should only be used
|
||||||
on personally controlled sites using self-signed certificates.
|
on personally controlled sites using self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
default: true
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
@ -71,7 +71,7 @@ EXAMPLES = '''
|
||||||
|
|
||||||
- name: Wait for handoffs to finish. Use with async and poll.
|
- name: Wait for handoffs to finish. Use with async and poll.
|
||||||
community.general.riak:
|
community.general.riak:
|
||||||
wait_for_handoffs: yes
|
wait_for_handoffs: true
|
||||||
|
|
||||||
- name: Wait for riak_kv service to startup
|
- name: Wait for riak_kv service to startup
|
||||||
community.general.riak:
|
community.general.riak:
|
||||||
|
|
|
@ -57,7 +57,7 @@ options:
|
||||||
- Automatically commit the change only if the import succeed. Sometimes it is necessary to use autocommit=true, since some content can't be changed
|
- Automatically commit the change only if the import succeed. Sometimes it is necessary to use autocommit=true, since some content can't be changed
|
||||||
within a transaction.
|
within a transaction.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'no'
|
default: false
|
||||||
notes:
|
notes:
|
||||||
- Requires the pymssql Python package on the remote host. For Ubuntu, this
|
- Requires the pymssql Python package on the remote host. For Ubuntu, this
|
||||||
is as easy as pip install pymssql (See M(ansible.builtin.pip).)
|
is as easy as pip install pymssql (See M(ansible.builtin.pip).)
|
||||||
|
|
|
@ -64,7 +64,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Remove any added source files and trees after adding to archive.
|
- Remove any added source files and trees after adding to archive.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
notes:
|
notes:
|
||||||
- Requires tarfile, zipfile, gzip and bzip2 packages on target host.
|
- Requires tarfile, zipfile, gzip and bzip2 packages on target host.
|
||||||
- Requires lzma or backports.lzma if using xz format.
|
- Requires lzma or backports.lzma if using xz format.
|
||||||
|
@ -84,7 +84,7 @@ EXAMPLES = r'''
|
||||||
- name: Compress regular file /path/to/foo into /path/to/foo.gz and remove it
|
- name: Compress regular file /path/to/foo into /path/to/foo.gz and remove it
|
||||||
community.general.archive:
|
community.general.archive:
|
||||||
path: /path/to/foo
|
path: /path/to/foo
|
||||||
remove: yes
|
remove: true
|
||||||
|
|
||||||
- name: Create a zip archive of /path/to/foo
|
- name: Create a zip archive of /path/to/foo
|
||||||
community.general.archive:
|
community.general.archive:
|
||||||
|
|
|
@ -65,44 +65,44 @@ options:
|
||||||
- Create a backup file including the timestamp information so you can get
|
- Create a backup file including the timestamp information so you can get
|
||||||
the original file back if you somehow clobbered it incorrectly.
|
the original file back if you somehow clobbered it incorrectly.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- If set to C(absent) and I(exclusive) set to C(yes) all matching I(option) lines are removed.
|
- If set to C(absent) and I(exclusive) set to C(true) all matching I(option) lines are removed.
|
||||||
- If set to C(absent) and I(exclusive) set to C(no) the specified C(option=value) lines are removed,
|
- If set to C(absent) and I(exclusive) set to C(false) the specified C(option=value) lines are removed,
|
||||||
but the other I(option)s with the same name are not touched.
|
but the other I(option)s with the same name are not touched.
|
||||||
- If set to C(present) and I(exclusive) set to C(no) the specified C(option=values) lines are added,
|
- If set to C(present) and I(exclusive) set to C(false) the specified C(option=values) lines are added,
|
||||||
but the other I(option)s with the same name are not touched.
|
but the other I(option)s with the same name are not touched.
|
||||||
- If set to C(present) and I(exclusive) set to C(yes) all given C(option=values) lines will be
|
- If set to C(present) and I(exclusive) set to C(true) all given C(option=values) lines will be
|
||||||
added and the other I(option)s with the same name are removed.
|
added and the other I(option)s with the same name are removed.
|
||||||
type: str
|
type: str
|
||||||
choices: [ absent, present ]
|
choices: [ absent, present ]
|
||||||
default: present
|
default: present
|
||||||
exclusive:
|
exclusive:
|
||||||
description:
|
description:
|
||||||
- If set to C(yes) (default), all matching I(option) lines are removed when I(state=absent),
|
- If set to C(true) (default), all matching I(option) lines are removed when I(state=absent),
|
||||||
or replaced when I(state=present).
|
or replaced when I(state=present).
|
||||||
- If set to C(no), only the specified I(value(s)) are added when I(state=present),
|
- If set to C(false), only the specified I(value(s)) are added when I(state=present),
|
||||||
or removed when I(state=absent), and existing ones are not modified.
|
or removed when I(state=absent), and existing ones are not modified.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
version_added: 3.6.0
|
version_added: 3.6.0
|
||||||
no_extra_spaces:
|
no_extra_spaces:
|
||||||
description:
|
description:
|
||||||
- Do not insert spaces before and after '=' symbol.
|
- Do not insert spaces before and after '=' symbol.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
create:
|
create:
|
||||||
description:
|
description:
|
||||||
- If set to C(no), the module will fail if the file does not already exist.
|
- If set to C(false), the module will fail if the file does not already exist.
|
||||||
- By default it will create the file if it is missing.
|
- By default it will create the file if it is missing.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
allow_no_value:
|
allow_no_value:
|
||||||
description:
|
description:
|
||||||
- Allow option without value and without '=' symbol.
|
- Allow option without value and without '=' symbol.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
notes:
|
notes:
|
||||||
- While it is possible to add an I(option) without specifying a I(value), this makes no sense.
|
- While it is possible to add an I(option) without specifying a I(value), this makes no sense.
|
||||||
- As of Ansible 2.3, the I(dest) option has been changed to I(path) as default, but I(dest) still works as well.
|
- As of Ansible 2.3, the I(dest) option has been changed to I(path) as default, but I(dest) still works as well.
|
||||||
|
@ -121,7 +121,7 @@ EXAMPLES = r'''
|
||||||
option: fav
|
option: fav
|
||||||
value: lemonade
|
value: lemonade
|
||||||
mode: '0600'
|
mode: '0600'
|
||||||
backup: yes
|
backup: true
|
||||||
|
|
||||||
- name: Ensure "temperature=cold is in section "[drinks]" in specified file
|
- name: Ensure "temperature=cold is in section "[drinks]" in specified file
|
||||||
community.general.ini_file:
|
community.general.ini_file:
|
||||||
|
@ -129,7 +129,7 @@ EXAMPLES = r'''
|
||||||
section: drinks
|
section: drinks
|
||||||
option: temperature
|
option: temperature
|
||||||
value: cold
|
value: cold
|
||||||
backup: yes
|
backup: true
|
||||||
|
|
||||||
- name: Add "beverage=lemon juice" is in section "[drinks]" in specified file
|
- name: Add "beverage=lemon juice" is in section "[drinks]" in specified file
|
||||||
community.general.ini_file:
|
community.general.ini_file:
|
||||||
|
@ -139,7 +139,7 @@ EXAMPLES = r'''
|
||||||
value: lemon juice
|
value: lemon juice
|
||||||
mode: '0600'
|
mode: '0600'
|
||||||
state: present
|
state: present
|
||||||
exclusive: no
|
exclusive: false
|
||||||
|
|
||||||
- name: Ensure multiple values "beverage=coke" and "beverage=pepsi" are in section "[drinks]" in specified file
|
- name: Ensure multiple values "beverage=coke" and "beverage=pepsi" are in section "[drinks]" in specified file
|
||||||
community.general.ini_file:
|
community.general.ini_file:
|
||||||
|
|
|
@ -31,14 +31,14 @@ options:
|
||||||
underscores (_). File names are limited to 31 characters, directory nesting is limited to 8 levels, and path
|
underscores (_). File names are limited to 31 characters, directory nesting is limited to 8 levels, and path
|
||||||
names are limited to 255 characters.'
|
names are limited to 255 characters.'
|
||||||
type: list
|
type: list
|
||||||
required: yes
|
required: true
|
||||||
elements: path
|
elements: path
|
||||||
dest_iso:
|
dest_iso:
|
||||||
description:
|
description:
|
||||||
- The absolute path with file name of the new generated ISO file on local machine.
|
- The absolute path with file name of the new generated ISO file on local machine.
|
||||||
- Will create intermediate folders when they does not exist.
|
- Will create intermediate folders when they does not exist.
|
||||||
type: path
|
type: path
|
||||||
required: yes
|
required: true
|
||||||
interchange_level:
|
interchange_level:
|
||||||
description:
|
description:
|
||||||
- The ISO9660 interchange level to use, it dictates the rules on the names of files.
|
- The ISO9660 interchange level to use, it dictates the rules on the names of files.
|
||||||
|
|
|
@ -35,26 +35,26 @@ options:
|
||||||
description:
|
description:
|
||||||
- The ISO image to extract files from.
|
- The ISO image to extract files from.
|
||||||
type: path
|
type: path
|
||||||
required: yes
|
required: true
|
||||||
aliases: [ path, src ]
|
aliases: [ path, src ]
|
||||||
dest:
|
dest:
|
||||||
description:
|
description:
|
||||||
- The destination directory to extract files to.
|
- The destination directory to extract files to.
|
||||||
type: path
|
type: path
|
||||||
required: yes
|
required: true
|
||||||
files:
|
files:
|
||||||
description:
|
description:
|
||||||
- A list of files to extract from the image.
|
- A list of files to extract from the image.
|
||||||
- Extracting directories does not work.
|
- Extracting directories does not work.
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
required: yes
|
required: true
|
||||||
force:
|
force:
|
||||||
description:
|
description:
|
||||||
- If C(yes), which will replace the remote file when contents are different than the source.
|
- If C(true), which will replace the remote file when contents are different than the source.
|
||||||
- If C(no), the file will only be extracted and copied if the destination does not already exist.
|
- If C(false), the file will only be extracted and copied if the destination does not already exist.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
executable:
|
executable:
|
||||||
description:
|
description:
|
||||||
- The path to the C(7z) executable to use for extracting files from the ISO.
|
- The path to the C(7z) executable to use for extracting files from the ISO.
|
||||||
|
@ -62,7 +62,7 @@ options:
|
||||||
type: path
|
type: path
|
||||||
notes:
|
notes:
|
||||||
- Only the file checksum (content) is taken into account when extracting files
|
- Only the file checksum (content) is taken into account when extracting files
|
||||||
from the ISO image. If C(force=no), only checks the presence of the file.
|
from the ISO image. If C(force=false), only checks the presence of the file.
|
||||||
- In Ansible 2.3 this module was using C(mount) and C(umount) commands only,
|
- In Ansible 2.3 this module was using C(mount) and C(umount) commands only,
|
||||||
requiring root access. This is no longer needed with the introduction of 7zip
|
requiring root access. This is no longer needed with the introduction of 7zip
|
||||||
for extraction.
|
for extraction.
|
||||||
|
|
|
@ -21,7 +21,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- The CSV filename to read data from.
|
- The CSV filename to read data from.
|
||||||
type: path
|
type: path
|
||||||
required: yes
|
required: true
|
||||||
aliases: [ filename ]
|
aliases: [ filename ]
|
||||||
key:
|
key:
|
||||||
description:
|
description:
|
||||||
|
@ -45,7 +45,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Whether the C(key) used is expected to be unique.
|
- Whether the C(key) used is expected to be unique.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
delimiter:
|
delimiter:
|
||||||
description:
|
description:
|
||||||
- A one-character string used to separate fields.
|
- A one-character string used to separate fields.
|
||||||
|
|
|
@ -81,18 +81,18 @@ options:
|
||||||
- Search for a given C(xpath) and provide the count of any matches.
|
- Search for a given C(xpath) and provide the count of any matches.
|
||||||
- This parameter requires C(xpath) to be set.
|
- This parameter requires C(xpath) to be set.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
print_match:
|
print_match:
|
||||||
description:
|
description:
|
||||||
- Search for a given C(xpath) and print out any matches.
|
- Search for a given C(xpath) and print out any matches.
|
||||||
- This parameter requires C(xpath) to be set.
|
- This parameter requires C(xpath) to be set.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
pretty_print:
|
pretty_print:
|
||||||
description:
|
description:
|
||||||
- Pretty print XML output.
|
- Pretty print XML output.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
content:
|
content:
|
||||||
description:
|
description:
|
||||||
- Search for a given C(xpath) and get content.
|
- Search for a given C(xpath) and get content.
|
||||||
|
@ -110,13 +110,13 @@ options:
|
||||||
- Create a backup file including the timestamp information so you can get
|
- Create a backup file including the timestamp information so you can get
|
||||||
the original file back if you somehow clobbered it incorrectly.
|
the original file back if you somehow clobbered it incorrectly.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
strip_cdata_tags:
|
strip_cdata_tags:
|
||||||
description:
|
description:
|
||||||
- Remove CDATA tags surrounding text values.
|
- Remove CDATA tags surrounding text values.
|
||||||
- Note that this might break your XML file if text values contain characters that could be interpreted as XML.
|
- Note that this might break your XML file if text values contain characters that could be interpreted as XML.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
insertbefore:
|
insertbefore:
|
||||||
description:
|
description:
|
||||||
- Add additional child-element(s) before the first selected element for a given C(xpath).
|
- Add additional child-element(s) before the first selected element for a given C(xpath).
|
||||||
|
@ -125,7 +125,7 @@ options:
|
||||||
or a hash where the key is an element name and the value is the element value.
|
or a hash where the key is an element name and the value is the element value.
|
||||||
- This parameter requires C(xpath) to be set.
|
- This parameter requires C(xpath) to be set.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
insertafter:
|
insertafter:
|
||||||
description:
|
description:
|
||||||
- Add additional child-element(s) after the last selected element for a given C(xpath).
|
- Add additional child-element(s) after the last selected element for a given C(xpath).
|
||||||
|
@ -134,7 +134,7 @@ options:
|
||||||
or a hash where the key is an element name and the value is the element value.
|
or a hash where the key is an element name and the value is the element value.
|
||||||
- This parameter requires C(xpath) to be set.
|
- This parameter requires C(xpath) to be set.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
requirements:
|
requirements:
|
||||||
- lxml >= 2.3.0
|
- lxml >= 2.3.0
|
||||||
notes:
|
notes:
|
||||||
|
@ -193,7 +193,7 @@ EXAMPLES = r'''
|
||||||
community.general.xml:
|
community.general.xml:
|
||||||
path: /foo/bar.xml
|
path: /foo/bar.xml
|
||||||
xpath: /business/beers/beer
|
xpath: /business/beers/beer
|
||||||
count: yes
|
count: true
|
||||||
register: hits
|
register: hits
|
||||||
|
|
||||||
- ansible.builtin.debug:
|
- ansible.builtin.debug:
|
||||||
|
@ -219,7 +219,7 @@ EXAMPLES = r'''
|
||||||
community.general.xml:
|
community.general.xml:
|
||||||
path: /foo/bar.xml
|
path: /foo/bar.xml
|
||||||
xpath: '/business/beers/beer[text()="Rochefort 10"]'
|
xpath: '/business/beers/beer[text()="Rochefort 10"]'
|
||||||
insertbefore: yes
|
insertbefore: true
|
||||||
add_children:
|
add_children:
|
||||||
- beer: Old Rasputin
|
- beer: Old Rasputin
|
||||||
- beer: Old Motor Oil
|
- beer: Old Motor Oil
|
||||||
|
@ -330,7 +330,7 @@ actions:
|
||||||
backup_file:
|
backup_file:
|
||||||
description: The name of the backup file that was created
|
description: The name of the backup file that was created
|
||||||
type: str
|
type: str
|
||||||
returned: when backup=yes
|
returned: when I(backup=true)
|
||||||
sample: /path/to/file.xml.1942.2017-08-24@14:16:01~
|
sample: /path/to/file.xml.1942.2017-08-24@14:16:01~
|
||||||
count:
|
count:
|
||||||
description: The count of xpath matches.
|
description: The count of xpath matches.
|
||||||
|
|
|
@ -17,9 +17,9 @@ description:
|
||||||
options:
|
options:
|
||||||
append:
|
append:
|
||||||
description:
|
description:
|
||||||
- If C(yes), add the listed I(user) and I(group) to the group members.
|
- If C(true), add the listed I(user) and I(group) to the group members.
|
||||||
- If C(no), only the listed I(user) and I(group) will be group members, removing any other members.
|
- If C(false), only the listed I(user) and I(group) will be group members, removing any other members.
|
||||||
default: no
|
default: false
|
||||||
type: bool
|
type: bool
|
||||||
version_added: 4.0.0
|
version_added: 4.0.0
|
||||||
cn:
|
cn:
|
||||||
|
@ -45,9 +45,9 @@ options:
|
||||||
group:
|
group:
|
||||||
description:
|
description:
|
||||||
- List of group names assigned to this group.
|
- List of group names assigned to this group.
|
||||||
- If I(append=no) and an empty list is passed all groups will be removed from this group.
|
- If I(append=false) and an empty list is passed all groups will be removed from this group.
|
||||||
- Groups that are already assigned but not passed will be removed.
|
- Groups that are already assigned but not passed will be removed.
|
||||||
- If I(append=yes) the listed groups will be assigned without removing other groups.
|
- If I(append=true) the listed groups will be assigned without removing other groups.
|
||||||
- If option is omitted assigned groups will not be checked or changed.
|
- If option is omitted assigned groups will not be checked or changed.
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
|
@ -58,9 +58,9 @@ options:
|
||||||
user:
|
user:
|
||||||
description:
|
description:
|
||||||
- List of user names assigned to this group.
|
- List of user names assigned to this group.
|
||||||
- If I(append=no) and an empty list is passed all users will be removed from this group.
|
- If I(append=false) and an empty list is passed all users will be removed from this group.
|
||||||
- Users that are already assigned but not passed will be removed.
|
- Users that are already assigned but not passed will be removed.
|
||||||
- If I(append=yes) the listed users will be assigned without removing other users.
|
- If I(append=true) the listed users will be assigned without removing other users.
|
||||||
- If option is omitted assigned users will not be checked or changed.
|
- If option is omitted assigned users will not be checked or changed.
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
|
@ -110,7 +110,7 @@ EXAMPLES = r'''
|
||||||
name: developers
|
name: developers
|
||||||
user:
|
user:
|
||||||
- john
|
- john
|
||||||
append: yes
|
append: true
|
||||||
state: present
|
state: present
|
||||||
ipa_host: ipa.example.com
|
ipa_host: ipa.example.com
|
||||||
ipa_user: admin
|
ipa_user: admin
|
||||||
|
|
|
@ -620,7 +620,7 @@ EXAMPLES = '''
|
||||||
client_template: test
|
client_template: test
|
||||||
use_template_config: False
|
use_template_config: False
|
||||||
use_template_scope: false
|
use_template_scope: false
|
||||||
use_template_mappers: no
|
use_template_mappers: false
|
||||||
always_display_in_console: true
|
always_display_in_console: true
|
||||||
registered_nodes:
|
registered_nodes:
|
||||||
node01.example.com: 1507828202
|
node01.example.com: 1507828202
|
||||||
|
|
|
@ -38,7 +38,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Verify TLS certificates (do not disable this in production).
|
- Verify TLS certificates (do not disable this in production).
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
|
|
||||||
realm:
|
realm:
|
||||||
type: str
|
type: str
|
||||||
|
|
|
@ -36,15 +36,15 @@ options:
|
||||||
type: str
|
type: str
|
||||||
use_ssl:
|
use_ssl:
|
||||||
description:
|
description:
|
||||||
- If C(no), an HTTP connection will be used instead of the default HTTPS connection.
|
- If C(false), an HTTP connection will be used instead of the default HTTPS connection.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
default: true
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(no), SSL certificates will not be validated.
|
- If C(false), SSL certificates will not be validated.
|
||||||
- This should only set to C(no) when used on personally controlled sites using self-signed certificates.
|
- This should only set to C(false) when used on personally controlled sites using self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
default: true
|
||||||
author:
|
author:
|
||||||
- Dag Wieers (@dagwieers)
|
- Dag Wieers (@dagwieers)
|
||||||
todo:
|
todo:
|
||||||
|
@ -60,7 +60,7 @@ EXAMPLES = r'''
|
||||||
host: cobbler01
|
host: cobbler01
|
||||||
username: cobbler
|
username: cobbler
|
||||||
password: MySuperSecureP4sswOrd
|
password: MySuperSecureP4sswOrd
|
||||||
run_once: yes
|
run_once: true
|
||||||
delegate_to: localhost
|
delegate_to: localhost
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -36,15 +36,15 @@ options:
|
||||||
type: str
|
type: str
|
||||||
use_ssl:
|
use_ssl:
|
||||||
description:
|
description:
|
||||||
- If C(no), an HTTP connection will be used instead of the default HTTPS connection.
|
- If C(false), an HTTP connection will be used instead of the default HTTPS connection.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
default: true
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(no), SSL certificates will not be validated.
|
- If C(false), SSL certificates will not be validated.
|
||||||
- This should only set to C(no) when used on personally controlled sites using self-signed certificates.
|
- This should only set to C(false) when used on personally controlled sites using self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
default: true
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- The system name to manage.
|
- The system name to manage.
|
||||||
|
@ -62,7 +62,7 @@ options:
|
||||||
- Sync on changes.
|
- Sync on changes.
|
||||||
- Concurrently syncing Cobbler is bound to fail.
|
- Concurrently syncing Cobbler is bound to fail.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Whether the system should be present, absent or a query is made.
|
- Whether the system should be present, absent or a query is made.
|
||||||
|
@ -101,7 +101,7 @@ EXAMPLES = r'''
|
||||||
password: ins3965!
|
password: ins3965!
|
||||||
name: bdsol-aci51-apic1.cisco.com
|
name: bdsol-aci51-apic1.cisco.com
|
||||||
properties:
|
properties:
|
||||||
netboot_enabled: yes
|
netboot_enabled: true
|
||||||
state: present
|
state: present
|
||||||
delegate_to: localhost
|
delegate_to: localhost
|
||||||
|
|
||||||
|
|
|
@ -63,7 +63,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Whether to force a reboot (even when the system is already booted).
|
- Whether to force a reboot (even when the system is already booted).
|
||||||
- As a safeguard, without force, hpilo_boot will refuse to reboot a server that is already running.
|
- As a safeguard, without force, hpilo_boot will refuse to reboot a server that is already running.
|
||||||
default: no
|
default: false
|
||||||
type: bool
|
type: bool
|
||||||
ssl_version:
|
ssl_version:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -36,7 +36,7 @@ options:
|
||||||
verbose:
|
verbose:
|
||||||
description:
|
description:
|
||||||
- Run hponcfg in verbose mode (-v).
|
- Run hponcfg in verbose mode (-v).
|
||||||
default: no
|
default: false
|
||||||
type: bool
|
type: bool
|
||||||
requirements:
|
requirements:
|
||||||
- hponcfg tool
|
- hponcfg tool
|
||||||
|
|
|
@ -71,10 +71,10 @@ options:
|
||||||
type: int
|
type: int
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(no), SSL certificates will not be validated.
|
- If C(false), SSL certificates will not be validated.
|
||||||
- This should only set to C(no) used on personally controlled sites using self-signed certificates.
|
- This should only set to C(false) used on personally controlled sites using self-signed certificates.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
default: true
|
||||||
notes:
|
notes:
|
||||||
- The XML fragments don't need an authentication cookie, this is injected by the module automatically.
|
- The XML fragments don't need an authentication cookie, this is injected by the module automatically.
|
||||||
- The Cisco IMC XML output is being translated to JSON using the Cobra convention.
|
- The Cisco IMC XML output is being translated to JSON using the Cobra convention.
|
||||||
|
@ -93,7 +93,7 @@ EXAMPLES = r'''
|
||||||
hostname: '{{ imc_hostname }}'
|
hostname: '{{ imc_hostname }}'
|
||||||
username: '{{ imc_username }}'
|
username: '{{ imc_username }}'
|
||||||
password: '{{ imc_password }}'
|
password: '{{ imc_password }}'
|
||||||
validate_certs: no
|
validate_certs: false
|
||||||
content: |
|
content: |
|
||||||
<configConfMo><inConfig>
|
<configConfMo><inConfig>
|
||||||
<computeRackUnit dn="sys/rack-unit-1" adminPower="down"/>
|
<computeRackUnit dn="sys/rack-unit-1" adminPower="down"/>
|
||||||
|
@ -105,7 +105,7 @@ EXAMPLES = r'''
|
||||||
hostname: '{{ imc_hostname }}'
|
hostname: '{{ imc_hostname }}'
|
||||||
username: '{{ imc_username }}'
|
username: '{{ imc_username }}'
|
||||||
password: '{{ imc_password }}'
|
password: '{{ imc_password }}'
|
||||||
validate_certs: no
|
validate_certs: false
|
||||||
timeout: 120
|
timeout: 120
|
||||||
content: |
|
content: |
|
||||||
<!-- Configure Serial-on-LAN -->
|
<!-- Configure Serial-on-LAN -->
|
||||||
|
@ -130,7 +130,7 @@ EXAMPLES = r'''
|
||||||
hostname: '{{ imc_hostname }}'
|
hostname: '{{ imc_hostname }}'
|
||||||
username: '{{ imc_username }}'
|
username: '{{ imc_username }}'
|
||||||
password: '{{ imc_password }}'
|
password: '{{ imc_password }}'
|
||||||
validate_certs: no
|
validate_certs: false
|
||||||
content: |
|
content: |
|
||||||
<!-- Configure PXE boot -->
|
<!-- Configure PXE boot -->
|
||||||
<configConfMo><inConfig>
|
<configConfMo><inConfig>
|
||||||
|
@ -148,7 +148,7 @@ EXAMPLES = r'''
|
||||||
hostname: '{{ imc_host }}'
|
hostname: '{{ imc_host }}'
|
||||||
username: '{{ imc_username }}'
|
username: '{{ imc_username }}'
|
||||||
password: '{{ imc_password }}'
|
password: '{{ imc_password }}'
|
||||||
validate_certs: no
|
validate_certs: false
|
||||||
content: |
|
content: |
|
||||||
<configConfMo><inConfig>
|
<configConfMo><inConfig>
|
||||||
<lsbootStorage dn="sys/rack-unit-1/boot-policy/storage-read-write" access="read-write" order="1" type="storage"/>
|
<lsbootStorage dn="sys/rack-unit-1/boot-policy/storage-read-write" access="read-write" order="1" type="storage"/>
|
||||||
|
@ -160,7 +160,7 @@ EXAMPLES = r'''
|
||||||
hostname: '{{ imc_host }}'
|
hostname: '{{ imc_host }}'
|
||||||
username: '{{ imc_username }}'
|
username: '{{ imc_username }}'
|
||||||
password: '{{ imc_password }}'
|
password: '{{ imc_password }}'
|
||||||
validate_certs: no
|
validate_certs: false
|
||||||
content: |
|
content: |
|
||||||
<configConfMo><inConfig>
|
<configConfMo><inConfig>
|
||||||
<computeRackUnit dn="sys/rack-unit-1" usrLbl="Customer Lab - POD{{ pod_id }} - {{ inventory_hostname_short }}"/>
|
<computeRackUnit dn="sys/rack-unit-1" usrLbl="Customer Lab - POD{{ pod_id }} - {{ inventory_hostname_short }}"/>
|
||||||
|
@ -172,7 +172,7 @@ EXAMPLES = r'''
|
||||||
hostname: '{{ imc_host }}'
|
hostname: '{{ imc_host }}'
|
||||||
username: '{{ imc_username }}'
|
username: '{{ imc_username }}'
|
||||||
password: '{{ imc_password }}'
|
password: '{{ imc_password }}'
|
||||||
validate_certs: no
|
validate_certs: false
|
||||||
timeout: 120
|
timeout: 120
|
||||||
content: |
|
content: |
|
||||||
<configConfMo><inConfig>
|
<configConfMo><inConfig>
|
||||||
|
|
|
@ -77,14 +77,14 @@ options:
|
||||||
- If set, ask that system firmware uses this device beyond next boot.
|
- If set, ask that system firmware uses this device beyond next boot.
|
||||||
Be aware many systems do not honor this.
|
Be aware many systems do not honor this.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'no'
|
default: false
|
||||||
uefiboot:
|
uefiboot:
|
||||||
description:
|
description:
|
||||||
- If set, request UEFI boot explicitly.
|
- If set, request UEFI boot explicitly.
|
||||||
Strictly speaking, the spec suggests that if not set, the system should BIOS boot and offers no "don't care" option.
|
Strictly speaking, the spec suggests that if not set, the system should BIOS boot and offers no "don't care" option.
|
||||||
In practice, this flag not being set does not preclude UEFI boot on any system I've encountered.
|
In practice, this flag not being set does not preclude UEFI boot on any system I've encountered.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'no'
|
default: false
|
||||||
requirements:
|
requirements:
|
||||||
- "python >= 2.6"
|
- "python >= 2.6"
|
||||||
- pyghmi
|
- pyghmi
|
||||||
|
|
|
@ -59,7 +59,7 @@ options:
|
||||||
aliases: [ keystone_v3_domain_id ]
|
aliases: [ keystone_v3_domain_id ]
|
||||||
tenant_mapping_enabled:
|
tenant_mapping_enabled:
|
||||||
type: bool
|
type: bool
|
||||||
default: 'no'
|
default: false
|
||||||
description: Whether to enable mapping of existing tenants. defaults to False.
|
description: Whether to enable mapping of existing tenants. defaults to False.
|
||||||
api_version:
|
api_version:
|
||||||
type: str
|
type: str
|
||||||
|
@ -88,7 +88,7 @@ options:
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description: Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True.
|
description: Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
default: true
|
||||||
security_protocol:
|
security_protocol:
|
||||||
type: str
|
type: str
|
||||||
description: How SSL certificates should be used for HTTPS requests. defaults to None.
|
description: How SSL certificates should be used for HTTPS requests. defaults to None.
|
||||||
|
@ -119,7 +119,7 @@ options:
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description: Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True.
|
description: Whether SSL certificates should be verified for HTTPS requests (deprecated). defaults to True.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'yes'
|
default: true
|
||||||
security_protocol:
|
security_protocol:
|
||||||
type: str
|
type: str
|
||||||
choices: ['ssl-with-validation','ssl-with-validation-custom-ca','ssl-without-validation','non-ssl']
|
choices: ['ssl-with-validation','ssl-with-validation-custom-ca','ssl-without-validation','non-ssl']
|
||||||
|
@ -179,7 +179,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Whether certificates should be verified for connections.
|
- Whether certificates should be verified for connections.
|
||||||
type: bool
|
type: bool
|
||||||
default: yes
|
default: true
|
||||||
aliases: [ verify_ssl ]
|
aliases: [ verify_ssl ]
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -56,7 +56,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Set value to C(true) to force node into install state if it already exists in stacki.
|
- Set value to C(true) to force node into install state if it already exists in stacki.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Set value to the desired state for the specified host.
|
- Set value to the desired state for the specified host.
|
||||||
|
|
|
@ -85,7 +85,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Specifies whether the certificate needs to be validated while communicating.
|
- Specifies whether the certificate needs to be validated while communicating.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- community.general.hpe3par
|
- community.general.hpe3par
|
||||||
|
|
||||||
|
@ -108,7 +108,7 @@ EXAMPLES = r'''
|
||||||
set_size: 8
|
set_size: 8
|
||||||
high_availability: MAG
|
high_availability: MAG
|
||||||
disk_type: FC
|
disk_type: FC
|
||||||
secure: no
|
secure: false
|
||||||
|
|
||||||
- name: Delete CPG sample_cpg
|
- name: Delete CPG sample_cpg
|
||||||
community.general.ss_3par_cpg:
|
community.general.ss_3par_cpg:
|
||||||
|
@ -117,7 +117,7 @@ EXAMPLES = r'''
|
||||||
storage_system_password: password
|
storage_system_password: password
|
||||||
state: absent
|
state: absent
|
||||||
cpg_name: sample_cpg
|
cpg_name: sample_cpg
|
||||||
secure: no
|
secure: false
|
||||||
'''
|
'''
|
||||||
|
|
||||||
RETURN = r'''
|
RETURN = r'''
|
||||||
|
|
|
@ -48,7 +48,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Apply permissions to everyone.
|
- Apply permissions to everyone.
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
permissions:
|
permissions:
|
||||||
description:
|
description:
|
||||||
- The list of permission(s) to delegate (required if C(state) is C(present)).
|
- The list of permission(s) to delegate (required if C(state) is C(present)).
|
||||||
|
@ -68,7 +68,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Unallow permissions recursively (ignored when C(state) is C(present)).
|
- Unallow permissions recursively (ignored when C(state) is C(present)).
|
||||||
type: bool
|
type: bool
|
||||||
default: no
|
default: false
|
||||||
author:
|
author:
|
||||||
- Nate Coraor (@natefoo)
|
- Nate Coraor (@natefoo)
|
||||||
'''
|
'''
|
||||||
|
@ -84,7 +84,7 @@ EXAMPLES = r'''
|
||||||
community.general.zfs_delegate_admin:
|
community.general.zfs_delegate_admin:
|
||||||
name: rpool/myvol
|
name: rpool/myvol
|
||||||
groups: backup
|
groups: backup
|
||||||
everyone: yes
|
everyone: true
|
||||||
permissions: send
|
permissions: send
|
||||||
|
|
||||||
- name: Grant `zfs send,receive` to users `foo` and `bar` with local scope only
|
- name: Grant `zfs send,receive` to users `foo` and `bar` with local scope only
|
||||||
|
@ -92,12 +92,12 @@ EXAMPLES = r'''
|
||||||
name: rpool/myfs
|
name: rpool/myfs
|
||||||
users: foo,bar
|
users: foo,bar
|
||||||
permissions: send,receive
|
permissions: send,receive
|
||||||
local: yes
|
local: true
|
||||||
|
|
||||||
- name: Revoke all permissions from everyone (permissions specifically assigned to users and groups remain)
|
- name: Revoke all permissions from everyone (permissions specifically assigned to users and groups remain)
|
||||||
community.general.zfs_delegate_admin:
|
community.general.zfs_delegate_admin:
|
||||||
name: rpool/myfs
|
name: rpool/myfs
|
||||||
everyone: yes
|
everyone: true
|
||||||
state: absent
|
state: absent
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -20,7 +20,7 @@ options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- ZFS dataset name.
|
- ZFS dataset name.
|
||||||
required: yes
|
required: true
|
||||||
aliases: [ "ds", "dataset" ]
|
aliases: [ "ds", "dataset" ]
|
||||||
type: str
|
type: str
|
||||||
recurse:
|
recurse:
|
||||||
|
@ -28,13 +28,13 @@ options:
|
||||||
- Specifies if properties for any children should be recursively
|
- Specifies if properties for any children should be recursively
|
||||||
displayed.
|
displayed.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'no'
|
default: false
|
||||||
parsable:
|
parsable:
|
||||||
description:
|
description:
|
||||||
- Specifies if property values should be displayed in machine
|
- Specifies if property values should be displayed in machine
|
||||||
friendly format.
|
friendly format.
|
||||||
type: bool
|
type: bool
|
||||||
default: 'no'
|
default: false
|
||||||
properties:
|
properties:
|
||||||
description:
|
description:
|
||||||
- Specifies which dataset properties should be queried in comma-separated format.
|
- Specifies which dataset properties should be queried in comma-separated format.
|
||||||
|
@ -62,7 +62,7 @@ EXAMPLES = '''
|
||||||
- name: Report space usage on ZFS filesystems under data/home
|
- name: Report space usage on ZFS filesystems under data/home
|
||||||
community.general.zfs_facts:
|
community.general.zfs_facts:
|
||||||
name: data/home
|
name: data/home
|
||||||
recurse: yes
|
recurse: true
|
||||||
type: filesystem
|
type: filesystem
|
||||||
|
|
||||||
- ansible.builtin.debug:
|
- ansible.builtin.debug:
|
||||||
|
|
Loading…
Reference in a new issue