mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-23 05:10:22 -07:00
doc style adjustments: modules [cd]* (#10397)
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.16) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py2.7) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.11) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.6) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.16) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py2.7) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.11) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.6) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run
* doc style adjustments: modules c* * doc style adjustments: modules d* * Update plugins/modules/consul_agent_check.py Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
3787808e72
commit
5e2ffb845f
36 changed files with 237 additions and 240 deletions
|
@ -14,7 +14,7 @@ module: campfire
|
|||
short_description: Send a message to Campfire
|
||||
description:
|
||||
- Send a message to Campfire.
|
||||
- Messages with newlines will result in a "Paste" message being sent.
|
||||
- Messages with newlines result in a "Paste" message being sent.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
|
|
|
@ -40,10 +40,10 @@ options:
|
|||
choices: [absent, present]
|
||||
default: present
|
||||
notes:
|
||||
- The capabilities system will automatically transform operators and flags into the effective set, so for example, C(cap_foo=ep)
|
||||
will probably become C(cap_foo+ep).
|
||||
- This module does not attempt to determine the final operator and flags to compare, so you will want to ensure that your
|
||||
capabilities argument matches the final capabilities.
|
||||
- The capabilities system automatically transforms operators and flags into the effective set, so for example, C(cap_foo=ep)
|
||||
probably becomes C(cap_foo+ep).
|
||||
- This module does not attempt to determine the final operator and flags to compare, so you want to ensure that your capabilities
|
||||
argument matches the final capabilities.
|
||||
author:
|
||||
- Nate Coraor (@natefoo)
|
||||
"""
|
||||
|
|
|
@ -28,7 +28,7 @@ options:
|
|||
executable:
|
||||
description:
|
||||
- Path to the C(cargo) installed in the system.
|
||||
- If not specified, the module will look C(cargo) in E(PATH).
|
||||
- If not specified, the module looks for C(cargo) in E(PATH).
|
||||
type: path
|
||||
version_added: 7.5.0
|
||||
name:
|
||||
|
@ -39,11 +39,11 @@ options:
|
|||
required: true
|
||||
path:
|
||||
description: The base path where to install the Rust packages. Cargo automatically appends V(/bin). In other words, V(/usr/local)
|
||||
will become V(/usr/local/bin).
|
||||
becomes V(/usr/local/bin).
|
||||
type: path
|
||||
version:
|
||||
description: The version to install. If O(name) contains multiple values, the module will try to install all of them in
|
||||
this version.
|
||||
description: The version to install. If O(name) contains multiple values, the module tries to install all of them in this
|
||||
version.
|
||||
type: str
|
||||
required: false
|
||||
locked:
|
||||
|
|
|
@ -50,38 +50,41 @@ cloud_init_data_facts:
|
|||
description: Facts of result and status.
|
||||
returned: success
|
||||
type: dict
|
||||
sample: '{
|
||||
"status": {
|
||||
sample:
|
||||
{
|
||||
"status": {
|
||||
"v1": {
|
||||
"datasource": "DataSourceCloudStack",
|
||||
"errors": []
|
||||
},
|
||||
"result": {
|
||||
"v1": {
|
||||
"datasource": "DataSourceCloudStack",
|
||||
"init": {
|
||||
"errors": [],
|
||||
"finished": 1522066377.0185432,
|
||||
"start": 1522066375.2648022
|
||||
},
|
||||
"init-local": {
|
||||
"errors": [],
|
||||
"finished": 1522066373.70919,
|
||||
"start": 1522066373.4726632
|
||||
},
|
||||
"modules-config": {
|
||||
"errors": [],
|
||||
"finished": 1522066380.9097016,
|
||||
"start": 1522066379.0011985
|
||||
},
|
||||
"modules-final": {
|
||||
"errors": [],
|
||||
"finished": 1522066383.56594,
|
||||
"start": 1522066382.3449218
|
||||
},
|
||||
"stage": null
|
||||
"datasource": "DataSourceCloudStack",
|
||||
"errors": []
|
||||
}
|
||||
}'
|
||||
},
|
||||
"result": {
|
||||
"v1": {
|
||||
"datasource": "DataSourceCloudStack",
|
||||
"init": {
|
||||
"errors": [],
|
||||
"finished": 1522066377.0185432,
|
||||
"start": 1522066375.2648022
|
||||
},
|
||||
"init-local": {
|
||||
"errors": [],
|
||||
"finished": 1522066373.70919,
|
||||
"start": 1522066373.4726632
|
||||
},
|
||||
"modules-config": {
|
||||
"errors": [],
|
||||
"finished": 1522066380.9097016,
|
||||
"start": 1522066379.0011985
|
||||
},
|
||||
"modules-final": {
|
||||
"errors": [],
|
||||
"finished": 1522066383.56594,
|
||||
"start": 1522066382.3449218
|
||||
},
|
||||
"stage": null
|
||||
}
|
||||
}
|
||||
}
|
||||
"""
|
||||
|
||||
import os
|
||||
|
|
|
@ -127,7 +127,7 @@ options:
|
|||
description:
|
||||
- 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 deletes all other records with the same record name and type.
|
||||
type: bool
|
||||
state:
|
||||
description:
|
||||
|
@ -156,8 +156,8 @@ options:
|
|||
description:
|
||||
- The type of DNS record to create. Required if O(state=present).
|
||||
- Support for V(SPF) has been removed from community.general 9.0.0 since that record type is no longer supported by
|
||||
- Support for V(PTR) has been added in community.general 11.1.0.
|
||||
CloudFlare.
|
||||
- Support for V(PTR) has been added in community.general 11.1.0.
|
||||
type: str
|
||||
choices: [A, AAAA, CNAME, DS, MX, NS, SRV, SSHFP, TLSA, CAA, TXT, PTR]
|
||||
value:
|
||||
|
@ -378,10 +378,7 @@ record:
|
|||
description: Extra Cloudflare-specific information about the record.
|
||||
returned: success
|
||||
type: dict
|
||||
sample:
|
||||
{
|
||||
"auto_added": false
|
||||
}
|
||||
sample: {"auto_added": false}
|
||||
modified_on:
|
||||
description: Record modification date.
|
||||
returned: success
|
||||
|
@ -412,7 +409,7 @@ record:
|
|||
returned: success
|
||||
type: list
|
||||
elements: str
|
||||
sample: ['production', 'app']
|
||||
sample: ["production", "app"]
|
||||
version_added: 10.1.0
|
||||
tags_modified_on:
|
||||
description: When the record tags were last modified. Omitted if there are no tags.
|
||||
|
|
|
@ -42,12 +42,12 @@ options:
|
|||
type: str
|
||||
use_ssl:
|
||||
description:
|
||||
- If V(false), an HTTP connection will be used instead of the default HTTPS connection.
|
||||
- If V(false), an HTTP connection is used instead of the default HTTPS connection.
|
||||
type: bool
|
||||
default: true
|
||||
validate_certs:
|
||||
description:
|
||||
- If V(false), SSL certificates will not be validated.
|
||||
- If V(false), SSL certificates are not validated.
|
||||
- This should only set to V(false) when used on personally controlled sites using self-signed certificates.
|
||||
type: bool
|
||||
default: true
|
||||
|
|
|
@ -42,12 +42,12 @@ options:
|
|||
type: str
|
||||
use_ssl:
|
||||
description:
|
||||
- If V(false), an HTTP connection will be used instead of the default HTTPS connection.
|
||||
- If V(false), an HTTP connection is used instead of the default HTTPS connection.
|
||||
type: bool
|
||||
default: true
|
||||
validate_certs:
|
||||
description:
|
||||
- If V(false), SSL certificates will not be validated.
|
||||
- If V(false), SSL certificates are not validated.
|
||||
- This should only set to V(false) when used on personally controlled sites using self-signed certificates.
|
||||
type: bool
|
||||
default: true
|
||||
|
|
|
@ -17,7 +17,7 @@ author:
|
|||
short_description: Dependency Manager for PHP
|
||||
description:
|
||||
- Composer is a tool for dependency management in PHP. It allows you to declare the dependent libraries your project needs
|
||||
and it will install them in your project for you.
|
||||
and it installs them in your project for you.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
|
@ -45,7 +45,7 @@ options:
|
|||
type: path
|
||||
description:
|
||||
- Directory of your project (see C(--working-dir)). This is required when the command is not run globally.
|
||||
- Will be ignored if O(global_command=true).
|
||||
- This is ignored if O(global_command=true).
|
||||
global_command:
|
||||
description:
|
||||
- Runs the specified command globally.
|
||||
|
|
|
@ -21,8 +21,8 @@ description:
|
|||
name and ID respectively by appending V(service:) Node level checks require a O(check_name) and optionally a O(check_id).
|
||||
- Currently, there is no complete way to retrieve the script, interval or TTL metadata for a registered check. Without this
|
||||
metadata it is not possible to tell if the data supplied with ansible represents a change to a check. As a result this
|
||||
does not attempt to determine changes and will always report a changed occurred. An API method is planned to supply this
|
||||
metadata so at that stage change management will be added.
|
||||
does not attempt to determine changes and it always reports a changed occurred. An API method is planned to supply this
|
||||
metadata so at that stage change management is to be added.
|
||||
- See U(http://consul.io) for more details.
|
||||
requirements:
|
||||
- python-consul
|
||||
|
@ -83,25 +83,25 @@ options:
|
|||
service_address:
|
||||
type: str
|
||||
description:
|
||||
- The address to advertise that the service will be listening on. This value will be passed as the C(address) parameter
|
||||
to Consul's C(/v1/agent/service/register) API method, so refer to the Consul API documentation for further details.
|
||||
- The address to advertise that the service is listening on. This value is passed as the C(address) parameter to Consul's
|
||||
C(/v1/agent/service/register) API method, so refer to the Consul API documentation for further details.
|
||||
tags:
|
||||
type: list
|
||||
elements: str
|
||||
description:
|
||||
- Tags that will be attached to the service registration.
|
||||
- Tags that are attached to the service registration.
|
||||
script:
|
||||
type: str
|
||||
description:
|
||||
- The script/command that will be run periodically to check the health of the service.
|
||||
- The script/command that is run periodically to check the health of the service.
|
||||
- Requires O(interval) to be provided.
|
||||
- Mutually exclusive with O(ttl), O(tcp) and O(http).
|
||||
interval:
|
||||
type: str
|
||||
description:
|
||||
- The interval at which the service check will be run. This is a number with a V(s) or V(m) suffix to signify the units
|
||||
of seconds or minutes, for example V(15s) or V(1m). If no suffix is supplied V(s) will be used by default, for example
|
||||
V(10) will be V(10s).
|
||||
- The interval at which the service check is run. This is a number with a V(s) or V(m) suffix to signify the units of
|
||||
seconds or minutes, for example V(15s) or V(1m). If no suffix is supplied V(s) is used by default, for example V(10)
|
||||
is V(10s).
|
||||
- Required if one of the parameters O(script), O(http), or O(tcp) is specified.
|
||||
check_id:
|
||||
type: str
|
||||
|
@ -122,25 +122,25 @@ options:
|
|||
ttl:
|
||||
type: str
|
||||
description:
|
||||
- Checks can be registered with a TTL instead of a O(script) and O(interval) this means that the service will check
|
||||
in with the agent before the TTL expires. If it does not the check will be considered failed. Required if registering
|
||||
a check and the script an interval are missing Similar to the interval this is a number with a V(s) or V(m) suffix
|
||||
to signify the units of seconds or minutes, for example V(15s) or V(1m). If no suffix is supplied V(s) will be used
|
||||
by default, for example V(10) will be V(10s).
|
||||
- Checks can be registered with a TTL instead of a O(script) and O(interval) this means that the service checks in with
|
||||
the agent before the TTL expires. If it does not the check is considered failed. Required if registering a check and
|
||||
the script an interval are missing Similar to the interval this is a number with a V(s) or V(m) suffix to signify
|
||||
the units of seconds or minutes, for example V(15s) or V(1m). If no suffix is supplied V(s) is used by default, for
|
||||
example V(10) is equivalent to V(10s).
|
||||
- Mutually exclusive with O(script), O(tcp) and O(http).
|
||||
tcp:
|
||||
type: str
|
||||
description:
|
||||
- Checks can be registered with a TCP port. This means that Consul will check if the connection attempt to that port
|
||||
is successful (that is, the port is currently accepting connections). The format is V(host:port), for example V(localhost:80).
|
||||
- Checks can be registered with a TCP port. This means that Consul checks if the connection attempt to that port is
|
||||
successful (that is, the port is currently accepting connections). The format is V(host:port), for example V(localhost:80).
|
||||
- Requires O(interval) to be provided.
|
||||
- Mutually exclusive with O(script), O(ttl) and O(http).
|
||||
version_added: '1.3.0'
|
||||
http:
|
||||
type: str
|
||||
description:
|
||||
- Checks can be registered with an HTTP endpoint. This means that Consul will check that the http endpoint returns a
|
||||
successful HTTP status.
|
||||
- Checks can be registered with an HTTP endpoint. This means that Consul checks that the http endpoint returns a successful
|
||||
HTTP status.
|
||||
- Requires O(interval) to be provided.
|
||||
- Mutually exclusive with O(script), O(ttl) and O(tcp).
|
||||
timeout:
|
||||
|
@ -148,7 +148,7 @@ options:
|
|||
description:
|
||||
- A custom HTTP check timeout. The Consul default is 10 seconds. Similar to the interval this is a number with a V(s)
|
||||
or V(m) suffix to signify the units of seconds or minutes, for example V(15s) or V(1m). If no suffix is supplied V(s)
|
||||
will be used by default, for example V(10) will be V(10s).
|
||||
is used by default, for example V(10) is equivalent to V(10s).
|
||||
token:
|
||||
type: str
|
||||
description:
|
||||
|
|
|
@ -50,7 +50,7 @@ RETURN = r"""
|
|||
result:
|
||||
description:
|
||||
- The bootstrap result as returned by the Consul HTTP API.
|
||||
- B(Note:) If O(bootstrap_secret) has been specified the C(SecretID) and C(ID) will not contain the secret but C(VALUE_SPECIFIED_IN_NO_LOG_PARAMETER).
|
||||
- B(Note:) If O(bootstrap_secret) has been specified the C(SecretID) and C(ID) do not contain the secret but C(VALUE_SPECIFIED_IN_NO_LOG_PARAMETER).
|
||||
If you pass O(bootstrap_secret), make sure your playbook/role does not depend on this return value!
|
||||
returned: changed
|
||||
type: dict
|
||||
|
|
|
@ -17,9 +17,9 @@ description:
|
|||
- Allows the addition, modification and deletion of checks in a Consul cluster using the agent. For more details on using
|
||||
and configuring Checks, see U(https://developer.hashicorp.com/consul/api-docs/agent/check).
|
||||
- Currently, there is no complete way to retrieve the script, interval or TTL metadata for a registered check. Without this
|
||||
metadata it is not possible to tell if the data supplied with ansible represents a change to a check. As a result this
|
||||
does not attempt to determine changes and will always report a changed occurred. An API method is planned to supply this
|
||||
metadata so at that stage change management will be added.
|
||||
metadata it is not possible to tell if the data supplied with ansible represents a change to a check. As a result, the
|
||||
module does not attempt to determine changes and it always reports a changed occurred. An API method is planned to supply
|
||||
this metadata so at that stage change management is to be added.
|
||||
author:
|
||||
- Michael Ilg (@Ilgmi)
|
||||
extends_documentation_fragment:
|
||||
|
@ -36,8 +36,8 @@ attributes:
|
|||
diff_mode:
|
||||
support: partial
|
||||
details:
|
||||
- In check mode the diff will show the object as it is defined in the module options and not the object structure of
|
||||
the Consul API.
|
||||
- In check mode the diff shows the object as it is defined in the module options and not the object structure of the
|
||||
Consul API.
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
|
@ -52,13 +52,13 @@ options:
|
|||
id:
|
||||
description:
|
||||
- Specifies a unique ID for this check on the node. This defaults to the O(name) parameter, but it may be necessary
|
||||
to provide an ID for uniqueness. This value will return in the response as "CheckId".
|
||||
to provide an ID for uniqueness. This value is returned in the response as V(CheckId).
|
||||
type: str
|
||||
interval:
|
||||
description:
|
||||
- The interval at which the service check will be run. This is a number with a V(s) or V(m) suffix to signify the units
|
||||
of seconds or minutes, for example V(15s) or V(1m). If no suffix is supplied V(s) will be used by default, for example
|
||||
V(10) will be V(10s).
|
||||
- The interval at which the service check is run. This is a number with a V(s) or V(m) suffix to signify the units of
|
||||
seconds or minutes, for example V(15s) or V(1m). If no suffix is supplied V(s) is used by default, for example V(10)
|
||||
is equivalent to V(10s).
|
||||
- Required if one of the parameters O(args), O(http), or O(tcp) is specified.
|
||||
type: str
|
||||
notes:
|
||||
|
@ -74,11 +74,11 @@ options:
|
|||
elements: str
|
||||
ttl:
|
||||
description:
|
||||
- Checks can be registered with a TTL instead of a O(args) and O(interval) this means that the service will check in
|
||||
with the agent before the TTL expires. If it does not the check will be considered failed. Required if registering
|
||||
a check and the script an interval are missing Similar to the interval this is a number with a V(s) or V(m) suffix
|
||||
to signify the units of seconds or minutes, for example V(15s) or V(1m). If no suffix is supplied V(s) will be used
|
||||
by default, for example V(10) will be V(10s).
|
||||
- Checks can be registered with a TTL instead of a O(args) and O(interval) this means that the service checks in with
|
||||
the agent before the TTL expires. If it does not the check is considered failed. Required if registering a check and
|
||||
the script an interval are missing Similar to the interval this is a number with a V(s) or V(m) suffix to signify
|
||||
the units of seconds or minutes, for example V(15s) or V(1m). If no suffix is supplied V(s) is used by default, for
|
||||
example V(10) is equivalent to V(10s).
|
||||
- Mutually exclusive with O(args), O(tcp) and O(http).
|
||||
type: str
|
||||
tcp:
|
||||
|
@ -91,8 +91,8 @@ options:
|
|||
version_added: '1.3.0'
|
||||
http:
|
||||
description:
|
||||
- Checks can be registered with an HTTP endpoint. This means that Consul will check that the http endpoint returns a
|
||||
successful HTTP status.
|
||||
- Checks can be registered with an HTTP endpoint. This means that Consul checks that the HTTP endpoint returns a successful
|
||||
HTTP status.
|
||||
- Requires O(interval) to be provided.
|
||||
- Mutually exclusive with O(args), O(ttl) and O(tcp).
|
||||
type: str
|
||||
|
@ -100,7 +100,7 @@ options:
|
|||
description:
|
||||
- A custom HTTP check timeout. The Consul default is 10 seconds. Similar to the interval this is a number with a V(s)
|
||||
or V(m) suffix to signify the units of seconds or minutes, for example V(15s) or V(1m). If no suffix is supplied V(s)
|
||||
will be used by default, for example V(10) will be V(10s).
|
||||
is used by default, for example V(10) is equivalent to V(10s).
|
||||
type: str
|
||||
service_id:
|
||||
description:
|
||||
|
|
|
@ -31,7 +31,7 @@ attributes:
|
|||
diff_mode:
|
||||
support: partial
|
||||
details:
|
||||
- In check mode the diff will miss operational attributes.
|
||||
- In check mode the diff misses operational attributes.
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
|
@ -50,13 +50,13 @@ options:
|
|||
type: str
|
||||
tags:
|
||||
description:
|
||||
- Tags that will be attached to the service registration.
|
||||
- Tags that are attached to the service registration.
|
||||
type: list
|
||||
elements: str
|
||||
address:
|
||||
description:
|
||||
- The address to advertise that the service will be listening on. This value will be passed as the C(address) parameter
|
||||
to Consul's C(/v1/agent/service/register) API method, so refer to the Consul API documentation for further details.
|
||||
- The address to advertise that the service listens on. This value is passed as the C(address) parameter to Consul's
|
||||
C(/v1/agent/service/register) API method, so refer to the Consul API documentation for further details.
|
||||
type: str
|
||||
meta:
|
||||
description:
|
||||
|
|
|
@ -29,7 +29,7 @@ attributes:
|
|||
diff_mode:
|
||||
support: partial
|
||||
details:
|
||||
- In check mode the diff will miss operational attributes.
|
||||
- In check mode the diff misses operational attributes.
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
|
@ -71,7 +71,7 @@ options:
|
|||
config:
|
||||
description:
|
||||
- The raw configuration to use for the chosen auth method.
|
||||
- Contents will vary depending upon the type chosen.
|
||||
- Contents vary depending upon the O(type) chosen.
|
||||
- Required when the auth method is created.
|
||||
type: dict
|
||||
"""
|
||||
|
|
|
@ -29,7 +29,7 @@ attributes:
|
|||
diff_mode:
|
||||
support: partial
|
||||
details:
|
||||
- In check mode the diff will miss operational attributes.
|
||||
- In check mode the diff misses operational attributes.
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
|
|
|
@ -36,12 +36,12 @@ options:
|
|||
state:
|
||||
description:
|
||||
- The action to take with the supplied key and value. If the state is V(present) and O(value) is set, the key contents
|
||||
will be set to the value supplied and C(changed) will be set to V(true) only if the value was different to the current
|
||||
contents. If the state is V(present) and O(value) is not set, the existing value associated to the key will be returned.
|
||||
The state V(absent) will remove the key/value pair, again C(changed) will be set to V(true) only if the key actually
|
||||
existed prior to the removal. An attempt can be made to obtain or free the lock associated with a key/value pair with
|
||||
the states V(acquire) or V(release) respectively. A valid session must be supplied to make the attempt C(changed)
|
||||
will be V(true) if the attempt is successful, V(false) otherwise.
|
||||
is set to the value supplied and C(changed) is set to V(true) only if the value was different to the current contents.
|
||||
If the state is V(present) and O(value) is not set, the existing value associated to the key is returned. The state
|
||||
V(absent) is used to remove the key/value pair, again C(changed) is set to V(true) only if the key actually existed
|
||||
prior to the removal. An attempt can be made to obtain or free the lock associated with a key/value pair with the
|
||||
states V(acquire) or V(release) respectively. A valid session must be supplied to make the attempt C(changed) is V(true)
|
||||
if the attempt is successful, V(false) otherwise.
|
||||
type: str
|
||||
choices: [absent, acquire, present, release]
|
||||
default: present
|
||||
|
@ -73,9 +73,8 @@ options:
|
|||
type: str
|
||||
cas:
|
||||
description:
|
||||
- Used when acquiring a lock with a session. If the O(cas) is V(0), then Consul will only put the key if it does not
|
||||
already exist. If the O(cas) value is non-zero, then the key is only set if the index matches the ModifyIndex of that
|
||||
key.
|
||||
- Used when acquiring a lock with a session. If the O(cas) is V(0), then Consul only puts the key if it does not already
|
||||
exist. If the O(cas) value is non-zero, then the key is only set if the index matches the ModifyIndex of that key.
|
||||
type: str
|
||||
flags:
|
||||
description:
|
||||
|
@ -103,8 +102,7 @@ options:
|
|||
default: true
|
||||
datacenter:
|
||||
description:
|
||||
- The name of the datacenter to query. If unspecified, the query will default to the datacenter of the Consul agent
|
||||
on O(host).
|
||||
- The name of the datacenter to query. If unspecified, the query defaults to the datacenter of the Consul agent on O(host).
|
||||
type: str
|
||||
version_added: 10.0.0
|
||||
"""
|
||||
|
|
|
@ -31,7 +31,7 @@ attributes:
|
|||
support: partial
|
||||
version_added: 8.3.0
|
||||
details:
|
||||
- In check mode the diff will miss operational attributes.
|
||||
- In check mode the diff misses operational attributes.
|
||||
action_group:
|
||||
version_added: 8.3.0
|
||||
options:
|
||||
|
|
|
@ -29,7 +29,7 @@ attributes:
|
|||
diff_mode:
|
||||
support: partial
|
||||
details:
|
||||
- In check mode the diff will miss operational attributes.
|
||||
- In check mode the diff misses operational attributes.
|
||||
version_added: 8.3.0
|
||||
action_group:
|
||||
version_added: 8.3.0
|
||||
|
@ -48,15 +48,15 @@ options:
|
|||
description:
|
||||
description:
|
||||
- Description of the role.
|
||||
- If not specified, the assigned description will not be changed.
|
||||
- If not specified, the assigned description is not changed.
|
||||
type: str
|
||||
policies:
|
||||
type: list
|
||||
elements: dict
|
||||
description:
|
||||
- List of policies to attach to the role. Each policy is a dict.
|
||||
- If the parameter is left blank, any policies currently assigned will not be changed.
|
||||
- Any empty array (V([])) will clear any policies previously set.
|
||||
- If the parameter is left blank, any policies currently assigned are not changed.
|
||||
- Any empty array (V([])) clears any policies previously set.
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
|
@ -90,8 +90,8 @@ options:
|
|||
elements: dict
|
||||
description:
|
||||
- List of service identities to attach to the role.
|
||||
- If not specified, any service identities currently assigned will not be changed.
|
||||
- If the parameter is an empty array (V([])), any node identities assigned will be unassigned.
|
||||
- If not specified, any service identities currently assigned are not changed.
|
||||
- If the parameter is an empty array (V([])), any node identities assigned are unassigned.
|
||||
suboptions:
|
||||
service_name:
|
||||
description:
|
||||
|
@ -106,9 +106,9 @@ options:
|
|||
- name
|
||||
datacenters:
|
||||
description:
|
||||
- The datacenters the policies will be effective.
|
||||
- This will result in effective policy only being valid in this datacenter.
|
||||
- If an empty array (V([])) is specified, the policies will valid in all datacenters.
|
||||
- The datacenters where the policies are effective.
|
||||
- This results in effective policy only being valid in this datacenter.
|
||||
- If an empty array (V([])) is specified, the policies are valid in all datacenters.
|
||||
- Including those which do not yet exist but may in the future.
|
||||
type: list
|
||||
elements: str
|
||||
|
@ -117,8 +117,8 @@ options:
|
|||
elements: dict
|
||||
description:
|
||||
- List of node identities to attach to the role.
|
||||
- If not specified, any node identities currently assigned will not be changed.
|
||||
- If the parameter is an empty array (V([])), any node identities assigned will be unassigned.
|
||||
- If not specified, any node identities currently assigned are not changed.
|
||||
- If the parameter is an empty array (V([])), any node identities assigned are unassigned.
|
||||
suboptions:
|
||||
node_name:
|
||||
description:
|
||||
|
@ -134,7 +134,7 @@ options:
|
|||
datacenter:
|
||||
description:
|
||||
- The nodes datacenter.
|
||||
- This will result in effective policy only being valid in this datacenter.
|
||||
- This results in effective policy only being valid in this datacenter.
|
||||
type: str
|
||||
required: true
|
||||
"""
|
||||
|
|
|
@ -57,7 +57,7 @@ options:
|
|||
default: 15
|
||||
node:
|
||||
description:
|
||||
- The name of the node that with which the session will be associated. By default this is the name of the agent.
|
||||
- The name of the node that with which the session is associated. By default this is the name of the agent.
|
||||
type: str
|
||||
datacenter:
|
||||
description:
|
||||
|
@ -65,8 +65,8 @@ options:
|
|||
type: str
|
||||
checks:
|
||||
description:
|
||||
- Checks that will be used to verify the session health. If all the checks fail, the session will be invalidated and
|
||||
any locks associated with the session will be release and can be acquired once the associated lock delay has expired.
|
||||
- Checks that are used to verify the session health. If all the checks fail, the session is invalidated and any locks
|
||||
associated with the session are released and can be acquired once the associated lock delay has expired.
|
||||
type: list
|
||||
elements: str
|
||||
behavior:
|
||||
|
|
|
@ -29,7 +29,7 @@ attributes:
|
|||
diff_mode:
|
||||
support: partial
|
||||
details:
|
||||
- In check mode the diff will miss operational attributes.
|
||||
- In check mode the diff misses operational attributes.
|
||||
action_group:
|
||||
version_added: 8.3.0
|
||||
options:
|
||||
|
@ -41,11 +41,11 @@ options:
|
|||
type: str
|
||||
accessor_id:
|
||||
description:
|
||||
- Specifies a UUID to use as the token's Accessor ID. If not specified a UUID will be generated for this field.
|
||||
- Specifies a UUID to use as the token's Accessor ID. If not specified a UUID is generated for this field.
|
||||
type: str
|
||||
secret_id:
|
||||
description:
|
||||
- Specifies a UUID to use as the token's Secret ID. If not specified a UUID will be generated for this field.
|
||||
- Specifies a UUID to use as the token's Secret ID. If not specified a UUID is generated for this field.
|
||||
type: str
|
||||
description:
|
||||
description:
|
||||
|
@ -56,8 +56,8 @@ options:
|
|||
elements: dict
|
||||
description:
|
||||
- List of policies to attach to the token. Each policy is a dict.
|
||||
- If the parameter is left blank, any policies currently assigned will not be changed.
|
||||
- Any empty array (V([])) will clear any policies previously set.
|
||||
- If the parameter is left blank, any policies currently assigned are not changed.
|
||||
- Any empty array (V([])) clears any policies previously set.
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
|
@ -74,8 +74,8 @@ options:
|
|||
elements: dict
|
||||
description:
|
||||
- List of roles to attach to the token. Each role is a dict.
|
||||
- If the parameter is left blank, any roles currently assigned will not be changed.
|
||||
- Any empty array (V([])) will clear any roles previously set.
|
||||
- If the parameter is left blank, any roles currently assigned are not changed.
|
||||
- Any empty array (V([])) clears any roles previously set.
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
|
@ -108,8 +108,8 @@ options:
|
|||
elements: dict
|
||||
description:
|
||||
- List of service identities to attach to the token.
|
||||
- If not specified, any service identities currently assigned will not be changed.
|
||||
- If the parameter is an empty array (V([])), any node identities assigned will be unassigned.
|
||||
- If not specified, any service identities currently assigned are not changed.
|
||||
- If the parameter is an empty array (V([])), any node identities assigned are unassigned.
|
||||
suboptions:
|
||||
service_name:
|
||||
description:
|
||||
|
@ -120,8 +120,8 @@ options:
|
|||
required: true
|
||||
datacenters:
|
||||
description:
|
||||
- The datacenters the token will be effective.
|
||||
- If an empty array (V([])) is specified, the token will valid in all datacenters.
|
||||
- The datacenters where the token is effective.
|
||||
- If an empty array (V([])) is specified, the token is valid in all datacenters.
|
||||
- Including those which do not yet exist but may in the future.
|
||||
type: list
|
||||
elements: str
|
||||
|
@ -130,8 +130,8 @@ options:
|
|||
elements: dict
|
||||
description:
|
||||
- List of node identities to attach to the token.
|
||||
- If not specified, any node identities currently assigned will not be changed.
|
||||
- If the parameter is an empty array (V([])), any node identities assigned will be unassigned.
|
||||
- If not specified, any node identities currently assigned are not changed.
|
||||
- If the parameter is an empty array (V([])), any node identities assigned are unassigned.
|
||||
suboptions:
|
||||
node_name:
|
||||
description:
|
||||
|
@ -143,7 +143,7 @@ options:
|
|||
datacenter:
|
||||
description:
|
||||
- The nodes datacenter.
|
||||
- This will result in effective token only being valid in this datacenter.
|
||||
- This results in effective token only being valid in this datacenter.
|
||||
type: str
|
||||
required: true
|
||||
local:
|
||||
|
@ -152,7 +152,7 @@ options:
|
|||
type: bool
|
||||
expiration_ttl:
|
||||
description:
|
||||
- This is a convenience field and if set will initialize the C(expiration_time). Can be specified in the form of V(60s)
|
||||
- This is a convenience field and if set it initializes the C(expiration_time). Can be specified in the form of V(60s)
|
||||
or V(5m) (that is, 60 seconds or 5 minutes, respectively). Ingored when the token is updated!
|
||||
type: str
|
||||
"""
|
||||
|
|
|
@ -59,16 +59,18 @@ options:
|
|||
install_recommendations:
|
||||
description:
|
||||
- If V(true), installs dependencies declared as recommends per META spec.
|
||||
- If V(false), it ensures the dependencies declared as recommends are not installed, overriding any decision made earlier in E(PERL_CPANM_OPT).
|
||||
- If parameter is not set, C(cpanm) will use its existing defaults.
|
||||
- If V(false), it ensures the dependencies declared as recommends are not installed, overriding any decision made earlier
|
||||
in E(PERL_CPANM_OPT).
|
||||
- If parameter is not set, C(cpanm) uses its existing defaults.
|
||||
- When these dependencies fail to install, cpanm continues the installation, since they are just recommendation.
|
||||
type: bool
|
||||
version_added: 10.3.0
|
||||
install_suggestions:
|
||||
description:
|
||||
- If V(true), installs dependencies declared as suggests per META spec.
|
||||
- If V(false), it ensures the dependencies declared as suggests are not installed, overriding any decision made earlier in E(PERL_CPANM_OPT).
|
||||
- If parameter is not set, C(cpanm) will use its existing defaults.
|
||||
- If V(false), it ensures the dependencies declared as suggests are not installed, overriding any decision made earlier
|
||||
in E(PERL_CPANM_OPT).
|
||||
- If parameter is not set, C(cpanm) uses its existing defaults.
|
||||
- When these dependencies fail to install, cpanm continues the installation, since they are just suggestion.
|
||||
type: bool
|
||||
version_added: 10.3.0
|
||||
|
@ -97,14 +99,13 @@ options:
|
|||
notes:
|
||||
- Please note that U(http://search.cpan.org/dist/App-cpanminus/bin/cpanm, cpanm) must be installed on the remote host.
|
||||
- 'This module now comes with a choice of execution O(mode): V(compatibility) or V(new).'
|
||||
- 'O(mode=compatibility): When using V(compatibility) mode, the module will keep backward compatibility. This was the default
|
||||
- 'O(mode=compatibility): When using V(compatibility) mode, the module keeps backward compatibility. This was the default
|
||||
mode before community.general 9.0.0. O(name) must be either a module name or a distribution file. If the perl module given
|
||||
by O(name) is installed (at the exact O(version) when specified), then nothing happens. Otherwise, it will be installed
|
||||
using the C(cpanm) executable. O(name) cannot be an URL, or a git URL. C(cpanm) version specifiers do not work in this
|
||||
mode.'
|
||||
- 'O(mode=new): When using V(new) mode, the module will behave differently. The O(name) parameter may refer to a module
|
||||
name, a distribution file, a HTTP URL or a git repository URL as described in C(cpanminus) documentation. C(cpanm) version
|
||||
specifiers are recognized. This is the default mode from community.general 9.0.0 onwards.'
|
||||
by O(name) is installed (at the exact O(version) when specified), then nothing happens. Otherwise, it is installed using
|
||||
the C(cpanm) executable. O(name) cannot be an URL, or a git URL. C(cpanm) version specifiers do not work in this mode.'
|
||||
- 'O(mode=new): When using V(new) mode, the module behaves differently. The O(name) parameter may refer to a module name,
|
||||
a distribution file, a HTTP URL or a git repository URL as described in C(cpanminus) documentation. C(cpanm) version specifiers
|
||||
are recognized. This is the default mode from community.general 9.0.0 onwards.'
|
||||
seealso:
|
||||
- name: C(cpanm) command manual page
|
||||
description: Manual page for the command.
|
||||
|
|
|
@ -43,12 +43,12 @@ options:
|
|||
type: str
|
||||
insertafter:
|
||||
description:
|
||||
- If specified, the variable will be inserted after the variable specified.
|
||||
- If specified, the variable is inserted after the variable specified.
|
||||
- Used with O(state=present).
|
||||
type: str
|
||||
insertbefore:
|
||||
description:
|
||||
- Used with O(state=present). If specified, the variable will be inserted just before the variable specified.
|
||||
- Used with O(state=present). If specified, the variable is inserted just before the variable specified.
|
||||
type: str
|
||||
state:
|
||||
description:
|
||||
|
|
|
@ -24,14 +24,14 @@ options:
|
|||
name:
|
||||
description:
|
||||
- Name of the encrypted block device as it appears in the C(/etc/crypttab) file, or optionally prefixed with V(/dev/mapper/),
|
||||
as it appears in the filesystem. V(/dev/mapper/) will be stripped from O(name).
|
||||
as it appears in the filesystem. V(/dev/mapper/) is stripped from O(name).
|
||||
type: str
|
||||
required: true
|
||||
state:
|
||||
description:
|
||||
- Use V(present) to add a line to C(/etc/crypttab) or update its definition if already present.
|
||||
- Use V(absent) to remove a line with matching O(name).
|
||||
- Use V(opts_present) to add options to those already present; options with different values will be updated.
|
||||
- Use V(opts_present) to add options to those already present; options with different values are updated.
|
||||
- Use V(opts_absent) to remove options from the existing set.
|
||||
type: str
|
||||
required: true
|
||||
|
|
|
@ -16,7 +16,7 @@ __metaclass__ = type
|
|||
|
||||
DOCUMENTATION = r"""
|
||||
module: datadog_event
|
||||
short_description: Posts events to Datadog service
|
||||
short_description: Posts events to Datadog service
|
||||
description:
|
||||
- Allows to post events to Datadog (www.datadoghq.com) service.
|
||||
- Uses http://docs.datadoghq.com/api/#events API.
|
||||
|
@ -89,8 +89,8 @@ options:
|
|||
- An arbitrary string to use for aggregation.
|
||||
validate_certs:
|
||||
description:
|
||||
- If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
|
||||
self-signed certificates.
|
||||
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
|
||||
certificates.
|
||||
type: bool
|
||||
default: true
|
||||
"""
|
||||
|
|
|
@ -92,26 +92,26 @@ options:
|
|||
type: dict
|
||||
description:
|
||||
- Dictionary of scopes to silence, with timestamps or None.
|
||||
- Each scope will be muted until the given POSIX timestamp or forever if the value is None.
|
||||
- Each scope is muted until the given POSIX timestamp or forever if the value is V(None).
|
||||
notify_no_data:
|
||||
description:
|
||||
- Whether this monitor will notify when data stops reporting.
|
||||
- Whether this monitor notifies when data stops reporting.
|
||||
type: bool
|
||||
default: false
|
||||
no_data_timeframe:
|
||||
description:
|
||||
- The number of minutes before a monitor will notify when data stops reporting.
|
||||
- The number of minutes before a monitor notifies when data stops reporting.
|
||||
- Must be at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks.
|
||||
- If not specified, it defaults to 2x timeframe for metric, 2 minutes for service.
|
||||
type: str
|
||||
timeout_h:
|
||||
description:
|
||||
- The number of hours of the monitor not reporting data before it will automatically resolve from a triggered state.
|
||||
- The number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
|
||||
type: str
|
||||
renotify_interval:
|
||||
description:
|
||||
- The number of minutes after the last notification before a monitor will re-notify on the current status.
|
||||
- It will only re-notify if it is not resolved.
|
||||
- The number of minutes after the last notification before a monitor re-notifies on the current status.
|
||||
- It only re-notifies if it is not resolved.
|
||||
type: str
|
||||
escalation_message:
|
||||
description:
|
||||
|
@ -120,7 +120,7 @@ options:
|
|||
type: str
|
||||
notify_audit:
|
||||
description:
|
||||
- Whether tagged users will be notified on changes to this monitor.
|
||||
- Whether tagged users are notified on changes to this monitor.
|
||||
type: bool
|
||||
default: false
|
||||
thresholds:
|
||||
|
@ -138,7 +138,7 @@ options:
|
|||
require_full_window:
|
||||
description:
|
||||
- Whether this monitor needs a full window of data before it gets evaluated.
|
||||
- We highly recommend you set this to False for sparse metrics, otherwise some evaluations will be skipped.
|
||||
- We highly recommend you set this to V(false) for sparse metrics, otherwise some evaluations are skipped.
|
||||
type: bool
|
||||
new_host_delay:
|
||||
description:
|
||||
|
@ -153,7 +153,7 @@ options:
|
|||
id:
|
||||
description:
|
||||
- The ID of the alert.
|
||||
- If set, will be used instead of the name to locate the alert.
|
||||
- If set, it is used instead of O(name) to locate the alert.
|
||||
type: str
|
||||
include_tags:
|
||||
description:
|
||||
|
|
|
@ -17,10 +17,10 @@ short_description: Modify and read dconf database
|
|||
description:
|
||||
- This module allows modifications and reading of C(dconf) database. The module is implemented as a wrapper around C(dconf)
|
||||
tool. Please see the dconf(1) man page for more details.
|
||||
- Since C(dconf) requires a running D-Bus session to change values, the module will try to detect an existing session and
|
||||
reuse it, or run the tool using C(dbus-run-session).
|
||||
- Since C(dconf) requires a running D-Bus session to change values, the module tries to detect an existing session and reuse
|
||||
it, or run the tool using C(dbus-run-session).
|
||||
requirements:
|
||||
- Optionally the C(gi.repository) Python library (usually included in the OS on hosts which have C(dconf)); this will become
|
||||
- Optionally the C(gi.repository) Python library (usually included in the OS on hosts which have C(dconf)); this is to become
|
||||
a non-optional requirement in a future major release of community.general.
|
||||
notes:
|
||||
- This module depends on C(psutil) Python library (version 4.0.0 and upwards), C(dconf), C(dbus-send), and C(dbus-run-session)
|
||||
|
@ -28,7 +28,7 @@ notes:
|
|||
- This module uses the C(gi.repository) Python library when available for accurate comparison of values in C(dconf) to values
|
||||
specified in Ansible code. C(gi.repository) is likely to be present on most systems which have C(dconf) but may not be
|
||||
present everywhere. When it is missing, a simple string comparison between values is used, and there may be false positives,
|
||||
that is, Ansible may think that a value is being changed when it is not. This fallback will be removed in a future version
|
||||
that is, Ansible may think that a value is being changed when it is not. This fallback is to be removed in a future version
|
||||
of this module, at which point the module will stop working on hosts without C(gi.repository).
|
||||
- Detection of existing, running D-Bus session, required to change settings using C(dconf), is not 100% reliable due to
|
||||
implementation details of D-Bus daemon itself. This might lead to running applications not picking-up changes on-the-fly
|
||||
|
|
|
@ -33,13 +33,12 @@ options:
|
|||
required: true
|
||||
dest:
|
||||
description:
|
||||
- The file name of the destination file where the compressed file will be decompressed.
|
||||
- If the destination file exists, it will be truncated and overwritten.
|
||||
- If not specified, the destination filename will be derived from O(src) by removing the compression format extension.
|
||||
For example, if O(src) is V(/path/to/file.txt.gz) and O(format) is V(gz), O(dest) will be V(/path/to/file.txt). If
|
||||
the O(src) file does not have an extension for the current O(format), the O(dest) filename will be made by appending
|
||||
C(_decompressed) to the O(src) filename. For instance, if O(src) is V(/path/to/file.myextension), the (dest) filename
|
||||
will be V(/path/to/file.myextension_decompressed).
|
||||
- The file name of the destination file where the compressed file is decompressed.
|
||||
- If the destination file exists, it is truncated and overwritten.
|
||||
- If not specified, the destination filename is derived from O(src) by removing the compression format extension. For
|
||||
example, when O(src) is V(/path/to/file.txt.gz) and O(format) is V(gz), O(dest) is V(/path/to/file.txt). If the O(src)
|
||||
file does not have an extension for the current O(format), the O(dest) filename is made by appending C(_decompressed)
|
||||
to the O(src) filename. For instance, when O(src) is V(/path/to/file.myextension), the (dest) filename is V(/path/to/file.myextension_decompressed).
|
||||
type: path
|
||||
format:
|
||||
description:
|
||||
|
|
|
@ -18,8 +18,8 @@ short_description: Manages some of the steps common in deploying projects
|
|||
description:
|
||||
- The Deploy Helper manages some of the steps common in deploying software. It creates a folder structure, manages a symlink
|
||||
for the current release and cleans up old releases.
|
||||
- Running it with the O(state=query) or O(state=present) will return the C(deploy_helper) fact. C(project_path), whatever
|
||||
you set in the O(path) parameter, C(current_path), the path to the symlink that points to the active release, C(releases_path),
|
||||
- Running it with the O(state=query) or O(state=present) returns the C(deploy_helper) fact. C(project_path), whatever you
|
||||
set in the O(path) parameter, C(current_path), the path to the symlink that points to the active release, C(releases_path),
|
||||
the path to the folder to keep releases in, C(shared_path), the path to the folder to keep shared resources in, C(unfinished_filename),
|
||||
the file to check for to recognize unfinished builds, C(previous_release), the release the 'current' symlink is pointing
|
||||
to, C(previous_release_path), the full path to the 'current' symlink target, C(new_release), either the O(release) parameter
|
||||
|
@ -41,12 +41,12 @@ options:
|
|||
type: str
|
||||
description:
|
||||
- The state of the project.
|
||||
- V(query) will only gather facts.
|
||||
- V(present) will create the project C(root) folder, and in it the C(releases) and C(shared) folders.
|
||||
- V(finalize) will remove the unfinished_filename file, create a symlink to the newly deployed release and optionally
|
||||
clean old releases.
|
||||
- V(clean) will remove failed & old releases.
|
||||
- V(absent) will remove the project folder (synonymous to the M(ansible.builtin.file) module with O(state=absent)).
|
||||
- V(query) gathers facts.
|
||||
- V(present) creates the project C(root) folder, and in it the C(releases) and C(shared) folders.
|
||||
- V(finalize) removes the unfinished_filename file, creates a symlink to the newly deployed release and optionally cleans
|
||||
old releases.
|
||||
- V(clean) removes failed & old releases.
|
||||
- V(absent) removes the project folder (synonymous to the M(ansible.builtin.file) module with O(state=absent)).
|
||||
choices: [present, finalize, absent, clean, query]
|
||||
default: present
|
||||
|
||||
|
@ -59,15 +59,15 @@ options:
|
|||
releases_path:
|
||||
type: str
|
||||
description:
|
||||
- The name of the folder that will hold the releases. This can be relative to O(path) or absolute. Returned in the C(deploy_helper.releases_path)
|
||||
- The name of the folder that holds the releases. This can be relative to O(path) or absolute. Returned in the C(deploy_helper.releases_path)
|
||||
fact.
|
||||
default: releases
|
||||
|
||||
shared_path:
|
||||
type: path
|
||||
description:
|
||||
- The name of the folder that will hold the shared resources. This can be relative to O(path) or absolute. If this is
|
||||
set to an empty string, no shared folder will be created. Returned in the C(deploy_helper.shared_path) fact.
|
||||
- The name of the folder that holds the shared resources. This can be relative to O(path) or absolute. If this is set
|
||||
to an empty string, no shared folder is created. Returned in the C(deploy_helper.shared_path) fact.
|
||||
default: shared
|
||||
|
||||
current_path:
|
||||
|
@ -81,8 +81,8 @@ options:
|
|||
type: str
|
||||
description:
|
||||
- The name of the file that indicates a deploy has not finished. All folders in the O(releases_path) that contain this
|
||||
file will be deleted on O(state=finalize) with O(clean=true), or O(state=clean). This file is automatically deleted
|
||||
from the C(new_release_path) during O(state=finalize).
|
||||
file are deleted on O(state=finalize) with O(clean=true), or O(state=clean). This file is automatically deleted from
|
||||
the C(new_release_path) during O(state=finalize).
|
||||
default: DEPLOY_UNFINISHED
|
||||
|
||||
clean:
|
||||
|
@ -95,16 +95,16 @@ options:
|
|||
type: int
|
||||
description:
|
||||
- The number of old releases to keep when cleaning. Used in O(state=finalize) and O(state=clean). Any unfinished builds
|
||||
will be deleted first, so only correct releases will count. The current version will not count.
|
||||
are deleted first, so only correct releases count. The current version does not count.
|
||||
default: 5
|
||||
|
||||
notes:
|
||||
- Facts are only returned for O(state=query) and O(state=present). If you use both, you should pass any overridden parameters
|
||||
to both calls, otherwise the second call will overwrite the facts of the first one.
|
||||
to both calls, otherwise the second call overwrites the facts of the first one.
|
||||
- When using O(state=clean), the releases are ordered by I(creation date). You should be able to switch to a new naming
|
||||
strategy without problems.
|
||||
- Because of the default behaviour of generating the C(new_release) fact, this module will not be idempotent unless you
|
||||
pass your own release name with O(release). Due to the nature of deploying software, this should not be much of a problem.
|
||||
- Because of the default behaviour of generating the C(new_release) fact, this module is not idempotent unless you pass
|
||||
your own release name with O(release). Due to the nature of deploying software, this should not be much of a problem.
|
||||
extends_documentation_fragment:
|
||||
- ansible.builtin.files
|
||||
- community.general.attributes
|
||||
|
|
|
@ -56,8 +56,7 @@ options:
|
|||
state:
|
||||
description:
|
||||
- The desired state for the target VLAN.
|
||||
- V(readonly) ensures that the state is only ever read, not modified (the module will fail if the resource does not
|
||||
exist).
|
||||
- V(readonly) ensures that the state is only ever read, not modified (the module fails if the resource does not exist).
|
||||
choices: [present, absent, readonly]
|
||||
default: present
|
||||
type: str
|
||||
|
@ -65,7 +64,7 @@ options:
|
|||
description:
|
||||
- Permit expansion of the target VLAN's network if the module parameters specify a larger network than the VLAN currently
|
||||
possesses.
|
||||
- If V(false), the module will fail under these conditions.
|
||||
- If V(false), the module fails under these conditions.
|
||||
- This is intended to prevent accidental expansion of a VLAN's network (since this operation is not reversible).
|
||||
type: bool
|
||||
default: false
|
||||
|
|
|
@ -22,7 +22,7 @@ options:
|
|||
database:
|
||||
description:
|
||||
- Specify databases to run checks against.
|
||||
- If not specified, Django will not run database tests.
|
||||
- If not specified, Django does not run database tests.
|
||||
type: list
|
||||
elements: str
|
||||
deploy:
|
||||
|
@ -32,7 +32,7 @@ options:
|
|||
default: false
|
||||
fail_level:
|
||||
description:
|
||||
- Message level that will trigger failure.
|
||||
- Message level that triggers failure.
|
||||
- Default is the Django default value. Check the documentation for the version being used.
|
||||
type: str
|
||||
choices: [CRITICAL, ERROR, WARNING, INFO, DEBUG]
|
||||
|
@ -49,7 +49,7 @@ options:
|
|||
elements: str
|
||||
notes:
|
||||
- The outcome of the module is found in the common return values RV(ignore:stdout), RV(ignore:stderr), RV(ignore:rc).
|
||||
- The module will fail if RV(ignore:rc) is not zero.
|
||||
- The module fails if RV(ignore:rc) is not zero.
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
|
|
|
@ -15,7 +15,7 @@ module: django_manage
|
|||
short_description: Manages a Django application
|
||||
description:
|
||||
- Manages a Django application using the C(manage.py) application frontend to C(django-admin). With the O(virtualenv) parameter,
|
||||
all management commands will be executed by the given C(virtualenv) installation.
|
||||
all management commands are executed by the given C(virtualenv) installation.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
|
@ -34,8 +34,8 @@ options:
|
|||
- V(loaddata) - Searches for and loads the contents of the named O(fixtures) into the database.
|
||||
- V(migrate) - Synchronizes the database state with models and migrations.
|
||||
- V(test) - Runs tests for all installed apps.
|
||||
- Other commands can be entered, but will fail if they are unknown to Django. Other commands that may prompt for user
|
||||
input should be run with the C(--noinput) flag.
|
||||
- Custom commands can be entered, but they fail unless they are known to Django. Custom commands that may prompt for
|
||||
user input should be run with the C(--noinput) flag.
|
||||
- Support for the values V(cleanup), V(syncdb), V(validate) was removed in community.general 9.0.0. See note about supported
|
||||
versions of Django.
|
||||
type: str
|
||||
|
@ -62,7 +62,7 @@ options:
|
|||
virtualenv:
|
||||
description:
|
||||
- An optional path to a C(virtualenv) installation to use while running the manage application.
|
||||
- The virtual environment must exist, otherwise the module will fail.
|
||||
- The virtual environment must exist, otherwise the module fails.
|
||||
type: path
|
||||
aliases: [virtual_env]
|
||||
apps:
|
||||
|
@ -78,7 +78,7 @@ options:
|
|||
clear:
|
||||
description:
|
||||
- Clear the existing files before trying to copy or link the original file.
|
||||
- Used only with the V(collectstatic) command. The C(--noinput) argument will be added automatically.
|
||||
- Used only with the V(collectstatic) command. The C(--noinput) argument is added automatically.
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
|
@ -101,18 +101,18 @@ options:
|
|||
required: false
|
||||
skip:
|
||||
description:
|
||||
- Will skip over out-of-order missing migrations, you can only use this parameter with V(migrate) command.
|
||||
- Skips over out-of-order missing migrations, you can only use this parameter with V(migrate) command.
|
||||
required: false
|
||||
type: bool
|
||||
merge:
|
||||
description:
|
||||
- Will run out-of-order or missing migrations as they are not rollback migrations, you can only use this parameter with
|
||||
- Runs out-of-order or missing migrations as they are not rollback migrations, you can only use this parameter with
|
||||
V(migrate) command.
|
||||
required: false
|
||||
type: bool
|
||||
link:
|
||||
description:
|
||||
- Will create links to the files instead of copying them, you can only use this parameter with V(collectstatic) command.
|
||||
- Creates links to the files instead of copying them, you can only use this parameter with V(collectstatic) command.
|
||||
required: false
|
||||
type: bool
|
||||
testrunner:
|
||||
|
@ -128,7 +128,7 @@ notes:
|
|||
module allows for free-form commands, not verifying the version of Django being used, it is B(strongly recommended) to
|
||||
use a more recent version of the framework.'
|
||||
- Please notice that Django 4.1 requires Python 3.8 or greater.
|
||||
- This module will not create a virtualenv if the O(virtualenv) parameter is specified and a virtual environment does not
|
||||
- This module does not create a virtualenv if the O(virtualenv) parameter is specified and a virtual environment does not
|
||||
already exist at the given location. This behavior changed in community.general version 9.0.0.
|
||||
- The recommended way to create a virtual environment in Ansible is by using M(ansible.builtin.pip).
|
||||
- This module assumes English error messages for the V(createcachetable) command to detect table existence, unfortunately.
|
||||
|
|
|
@ -120,7 +120,7 @@ changed_repos:
|
|||
returned: success
|
||||
type: list
|
||||
elements: str
|
||||
sample: ['crb']
|
||||
sample: ["crb"]
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
|
|
@ -22,9 +22,9 @@ attributes:
|
|||
support: partial
|
||||
details:
|
||||
- The logics of the C(versionlock) plugin for corner cases could be confusing, so please take in account that this module
|
||||
will do its best to give a C(check_mode) prediction on what is going to happen. In case of doubt, check the documentation
|
||||
does its best to give a C(check_mode) prediction on what is going to happen. In case of doubt, check the documentation
|
||||
of the plugin.
|
||||
- Sometimes the module could predict changes in C(check_mode) that will not be such because C(versionlock) concludes
|
||||
- Sometimes the module could predict changes in C(check_mode) that are not fulfilled because C(versionlock) concludes
|
||||
that there is already a entry in C(locklist) that already matches.
|
||||
diff_mode:
|
||||
support: none
|
||||
|
@ -47,12 +47,12 @@ options:
|
|||
state:
|
||||
description:
|
||||
- Whether to add (V(present) or V(excluded)) to or remove (V(absent) or V(clean)) from the C(locklist).
|
||||
- V(present) will add a package name spec to the C(locklist). If there is a installed package that matches, then only
|
||||
that version will be added. Otherwise, all available package versions will be added.
|
||||
- V(excluded) will add a package name spec as excluded to the C(locklist). It means that packages represented by the
|
||||
package name spec will be excluded from transaction operations. All available package versions will be added.
|
||||
- V(absent) will delete entries in the C(locklist) that match the package name spec.
|
||||
- V(clean) will delete all entries in the C(locklist). This option is mutually exclusive with O(name).
|
||||
- V(present) adds a package name spec to the C(locklist). If there is a installed package that matches, then only that
|
||||
version is added. Otherwise, all available package versions are added.
|
||||
- V(excluded) adds a package name spec as excluded to the C(locklist). It means that packages represented by the package
|
||||
name spec are excluded from transaction operations. All available package versions are added.
|
||||
- V(absent) deletes entries in the C(locklist) that match the package name spec.
|
||||
- V(clean) deletes all entries in the C(locklist). This option is mutually exclusive with O(name).
|
||||
choices: ['absent', 'clean', 'excluded', 'present']
|
||||
type: str
|
||||
default: present
|
||||
|
@ -108,25 +108,25 @@ locklist_pre:
|
|||
returned: success
|
||||
type: list
|
||||
elements: str
|
||||
sample: ['bash-0:4.4.20-1.el8_4.*', '!bind-32:9.11.26-4.el8_4.*']
|
||||
sample: ["bash-0:4.4.20-1.el8_4.*", "!bind-32:9.11.26-4.el8_4.*"]
|
||||
locklist_post:
|
||||
description: Locklist after module execution.
|
||||
returned: success and (not check mode or state is clean)
|
||||
type: list
|
||||
elements: str
|
||||
sample: ['bash-0:4.4.20-1.el8_4.*']
|
||||
sample: ["bash-0:4.4.20-1.el8_4.*"]
|
||||
specs_toadd:
|
||||
description: Package name specs meant to be added by versionlock.
|
||||
returned: success
|
||||
type: list
|
||||
elements: str
|
||||
sample: ['bash']
|
||||
sample: ["bash"]
|
||||
specs_todelete:
|
||||
description: Package name specs meant to be deleted by versionlock.
|
||||
returned: success
|
||||
type: list
|
||||
elements: str
|
||||
sample: ['bind']
|
||||
sample: ["bind"]
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
|
|
@ -25,8 +25,8 @@ attributes:
|
|||
options:
|
||||
account_email:
|
||||
description:
|
||||
- Account email. If omitted, the environment variables E(DNSIMPLE_EMAIL) and E(DNSIMPLE_API_TOKEN) will be looked for.
|
||||
- 'If those variables are not found, a C(.dnsimple) file will be looked for, see: U(https://github.com/mikemaccana/dnsimple-python#getting-started).'
|
||||
- Account email. If omitted, the environment variables E(DNSIMPLE_EMAIL) and E(DNSIMPLE_API_TOKEN) are looked for.
|
||||
- 'If those variables are not found, a C(.dnsimple) file is looked for, see: U(https://github.com/mikemaccana/dnsimple-python#getting-started).'
|
||||
- C(.dnsimple) config files are only supported in dnsimple-python<2.0.0.
|
||||
type: str
|
||||
account_api_token:
|
||||
|
@ -36,12 +36,12 @@ options:
|
|||
domain:
|
||||
description:
|
||||
- Domain to work with. Can be the domain name (for example V(mydomain.com)) or the numeric ID of the domain in DNSimple.
|
||||
- If omitted, a list of domains will be returned.
|
||||
- If domain is present but the domain does not exist, it will be created.
|
||||
- If omitted, a list of domains is returned.
|
||||
- If domain is present but the domain does not exist, it is created.
|
||||
type: str
|
||||
record:
|
||||
description:
|
||||
- Record to add, if blank a record for the domain will be created, supports the wildcard (*).
|
||||
- Record to add, if blank a record for the domain is created, supports the wildcard (*).
|
||||
type: str
|
||||
record_ids:
|
||||
description:
|
||||
|
|
|
@ -26,8 +26,8 @@ options:
|
|||
name:
|
||||
description:
|
||||
- The domain name to retrieve info from.
|
||||
- Will return all associated records for this domain if specified.
|
||||
- If not specified, will return all domains associated with the account ID.
|
||||
- Returns all associated records for this domain if specified.
|
||||
- If not specified, returns all domains associated with the account ID.
|
||||
type: str
|
||||
|
||||
account_id:
|
||||
|
@ -43,7 +43,7 @@ options:
|
|||
record:
|
||||
description:
|
||||
- The record to find.
|
||||
- If specified, only this record will be returned instead of all records.
|
||||
- If specified, only this record is returned instead of all records.
|
||||
required: false
|
||||
type: str
|
||||
|
||||
|
|
|
@ -50,7 +50,7 @@ options:
|
|||
|
||||
record_name:
|
||||
description:
|
||||
- Record name to get/create/delete/update. If record_name is not specified; all records for the domain will be returned
|
||||
- Record name to get/create/delete/update. If O(record_name) is not specified; all records for the domain are returned
|
||||
in "result" regardless of the state argument.
|
||||
type: str
|
||||
|
||||
|
@ -64,8 +64,8 @@ options:
|
|||
description:
|
||||
- 'Record value. HTTPRED: <redirection URL>, MX: <priority> <target name>, NS: <name server>, PTR: <target name>, SRV:
|
||||
<priority> <weight> <port> <target name>, TXT: <text value>".'
|
||||
- If record_value is not specified; no changes will be made and the record will be returned in 'result' (in other words,
|
||||
this module can be used to fetch a record's current ID, type, and ttl).
|
||||
- If O(record_value) is not specified; no changes are made and the record is returned in RV(ignore:result) (in other
|
||||
words, this module can be used to fetch a record's current ID, type, and TTL).
|
||||
type: str
|
||||
|
||||
record_ttl:
|
||||
|
@ -83,8 +83,8 @@ options:
|
|||
|
||||
validate_certs:
|
||||
description:
|
||||
- If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
|
||||
self-signed certificates.
|
||||
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
|
||||
certificates.
|
||||
type: bool
|
||||
default: true
|
||||
|
||||
|
@ -128,7 +128,7 @@ options:
|
|||
|
||||
contactList:
|
||||
description:
|
||||
- Name or ID of the contact list that the monitor will notify.
|
||||
- Name or ID of the contact list that the monitor notifies.
|
||||
- The default V('') means the Account Owner.
|
||||
type: str
|
||||
|
||||
|
@ -195,7 +195,7 @@ notes:
|
|||
- Only A records can have a O(monitor) or O(failover).
|
||||
- To add failover, the O(failover), O(autoFailover), O(port), O(protocol), O(ip1), and O(ip2) options are required.
|
||||
- To add monitor, the O(monitor), O(port), O(protocol), O(maxEmails), O(systemDescription), and O(ip1) options are required.
|
||||
- The monitor and the failover will share O(port), O(protocol), and O(ip1) options.
|
||||
- The options O(monitor) and O(failover) share O(port), O(protocol), and O(ip1) options.
|
||||
requirements: [hashlib, hmac]
|
||||
author: "Brice Burgess (@briceburg)"
|
||||
"""
|
||||
|
|
|
@ -17,8 +17,8 @@ author:
|
|||
- quidame (@quidame)
|
||||
description:
|
||||
- A diversion is for C(dpkg) the knowledge that only a given package (or the local administrator) is allowed to install
|
||||
a file at a given location. Other packages shipping their own version of this file will be forced to O(divert) it, that
|
||||
is to install it at another location. It allows one to keep changes in a file provided by a debian package by preventing
|
||||
a file at a given location. Other packages shipping their own version of this file are forced to O(divert) it, that is
|
||||
to install it at another location. It allows one to keep changes in a file provided by a debian package by preventing
|
||||
it being overwritten on package upgrade.
|
||||
- This module manages diversions of debian packages files using the C(dpkg-divert) commandline tool. It can either create
|
||||
or remove a diversion for a given file, but also update an existing diversion to modify its O(holder) and/or its O(divert)
|
||||
|
@ -54,7 +54,7 @@ options:
|
|||
type: str
|
||||
divert:
|
||||
description:
|
||||
- The location where the versions of file will be diverted.
|
||||
- The location where the versions of file are diverted.
|
||||
- Default is to add suffix C(.distrib) to the file path.
|
||||
- This parameter is ignored when O(state=absent).
|
||||
type: path
|
||||
|
@ -70,7 +70,7 @@ options:
|
|||
force:
|
||||
description:
|
||||
- When O(rename=true) and O(force=true), renaming is performed even if the target of the renaming exists, in other words
|
||||
the existing contents of the file at this location will be lost.
|
||||
the existing contents of the file at this location are lost.
|
||||
- This parameter is ignored when O(rename=false).
|
||||
type: bool
|
||||
default: false
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue