mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Use semantic markup (modules m-n) (#6679)
* Use semantic markup. * Use option instead of alias. * Simplify. * Fix/improve nagios docs.
This commit is contained in:
parent
c694abbdf9
commit
b271dba4bf
24 changed files with 263 additions and 259 deletions
|
@ -55,7 +55,7 @@ options:
|
||||||
variant:
|
variant:
|
||||||
description:
|
description:
|
||||||
- A port variant specification.
|
- A port variant specification.
|
||||||
- 'C(variant) is only supported with state: I(installed)/I(present).'
|
- 'O(variant) is only supported with O(state=installed) and O(state=present).'
|
||||||
aliases: ['variants']
|
aliases: ['variants']
|
||||||
type: str
|
type: str
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -53,7 +53,7 @@ options:
|
||||||
target:
|
target:
|
||||||
description:
|
description:
|
||||||
- The target to run.
|
- The target to run.
|
||||||
- Typically this would be something like C(install), C(test), or C(all).
|
- Typically this would be something like V(install), V(test), or V(all).
|
||||||
type: str
|
type: str
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
@ -86,7 +86,7 @@ EXAMPLES = r'''
|
||||||
RETURN = r'''
|
RETURN = r'''
|
||||||
chdir:
|
chdir:
|
||||||
description:
|
description:
|
||||||
- The value of the module parameter I(chdir).
|
- The value of the module parameter O(chdir).
|
||||||
type: str
|
type: str
|
||||||
returned: success
|
returned: success
|
||||||
command:
|
command:
|
||||||
|
@ -97,22 +97,22 @@ command:
|
||||||
version_added: 6.5.0
|
version_added: 6.5.0
|
||||||
file:
|
file:
|
||||||
description:
|
description:
|
||||||
- The value of the module parameter I(file).
|
- The value of the module parameter O(file).
|
||||||
type: str
|
type: str
|
||||||
returned: success
|
returned: success
|
||||||
jobs:
|
jobs:
|
||||||
description:
|
description:
|
||||||
- The value of the module parameter I(jobs).
|
- The value of the module parameter O(jobs).
|
||||||
type: int
|
type: int
|
||||||
returned: success
|
returned: success
|
||||||
params:
|
params:
|
||||||
description:
|
description:
|
||||||
- The value of the module parameter I(params).
|
- The value of the module parameter O(params).
|
||||||
type: dict
|
type: dict
|
||||||
returned: success
|
returned: success
|
||||||
target:
|
target:
|
||||||
description:
|
description:
|
||||||
- The value of the module parameter I(target).
|
- The value of the module parameter O(target).
|
||||||
type: str
|
type: str
|
||||||
returned: success
|
returned: success
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -32,10 +32,10 @@ options:
|
||||||
state:
|
state:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- C(absent) - policy_profiles should not exist,
|
- V(absent) - policy_profiles should not exist,
|
||||||
- C(present) - policy_profiles should exist,
|
- V(present) - policy_profiles should exist,
|
||||||
- >
|
- >
|
||||||
C(list) - list current policy_profiles and policies.
|
V(list) - list current policy_profiles and policies.
|
||||||
This state is deprecated and will be removed 8.0.0.
|
This state is deprecated and will be removed 8.0.0.
|
||||||
Please use the module M(community.general.manageiq_policies_info) instead.
|
Please use the module M(community.general.manageiq_policies_info) instead.
|
||||||
choices: ['absent', 'present', 'list']
|
choices: ['absent', 'present', 'list']
|
||||||
|
@ -44,8 +44,8 @@ options:
|
||||||
type: list
|
type: list
|
||||||
elements: dict
|
elements: dict
|
||||||
description:
|
description:
|
||||||
- List of dictionaries, each includes the policy_profile C(name) key.
|
- List of dictionaries, each includes the policy_profile V(name) key.
|
||||||
- Required if I(state) is C(present) or C(absent).
|
- Required if O(state) is V(present) or V(absent).
|
||||||
resource_type:
|
resource_type:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
|
@ -58,12 +58,12 @@ options:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- The name of the resource to which the profile should be [un]assigned.
|
- The name of the resource to which the profile should be [un]assigned.
|
||||||
- Must be specified if I(resource_id) is not set. Both options are mutually exclusive.
|
- Must be specified if O(resource_id) is not set. Both options are mutually exclusive.
|
||||||
resource_id:
|
resource_id:
|
||||||
type: int
|
type: int
|
||||||
description:
|
description:
|
||||||
- The ID of the resource to which the profile should be [un]assigned.
|
- The ID of the resource to which the profile should be [un]assigned.
|
||||||
- Must be specified if I(resource_name) is not set. Both options are mutually exclusive.
|
- Must be specified if O(resource_name) is not set. Both options are mutually exclusive.
|
||||||
version_added: 2.2.0
|
version_added: 2.2.0
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -38,12 +38,12 @@ options:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- The name of the resource to obtain the profile for.
|
- The name of the resource to obtain the profile for.
|
||||||
- Must be specified if I(resource_id) is not set. Both options are mutually exclusive.
|
- Must be specified if O(resource_id) is not set. Both options are mutually exclusive.
|
||||||
resource_id:
|
resource_id:
|
||||||
type: int
|
type: int
|
||||||
description:
|
description:
|
||||||
- The ID of the resource to obtain the profile for.
|
- The ID of the resource to obtain the profile for.
|
||||||
- Must be specified if I(resource_name) is not set. Both options are mutually exclusive.
|
- Must be specified if O(resource_name) is not set. Both options are mutually exclusive.
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -32,10 +32,10 @@ options:
|
||||||
state:
|
state:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- C(absent) - tags should not exist.
|
- V(absent) - tags should not exist.
|
||||||
- C(present) - tags should exist.
|
- V(present) - tags should exist.
|
||||||
- >
|
- >
|
||||||
C(list) - list current tags.
|
V(list) - list current tags.
|
||||||
This state is deprecated and will be removed 8.0.0.
|
This state is deprecated and will be removed 8.0.0.
|
||||||
Please use the module M(community.general.manageiq_tags_info) instead.
|
Please use the module M(community.general.manageiq_tags_info) instead.
|
||||||
choices: ['absent', 'present', 'list']
|
choices: ['absent', 'present', 'list']
|
||||||
|
@ -44,8 +44,8 @@ options:
|
||||||
type: list
|
type: list
|
||||||
elements: dict
|
elements: dict
|
||||||
description:
|
description:
|
||||||
- C(tags) - list of dictionaries, each includes C(name) and c(category) keys.
|
- V(tags) - list of dictionaries, each includes C(name) and C(category) keys.
|
||||||
- Required if I(state) is C(present) or C(absent).
|
- Required if O(state) is V(present) or V(absent).
|
||||||
resource_type:
|
resource_type:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
|
@ -58,11 +58,11 @@ options:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- The name of the resource at which tags will be controlled.
|
- The name of the resource at which tags will be controlled.
|
||||||
- Must be specified if I(resource_id) is not set. Both options are mutually exclusive.
|
- Must be specified if O(resource_id) is not set. Both options are mutually exclusive.
|
||||||
resource_id:
|
resource_id:
|
||||||
description:
|
description:
|
||||||
- The ID of the resource at which tags will be controlled.
|
- The ID of the resource at which tags will be controlled.
|
||||||
- Must be specified if I(resource_name) is not set. Both options are mutually exclusive.
|
- Must be specified if O(resource_name) is not set. Both options are mutually exclusive.
|
||||||
type: int
|
type: int
|
||||||
version_added: 2.2.0
|
version_added: 2.2.0
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -36,11 +36,11 @@ options:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- The name of the resource at which tags will be controlled.
|
- The name of the resource at which tags will be controlled.
|
||||||
- Must be specified if I(resource_id) is not set. Both options are mutually exclusive.
|
- Must be specified if O(resource_id) is not set. Both options are mutually exclusive.
|
||||||
resource_id:
|
resource_id:
|
||||||
description:
|
description:
|
||||||
- The ID of the resource at which tags will be controlled.
|
- The ID of the resource at which tags will be controlled.
|
||||||
- Must be specified if I(resource_name) is not set. Both options are mutually exclusive.
|
- Must be specified if O(resource_name) is not set. Both options are mutually exclusive.
|
||||||
type: int
|
type: int
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -39,26 +39,26 @@ options:
|
||||||
description:
|
description:
|
||||||
- Mattermost webhook api key. Log into your mattermost site, go to
|
- Mattermost webhook api key. Log into your mattermost site, go to
|
||||||
Menu -> Integration -> Incoming Webhook -> Add Incoming Webhook.
|
Menu -> Integration -> Incoming Webhook -> Add Incoming Webhook.
|
||||||
This will give you full URL. api_key is the last part.
|
This will give you full URL. I(api_key) is the last part.
|
||||||
http://mattermost.example.com/hooks/C(API_KEY)
|
http://mattermost.example.com/hooks/C(API_KEY)
|
||||||
required: true
|
required: true
|
||||||
text:
|
text:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- Text to send. Note that the module does not handle escaping characters.
|
- Text to send. Note that the module does not handle escaping characters.
|
||||||
- Required when I(attachments) is not set.
|
- Required when O(attachments) is not set.
|
||||||
attachments:
|
attachments:
|
||||||
type: list
|
type: list
|
||||||
elements: dict
|
elements: dict
|
||||||
description:
|
description:
|
||||||
- Define a list of attachments.
|
- Define a list of attachments.
|
||||||
- For more information, see U(https://developers.mattermost.com/integrate/admin-guide/admin-message-attachments/).
|
- For more information, see U(https://developers.mattermost.com/integrate/admin-guide/admin-message-attachments/).
|
||||||
- Required when I(text) is not set.
|
- Required when O(text) is not set.
|
||||||
version_added: 4.3.0
|
version_added: 4.3.0
|
||||||
channel:
|
channel:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- Channel to send the message to. If absent, the message goes to the channel selected for the I(api_key).
|
- Channel to send the message to. If absent, the message goes to the channel selected for the O(api_key).
|
||||||
username:
|
username:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
|
@ -71,7 +71,7 @@ options:
|
||||||
default: https://docs.ansible.com/favicon.ico
|
default: https://docs.ansible.com/favicon.ico
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(false), SSL certificates will not be validated. This should only be used
|
- If V(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.
|
||||||
default: true
|
default: true
|
||||||
type: bool
|
type: bool
|
||||||
|
|
|
@ -43,14 +43,14 @@ options:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- The maven version coordinate
|
- The maven version coordinate
|
||||||
- Mutually exclusive with I(version_by_spec).
|
- Mutually exclusive with O(version_by_spec).
|
||||||
version_by_spec:
|
version_by_spec:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- The maven dependency version ranges.
|
- The maven dependency version ranges.
|
||||||
- See supported version ranges on U(https://cwiki.apache.org/confluence/display/MAVENOLD/Dependency+Mediation+and+Conflict+Resolution)
|
- See supported version ranges on U(https://cwiki.apache.org/confluence/display/MAVENOLD/Dependency+Mediation+and+Conflict+Resolution)
|
||||||
- The range type "(,1.0],[1.2,)" and "(,1.1),(1.1,)" is not supported.
|
- The range type "(,1.0],[1.2,)" and "(,1.1),(1.1,)" is not supported.
|
||||||
- Mutually exclusive with I(version).
|
- Mutually exclusive with O(version).
|
||||||
version_added: '0.2.0'
|
version_added: '0.2.0'
|
||||||
classifier:
|
classifier:
|
||||||
type: str
|
type: str
|
||||||
|
@ -111,48 +111,48 @@ options:
|
||||||
default: 10
|
default: 10
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(false), SSL certificates will not be validated. This should only be set to C(false) when no other option exists.
|
- If V(false), SSL certificates will not be validated. This should only be set to V(false) when no other option exists.
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
client_cert:
|
client_cert:
|
||||||
description:
|
description:
|
||||||
- PEM formatted certificate chain file to be used for SSL client authentication.
|
- PEM formatted certificate chain file to be used for SSL client authentication.
|
||||||
- This file can also include the key as well, and if the key is included, I(client_key) is not required.
|
- This file can also include the key as well, and if the key is included, O(client_key) is not required.
|
||||||
type: path
|
type: path
|
||||||
version_added: '1.3.0'
|
version_added: '1.3.0'
|
||||||
client_key:
|
client_key:
|
||||||
description:
|
description:
|
||||||
- PEM formatted file that contains your private key to be used for SSL client authentication.
|
- PEM formatted file that contains your private key to be used for SSL client authentication.
|
||||||
- If I(client_cert) contains both the certificate and key, this option is not required.
|
- If O(client_cert) contains both the certificate and key, this option is not required.
|
||||||
type: path
|
type: path
|
||||||
version_added: '1.3.0'
|
version_added: '1.3.0'
|
||||||
keep_name:
|
keep_name:
|
||||||
description:
|
description:
|
||||||
- If C(true), the downloaded artifact's name is preserved, i.e the version number remains part of it.
|
- If V(true), the downloaded artifact's name is preserved, i.e the version number remains part of it.
|
||||||
- This option only has effect when C(dest) is a directory and C(version) is set to C(latest) or C(version_by_spec)
|
- This option only has effect when I(dest) is a directory and I(version) is set to V(latest) or O(version_by_spec)
|
||||||
is defined.
|
is defined.
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
verify_checksum:
|
verify_checksum:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- If C(never), the MD5/SHA1 checksum will never be downloaded and verified.
|
- If V(never), the MD5/SHA1 checksum will never be downloaded and verified.
|
||||||
- If C(download), the MD5/SHA1 checksum will be downloaded and verified only after artifact download. This is the default.
|
- If V(download), the MD5/SHA1 checksum will be downloaded and verified only after artifact download. This is the default.
|
||||||
- If C(change), the MD5/SHA1 checksum will be downloaded and verified if the destination already exist,
|
- If V(change), the MD5/SHA1 checksum will be downloaded and verified if the destination already exist,
|
||||||
to verify if they are identical. This was the behaviour before 2.6. Since it downloads the checksum before (maybe)
|
to verify if they are identical. This was the behaviour before 2.6. Since it downloads the checksum before (maybe)
|
||||||
downloading the artifact, and since some repository software, when acting as a proxy/cache, return a 404 error
|
downloading the artifact, and since some repository software, when acting as a proxy/cache, return a 404 error
|
||||||
if the artifact has not been cached yet, it may fail unexpectedly.
|
if the artifact has not been cached yet, it may fail unexpectedly.
|
||||||
If you still need it, you should consider using C(always) instead - if you deal with a checksum, it is better to
|
If you still need it, you should consider using V(always) instead - if you deal with a checksum, it is better to
|
||||||
use it to verify integrity after download.
|
use it to verify integrity after download.
|
||||||
- C(always) combines C(download) and C(change).
|
- V(always) combines V(download) and V(change).
|
||||||
required: false
|
required: false
|
||||||
default: 'download'
|
default: 'download'
|
||||||
choices: ['never', 'download', 'change', 'always']
|
choices: ['never', 'download', 'change', 'always']
|
||||||
checksum_alg:
|
checksum_alg:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- If C(md5), checksums will use the MD5 algorithm. This is the default.
|
- If V(md5), checksums will use the MD5 algorithm. This is the default.
|
||||||
- If C(sha1), checksums will use the SHA1 algorithm. This can be used on systems configured to use
|
- If V(sha1), checksums will use the SHA1 algorithm. This can be used on systems configured to use
|
||||||
FIPS-compliant algorithms, since MD5 will be blocked on such systems.
|
FIPS-compliant algorithms, since MD5 will be blocked on such systems.
|
||||||
default: 'md5'
|
default: 'md5'
|
||||||
choices: ['md5', 'sha1']
|
choices: ['md5', 'sha1']
|
||||||
|
@ -162,14 +162,14 @@ options:
|
||||||
elements: str
|
elements: str
|
||||||
version_added: 5.2.0
|
version_added: 5.2.0
|
||||||
description:
|
description:
|
||||||
- A list of headers that should not be included in the redirection. This headers are sent to the fetch_url C(fetch_url) function.
|
- A list of headers that should not be included in the redirection. This headers are sent to the C(fetch_url) function.
|
||||||
- On ansible-core version 2.12 or later, the default of this option is C([Authorization, Cookie]).
|
- On ansible-core version 2.12 or later, the default of this option is V([Authorization, Cookie]).
|
||||||
- Useful if the redirection URL does not need to have sensitive headers in the request.
|
- Useful if the redirection URL does not need to have sensitive headers in the request.
|
||||||
- Requires ansible-core version 2.12 or later.
|
- Requires ansible-core version 2.12 or later.
|
||||||
directory_mode:
|
directory_mode:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- Filesystem permission mode applied recursively to I(dest) when it is a directory.
|
- Filesystem permission mode applied recursively to O(dest) when it is a directory.
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- ansible.builtin.files
|
- ansible.builtin.files
|
||||||
- community.general.attributes
|
- community.general.attributes
|
||||||
|
|
|
@ -18,8 +18,8 @@ notes:
|
||||||
happen every 15 minutes by default, however you can request an immediate reload if
|
happen every 15 minutes by default, however you can request an immediate reload if
|
||||||
later tasks rely on the records being created. An API key generated via the
|
later tasks rely on the records being created. An API key generated via the
|
||||||
Memset customer control panel is required with the following minimum scope -
|
Memset customer control panel is required with the following minimum scope -
|
||||||
I(dns.reload). If you wish to poll the job status to wait until the reload has
|
C(dns.reload). If you wish to poll the job status to wait until the reload has
|
||||||
completed, then I(job.status) is also required.
|
completed, then C(job.status) is also required.
|
||||||
description:
|
description:
|
||||||
- Request a reload of Memset's DNS infrastructure, and optionally poll until it finishes.
|
- Request a reload of Memset's DNS infrastructure, and optionally poll until it finishes.
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
|
|
|
@ -15,7 +15,7 @@ author: "Simon Weald (@glitchcrab)"
|
||||||
short_description: Retrieve Memstore product usage information
|
short_description: Retrieve Memstore product usage information
|
||||||
notes:
|
notes:
|
||||||
- An API key generated via the Memset customer control panel is needed with the
|
- An API key generated via the Memset customer control panel is needed with the
|
||||||
following minimum scope - I(memstore.usage).
|
following minimum scope - C(memstore.usage).
|
||||||
description:
|
description:
|
||||||
- Retrieve Memstore product usage information.
|
- Retrieve Memstore product usage information.
|
||||||
- This module was called C(memset_memstore_facts) before Ansible 2.9. The usage did not change.
|
- This module was called C(memset_memstore_facts) before Ansible 2.9. The usage did not change.
|
||||||
|
@ -36,7 +36,7 @@ options:
|
||||||
required: true
|
required: true
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- The Memstore product name (i.e. C(mstestyaa1)).
|
- The Memstore product name (that is, C(mstestyaa1)).
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -15,7 +15,7 @@ author: "Simon Weald (@glitchcrab)"
|
||||||
short_description: Retrieve server information
|
short_description: Retrieve server information
|
||||||
notes:
|
notes:
|
||||||
- An API key generated via the Memset customer control panel is needed with the
|
- An API key generated via the Memset customer control panel is needed with the
|
||||||
following minimum scope - I(server.info).
|
following minimum scope - C(server.info).
|
||||||
description:
|
description:
|
||||||
- Retrieve server information.
|
- Retrieve server information.
|
||||||
- This module was called C(memset_server_facts) before Ansible 2.9. The usage did not change.
|
- This module was called C(memset_server_facts) before Ansible 2.9. The usage did not change.
|
||||||
|
@ -36,7 +36,7 @@ options:
|
||||||
required: true
|
required: true
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- The server product name (i.e. C(testyaa1)).
|
- The server product name (that is, C(testyaa1)).
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -17,7 +17,7 @@ notes:
|
||||||
- Zones can be thought of as a logical group of domains, all of which share the
|
- Zones can be thought of as a logical group of domains, all of which share the
|
||||||
same DNS records (i.e. they point to the same IP). An API key generated via the
|
same DNS records (i.e. they point to the same IP). An API key generated via the
|
||||||
Memset customer control panel is needed with the following minimum scope -
|
Memset customer control panel is needed with the following minimum scope -
|
||||||
I(dns.zone_create), I(dns.zone_delete), I(dns.zone_list).
|
C(dns.zone_create), C(dns.zone_delete), C(dns.zone_list).
|
||||||
description:
|
description:
|
||||||
- Manage DNS zones in a Memset account.
|
- Manage DNS zones in a Memset account.
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
|
|
|
@ -17,9 +17,9 @@ notes:
|
||||||
- Zone domains can be thought of as a collection of domains, all of which share the
|
- Zone domains can be thought of as a collection of domains, all of which share the
|
||||||
same DNS records (i.e. they point to the same IP). An API key generated via the
|
same DNS records (i.e. they point to the same IP). An API key generated via the
|
||||||
Memset customer control panel is needed with the following minimum scope -
|
Memset customer control panel is needed with the following minimum scope -
|
||||||
I(dns.zone_domain_create), I(dns.zone_domain_delete), I(dns.zone_domain_list).
|
C(dns.zone_domain_create), C(dns.zone_domain_delete), C(dns.zone_domain_list).
|
||||||
- Currently this module can only create one domain at a time. Multiple domains should
|
- Currently this module can only create one domain at a time. Multiple domains should
|
||||||
be created using C(with_items).
|
be created using C(loop).
|
||||||
description:
|
description:
|
||||||
- Manage DNS zone domains in a Memset account.
|
- Manage DNS zone domains in a Memset account.
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
|
|
|
@ -17,9 +17,9 @@ notes:
|
||||||
- Zones can be thought of as a logical group of domains, all of which share the
|
- Zones can be thought of as a logical group of domains, all of which share the
|
||||||
same DNS records (i.e. they point to the same IP). An API key generated via the
|
same DNS records (i.e. they point to the same IP). An API key generated via the
|
||||||
Memset customer control panel is needed with the following minimum scope -
|
Memset customer control panel is needed with the following minimum scope -
|
||||||
I(dns.zone_create), I(dns.zone_delete), I(dns.zone_list).
|
C(dns.zone_create), C(dns.zone_delete), C(dns.zone_list).
|
||||||
- Currently this module can only create one DNS record at a time. Multiple records
|
- Currently this module can only create one DNS record at a time. Multiple records
|
||||||
should be created using C(with_items).
|
should be created using C(loop).
|
||||||
description:
|
description:
|
||||||
- Manage DNS records in a Memset account.
|
- Manage DNS records in a Memset account.
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
|
|
|
@ -14,7 +14,7 @@ DOCUMENTATION = '''
|
||||||
module: monit
|
module: monit
|
||||||
short_description: Manage the state of a program monitored via Monit
|
short_description: Manage the state of a program monitored via Monit
|
||||||
description:
|
description:
|
||||||
- Manage the state of a program monitored via I(Monit).
|
- Manage the state of a program monitored via Monit.
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- community.general.attributes
|
- community.general.attributes
|
||||||
attributes:
|
attributes:
|
||||||
|
@ -25,7 +25,7 @@ attributes:
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- The name of the I(monit) program/process to manage.
|
- The name of the C(monit) program/process to manage.
|
||||||
required: true
|
required: true
|
||||||
type: str
|
type: str
|
||||||
state:
|
state:
|
||||||
|
|
|
@ -40,7 +40,7 @@ options:
|
||||||
password:
|
password:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- Password for C(username) to authenticate against the broker.
|
- Password for O(username) to authenticate against the broker.
|
||||||
client_id:
|
client_id:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
|
@ -54,8 +54,8 @@ options:
|
||||||
payload:
|
payload:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- Payload. The special string C("None") may be used to send a NULL
|
- Payload. The special string V("None") may be used to send a NULL
|
||||||
(i.e. empty) payload which is useful to simply notify with the I(topic)
|
(that is, empty) payload which is useful to simply notify with the O(topic)
|
||||||
or to clear previously retained messages.
|
or to clear previously retained messages.
|
||||||
required: true
|
required: true
|
||||||
qos:
|
qos:
|
||||||
|
|
|
@ -46,27 +46,28 @@ options:
|
||||||
type: str
|
type: str
|
||||||
required: true
|
required: true
|
||||||
login_port:
|
login_port:
|
||||||
description: Port of the MSSQL server. Requires I(login_host) be defined as well.
|
description: Port of the MSSQL server. Requires O(login_host) be defined as well.
|
||||||
default: 1433
|
default: 1433
|
||||||
type: int
|
type: int
|
||||||
script:
|
script:
|
||||||
description:
|
description:
|
||||||
- The SQL script to be executed.
|
- The SQL script to be executed.
|
||||||
- Script can contain multiple SQL statements. Multiple Batches can be separated by C(GO) command.
|
- Script can contain multiple SQL statements. Multiple Batches can be separated by V(GO) command.
|
||||||
- Each batch must return at least one result set.
|
- Each batch must return at least one result set.
|
||||||
required: true
|
required: true
|
||||||
type: str
|
type: str
|
||||||
output:
|
output:
|
||||||
description:
|
description:
|
||||||
- With C(default) each row will be returned as a list of values. See C(query_results).
|
- With V(default) each row will be returned as a list of values. See RV(query_results).
|
||||||
- Output format C(dict) will return dictionary with the column names as keys. See C(query_results_dict).
|
- Output format V(dict) will return dictionary with the column names as keys. See RV(query_results_dict).
|
||||||
- C(dict) requires named columns to be returned by each query otherwise an error is thrown.
|
- V(dict) requires named columns to be returned by each query otherwise an error is thrown.
|
||||||
choices: [ "dict", "default" ]
|
choices: [ "dict", "default" ]
|
||||||
default: 'default'
|
default: 'default'
|
||||||
type: str
|
type: str
|
||||||
params:
|
params:
|
||||||
description: |
|
description: |
|
||||||
Parameters passed to the script as SQL parameters. ('SELECT %(name)s"' with C(example: '{"name": "John Doe"}).)'
|
Parameters passed to the script as SQL parameters.
|
||||||
|
(Query V('SELECT %(name\)s"') with V(example: '{"name": "John Doe"}).)'
|
||||||
type: dict
|
type: dict
|
||||||
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
|
||||||
|
@ -148,17 +149,17 @@ EXAMPLES = r'''
|
||||||
|
|
||||||
RETURN = r'''
|
RETURN = r'''
|
||||||
query_results:
|
query_results:
|
||||||
description: List of batches (queries separated by C(GO) keyword).
|
description: List of batches (queries separated by V(GO) keyword).
|
||||||
type: list
|
type: list
|
||||||
elements: list
|
elements: list
|
||||||
returned: success and I(output=default)
|
returned: success and O(output=default)
|
||||||
sample: [[[["Batch 0 - Select 0"]], [["Batch 0 - Select 1"]]], [[["Batch 1 - Select 0"]]]]
|
sample: [[[["Batch 0 - Select 0"]], [["Batch 0 - Select 1"]]], [[["Batch 1 - Select 0"]]]]
|
||||||
contains:
|
contains:
|
||||||
queries:
|
queries:
|
||||||
description:
|
description:
|
||||||
- List of result sets of each query.
|
- List of result sets of each query.
|
||||||
- If a query returns no results, the results of this and all the following queries will not be included in the output.
|
- If a query returns no results, the results of this and all the following queries will not be included in the output.
|
||||||
- Use the C(GO) keyword in I(script) to separate queries.
|
- Use the V(GO) keyword in O(script) to separate queries.
|
||||||
type: list
|
type: list
|
||||||
elements: list
|
elements: list
|
||||||
contains:
|
contains:
|
||||||
|
@ -175,10 +176,10 @@ query_results:
|
||||||
example: ["Batch 0 - Select 0"]
|
example: ["Batch 0 - Select 0"]
|
||||||
returned: success, if output is default
|
returned: success, if output is default
|
||||||
query_results_dict:
|
query_results_dict:
|
||||||
description: List of batches (queries separated by C(GO) keyword).
|
description: List of batches (queries separated by V(GO) keyword).
|
||||||
type: list
|
type: list
|
||||||
elements: list
|
elements: list
|
||||||
returned: success and I(output=dict)
|
returned: success and O(output=dict)
|
||||||
sample: [[[["Batch 0 - Select 0"]], [["Batch 0 - Select 1"]]], [[["Batch 1 - Select 0"]]]]
|
sample: [[[["Batch 0 - Select 0"]], [["Batch 0 - Select 1"]]], [[["Batch 1 - Select 0"]]]]
|
||||||
contains:
|
contains:
|
||||||
queries:
|
queries:
|
||||||
|
|
|
@ -21,13 +21,13 @@ short_description: Perform common tasks in Nagios related to downtime and notifi
|
||||||
description:
|
description:
|
||||||
- "The C(nagios) module has two basic functions: scheduling downtime and toggling alerts for services or hosts."
|
- "The C(nagios) module has two basic functions: scheduling downtime and toggling alerts for services or hosts."
|
||||||
- The C(nagios) module is not idempotent.
|
- The C(nagios) module is not idempotent.
|
||||||
- All actions require the I(host) parameter to be given explicitly. In playbooks you can use the C({{inventory_hostname}}) variable to refer
|
- All actions require the O(host) parameter to be given explicitly. In playbooks you can use the C({{inventory_hostname}}) variable to refer
|
||||||
to the host the playbook is currently running on.
|
to the host the playbook is currently running on.
|
||||||
- You can specify multiple services at once by separating them with commas, .e.g. I(services=httpd,nfs,puppet).
|
- You can specify multiple services at once by separating them with commas, .e.g. O(services=httpd,nfs,puppet).
|
||||||
- When specifying what service to handle there is a special service value, I(host), which will handle alerts/downtime/acknowledge for the I(host itself),
|
- When specifying what service to handle there is a special service value, O(host), which will handle alerts/downtime/acknowledge for the I(host itself),
|
||||||
e.g., I(service=host). This keyword may not be given with other services at the same time.
|
for example O(services=host). This keyword may not be given with other services at the same time.
|
||||||
I(Setting alerts/downtime/acknowledge for a host does not affect alerts/downtime/acknowledge for any of the services running on it.)
|
B(Setting alerts/downtime/acknowledge for a host does not affect alerts/downtime/acknowledge for any of the services running on it.)
|
||||||
To schedule downtime for all services on particular host use keyword "all", e.g., I(service=all).
|
To schedule downtime for all services on particular host use keyword "all", for example O(services=all).
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- community.general.attributes
|
- community.general.attributes
|
||||||
attributes:
|
attributes:
|
||||||
|
@ -41,7 +41,7 @@ options:
|
||||||
- Action to take.
|
- Action to take.
|
||||||
- servicegroup options were added in 2.0.
|
- servicegroup options were added in 2.0.
|
||||||
- delete_downtime options were added in 2.2.
|
- delete_downtime options were added in 2.2.
|
||||||
- The C(acknowledge) and C(forced_check) actions were added in community.general 1.2.0.
|
- The V(acknowledge) and V(forced_check) actions were added in community.general 1.2.0.
|
||||||
required: true
|
required: true
|
||||||
choices: [ "downtime", "delete_downtime", "enable_alerts", "disable_alerts", "silence", "unsilence",
|
choices: [ "downtime", "delete_downtime", "enable_alerts", "disable_alerts", "silence", "unsilence",
|
||||||
"silence_nagios", "unsilence_nagios", "command", "servicegroup_service_downtime",
|
"silence_nagios", "unsilence_nagios", "command", "servicegroup_service_downtime",
|
||||||
|
@ -59,12 +59,12 @@ options:
|
||||||
author:
|
author:
|
||||||
description:
|
description:
|
||||||
- Author to leave downtime comments as.
|
- Author to leave downtime comments as.
|
||||||
Only used when I(action) is C(downtime) or C(acknowledge).
|
Only used when O(action) is V(downtime) or V(acknowledge).
|
||||||
type: str
|
type: str
|
||||||
default: Ansible
|
default: Ansible
|
||||||
comment:
|
comment:
|
||||||
description:
|
description:
|
||||||
- Comment when I(action) is C(downtime) or C(acknowledge).
|
- Comment when O(action) is V(downtime) or V(acknowledge).
|
||||||
type: str
|
type: str
|
||||||
default: Scheduling downtime
|
default: Scheduling downtime
|
||||||
start:
|
start:
|
||||||
|
@ -75,27 +75,24 @@ options:
|
||||||
minutes:
|
minutes:
|
||||||
description:
|
description:
|
||||||
- Minutes to schedule downtime for.
|
- Minutes to schedule downtime for.
|
||||||
- Only usable with the C(downtime) action.
|
- Only usable with O(action=downtime).
|
||||||
type: int
|
type: int
|
||||||
default: 30
|
default: 30
|
||||||
services:
|
services:
|
||||||
description:
|
description:
|
||||||
- >
|
- What to manage downtime/alerts for. Separate multiple services with commas.
|
||||||
What to manage downtime/alerts for. Separate multiple services with commas.
|
- "B(Required) option when O(action) is one of: V(downtime), V(acknowledge), V(forced_check), V(enable_alerts), V(disable_alerts)."
|
||||||
I(service) is an alias for I(services).
|
|
||||||
B(Required) option when I(action) is one of: C(downtime), C(acknowledge), C(forced_check), C(enable_alerts), C(disable_alerts).
|
|
||||||
aliases: [ "service" ]
|
aliases: [ "service" ]
|
||||||
type: str
|
type: str
|
||||||
servicegroup:
|
servicegroup:
|
||||||
description:
|
description:
|
||||||
- The Servicegroup we want to set downtimes/alerts for.
|
- The Servicegroup we want to set downtimes/alerts for.
|
||||||
B(Required) option when using the C(servicegroup_service_downtime) amd C(servicegroup_host_downtime).
|
- B(Required) option when using the V(servicegroup_service_downtime) and V(servicegroup_host_downtime) O(action).
|
||||||
type: str
|
type: str
|
||||||
command:
|
command:
|
||||||
description:
|
description:
|
||||||
- The raw command to send to nagios, which
|
- The raw command to send to nagios, which should not include the submitted time header or the line-feed.
|
||||||
should not include the submitted time header or the line-feed
|
- B(Required) option when using the V(command) O(action).
|
||||||
B(Required) option when using the C(command) action.
|
|
||||||
type: str
|
type: str
|
||||||
|
|
||||||
author: "Tim Bielawa (@tbielawa)"
|
author: "Tim Bielawa (@tbielawa)"
|
||||||
|
|
|
@ -46,7 +46,7 @@ options:
|
||||||
type: str
|
type: str
|
||||||
record:
|
record:
|
||||||
description:
|
description:
|
||||||
- Record to add or delete, supports wildcard (*). Default is C(@) (e.g. the zone name).
|
- Record to add or delete, supports wildcard (V(*)). Default is V(@) (that is, the zone name).
|
||||||
default: "@"
|
default: "@"
|
||||||
aliases: [ name ]
|
aliases: [ name ]
|
||||||
type: str
|
type: str
|
||||||
|
@ -65,11 +65,11 @@ options:
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
description:
|
description:
|
||||||
- Whether the record should be the only one for that record type and record name. Only use with I(state=present).
|
- Whether the record should be the only one for that record type and record name. Only use with O(state=present).
|
||||||
- This will delete all other records with the same record name and type.
|
- This will delete all other records with the same record name and type.
|
||||||
priority:
|
priority:
|
||||||
description:
|
description:
|
||||||
- Record priority. Required for I(type=MX).
|
- Record priority. Required for O(type=MX).
|
||||||
required: false
|
required: false
|
||||||
type: int
|
type: int
|
||||||
state:
|
state:
|
||||||
|
|
|
@ -32,14 +32,14 @@ options:
|
||||||
app_name:
|
app_name:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- The value of app_name in the newrelic.yml file used by the application.
|
- The value of C(app_name) in the C(newrelic.yml) file used by the application.
|
||||||
- One of I(app_name) or I(application_id) is required.
|
- One of O(app_name) or O(application_id) is required.
|
||||||
required: false
|
required: false
|
||||||
application_id:
|
application_id:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- The application ID found in the metadata of the application in APM.
|
- The application ID found in the metadata of the application in APM.
|
||||||
- One of I(app_name) or I(application_id) is required.
|
- One of O(app_name) or O(application_id) is required.
|
||||||
required: false
|
required: false
|
||||||
changelog:
|
changelog:
|
||||||
type: str
|
type: str
|
||||||
|
@ -63,7 +63,7 @@ options:
|
||||||
required: false
|
required: false
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- If C(false), SSL certificates will not be validated. This should only be used
|
- If V(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.
|
||||||
required: false
|
required: false
|
||||||
default: true
|
default: true
|
||||||
|
|
|
@ -31,23 +31,23 @@ options:
|
||||||
type: str
|
type: str
|
||||||
mac:
|
mac:
|
||||||
description:
|
description:
|
||||||
- Specifies the I(mac) address to attach the nic tag to when not creating an I(etherstub).
|
- Specifies the O(mac) address to attach the nic tag to when not creating an O(etherstub).
|
||||||
- Parameters I(mac) and I(etherstub) are mutually exclusive.
|
- Parameters O(mac) and O(etherstub) are mutually exclusive.
|
||||||
type: str
|
type: str
|
||||||
etherstub:
|
etherstub:
|
||||||
description:
|
description:
|
||||||
- Specifies that the nic tag will be attached to a created I(etherstub).
|
- Specifies that the nic tag will be attached to a created O(etherstub).
|
||||||
- Parameter I(etherstub) is mutually exclusive with both I(mtu), and I(mac).
|
- Parameter O(etherstub) is mutually exclusive with both O(mtu), and O(mac).
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
mtu:
|
mtu:
|
||||||
description:
|
description:
|
||||||
- Specifies the size of the I(mtu) of the desired nic tag.
|
- Specifies the size of the O(mtu) of the desired nic tag.
|
||||||
- Parameters I(mtu) and I(etherstub) are mutually exclusive.
|
- Parameters O(mtu) and O(etherstub) are mutually exclusive.
|
||||||
type: int
|
type: int
|
||||||
force:
|
force:
|
||||||
description:
|
description:
|
||||||
- When I(state) is absent set this switch will use the C(-f) parameter and delete the nic tag regardless of existing VMs.
|
- When O(state=absent) this switch will use the C(-f) parameter and delete the nic tag regardless of existing VMs.
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
state:
|
state:
|
||||||
|
|
|
@ -52,22 +52,22 @@ options:
|
||||||
description:
|
description:
|
||||||
- The interface to bind the connection to.
|
- The interface to bind the connection to.
|
||||||
- The connection will only be applicable to this interface name.
|
- The connection will only be applicable to this interface name.
|
||||||
- A special value of C('*') can be used for interface-independent connections.
|
- A special value of V('*') can be used for interface-independent connections.
|
||||||
- The ifname argument is mandatory for all connection types except bond, team, bridge, vlan and vpn.
|
- The ifname argument is mandatory for all connection types except bond, team, bridge, vlan and vpn.
|
||||||
- This parameter defaults to C(conn_name) when left unset for all connection types except vpn that removes it.
|
- This parameter defaults to O(conn_name) when left unset for all connection types except vpn that removes it.
|
||||||
type: str
|
type: str
|
||||||
type:
|
type:
|
||||||
description:
|
description:
|
||||||
- This is the type of device or network connection that you wish to create or modify.
|
- This is the type of device or network connection that you wish to create or modify.
|
||||||
- Type C(dummy) is added in community.general 3.5.0.
|
- Type V(dummy) is added in community.general 3.5.0.
|
||||||
- Type C(generic) is added in Ansible 2.5.
|
- Type V(generic) is added in Ansible 2.5.
|
||||||
- Type C(infiniband) is added in community.general 2.0.0.
|
- Type V(infiniband) is added in community.general 2.0.0.
|
||||||
- Type C(gsm) is added in community.general 3.7.0.
|
- Type V(gsm) is added in community.general 3.7.0.
|
||||||
- Type C(macvlan) is added in community.general 6.6.0.
|
- Type V(macvlan) is added in community.general 6.6.0.
|
||||||
- Type C(wireguard) is added in community.general 4.3.0.
|
- Type V(wireguard) is added in community.general 4.3.0.
|
||||||
- Type C(vpn) is added in community.general 5.1.0.
|
- Type V(vpn) is added in community.general 5.1.0.
|
||||||
- Using C(bond-slave), C(bridge-slave) or C(team-slave) implies C(ethernet) connection type with corresponding I(slave_type) option.
|
- Using V(bond-slave), V(bridge-slave), or V(team-slave) implies V(ethernet) connection type with corresponding O(slave_type) option.
|
||||||
- If you want to control non-ethernet connection attached to C(bond), C(bridge) or C(team) consider using C(slave_type) option.
|
- If you want to control non-ethernet connection attached to V(bond), V(bridge), or V(team) consider using O(slave_type) option.
|
||||||
type: str
|
type: str
|
||||||
choices: [ bond, bond-slave, bridge, bridge-slave, dummy, ethernet, generic, gre, infiniband, ipip, macvlan, sit, team, team-slave, vlan, vxlan,
|
choices: [ bond, bond-slave, bridge, bridge-slave, dummy, ethernet, generic, gre, infiniband, ipip, macvlan, sit, team, team-slave, vlan, vxlan,
|
||||||
wifi, gsm, wireguard, vpn ]
|
wifi, gsm, wireguard, vpn ]
|
||||||
|
@ -85,26 +85,26 @@ options:
|
||||||
version_added: 5.8.0
|
version_added: 5.8.0
|
||||||
slave_type:
|
slave_type:
|
||||||
description:
|
description:
|
||||||
- Type of the device of this slave's master connection (for example C(bond)).
|
- Type of the device of this slave's master connection (for example V(bond)).
|
||||||
type: str
|
type: str
|
||||||
choices: [ 'bond', 'bridge', 'team' ]
|
choices: [ 'bond', 'bridge', 'team' ]
|
||||||
version_added: 7.0.0
|
version_added: 7.0.0
|
||||||
master:
|
master:
|
||||||
description:
|
description:
|
||||||
- Master <master (ifname, or connection UUID or conn_name) of bridge, team, bond master connection profile.
|
- Master <master (ifname, or connection UUID or conn_name) of bridge, team, bond master connection profile.
|
||||||
- Mandatory if I(slave_type) is defined.
|
- Mandatory if O(slave_type) is defined.
|
||||||
type: str
|
type: str
|
||||||
ip4:
|
ip4:
|
||||||
description:
|
description:
|
||||||
- List of IPv4 addresses to this interface.
|
- List of IPv4 addresses to this interface.
|
||||||
- Use the format C(192.0.2.24/24) or C(192.0.2.24).
|
- Use the format V(192.0.2.24/24) or V(192.0.2.24).
|
||||||
- If defined and I(method4) is not specified, automatically set C(ipv4.method) to C(manual).
|
- If defined and O(method4) is not specified, automatically set C(ipv4.method) to V(manual).
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
gw4:
|
gw4:
|
||||||
description:
|
description:
|
||||||
- The IPv4 gateway for this interface.
|
- The IPv4 gateway for this interface.
|
||||||
- Use the format C(192.0.2.1).
|
- Use the format V(192.0.2.1).
|
||||||
- This parameter is mutually_exclusive with never_default4 parameter.
|
- This parameter is mutually_exclusive with never_default4 parameter.
|
||||||
type: str
|
type: str
|
||||||
gw4_ignore_auto:
|
gw4_ignore_auto:
|
||||||
|
@ -116,8 +116,8 @@ options:
|
||||||
routes4:
|
routes4:
|
||||||
description:
|
description:
|
||||||
- The list of IPv4 routes.
|
- The list of IPv4 routes.
|
||||||
- Use the format C(192.0.3.0/24 192.0.2.1).
|
- Use the format V(192.0.3.0/24 192.0.2.1).
|
||||||
- To specify more complex routes, use the I(routes4_extended) option.
|
- To specify more complex routes, use the O(routes4_extended) option.
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
version_added: 2.0.0
|
version_added: 2.0.0
|
||||||
|
@ -130,12 +130,12 @@ options:
|
||||||
ip:
|
ip:
|
||||||
description:
|
description:
|
||||||
- IP or prefix of route.
|
- IP or prefix of route.
|
||||||
- Use the format C(192.0.3.0/24).
|
- Use the format V(192.0.3.0/24).
|
||||||
type: str
|
type: str
|
||||||
required: true
|
required: true
|
||||||
next_hop:
|
next_hop:
|
||||||
description:
|
description:
|
||||||
- Use the format C(192.0.2.1).
|
- Use the format V(192.0.2.1).
|
||||||
type: str
|
type: str
|
||||||
metric:
|
metric:
|
||||||
description:
|
description:
|
||||||
|
@ -183,7 +183,7 @@ options:
|
||||||
dns4:
|
dns4:
|
||||||
description:
|
description:
|
||||||
- A list of up to 3 DNS servers.
|
- A list of up to 3 DNS servers.
|
||||||
- The entries must be IPv4 addresses, for example C(192.0.2.53).
|
- The entries must be IPv4 addresses, for example V(192.0.2.53).
|
||||||
elements: str
|
elements: str
|
||||||
type: list
|
type: list
|
||||||
dns4_search:
|
dns4_search:
|
||||||
|
@ -200,28 +200,28 @@ options:
|
||||||
method4:
|
method4:
|
||||||
description:
|
description:
|
||||||
- Configuration method to be used for IPv4.
|
- Configuration method to be used for IPv4.
|
||||||
- If I(ip4) is set, C(ipv4.method) is automatically set to C(manual) and this parameter is not needed.
|
- If O(ip4) is set, C(ipv4.method) is automatically set to V(manual) and this parameter is not needed.
|
||||||
type: str
|
type: str
|
||||||
choices: [auto, link-local, manual, shared, disabled]
|
choices: [auto, link-local, manual, shared, disabled]
|
||||||
version_added: 2.2.0
|
version_added: 2.2.0
|
||||||
may_fail4:
|
may_fail4:
|
||||||
description:
|
description:
|
||||||
- If you need I(ip4) configured before C(network-online.target) is reached, set this option to C(false).
|
- If you need O(ip4) configured before C(network-online.target) is reached, set this option to V(false).
|
||||||
- This option applies when C(method4) is not C(disabled).
|
- This option applies when O(method4) is not V(disabled).
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
version_added: 3.3.0
|
version_added: 3.3.0
|
||||||
ip6:
|
ip6:
|
||||||
description:
|
description:
|
||||||
- List of IPv6 addresses to this interface.
|
- List of IPv6 addresses to this interface.
|
||||||
- Use the format C(abbe::cafe/128) or C(abbe::cafe).
|
- Use the format V(abbe::cafe/128) or V(abbe::cafe).
|
||||||
- If defined and I(method6) is not specified, automatically set C(ipv6.method) to C(manual).
|
- If defined and O(method6) is not specified, automatically set C(ipv6.method) to V(manual).
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
gw6:
|
gw6:
|
||||||
description:
|
description:
|
||||||
- The IPv6 gateway for this interface.
|
- The IPv6 gateway for this interface.
|
||||||
- Use the format C(2001:db8::1).
|
- Use the format V(2001:db8::1).
|
||||||
type: str
|
type: str
|
||||||
gw6_ignore_auto:
|
gw6_ignore_auto:
|
||||||
description:
|
description:
|
||||||
|
@ -232,8 +232,8 @@ options:
|
||||||
routes6:
|
routes6:
|
||||||
description:
|
description:
|
||||||
- The list of IPv6 routes.
|
- The list of IPv6 routes.
|
||||||
- Use the format C(fd12:3456:789a:1::/64 2001:dead:beef::1).
|
- Use the format V(fd12:3456:789a:1::/64 2001:dead:beef::1).
|
||||||
- To specify more complex routes, use the I(routes6_extended) option.
|
- To specify more complex routes, use the O(routes6_extended) option.
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
version_added: 4.4.0
|
version_added: 4.4.0
|
||||||
|
@ -246,12 +246,12 @@ options:
|
||||||
ip:
|
ip:
|
||||||
description:
|
description:
|
||||||
- IP or prefix of route.
|
- IP or prefix of route.
|
||||||
- Use the format C(fd12:3456:789a:1::/64).
|
- Use the format V(fd12:3456:789a:1::/64).
|
||||||
type: str
|
type: str
|
||||||
required: true
|
required: true
|
||||||
next_hop:
|
next_hop:
|
||||||
description:
|
description:
|
||||||
- Use the format C(2001:dead:beef::1).
|
- Use the format V(2001:dead:beef::1).
|
||||||
type: str
|
type: str
|
||||||
metric:
|
metric:
|
||||||
description:
|
description:
|
||||||
|
@ -282,7 +282,7 @@ options:
|
||||||
dns6:
|
dns6:
|
||||||
description:
|
description:
|
||||||
- A list of up to 3 DNS servers.
|
- A list of up to 3 DNS servers.
|
||||||
- The entries must be IPv6 addresses, for example C(2001:4860:4860::8888).
|
- The entries must be IPv6 addresses, for example V(2001:4860:4860::8888).
|
||||||
elements: str
|
elements: str
|
||||||
type: list
|
type: list
|
||||||
dns6_search:
|
dns6_search:
|
||||||
|
@ -299,8 +299,8 @@ options:
|
||||||
method6:
|
method6:
|
||||||
description:
|
description:
|
||||||
- Configuration method to be used for IPv6
|
- Configuration method to be used for IPv6
|
||||||
- If I(ip6) is set, C(ipv6.method) is automatically set to C(manual) and this parameter is not needed.
|
- If O(ip6) is set, C(ipv6.method) is automatically set to V(manual) and this parameter is not needed.
|
||||||
- C(disabled) was added in community.general 3.3.0.
|
- V(disabled) was added in community.general 3.3.0.
|
||||||
type: str
|
type: str
|
||||||
choices: [ignore, auto, dhcp, link-local, manual, shared, disabled]
|
choices: [ignore, auto, dhcp, link-local, manual, shared, disabled]
|
||||||
version_added: 2.2.0
|
version_added: 2.2.0
|
||||||
|
@ -313,7 +313,7 @@ options:
|
||||||
addr_gen_mode6:
|
addr_gen_mode6:
|
||||||
description:
|
description:
|
||||||
- Configure method for creating the address for use with IPv6 Stateless Address Autoconfiguration.
|
- Configure method for creating the address for use with IPv6 Stateless Address Autoconfiguration.
|
||||||
- C(default) and C(deafult-or-eui64) have been added in community.general 6.5.0.
|
- V(default) and V(default-or-eui64) have been added in community.general 6.5.0.
|
||||||
type: str
|
type: str
|
||||||
choices: [default, default-or-eui64, eui64, stable-privacy]
|
choices: [default, default-or-eui64, eui64, stable-privacy]
|
||||||
version_added: 4.2.0
|
version_added: 4.2.0
|
||||||
|
@ -321,7 +321,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- The connection MTU, e.g. 9000. This can't be applied when creating the interface and is done once the interface has been created.
|
- The connection MTU, e.g. 9000. This can't be applied when creating the interface and is done once the interface has been created.
|
||||||
- Can be used when modifying Team, VLAN, Ethernet (Future plans to implement wifi, gsm, pppoe, infiniband)
|
- Can be used when modifying Team, VLAN, Ethernet (Future plans to implement wifi, gsm, pppoe, infiniband)
|
||||||
- This parameter defaults to C(1500) when unset.
|
- This parameter defaults to V(1500) when unset.
|
||||||
type: int
|
type: int
|
||||||
dhcp_client_id:
|
dhcp_client_id:
|
||||||
description:
|
description:
|
||||||
|
@ -334,7 +334,7 @@ options:
|
||||||
miimon:
|
miimon:
|
||||||
description:
|
description:
|
||||||
- This is only used with bond - miimon.
|
- This is only used with bond - miimon.
|
||||||
- This parameter defaults to C(100) when unset.
|
- This parameter defaults to V(100) when unset.
|
||||||
type: int
|
type: int
|
||||||
downdelay:
|
downdelay:
|
||||||
description:
|
description:
|
||||||
|
@ -406,7 +406,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- This is only used with 'bridge-slave' - 'hairpin mode' for the slave, which allows frames to be sent back out through the slave the
|
- This is only used with 'bridge-slave' - 'hairpin mode' for the slave, which allows frames to be sent back out through the slave the
|
||||||
frame was received on.
|
frame was received on.
|
||||||
- The default change to C(false) in community.general 7.0.0. It used to be C(true) before.
|
- The default change to V(false) in community.general 7.0.0. It used to be V(true) before.
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
runner:
|
runner:
|
||||||
|
@ -426,9 +426,9 @@ options:
|
||||||
runner_fast_rate:
|
runner_fast_rate:
|
||||||
description:
|
description:
|
||||||
- Option specifies the rate at which our link partner is asked to transmit LACPDU
|
- Option specifies the rate at which our link partner is asked to transmit LACPDU
|
||||||
packets. If this is C(true) then packets will be sent once per second. Otherwise they
|
packets. If this is V(true) then packets will be sent once per second. Otherwise they
|
||||||
will be sent every 30 seconds.
|
will be sent every 30 seconds.
|
||||||
- Only allowed for C(lacp) runner.
|
- Only allowed for O(runner=lacp).
|
||||||
type: bool
|
type: bool
|
||||||
version_added: 6.5.0
|
version_added: 6.5.0
|
||||||
vlanid:
|
vlanid:
|
||||||
|
@ -478,13 +478,13 @@ options:
|
||||||
ip_tunnel_input_key:
|
ip_tunnel_input_key:
|
||||||
description:
|
description:
|
||||||
- The key used for tunnel input packets.
|
- The key used for tunnel input packets.
|
||||||
- Only used when I(type=gre).
|
- Only used when O(type=gre).
|
||||||
type: str
|
type: str
|
||||||
version_added: 3.6.0
|
version_added: 3.6.0
|
||||||
ip_tunnel_output_key:
|
ip_tunnel_output_key:
|
||||||
description:
|
description:
|
||||||
- The key used for tunnel output packets.
|
- The key used for tunnel output packets.
|
||||||
- Only used when I(type=gre).
|
- Only used when O(type=gre).
|
||||||
type: str
|
type: str
|
||||||
version_added: 3.6.0
|
version_added: 3.6.0
|
||||||
zone:
|
zone:
|
||||||
|
@ -500,23 +500,25 @@ options:
|
||||||
- 'An up-to-date list of supported attributes can be found here:
|
- 'An up-to-date list of supported attributes can be found here:
|
||||||
U(https://networkmanager.dev/docs/api/latest/settings-802-11-wireless-security.html).'
|
U(https://networkmanager.dev/docs/api/latest/settings-802-11-wireless-security.html).'
|
||||||
- 'For instance to use common WPA-PSK auth with a password:
|
- 'For instance to use common WPA-PSK auth with a password:
|
||||||
C({key-mgmt: wpa-psk, psk: my_password}).'
|
V({key-mgmt: wpa-psk, psk: my_password}).'
|
||||||
type: dict
|
type: dict
|
||||||
suboptions:
|
suboptions:
|
||||||
auth-alg:
|
auth-alg:
|
||||||
description:
|
description:
|
||||||
- When WEP is used (that is, if I(key-mgmt) = C(none) or C(ieee8021x)) indicate the 802.11 authentication algorithm required by the AP here.
|
- When WEP is used (that is, if O(wifi_sec.key-mgmt) is V(none) or V(ieee8021x)) indicate the 802.11
|
||||||
- One of C(open) for Open System, C(shared) for Shared Key, or C(leap) for Cisco LEAP.
|
authentication algorithm required by the AP here.
|
||||||
- When using Cisco LEAP (that is, if I(key-mgmt=ieee8021x) and I(auth-alg=leap)) the I(leap-username) and I(leap-password) properties
|
- One of V(open) for Open System, V(shared) for Shared Key, or V(leap) for Cisco LEAP.
|
||||||
|
- When using Cisco LEAP (that is, if O(wifi_sec.key-mgmt=ieee8021x) and O(wifi_sec.auth-alg=leap))
|
||||||
|
the O(wifi_sec.leap-username) and O(wifi_sec.leap-password) properties
|
||||||
must be specified.
|
must be specified.
|
||||||
type: str
|
type: str
|
||||||
choices: [ open, shared, leap ]
|
choices: [ open, shared, leap ]
|
||||||
fils:
|
fils:
|
||||||
description:
|
description:
|
||||||
- Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection.
|
- Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection.
|
||||||
- One of C(0) (use global default value), C(1) (disable FILS), C(2) (enable FILS if the supplicant and the access point support it) or C(3)
|
- One of V(0) (use global default value), V(1) (disable FILS), V(2) (enable FILS if the supplicant and the access point support it) or V(3)
|
||||||
(enable FILS and fail if not supported).
|
(enable FILS and fail if not supported).
|
||||||
- When set to C(0) and no global default is set, FILS will be optionally enabled.
|
- When set to V(0) and no global default is set, FILS will be optionally enabled.
|
||||||
type: int
|
type: int
|
||||||
choices: [ 0, 1, 2, 3 ]
|
choices: [ 0, 1, 2, 3 ]
|
||||||
default: 0
|
default: 0
|
||||||
|
@ -531,20 +533,20 @@ options:
|
||||||
key-mgmt:
|
key-mgmt:
|
||||||
description:
|
description:
|
||||||
- Key management used for the connection.
|
- Key management used for the connection.
|
||||||
- One of C(none) (WEP or no password protection), C(ieee8021x) (Dynamic WEP), C(owe) (Opportunistic Wireless Encryption), C(wpa-psk) (WPA2
|
- One of V(none) (WEP or no password protection), V(ieee8021x) (Dynamic WEP), V(owe) (Opportunistic Wireless Encryption), V(wpa-psk) (WPA2
|
||||||
+ WPA3 personal), C(sae) (WPA3 personal only), C(wpa-eap) (WPA2 + WPA3 enterprise) or C(wpa-eap-suite-b-192) (WPA3 enterprise only).
|
+ WPA3 personal), V(sae) (WPA3 personal only), V(wpa-eap) (WPA2 + WPA3 enterprise) or V(wpa-eap-suite-b-192) (WPA3 enterprise only).
|
||||||
- This property must be set for any Wi-Fi connection that uses security.
|
- This property must be set for any Wi-Fi connection that uses security.
|
||||||
type: str
|
type: str
|
||||||
choices: [ none, ieee8021x, owe, wpa-psk, sae, wpa-eap, wpa-eap-suite-b-192 ]
|
choices: [ none, ieee8021x, owe, wpa-psk, sae, wpa-eap, wpa-eap-suite-b-192 ]
|
||||||
leap-password-flags:
|
leap-password-flags:
|
||||||
description: Flags indicating how to handle the I(leap-password) property.
|
description: Flags indicating how to handle the O(wifi_sec.leap-password) property.
|
||||||
type: list
|
type: list
|
||||||
elements: int
|
elements: int
|
||||||
leap-password:
|
leap-password:
|
||||||
description: The login password for legacy LEAP connections (that is, if I(key-mgmt=ieee8021x) and I(auth-alg=leap)).
|
description: The login password for legacy LEAP connections (that is, if O(wifi_sec.key-mgmt=ieee8021x) and O(wifi_sec.auth-alg=leap)).
|
||||||
type: str
|
type: str
|
||||||
leap-username:
|
leap-username:
|
||||||
description: The login username for legacy LEAP connections (that is, if I(key-mgmt=ieee8021x) and I(auth-alg=leap)).
|
description: The login username for legacy LEAP connections (that is, if O(wifi_sec.key-mgmt=ieee8021x) and O(wifi_sec.auth-alg=leap)).
|
||||||
type: str
|
type: str
|
||||||
pairwise:
|
pairwise:
|
||||||
description:
|
description:
|
||||||
|
@ -557,68 +559,72 @@ options:
|
||||||
pmf:
|
pmf:
|
||||||
description:
|
description:
|
||||||
- Indicates whether Protected Management Frames (802.11w) must be enabled for the connection.
|
- Indicates whether Protected Management Frames (802.11w) must be enabled for the connection.
|
||||||
- One of C(0) (use global default value), C(1) (disable PMF), C(2) (enable PMF if the supplicant and the access point support it) or C(3)
|
- One of V(0) (use global default value), V(1) (disable PMF), V(2) (enable PMF if the
|
||||||
(enable PMF and fail if not supported).
|
supplicant and the access point support it) or V(3) (enable PMF and fail if not supported).
|
||||||
- When set to C(0) and no global default is set, PMF will be optionally enabled.
|
- When set to V(0) and no global default is set, PMF will be optionally enabled.
|
||||||
type: int
|
type: int
|
||||||
choices: [ 0, 1, 2, 3 ]
|
choices: [ 0, 1, 2, 3 ]
|
||||||
default: 0
|
default: 0
|
||||||
proto:
|
proto:
|
||||||
description:
|
description:
|
||||||
- List of strings specifying the allowed WPA protocol versions to use.
|
- List of strings specifying the allowed WPA protocol versions to use.
|
||||||
- Each element may be C(wpa) (allow WPA) or C(rsn) (allow WPA2/RSN).
|
- Each element may be V(wpa) (allow WPA) or V(rsn) (allow WPA2/RSN).
|
||||||
- If not specified, both WPA and RSN connections are allowed.
|
- If not specified, both WPA and RSN connections are allowed.
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
choices: [ wpa, rsn ]
|
choices: [ wpa, rsn ]
|
||||||
psk-flags:
|
psk-flags:
|
||||||
description: Flags indicating how to handle the I(psk) property.
|
description: Flags indicating how to handle the O(wifi_sec.psk) property.
|
||||||
type: list
|
type: list
|
||||||
elements: int
|
elements: int
|
||||||
psk:
|
psk:
|
||||||
description:
|
description:
|
||||||
- Pre-Shared-Key for WPA networks.
|
- Pre-Shared-Key for WPA networks.
|
||||||
- For WPA-PSK, it is either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the
|
- For WPA-PSK, it is either an ASCII passphrase of 8 to 63 characters that is
|
||||||
|
(as specified in the 802.11i standard) hashed to derive the
|
||||||
actual key, or the key in form of 64 hexadecimal character.
|
actual key, or the key in form of 64 hexadecimal character.
|
||||||
- The WPA3-Personal networks use a passphrase of any length for SAE authentication.
|
- The WPA3-Personal networks use a passphrase of any length for SAE authentication.
|
||||||
type: str
|
type: str
|
||||||
wep-key-flags:
|
wep-key-flags:
|
||||||
description: Flags indicating how to handle the I(wep-key0), I(wep-key1), I(wep-key2), and I(wep-key3) properties.
|
description:
|
||||||
|
- Flags indicating how to handle the O(wifi_sec.wep-key0), O(wifi_sec.wep-key1),
|
||||||
|
O(wifi_sec.wep-key2), and O(wifi_sec.wep-key3) properties.
|
||||||
type: list
|
type: list
|
||||||
elements: int
|
elements: int
|
||||||
wep-key-type:
|
wep-key-type:
|
||||||
description:
|
description:
|
||||||
- Controls the interpretation of WEP keys.
|
- Controls the interpretation of WEP keys.
|
||||||
- Allowed values are C(1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII
|
- Allowed values are V(1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII
|
||||||
password; or C(2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the
|
password; or V(2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the
|
||||||
actual WEP key.
|
actual WEP key.
|
||||||
type: int
|
type: int
|
||||||
choices: [ 1, 2 ]
|
choices: [ 1, 2 ]
|
||||||
wep-key0:
|
wep-key0:
|
||||||
description:
|
description:
|
||||||
- Index 0 WEP key. This is the WEP key used in most networks.
|
- Index 0 WEP key. This is the WEP key used in most networks.
|
||||||
- See the I(wep-key-type) property for a description of how this key is interpreted.
|
- See the O(wifi_sec.wep-key-type) property for a description of how this key is interpreted.
|
||||||
type: str
|
type: str
|
||||||
wep-key1:
|
wep-key1:
|
||||||
description:
|
description:
|
||||||
- Index 1 WEP key. This WEP index is not used by most networks.
|
- Index 1 WEP key. This WEP index is not used by most networks.
|
||||||
- See the I(wep-key-type) property for a description of how this key is interpreted.
|
- See the O(wifi_sec.wep-key-type) property for a description of how this key is interpreted.
|
||||||
type: str
|
type: str
|
||||||
wep-key2:
|
wep-key2:
|
||||||
description:
|
description:
|
||||||
- Index 2 WEP key. This WEP index is not used by most networks.
|
- Index 2 WEP key. This WEP index is not used by most networks.
|
||||||
- See the I(wep-key-type) property for a description of how this key is interpreted.
|
- See the O(wifi_sec.wep-key-type) property for a description of how this key is interpreted.
|
||||||
type: str
|
type: str
|
||||||
wep-key3:
|
wep-key3:
|
||||||
description:
|
description:
|
||||||
- Index 3 WEP key. This WEP index is not used by most networks.
|
- Index 3 WEP key. This WEP index is not used by most networks.
|
||||||
- See the I(wep-key-type) property for a description of how this key is interpreted.
|
- See the O(wifi_sec.wep-key-type) property for a description of how this key is interpreted.
|
||||||
type: str
|
type: str
|
||||||
wep-tx-keyidx:
|
wep-tx-keyidx:
|
||||||
description:
|
description:
|
||||||
- When static WEP is used (that is, if I(key-mgmt=none)) and a non-default WEP key index is used by the AP, put that WEP key index here.
|
- When static WEP is used (that is, if O(wifi_sec.key-mgmt=none)) and a non-default WEP key index
|
||||||
- Valid values are C(0) (default key) through C(3).
|
is used by the AP, put that WEP key index here.
|
||||||
- Note that some consumer access points (like the Linksys WRT54G) number the keys C(1) - C(4).
|
- Valid values are V(0) (default key) through V(3).
|
||||||
|
- Note that some consumer access points (like the Linksys WRT54G) number the keys V(1) to V(4).
|
||||||
type: int
|
type: int
|
||||||
choices: [ 0, 1, 2, 3 ]
|
choices: [ 0, 1, 2, 3 ]
|
||||||
default: 0
|
default: 0
|
||||||
|
@ -627,7 +633,7 @@ options:
|
||||||
- Flags indicating which mode of WPS is to be used if any.
|
- Flags indicating which mode of WPS is to be used if any.
|
||||||
- There is little point in changing the default setting as NetworkManager will automatically determine whether it is feasible to start WPS
|
- There is little point in changing the default setting as NetworkManager will automatically determine whether it is feasible to start WPS
|
||||||
enrollment from the Access Point capabilities.
|
enrollment from the Access Point capabilities.
|
||||||
- WPS can be disabled by setting this property to a value of C(1).
|
- WPS can be disabled by setting this property to a value of V(1).
|
||||||
type: int
|
type: int
|
||||||
default: 0
|
default: 0
|
||||||
version_added: 3.0.0
|
version_added: 3.0.0
|
||||||
|
@ -643,34 +649,34 @@ options:
|
||||||
- 'An up-to-date list of supported attributes can be found here:
|
- 'An up-to-date list of supported attributes can be found here:
|
||||||
U(https://networkmanager.dev/docs/api/latest/settings-802-11-wireless.html).'
|
U(https://networkmanager.dev/docs/api/latest/settings-802-11-wireless.html).'
|
||||||
- 'For instance to create a hidden AP mode WiFi connection:
|
- 'For instance to create a hidden AP mode WiFi connection:
|
||||||
C({hidden: true, mode: ap}).'
|
V({hidden: true, mode: ap}).'
|
||||||
type: dict
|
type: dict
|
||||||
suboptions:
|
suboptions:
|
||||||
ap-isolation:
|
ap-isolation:
|
||||||
description:
|
description:
|
||||||
- Configures AP isolation, which prevents communication between wireless devices connected to this AP.
|
- Configures AP isolation, which prevents communication between wireless devices connected to this AP.
|
||||||
- This property can be set to a value different from C(-1) only when the interface is configured in AP mode.
|
- This property can be set to a value different from V(-1) only when the interface is configured in AP mode.
|
||||||
- If set to C(1), devices are not able to communicate with each other. This increases security because it protects devices against attacks
|
- If set to V(1), devices are not able to communicate with each other. This increases security because it protects devices against attacks
|
||||||
from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file
|
from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file
|
||||||
shares, printers, etc.
|
shares, printers, etc.
|
||||||
- If set to C(0), devices can talk to each other.
|
- If set to V(0), devices can talk to each other.
|
||||||
- When set to C(-1), the global default is used; in case the global default is unspecified it is assumed to be C(0).
|
- When set to V(-1), the global default is used; in case the global default is unspecified it is assumed to be V(0).
|
||||||
type: int
|
type: int
|
||||||
choices: [ -1, 0, 1 ]
|
choices: [ -1, 0, 1 ]
|
||||||
default: -1
|
default: -1
|
||||||
assigned-mac-address:
|
assigned-mac-address:
|
||||||
description:
|
description:
|
||||||
- The new field for the cloned MAC address.
|
- The new field for the cloned MAC address.
|
||||||
- It can be either a hardware address in ASCII representation, or one of the special values C(preserve), C(permanent), C(random) or
|
- It can be either a hardware address in ASCII representation, or one of the special values V(preserve), V(permanent), V(random) or
|
||||||
C(stable).
|
V(stable).
|
||||||
- This field replaces the deprecated I(cloned-mac-address) on D-Bus, which can only contain explicit hardware addresses.
|
- This field replaces the deprecated O(wifi.cloned-mac-address) on D-Bus, which can only contain explicit hardware addresses.
|
||||||
- Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property I(cloned-mac-address).
|
- Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property C(cloned-mac-address).
|
||||||
type: str
|
type: str
|
||||||
band:
|
band:
|
||||||
description:
|
description:
|
||||||
- 802.11 frequency band of the network.
|
- 802.11 frequency band of the network.
|
||||||
- One of C(a) for 5GHz 802.11a or C(bg) for 2.4GHz 802.11.
|
- One of V(a) for 5GHz 802.11a or V(bg) for 2.4GHz 802.11.
|
||||||
- This will lock associations to the Wi-Fi network to the specific band, so for example, if C(a) is specified, the device will not
|
- This will lock associations to the Wi-Fi network to the specific band, so for example, if V(a) is specified, the device will not
|
||||||
associate with the same network in the 2.4GHz band even if the network's settings are compatible.
|
associate with the same network in the 2.4GHz band even if the network's settings are compatible.
|
||||||
- This setting depends on specific driver capability and may not work with all drivers.
|
- This setting depends on specific driver capability and may not work with all drivers.
|
||||||
type: str
|
type: str
|
||||||
|
@ -685,38 +691,38 @@ options:
|
||||||
description:
|
description:
|
||||||
- Wireless channel to use for the Wi-Fi connection.
|
- Wireless channel to use for the Wi-Fi connection.
|
||||||
- The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel.
|
- The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel.
|
||||||
- Because channel numbers overlap between bands, this property also requires the I(band) property to be set.
|
- Because channel numbers overlap between bands, this property also requires the O(wifi.band) property to be set.
|
||||||
type: int
|
type: int
|
||||||
default: 0
|
default: 0
|
||||||
cloned-mac-address:
|
cloned-mac-address:
|
||||||
description:
|
description:
|
||||||
- This D-Bus field is deprecated in favor of I(assigned-mac-address) which is more flexible and allows specifying special variants like
|
- This D-Bus field is deprecated in favor of O(wifi.assigned-mac-address) which is more flexible and allows specifying special variants like
|
||||||
C(random).
|
V(random).
|
||||||
- For libnm and nmcli, this field is called I(cloned-mac-address).
|
- For libnm and nmcli, this field is called C(cloned-mac-address).
|
||||||
type: str
|
type: str
|
||||||
generate-mac-address-mask:
|
generate-mac-address-mask:
|
||||||
description:
|
description:
|
||||||
- With I(cloned-mac-address) setting C(random) or C(stable), by default all bits of the MAC address are scrambled and a
|
- With O(wifi.cloned-mac-address) setting V(random) or V(stable), by default all bits of the MAC address are scrambled and a
|
||||||
locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed.
|
locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed.
|
||||||
- Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.
|
- Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.
|
||||||
- If the property is C(null), it is eligible to be overwritten by a default connection setting.
|
- If the property is V(null), it is eligible to be overwritten by a default connection setting.
|
||||||
- If the value is still c(null) or an empty string, the default is to create a locally-administered, unicast MAC address.
|
- If the value is still V(null) or an empty string, the default is to create a locally-administered, unicast MAC address.
|
||||||
- If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC
|
- If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC
|
||||||
address of the device, while the unset bits are subject to randomization.
|
address of the device, while the unset bits are subject to randomization.
|
||||||
- Setting C(FE:FF:FF:00:00:00) means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the
|
- Setting V(FE:FF:FF:00:00:00) means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the
|
||||||
C(random) or C(stable) algorithm.
|
V(random) or V(stable) algorithm.
|
||||||
- If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits
|
- If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits
|
||||||
that shall not be randomized.
|
that shall not be randomized.
|
||||||
- For example, a value of C(FE:FF:FF:00:00:00 68:F7:28:00:00:00) will set the OUI of the MAC address to 68:F7:28, while the lower bits are
|
- For example, a value of V(FE:FF:FF:00:00:00 68:F7:28:00:00:00) will set the OUI of the MAC address to 68:F7:28, while the lower bits are
|
||||||
randomized.
|
randomized.
|
||||||
- A value of C(02:00:00:00:00:00 00:00:00:00:00:00) will create a fully scrambled globally-administered, burned-in MAC address.
|
- A value of V(02:00:00:00:00:00 00:00:00:00:00:00) will create a fully scrambled globally-administered, burned-in MAC address.
|
||||||
- If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example,
|
- If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example,
|
||||||
C(02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00) will create a fully scrambled MAC address, randomly locally or globally
|
V(02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00) will create a fully scrambled MAC address, randomly locally or globally
|
||||||
administered.
|
administered.
|
||||||
type: str
|
type: str
|
||||||
hidden:
|
hidden:
|
||||||
description:
|
description:
|
||||||
- If C(true), indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode.
|
- If V(true), indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode.
|
||||||
- In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID.
|
- In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID.
|
||||||
However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with
|
However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with
|
||||||
caution.
|
caution.
|
||||||
|
@ -728,14 +734,14 @@ options:
|
||||||
mac-address-blacklist:
|
mac-address-blacklist:
|
||||||
description:
|
description:
|
||||||
- A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply.
|
- A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply.
|
||||||
- Each MAC address should be given in the standard hex-digits-and-colons notation (for example, C(00:11:22:33:44:55)).
|
- Each MAC address should be given in the standard hex-digits-and-colons notation (for example, V(00:11:22:33:44:55)).
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
mac-address-randomization:
|
mac-address-randomization:
|
||||||
description:
|
description:
|
||||||
- One of C(0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), C(1)
|
- One of V(0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), V(1)
|
||||||
(never randomize the MAC address), or C(2) (always randomize the MAC address).
|
(never randomize the MAC address), or V(2) (always randomize the MAC address).
|
||||||
- This property is deprecated for I(cloned-mac-address).
|
- This property is deprecated for O(wifi.cloned-mac-address).
|
||||||
type: int
|
type: int
|
||||||
default: 0
|
default: 0
|
||||||
choices: [ 0, 1, 2 ]
|
choices: [ 0, 1, 2 ]
|
||||||
|
@ -745,7 +751,7 @@ options:
|
||||||
- This property does not change the MAC address of the device (for example for MAC spoofing).
|
- This property does not change the MAC address of the device (for example for MAC spoofing).
|
||||||
type: str
|
type: str
|
||||||
mode:
|
mode:
|
||||||
description: Wi-Fi network mode. If blank, C(infrastructure) is assumed.
|
description: Wi-Fi network mode. If blank, V(infrastructure) is assumed.
|
||||||
type: str
|
type: str
|
||||||
choices: [ infrastructure, mesh, adhoc, ap ]
|
choices: [ infrastructure, mesh, adhoc, ap ]
|
||||||
default: infrastructure
|
default: infrastructure
|
||||||
|
@ -755,7 +761,7 @@ options:
|
||||||
default: 0
|
default: 0
|
||||||
powersave:
|
powersave:
|
||||||
description:
|
description:
|
||||||
- One of C(2) (disable Wi-Fi power saving), C(3) (enable Wi-Fi power saving), C(1) (don't touch currently configure setting) or C(0) (use
|
- One of V(2) (disable Wi-Fi power saving), V(3) (enable Wi-Fi power saving), V(1) (don't touch currently configure setting) or V(0) (use
|
||||||
the globally configured value).
|
the globally configured value).
|
||||||
- All other values are reserved.
|
- All other values are reserved.
|
||||||
type: int
|
type: int
|
||||||
|
@ -764,7 +770,7 @@ options:
|
||||||
rate:
|
rate:
|
||||||
description:
|
description:
|
||||||
- If non-zero, directs the device to only use the specified bitrate for communication with the access point.
|
- If non-zero, directs the device to only use the specified bitrate for communication with the access point.
|
||||||
- Units are in Kb/s, so for example C(5500) = 5.5 Mbit/s.
|
- Units are in Kb/s, so for example V(5500) = 5.5 Mbit/s.
|
||||||
- This property is highly driver dependent and not all devices support setting a static bitrate.
|
- This property is highly driver dependent and not all devices support setting a static bitrate.
|
||||||
type: int
|
type: int
|
||||||
default: 0
|
default: 0
|
||||||
|
@ -778,11 +784,11 @@ options:
|
||||||
wake-on-wlan:
|
wake-on-wlan:
|
||||||
description:
|
description:
|
||||||
- The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options.
|
- The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options.
|
||||||
- May be any combination of C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY) (C(0x2)), C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT) (C(0x4)),
|
- May be any combination of C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY) (V(0x2)), C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT) (V(0x4)),
|
||||||
C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC) (C(0x8)), C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE) (C(0x10)),
|
C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC) (V(0x8)), C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE) (V(0x10)),
|
||||||
C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST) (C(0x20)), C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE) (C(0x40)),
|
C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST) (V(0x20)), C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE) (V(0x40)),
|
||||||
C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE) (C(0x80)), C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP) (C(0x100)) or the special values
|
C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE) (V(0x80)), C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP) (V(0x100)) or the special values
|
||||||
C(0x1) (to use global settings) and C(0x8000) (to disable management of Wake-on-LAN in NetworkManager).
|
V(0x1) (to use global settings) and V(0x8000) (to disable management of Wake-on-LAN in NetworkManager).
|
||||||
- Note the option values' sum must be specified in order to combine multiple options.
|
- Note the option values' sum must be specified in order to combine multiple options.
|
||||||
type: int
|
type: int
|
||||||
default: 1
|
default: 1
|
||||||
|
@ -790,7 +796,7 @@ options:
|
||||||
ignore_unsupported_suboptions:
|
ignore_unsupported_suboptions:
|
||||||
description:
|
description:
|
||||||
- Ignore suboptions which are invalid or unsupported by the version of NetworkManager/nmcli installed on the host.
|
- Ignore suboptions which are invalid or unsupported by the version of NetworkManager/nmcli installed on the host.
|
||||||
- Only I(wifi) and I(wifi_sec) options are currently affected.
|
- Only O(wifi) and O(wifi_sec) options are currently affected.
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
version_added: 3.6.0
|
version_added: 3.6.0
|
||||||
|
@ -801,7 +807,7 @@ options:
|
||||||
- 'An up-to-date list of supported attributes can be found here:
|
- 'An up-to-date list of supported attributes can be found here:
|
||||||
U(https://networkmanager.dev/docs/api/latest/settings-gsm.html).'
|
U(https://networkmanager.dev/docs/api/latest/settings-gsm.html).'
|
||||||
- 'For instance to use apn, pin, username and password:
|
- 'For instance to use apn, pin, username and password:
|
||||||
C({apn: provider.apn, pin: 1234, username: apn.username, password: apn.password}).'
|
V({apn: provider.apn, pin: 1234, username: apn.username, password: apn.password}).'
|
||||||
type: dict
|
type: dict
|
||||||
version_added: 3.7.0
|
version_added: 3.7.0
|
||||||
suboptions:
|
suboptions:
|
||||||
|
@ -813,18 +819,18 @@ options:
|
||||||
- The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.
|
- The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.
|
||||||
type: str
|
type: str
|
||||||
auto-config:
|
auto-config:
|
||||||
description: When C(true), the settings such as I(gsm.apn), I(gsm.username), or I(gsm.password) will default to values that match the network
|
description: When V(true), the settings such as O(gsm.apn), O(gsm.username), or O(gsm.password) will default to values that match the network
|
||||||
the modem will register to in the Mobile Broadband Provider database.
|
the modem will register to in the Mobile Broadband Provider database.
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
device-id:
|
device-id:
|
||||||
description:
|
description:
|
||||||
- The device unique identifier (as given by the C(WWAN) management service) which this connection applies to.
|
- The device unique identifier (as given by the V(WWAN) management service) which this connection applies to.
|
||||||
- If given, the connection will only apply to the specified device.
|
- If given, the connection will only apply to the specified device.
|
||||||
type: str
|
type: str
|
||||||
home-only:
|
home-only:
|
||||||
description:
|
description:
|
||||||
- When C(true), only connections to the home network will be allowed.
|
- When V(true), only connections to the home network will be allowed.
|
||||||
- Connections to roaming networks will not be made.
|
- Connections to roaming networks will not be made.
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
|
@ -849,13 +855,13 @@ options:
|
||||||
type: str
|
type: str
|
||||||
password-flags:
|
password-flags:
|
||||||
description:
|
description:
|
||||||
- NMSettingSecretFlags indicating how to handle the I(password) property.
|
- NMSettingSecretFlags indicating how to handle the O(gsm.password) property.
|
||||||
- 'Following choices are allowed:
|
- 'Following choices are allowed:
|
||||||
C(0) B(NONE): The system is responsible for providing and storing this secret (default),
|
V(0) B(NONE): The system is responsible for providing and storing this secret (default),
|
||||||
C(1) B(AGENT_OWNED): A user secret agent is responsible for providing and storing this secret; when it is required agents will be
|
V(1) B(AGENT_OWNED): A user secret agent is responsible for providing and storing this secret; when it is required agents will be
|
||||||
asked to retrieve it
|
asked to retrieve it
|
||||||
C(2) B(NOT_SAVED): This secret should not be saved, but should be requested from the user each time it is needed
|
V(2) B(NOT_SAVED): This secret should not be saved, but should be requested from the user each time it is needed
|
||||||
C(4) B(NOT_REQUIRED): In situations where it cannot be automatically determined that the secret is required
|
V(4) B(NOT_REQUIRED): In situations where it cannot be automatically determined that the secret is required
|
||||||
(some VPNs and PPP providers do not require all secrets) this flag indicates that the specific secret is not required.'
|
(some VPNs and PPP providers do not require all secrets) this flag indicates that the specific secret is not required.'
|
||||||
type: int
|
type: int
|
||||||
choices: [ 0, 1, 2 , 4 ]
|
choices: [ 0, 1, 2 , 4 ]
|
||||||
|
@ -867,21 +873,21 @@ options:
|
||||||
type: str
|
type: str
|
||||||
pin-flags:
|
pin-flags:
|
||||||
description:
|
description:
|
||||||
- NMSettingSecretFlags indicating how to handle the I(gsm.pin) property.
|
- NMSettingSecretFlags indicating how to handle the O(gsm.pin) property.
|
||||||
- See I(gsm.password-flags) for NMSettingSecretFlags choices.
|
- See O(gsm.password-flags) for NMSettingSecretFlags choices.
|
||||||
type: int
|
type: int
|
||||||
choices: [ 0, 1, 2 , 4 ]
|
choices: [ 0, 1, 2 , 4 ]
|
||||||
default: 0
|
default: 0
|
||||||
sim-id:
|
sim-id:
|
||||||
description:
|
description:
|
||||||
- The SIM card unique identifier (as given by the C(WWAN) management service) which this connection applies to.
|
- The SIM card unique identifier (as given by the C(WWAN) management service) which this connection applies to.
|
||||||
- 'If given, the connection will apply to any device also allowed by I(gsm.device-id) which contains a SIM card matching
|
- 'If given, the connection will apply to any device also allowed by O(gsm.device-id) which contains a SIM card matching
|
||||||
the given identifier.'
|
the given identifier.'
|
||||||
type: str
|
type: str
|
||||||
sim-operator-id:
|
sim-operator-id:
|
||||||
description:
|
description:
|
||||||
- A MCC/MNC string like C(310260) or C(21601I) identifying the specific mobile network operator which this connection applies to.
|
- A MCC/MNC string like V(310260) or V(21601I) identifying the specific mobile network operator which this connection applies to.
|
||||||
- 'If given, the connection will apply to any device also allowed by I(gsm.device-id) and I(gsm.sim-id) which contains a SIM card
|
- 'If given, the connection will apply to any device also allowed by O(gsm.device-id) and O(gsm.sim-id) which contains a SIM card
|
||||||
provisioned by the given operator.'
|
provisioned by the given operator.'
|
||||||
type: str
|
type: str
|
||||||
username:
|
username:
|
||||||
|
@ -901,8 +907,8 @@ options:
|
||||||
mode:
|
mode:
|
||||||
description:
|
description:
|
||||||
- The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.
|
- The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.
|
||||||
- 'Following choices are allowed: C(1) B(vepa), C(2) B(bridge), C(3) B(private), C(4) B(passthru)
|
- 'Following choices are allowed: V(1) B(vepa), V(2) B(bridge), V(3) B(private), V(4) B(passthru)
|
||||||
and C(5) B(source)'
|
and V(5) B(source)'
|
||||||
type: int
|
type: int
|
||||||
choices: [ 1, 2, 3, 4, 5 ]
|
choices: [ 1, 2, 3, 4, 5 ]
|
||||||
required: true
|
required: true
|
||||||
|
@ -928,7 +934,7 @@ options:
|
||||||
- 'An up-to-date list of supported attributes can be found here:
|
- 'An up-to-date list of supported attributes can be found here:
|
||||||
U(https://networkmanager.dev/docs/api/latest/settings-wireguard.html).'
|
U(https://networkmanager.dev/docs/api/latest/settings-wireguard.html).'
|
||||||
- 'For instance to configure a listen port:
|
- 'For instance to configure a listen port:
|
||||||
C({listen-port: 12345}).'
|
V({listen-port: 12345}).'
|
||||||
type: dict
|
type: dict
|
||||||
version_added: 4.3.0
|
version_added: 4.3.0
|
||||||
suboptions:
|
suboptions:
|
||||||
|
@ -936,19 +942,19 @@ options:
|
||||||
description:
|
description:
|
||||||
- The 32-bit fwmark for outgoing packets.
|
- The 32-bit fwmark for outgoing packets.
|
||||||
- The use of fwmark is optional and is by default off. Setting it to 0 disables it.
|
- The use of fwmark is optional and is by default off. Setting it to 0 disables it.
|
||||||
- Note that I(wireguard.ip4-auto-default-route) or I(wireguard.ip6-auto-default-route) enabled, implies to automatically choose a fwmark.
|
- Note that O(wireguard.ip4-auto-default-route) or O(wireguard.ip6-auto-default-route) enabled, implies to automatically choose a fwmark.
|
||||||
type: int
|
type: int
|
||||||
ip4-auto-default-route:
|
ip4-auto-default-route:
|
||||||
description:
|
description:
|
||||||
- Whether to enable special handling of the IPv4 default route.
|
- Whether to enable special handling of the IPv4 default route.
|
||||||
- If enabled, the IPv4 default route from I(wireguard.peer-routes) will be placed to a dedicated routing-table and two policy
|
- If enabled, the IPv4 default route from O(wireguard.peer-routes) will be placed to a dedicated routing-table and two policy
|
||||||
routing rules will be added.
|
routing rules will be added.
|
||||||
- The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen
|
- The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen
|
||||||
automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing"
|
automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing"
|
||||||
type: bool
|
type: bool
|
||||||
ip6-auto-default-route:
|
ip6-auto-default-route:
|
||||||
description:
|
description:
|
||||||
- Like I(wireguard.ip4-auto-default-route), but for the IPv6 default route.
|
- Like O(wireguard.ip4-auto-default-route), but for the IPv6 default route.
|
||||||
type: bool
|
type: bool
|
||||||
listen-port:
|
listen-port:
|
||||||
description: The WireGuard connection listen-port. If not specified, the port will be chosen randomly when the
|
description: The WireGuard connection listen-port. If not specified, the port will be chosen randomly when the
|
||||||
|
@ -963,18 +969,18 @@ options:
|
||||||
peer-routes:
|
peer-routes:
|
||||||
description:
|
description:
|
||||||
- Whether to automatically add routes for the AllowedIPs ranges of the peers.
|
- Whether to automatically add routes for the AllowedIPs ranges of the peers.
|
||||||
- If C(true) (the default), NetworkManager will automatically add routes in the routing tables according to C(ipv4.route-table) and
|
- If V(true) (the default), NetworkManager will automatically add routes in the routing tables according to C(ipv4.route-table) and
|
||||||
C(ipv6.route-table). Usually you want this automatism enabled.
|
C(ipv6.route-table). Usually you want this automatism enabled.
|
||||||
- If C(false), no such routes are added automatically. In this case, the user may want to configure static routes in C(ipv4.routes)
|
- If V(false), no such routes are added automatically. In this case, the user may want to configure static routes in C(ipv4.routes)
|
||||||
and C(ipv6.routes), respectively.
|
and C(ipv6.routes), respectively.
|
||||||
- Note that if the peer's AllowedIPs is C(0.0.0.0/0) or C(::/0) and the profile's C(ipv4.never-default) or C(ipv6.never-default)
|
- Note that if the peer's AllowedIPs is V(0.0.0.0/0) or V(::/0) and the profile's C(ipv4.never-default) or C(ipv6.never-default)
|
||||||
setting is enabled, the peer route for this peer won't be added automatically.
|
setting is enabled, the peer route for this peer won't be added automatically.
|
||||||
type: bool
|
type: bool
|
||||||
private-key:
|
private-key:
|
||||||
description: The 256 bit private-key in base64 encoding.
|
description: The 256 bit private-key in base64 encoding.
|
||||||
type: str
|
type: str
|
||||||
private-key-flags:
|
private-key-flags:
|
||||||
description: C(NMSettingSecretFlags) indicating how to handle the I(wireguard.private-key) property.
|
description: C(NMSettingSecretFlags) indicating how to handle the O(wireguard.private-key) property.
|
||||||
type: int
|
type: int
|
||||||
choices: [ 0, 1, 2 ]
|
choices: [ 0, 1, 2 ]
|
||||||
vpn:
|
vpn:
|
||||||
|
@ -994,19 +1000,19 @@ options:
|
||||||
type: str
|
type: str
|
||||||
required: true
|
required: true
|
||||||
gateway:
|
gateway:
|
||||||
description: The gateway to connection. It can be an IP address (for example C(192.0.2.1))
|
description: The gateway to connection. It can be an IP address (for example V(192.0.2.1))
|
||||||
or a FQDN address (for example C(vpn.example.com)).
|
or a FQDN address (for example V(vpn.example.com)).
|
||||||
type: str
|
type: str
|
||||||
required: true
|
required: true
|
||||||
password-flags:
|
password-flags:
|
||||||
description:
|
description:
|
||||||
- NMSettingSecretFlags indicating how to handle the I(password) property.
|
- NMSettingSecretFlags indicating how to handle the C(vpn.password) property.
|
||||||
- 'Following choices are allowed:
|
- 'Following choices are allowed:
|
||||||
C(0) B(NONE): The system is responsible for providing and storing this secret (default);
|
V(0) B(NONE): The system is responsible for providing and storing this secret (default);
|
||||||
C(1) B(AGENT_OWNED): A user secret agent is responsible for providing and storing this secret; when it is required agents will be
|
V(1) B(AGENT_OWNED): A user secret agent is responsible for providing and storing this secret; when it is required agents will be
|
||||||
asked to retrieve it;
|
asked to retrieve it;
|
||||||
C(2) B(NOT_SAVED): This secret should not be saved, but should be requested from the user each time it is needed;
|
V(2) B(NOT_SAVED): This secret should not be saved, but should be requested from the user each time it is needed;
|
||||||
C(4) B(NOT_REQUIRED): In situations where it cannot be automatically determined that the secret is required
|
V(4) B(NOT_REQUIRED): In situations where it cannot be automatically determined that the secret is required
|
||||||
(some VPNs and PPP providers do not require all secrets) this flag indicates that the specific secret is not required.'
|
(some VPNs and PPP providers do not require all secrets) this flag indicates that the specific secret is not required.'
|
||||||
type: int
|
type: int
|
||||||
choices: [ 0, 1, 2 , 4 ]
|
choices: [ 0, 1, 2 , 4 ]
|
||||||
|
@ -1018,14 +1024,14 @@ options:
|
||||||
ipsec-enabled:
|
ipsec-enabled:
|
||||||
description:
|
description:
|
||||||
- Enable or disable IPSec tunnel to L2TP host.
|
- Enable or disable IPSec tunnel to L2TP host.
|
||||||
- This option is need when C(service-type) is C(org.freedesktop.NetworkManager.l2tp).
|
- This option is need when O(vpn.service-type) is V(org.freedesktop.NetworkManager.l2tp).
|
||||||
type: bool
|
type: bool
|
||||||
ipsec-psk:
|
ipsec-psk:
|
||||||
description:
|
description:
|
||||||
- The pre-shared key in base64 encoding.
|
- The pre-shared key in base64 encoding.
|
||||||
- >
|
- >
|
||||||
You can encode using this Ansible jinja2 expression: C("0s{{ '[YOUR PRE-SHARED KEY]' | ansible.builtin.b64encode }}").
|
You can encode using this Ansible jinja2 expression: V("0s{{ '[YOUR PRE-SHARED KEY]' | ansible.builtin.b64encode }}").
|
||||||
- This is only used when I(ipsec-enabled=true).
|
- This is only used when O(vpn.ipsec-enabled=true).
|
||||||
type: str
|
type: str
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
|
@ -33,7 +33,7 @@ options:
|
||||||
description:
|
description:
|
||||||
- Name of job for delete, stop and start job without source.
|
- Name of job for delete, stop and start job without source.
|
||||||
- Name of job for delete, stop and start job without source.
|
- Name of job for delete, stop and start job without source.
|
||||||
- Either this or I(content) must be specified.
|
- Either this or O(content) must be specified.
|
||||||
type: str
|
type: str
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
|
@ -49,7 +49,7 @@ options:
|
||||||
content:
|
content:
|
||||||
description:
|
description:
|
||||||
- Content of Nomad job.
|
- Content of Nomad job.
|
||||||
- Either this or I(name) must be specified.
|
- Either this or O(name) must be specified.
|
||||||
type: str
|
type: str
|
||||||
content_format:
|
content_format:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -36,26 +36,26 @@ options:
|
||||||
required: false
|
required: false
|
||||||
choices: [ started, stopped, reset, restarted, reloaded ]
|
choices: [ started, stopped, reset, restarted, reloaded ]
|
||||||
description:
|
description:
|
||||||
- C(started)/C(stopped) are idempotent actions that will not run
|
- V(started)/V(stopped) are idempotent actions that will not run
|
||||||
commands unless necessary.
|
commands unless necessary.
|
||||||
C(restarted) will always bounce the service.
|
V(restarted) will always bounce the service.
|
||||||
C(reloaded) will send a SIGHUP or start the service.
|
V(reloaded) will send a SIGHUP or start the service.
|
||||||
C(reset) will start or stop the service according to whether it is
|
V(reset) will start or stop the service according to whether it is
|
||||||
enabled or not.
|
enabled or not.
|
||||||
enabled:
|
enabled:
|
||||||
required: false
|
required: false
|
||||||
type: bool
|
type: bool
|
||||||
description:
|
description:
|
||||||
- Enable or disable the service, independently of C(*.preset) file
|
- Enable or disable the service, independently of C(*.preset) file
|
||||||
preference or running state. Mutually exclusive with I(preset). Will take
|
preference or running state. Mutually exclusive with O(preset). Will take
|
||||||
effect prior to I(state=reset).
|
effect prior to O(state=reset).
|
||||||
preset:
|
preset:
|
||||||
required: false
|
required: false
|
||||||
type: bool
|
type: bool
|
||||||
description:
|
description:
|
||||||
- Enable or disable the service according to local preferences in C(*.preset) files.
|
- Enable or disable the service according to local preferences in C(*.preset) files.
|
||||||
Mutually exclusive with I(enabled). Only has an effect if set to true. Will take
|
Mutually exclusive with O(enabled). Only has an effect if set to true. Will take
|
||||||
effect prior to I(state=reset).
|
effect prior to O(state=reset).
|
||||||
user:
|
user:
|
||||||
required: false
|
required: false
|
||||||
default: false
|
default: false
|
||||||
|
@ -146,12 +146,12 @@ preset:
|
||||||
type: bool
|
type: bool
|
||||||
sample: 'False'
|
sample: 'False'
|
||||||
state:
|
state:
|
||||||
description: service process run state, C(None) if the service is not loaded and will not be started
|
description: service process run state, V(none) if the service is not loaded and will not be started
|
||||||
returned: if state option is used
|
returned: if state option is used
|
||||||
type: str
|
type: str
|
||||||
sample: "reloaded"
|
sample: "reloaded"
|
||||||
status:
|
status:
|
||||||
description: A dictionary with the key=value pairs returned by C(system-control show-json) or C(None) if the service is not loaded
|
description: A dictionary with the key=value pairs returned by C(system-control show-json) or V(none) if the service is not loaded
|
||||||
returned: success
|
returned: success
|
||||||
type: complex
|
type: complex
|
||||||
contains:
|
contains:
|
||||||
|
|
Loading…
Reference in a new issue