mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
[PR #6699/7ae8cc99 backport][stable-7] Semantic markup: use E() in more places (#6700)
Semantic markup: use E() in more places (#6699)
Use semantic markup.
(cherry picked from commit 7ae8cc9902
)
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
94f23ee647
commit
6789f7939a
19 changed files with 93 additions and 93 deletions
|
@ -15,27 +15,27 @@ class ModuleDocFragment(object):
|
||||||
options:
|
options:
|
||||||
alicloud_access_key:
|
alicloud_access_key:
|
||||||
description:
|
description:
|
||||||
- Alibaba Cloud access key. If not set then the value of environment variable C(ALICLOUD_ACCESS_KEY),
|
- Alibaba Cloud access key. If not set then the value of environment variable E(ALICLOUD_ACCESS_KEY),
|
||||||
C(ALICLOUD_ACCESS_KEY_ID) will be used instead.
|
E(ALICLOUD_ACCESS_KEY_ID) will be used instead.
|
||||||
aliases: ['access_key_id', 'access_key']
|
aliases: ['access_key_id', 'access_key']
|
||||||
type: str
|
type: str
|
||||||
alicloud_secret_key:
|
alicloud_secret_key:
|
||||||
description:
|
description:
|
||||||
- Alibaba Cloud secret key. If not set then the value of environment variable C(ALICLOUD_SECRET_KEY),
|
- Alibaba Cloud secret key. If not set then the value of environment variable E(ALICLOUD_SECRET_KEY),
|
||||||
C(ALICLOUD_SECRET_ACCESS_KEY) will be used instead.
|
E(ALICLOUD_SECRET_ACCESS_KEY) will be used instead.
|
||||||
aliases: ['secret_access_key', 'secret_key']
|
aliases: ['secret_access_key', 'secret_key']
|
||||||
type: str
|
type: str
|
||||||
alicloud_region:
|
alicloud_region:
|
||||||
description:
|
description:
|
||||||
- The Alibaba Cloud region to use. If not specified then the value of environment variable
|
- The Alibaba Cloud region to use. If not specified then the value of environment variable
|
||||||
C(ALICLOUD_REGION), C(ALICLOUD_REGION_ID) will be used instead.
|
E(ALICLOUD_REGION), E(ALICLOUD_REGION_ID) will be used instead.
|
||||||
aliases: ['region', 'region_id']
|
aliases: ['region', 'region_id']
|
||||||
required: true
|
required: true
|
||||||
type: str
|
type: str
|
||||||
alicloud_security_token:
|
alicloud_security_token:
|
||||||
description:
|
description:
|
||||||
- The Alibaba Cloud security token. If not specified then the value of environment variable
|
- The Alibaba Cloud security token. If not specified then the value of environment variable
|
||||||
C(ALICLOUD_SECURITY_TOKEN) will be used instead.
|
E(ALICLOUD_SECURITY_TOKEN) will be used instead.
|
||||||
aliases: ['security_token']
|
aliases: ['security_token']
|
||||||
type: str
|
type: str
|
||||||
alicloud_assume_role:
|
alicloud_assume_role:
|
||||||
|
@ -48,7 +48,7 @@ options:
|
||||||
alicloud_assume_role_arn:
|
alicloud_assume_role_arn:
|
||||||
description:
|
description:
|
||||||
- The Alibaba Cloud role_arn. The ARN of the role to assume. If ARN is set to an empty string,
|
- The Alibaba Cloud role_arn. The ARN of the role to assume. If ARN is set to an empty string,
|
||||||
it does not perform role switching. It supports environment variable ALICLOUD_ASSUME_ROLE_ARN.
|
it does not perform role switching. It supports environment variable E(ALICLOUD_ASSUME_ROLE_ARN).
|
||||||
ansible will execute with provided credentials.
|
ansible will execute with provided credentials.
|
||||||
aliases: ['assume_role_arn']
|
aliases: ['assume_role_arn']
|
||||||
type: str
|
type: str
|
||||||
|
@ -56,14 +56,14 @@ options:
|
||||||
description:
|
description:
|
||||||
- The Alibaba Cloud session_name. The session name to use when assuming the role. If omitted,
|
- The Alibaba Cloud session_name. The session name to use when assuming the role. If omitted,
|
||||||
'ansible' is passed to the AssumeRole call as session name. It supports environment variable
|
'ansible' is passed to the AssumeRole call as session name. It supports environment variable
|
||||||
ALICLOUD_ASSUME_ROLE_SESSION_NAME
|
E(ALICLOUD_ASSUME_ROLE_SESSION_NAME).
|
||||||
aliases: ['assume_role_session_name']
|
aliases: ['assume_role_session_name']
|
||||||
type: str
|
type: str
|
||||||
alicloud_assume_role_session_expiration:
|
alicloud_assume_role_session_expiration:
|
||||||
description:
|
description:
|
||||||
- The Alibaba Cloud session_expiration. The time after which the established session for assuming
|
- The Alibaba Cloud session_expiration. The time after which the established session for assuming
|
||||||
role expires. Valid value range 900-3600 seconds. Default to 3600 (in this case Alicloud use own default
|
role expires. Valid value range 900-3600 seconds. Default to 3600 (in this case Alicloud use own default
|
||||||
value). It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION
|
value). It supports environment variable E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION).
|
||||||
aliases: ['assume_role_session_expiration']
|
aliases: ['assume_role_session_expiration']
|
||||||
type: int
|
type: int
|
||||||
ecs_role_name:
|
ecs_role_name:
|
||||||
|
@ -79,11 +79,11 @@ options:
|
||||||
profile:
|
profile:
|
||||||
description:
|
description:
|
||||||
- This is the Alicloud profile name as set in the shared credentials file. It can also be sourced from the
|
- This is the Alicloud profile name as set in the shared credentials file. It can also be sourced from the
|
||||||
ALICLOUD_PROFILE environment variable.
|
E(ALICLOUD_PROFILE) environment variable.
|
||||||
type: str
|
type: str
|
||||||
shared_credentials_file:
|
shared_credentials_file:
|
||||||
description:
|
description:
|
||||||
- This is the path to the shared credentials file. It can also be sourced from the ALICLOUD_SHARED_CREDENTIALS_FILE
|
- This is the path to the shared credentials file. It can also be sourced from the E(ALICLOUD_SHARED_CREDENTIALS_FILE)
|
||||||
environment variable.
|
environment variable.
|
||||||
- If this is not set and a profile is specified, ~/.aliyun/config.json will be used.
|
- If this is not set and a profile is specified, ~/.aliyun/config.json will be used.
|
||||||
type: str
|
type: str
|
||||||
|
@ -94,16 +94,16 @@ requirements:
|
||||||
notes:
|
notes:
|
||||||
- If parameters are not set within the module, the following
|
- If parameters are not set within the module, the following
|
||||||
environment variables can be used in decreasing order of precedence
|
environment variables can be used in decreasing order of precedence
|
||||||
C(ALICLOUD_ACCESS_KEY) or C(ALICLOUD_ACCESS_KEY_ID),
|
E(ALICLOUD_ACCESS_KEY) or E(ALICLOUD_ACCESS_KEY_ID),
|
||||||
C(ALICLOUD_SECRET_KEY) or C(ALICLOUD_SECRET_ACCESS_KEY),
|
E(ALICLOUD_SECRET_KEY) or E(ALICLOUD_SECRET_ACCESS_KEY),
|
||||||
C(ALICLOUD_REGION) or C(ALICLOUD_REGION_ID),
|
E(ALICLOUD_REGION) or E(ALICLOUD_REGION_ID),
|
||||||
C(ALICLOUD_SECURITY_TOKEN),
|
E(ALICLOUD_SECURITY_TOKEN),
|
||||||
C(ALICLOUD_ECS_ROLE_NAME),
|
E(ALICLOUD_ECS_ROLE_NAME),
|
||||||
C(ALICLOUD_SHARED_CREDENTIALS_FILE),
|
E(ALICLOUD_SHARED_CREDENTIALS_FILE),
|
||||||
C(ALICLOUD_PROFILE),
|
E(ALICLOUD_PROFILE),
|
||||||
C(ALICLOUD_ASSUME_ROLE_ARN),
|
E(ALICLOUD_ASSUME_ROLE_ARN),
|
||||||
C(ALICLOUD_ASSUME_ROLE_SESSION_NAME),
|
E(ALICLOUD_ASSUME_ROLE_SESSION_NAME),
|
||||||
C(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION),
|
E(ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION),
|
||||||
- C(ALICLOUD_REGION) or C(ALICLOUD_REGION_ID) can be typically be used to specify the
|
- E(ALICLOUD_REGION) or E(ALICLOUD_REGION_ID) can be typically be used to specify the
|
||||||
ALICLOUD region, when required, but this can also be configured in the footmark config file
|
ALICLOUD region, when required, but this can also be configured in the footmark config file
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -16,17 +16,17 @@ options:
|
||||||
client_id:
|
client_id:
|
||||||
description:
|
description:
|
||||||
- The OAuth consumer key.
|
- The OAuth consumer key.
|
||||||
- If not set the environment variable C(BITBUCKET_CLIENT_ID) will be used.
|
- If not set the environment variable E(BITBUCKET_CLIENT_ID) will be used.
|
||||||
type: str
|
type: str
|
||||||
client_secret:
|
client_secret:
|
||||||
description:
|
description:
|
||||||
- The OAuth consumer secret.
|
- The OAuth consumer secret.
|
||||||
- If not set the environment variable C(BITBUCKET_CLIENT_SECRET) will be used.
|
- If not set the environment variable E(BITBUCKET_CLIENT_SECRET) will be used.
|
||||||
type: str
|
type: str
|
||||||
user:
|
user:
|
||||||
description:
|
description:
|
||||||
- The username.
|
- The username.
|
||||||
- If not set the environment variable C(BITBUCKET_USERNAME) will be used.
|
- If not set the environment variable E(BITBUCKET_USERNAME) will be used.
|
||||||
- O(ignore:username) is an alias of O(user) since community.general 6.0.0. It was an alias of O(workspace) before.
|
- O(ignore:username) is an alias of O(user) since community.general 6.0.0. It was an alias of O(workspace) before.
|
||||||
type: str
|
type: str
|
||||||
version_added: 4.0.0
|
version_added: 4.0.0
|
||||||
|
@ -34,7 +34,7 @@ options:
|
||||||
password:
|
password:
|
||||||
description:
|
description:
|
||||||
- The App password.
|
- The App password.
|
||||||
- If not set the environment variable C(BITBUCKET_PASSWORD) will be used.
|
- If not set the environment variable E(BITBUCKET_PASSWORD) will be used.
|
||||||
type: str
|
type: str
|
||||||
version_added: 4.0.0
|
version_added: 4.0.0
|
||||||
notes:
|
notes:
|
||||||
|
|
|
@ -29,12 +29,12 @@ options:
|
||||||
mcp_user:
|
mcp_user:
|
||||||
description:
|
description:
|
||||||
- The username used to authenticate to the CloudControl API.
|
- The username used to authenticate to the CloudControl API.
|
||||||
- If not specified, will fall back to C(MCP_USER) from environment variable or C(~/.dimensiondata).
|
- If not specified, will fall back to E(MCP_USER) from environment variable or C(~/.dimensiondata).
|
||||||
type: str
|
type: str
|
||||||
mcp_password:
|
mcp_password:
|
||||||
description:
|
description:
|
||||||
- The password used to authenticate to the CloudControl API.
|
- The password used to authenticate to the CloudControl API.
|
||||||
- If not specified, will fall back to C(MCP_PASSWORD) from environment variable or C(~/.dimensiondata).
|
- If not specified, will fall back to E(MCP_PASSWORD) from environment variable or C(~/.dimensiondata).
|
||||||
- Required if O(mcp_user) is specified.
|
- Required if O(mcp_user) is specified.
|
||||||
type: str
|
type: str
|
||||||
location:
|
location:
|
||||||
|
|
|
@ -51,16 +51,16 @@ options:
|
||||||
type: str
|
type: str
|
||||||
notes:
|
notes:
|
||||||
- For authentication, you can set identity_endpoint using the
|
- For authentication, you can set identity_endpoint using the
|
||||||
C(ANSIBLE_HWC_IDENTITY_ENDPOINT) env variable.
|
E(ANSIBLE_HWC_IDENTITY_ENDPOINT) env variable.
|
||||||
- For authentication, you can set user using the
|
- For authentication, you can set user using the
|
||||||
C(ANSIBLE_HWC_USER) env variable.
|
E(ANSIBLE_HWC_USER) env variable.
|
||||||
- For authentication, you can set password using the C(ANSIBLE_HWC_PASSWORD) env
|
- For authentication, you can set password using the E(ANSIBLE_HWC_PASSWORD) env
|
||||||
variable.
|
variable.
|
||||||
- For authentication, you can set domain using the C(ANSIBLE_HWC_DOMAIN) env
|
- For authentication, you can set domain using the E(ANSIBLE_HWC_DOMAIN) env
|
||||||
variable.
|
variable.
|
||||||
- For authentication, you can set project using the C(ANSIBLE_HWC_PROJECT) env
|
- For authentication, you can set project using the E(ANSIBLE_HWC_PROJECT) env
|
||||||
variable.
|
variable.
|
||||||
- For authentication, you can set region using the C(ANSIBLE_HWC_REGION) env variable.
|
- For authentication, you can set region using the E(ANSIBLE_HWC_REGION) env variable.
|
||||||
- Environment variables values will only be used if the playbook values are
|
- Environment variables values will only be used if the playbook values are
|
||||||
not set.
|
not set.
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -22,14 +22,14 @@ options:
|
||||||
username:
|
username:
|
||||||
description:
|
description:
|
||||||
- Username that will be used to authenticate against InfluxDB server.
|
- Username that will be used to authenticate against InfluxDB server.
|
||||||
- Alias O(ignore:login_username) added in Ansible 2.5.
|
- Alias O(login_username) added in Ansible 2.5.
|
||||||
type: str
|
type: str
|
||||||
default: root
|
default: root
|
||||||
aliases: [ login_username ]
|
aliases: [ login_username ]
|
||||||
password:
|
password:
|
||||||
description:
|
description:
|
||||||
- Password that will be used to authenticate against InfluxDB server.
|
- Password that will be used to authenticate against InfluxDB server.
|
||||||
- Alias O(ignore:login_password) added in Ansible 2.5.
|
- Alias O(login_password) added in Ansible 2.5.
|
||||||
type: str
|
type: str
|
||||||
default: root
|
default: root
|
||||||
aliases: [ login_password ]
|
aliases: [ login_password ]
|
||||||
|
|
|
@ -16,44 +16,44 @@ options:
|
||||||
ipa_port:
|
ipa_port:
|
||||||
description:
|
description:
|
||||||
- Port of FreeIPA / IPA server.
|
- Port of FreeIPA / IPA server.
|
||||||
- If the value is not specified in the task, the value of environment variable C(IPA_PORT) will be used instead.
|
- If the value is not specified in the task, the value of environment variable E(IPA_PORT) will be used instead.
|
||||||
- If both the environment variable C(IPA_PORT) and the value are not specified in the task, then default value is set.
|
- If both the environment variable E(IPA_PORT) and the value are not specified in the task, then default value is set.
|
||||||
- Environment variable fallback mechanism is added in Ansible 2.5.
|
- Environment variable fallback mechanism is added in Ansible 2.5.
|
||||||
type: int
|
type: int
|
||||||
default: 443
|
default: 443
|
||||||
ipa_host:
|
ipa_host:
|
||||||
description:
|
description:
|
||||||
- IP or hostname of IPA server.
|
- IP or hostname of IPA server.
|
||||||
- If the value is not specified in the task, the value of environment variable C(IPA_HOST) will be used instead.
|
- If the value is not specified in the task, the value of environment variable E(IPA_HOST) will be used instead.
|
||||||
- If both the environment variable C(IPA_HOST) and the value are not specified in the task, then DNS will be used to try to discover the FreeIPA server.
|
- If both the environment variable E(IPA_HOST) and the value are not specified in the task, then DNS will be used to try to discover the FreeIPA server.
|
||||||
- The relevant entry needed in FreeIPA is the 'ipa-ca' entry.
|
- The relevant entry needed in FreeIPA is the 'ipa-ca' entry.
|
||||||
- If neither the DNS entry, nor the environment C(IPA_HOST), nor the value are available in the task, then the default value will be used.
|
- If neither the DNS entry, nor the environment E(IPA_HOST), nor the value are available in the task, then the default value will be used.
|
||||||
- Environment variable fallback mechanism is added in Ansible 2.5.
|
- Environment variable fallback mechanism is added in Ansible 2.5.
|
||||||
type: str
|
type: str
|
||||||
default: ipa.example.com
|
default: ipa.example.com
|
||||||
ipa_user:
|
ipa_user:
|
||||||
description:
|
description:
|
||||||
- Administrative account used on IPA server.
|
- Administrative account used on IPA server.
|
||||||
- If the value is not specified in the task, the value of environment variable C(IPA_USER) will be used instead.
|
- If the value is not specified in the task, the value of environment variable E(IPA_USER) will be used instead.
|
||||||
- If both the environment variable C(IPA_USER) and the value are not specified in the task, then default value is set.
|
- If both the environment variable E(IPA_USER) and the value are not specified in the task, then default value is set.
|
||||||
- Environment variable fallback mechanism is added in Ansible 2.5.
|
- Environment variable fallback mechanism is added in Ansible 2.5.
|
||||||
type: str
|
type: str
|
||||||
default: admin
|
default: admin
|
||||||
ipa_pass:
|
ipa_pass:
|
||||||
description:
|
description:
|
||||||
- Password of administrative user.
|
- Password of administrative user.
|
||||||
- If the value is not specified in the task, the value of environment variable C(IPA_PASS) will be used instead.
|
- If the value is not specified in the task, the value of environment variable E(IPA_PASS) will be used instead.
|
||||||
- Note that if the 'urllib_gssapi' library is available, it is possible to use GSSAPI to authenticate to FreeIPA.
|
- Note that if the C(urllib_gssapi) library is available, it is possible to use GSSAPI to authenticate to FreeIPA.
|
||||||
- If the environment variable C(KRB5CCNAME) is available, the module will use this kerberos credentials cache to authenticate to the FreeIPA server.
|
- If the environment variable E(KRB5CCNAME) is available, the module will use this kerberos credentials cache to authenticate to the FreeIPA server.
|
||||||
- If the environment variable C(KRB5_CLIENT_KTNAME) is available, and C(KRB5CCNAME) is not; the module will use this kerberos keytab to authenticate.
|
- If the environment variable E(KRB5_CLIENT_KTNAME) is available, and E(KRB5CCNAME) is not; the module will use this kerberos keytab to authenticate.
|
||||||
- If GSSAPI is not available, the usage of 'ipa_pass' is required.
|
- If GSSAPI is not available, the usage of O(ipa_pass) is required.
|
||||||
- Environment variable fallback mechanism is added in Ansible 2.5.
|
- Environment variable fallback mechanism is added in Ansible 2.5.
|
||||||
type: str
|
type: str
|
||||||
ipa_prot:
|
ipa_prot:
|
||||||
description:
|
description:
|
||||||
- Protocol used by IPA server.
|
- Protocol used by IPA server.
|
||||||
- If the value is not specified in the task, the value of environment variable C(IPA_PROT) will be used instead.
|
- If the value is not specified in the task, the value of environment variable E(IPA_PROT) will be used instead.
|
||||||
- If both the environment variable C(IPA_PROT) and the value are not specified in the task, then default value is set.
|
- If both the environment variable E(IPA_PROT) and the value are not specified in the task, then default value is set.
|
||||||
- Environment variable fallback mechanism is added in Ansible 2.5.
|
- Environment variable fallback mechanism is added in Ansible 2.5.
|
||||||
type: str
|
type: str
|
||||||
choices: [ http, https ]
|
choices: [ http, https ]
|
||||||
|
@ -69,8 +69,8 @@ options:
|
||||||
description:
|
description:
|
||||||
- Specifies idle timeout (in seconds) for the connection.
|
- Specifies idle timeout (in seconds) for the connection.
|
||||||
- For bulk operations, you may want to increase this in order to avoid timeout from IPA server.
|
- For bulk operations, you may want to increase this in order to avoid timeout from IPA server.
|
||||||
- If the value is not specified in the task, the value of environment variable C(IPA_TIMEOUT) will be used instead.
|
- If the value is not specified in the task, the value of environment variable E(IPA_TIMEOUT) will be used instead.
|
||||||
- If both the environment variable C(IPA_TIMEOUT) and the value are not specified in the task, then default value is set.
|
- If both the environment variable E(IPA_TIMEOUT) and the value are not specified in the task, then default value is set.
|
||||||
type: int
|
type: int
|
||||||
default: 10
|
default: 10
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -21,30 +21,30 @@ options:
|
||||||
suboptions:
|
suboptions:
|
||||||
url:
|
url:
|
||||||
description:
|
description:
|
||||||
- ManageIQ environment URL. C(MIQ_URL) environment variable if set. otherwise, it is required to pass it.
|
- ManageIQ environment URL. E(MIQ_URL) environment variable if set. Otherwise, it is required to pass it.
|
||||||
type: str
|
type: str
|
||||||
required: false
|
required: false
|
||||||
username:
|
username:
|
||||||
description:
|
description:
|
||||||
- ManageIQ username. C(MIQ_USERNAME) environment variable if set. otherwise, required if no token is passed in.
|
- ManageIQ username. E(MIQ_USERNAME) environment variable if set. Otherwise, required if no token is passed in.
|
||||||
type: str
|
type: str
|
||||||
password:
|
password:
|
||||||
description:
|
description:
|
||||||
- ManageIQ password. C(MIQ_PASSWORD) environment variable if set. otherwise, required if no token is passed in.
|
- ManageIQ password. E(MIQ_PASSWORD) environment variable if set. Otherwise, required if no token is passed in.
|
||||||
type: str
|
type: str
|
||||||
token:
|
token:
|
||||||
description:
|
description:
|
||||||
- ManageIQ token. C(MIQ_TOKEN) environment variable if set. otherwise, required if no username or password is passed in.
|
- ManageIQ token. E(MIQ_TOKEN) environment variable if set. Otherwise, required if no username or password is passed in.
|
||||||
type: str
|
type: str
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- Whether SSL certificates should be verified for HTTPS requests. defaults to True.
|
- Whether SSL certificates should be verified for HTTPS requests.
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
aliases: [ verify_ssl ]
|
aliases: [ verify_ssl ]
|
||||||
ca_cert:
|
ca_cert:
|
||||||
description:
|
description:
|
||||||
- The path to a CA bundle file or directory with certificates. defaults to None.
|
- The path to a CA bundle file or directory with certificates.
|
||||||
type: str
|
type: str
|
||||||
aliases: [ ca_bundle_path ]
|
aliases: [ ca_bundle_path ]
|
||||||
|
|
||||||
|
|
|
@ -39,7 +39,7 @@ notes:
|
||||||
- Also see the API documentation on U(https://console.online.net/en/api/)
|
- Also see the API documentation on U(https://console.online.net/en/api/)
|
||||||
- If O(api_token) is not set within the module, the following
|
- If O(api_token) is not set within the module, the following
|
||||||
environment variables can be used in decreasing order of precedence
|
environment variables can be used in decreasing order of precedence
|
||||||
C(ONLINE_TOKEN), C(ONLINE_API_KEY), C(ONLINE_OAUTH_TOKEN), C(ONLINE_API_TOKEN)
|
E(ONLINE_TOKEN), E(ONLINE_API_KEY), E(ONLINE_OAUTH_TOKEN), E(ONLINE_API_TOKEN).
|
||||||
- If one wants to use a different O(api_url) one can also set the C(ONLINE_API_URL)
|
- If one wants to use a different O(api_url) one can also set the E(ONLINE_API_URL)
|
||||||
environment variable.
|
environment variable.
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -15,26 +15,26 @@ options:
|
||||||
api_url:
|
api_url:
|
||||||
description:
|
description:
|
||||||
- The ENDPOINT URL of the XMLRPC server.
|
- The ENDPOINT URL of the XMLRPC server.
|
||||||
- If not specified then the value of the C(ONE_URL) environment variable, if any, is used.
|
- If not specified then the value of the E(ONE_URL) environment variable, if any, is used.
|
||||||
type: str
|
type: str
|
||||||
aliases:
|
aliases:
|
||||||
- api_endpoint
|
- api_endpoint
|
||||||
api_username:
|
api_username:
|
||||||
description:
|
description:
|
||||||
- The name of the user for XMLRPC authentication.
|
- The name of the user for XMLRPC authentication.
|
||||||
- If not specified then the value of the C(ONE_USERNAME) environment variable, if any, is used.
|
- If not specified then the value of the E(ONE_USERNAME) environment variable, if any, is used.
|
||||||
type: str
|
type: str
|
||||||
api_password:
|
api_password:
|
||||||
description:
|
description:
|
||||||
- The password or token for XMLRPC authentication.
|
- The password or token for XMLRPC authentication.
|
||||||
- If not specified then the value of the C(ONE_PASSWORD) environment variable, if any, is used.
|
- If not specified then the value of the E(ONE_PASSWORD) environment variable, if any, is used.
|
||||||
type: str
|
type: str
|
||||||
aliases:
|
aliases:
|
||||||
- api_token
|
- api_token
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- Whether to validate the TLS/SSL certificates or not.
|
- Whether to validate the TLS/SSL certificates or not.
|
||||||
- This parameter is ignored if C(PYTHONHTTPSVERIFY) environment variable is used.
|
- This parameter is ignored if E(PYTHONHTTPSVERIFY) environment variable is used.
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
wait_timeout:
|
wait_timeout:
|
||||||
|
|
|
@ -36,7 +36,7 @@ options:
|
||||||
either the CLI login or the eAPI authentication depending on which
|
either the CLI login or the eAPI authentication depending on which
|
||||||
transport is used. Note this argument does not affect the SSH
|
transport is used. Note this argument does not affect the SSH
|
||||||
transport. If the value is not specified in the task, the value of
|
transport. If the value is not specified in the task, the value of
|
||||||
environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
|
environment variable E(ANSIBLE_NET_USERNAME) will be used instead.
|
||||||
type: str
|
type: str
|
||||||
password:
|
password:
|
||||||
description:
|
description:
|
||||||
|
@ -44,7 +44,7 @@ options:
|
||||||
the remote device. This is a common argument used for either O(transport=cli)
|
the remote device. This is a common argument used for either O(transport=cli)
|
||||||
or O(transport=rest). Note this argument does not affect the SSH
|
or O(transport=rest). Note this argument does not affect the SSH
|
||||||
transport. If the value is not specified in the task, the value of
|
transport. If the value is not specified in the task, the value of
|
||||||
environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
|
environment variable E(ANSIBLE_NET_PASSWORD) will be used instead.
|
||||||
type: str
|
type: str
|
||||||
timeout:
|
timeout:
|
||||||
description:
|
description:
|
||||||
|
@ -58,7 +58,7 @@ options:
|
||||||
- Specifies the SSH key to use to authenticate the connection to
|
- Specifies the SSH key to use to authenticate the connection to
|
||||||
the remote device. This argument is only used for O(transport=cli).
|
the remote device. This argument is only used for O(transport=cli).
|
||||||
If the value is not specified in the task, the value of
|
If the value is not specified in the task, the value of
|
||||||
environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
|
environment variable E(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
|
||||||
type: path
|
type: path
|
||||||
transport:
|
transport:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -18,26 +18,26 @@ class ModuleDocFragment(object):
|
||||||
options:
|
options:
|
||||||
config_file_location:
|
config_file_location:
|
||||||
description:
|
description:
|
||||||
- Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable,
|
- Path to configuration file. If not set then the value of the E(OCI_CONFIG_FILE) environment variable,
|
||||||
if any, is used. Otherwise, defaults to ~/.oci/config.
|
if any, is used. Otherwise, defaults to ~/.oci/config.
|
||||||
type: str
|
type: str
|
||||||
config_profile_name:
|
config_profile_name:
|
||||||
description:
|
description:
|
||||||
- The profile to load from the config file referenced by O(config_file_location). If not set, then the
|
- The profile to load from the config file referenced by O(config_file_location). If not set, then the
|
||||||
value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the
|
value of the E(OCI_CONFIG_PROFILE) environment variable, if any, is used. Otherwise, defaults to the
|
||||||
"DEFAULT" profile in O(config_file_location).
|
"DEFAULT" profile in O(config_file_location).
|
||||||
default: "DEFAULT"
|
default: "DEFAULT"
|
||||||
type: str
|
type: str
|
||||||
api_user:
|
api_user:
|
||||||
description:
|
description:
|
||||||
- The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the
|
- The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the
|
||||||
value of the OCI_USER_OCID environment variable, if any, is used. This option is required if the user
|
value of the E(OCI_USER_OCID) environment variable, if any, is used. This option is required if the user
|
||||||
is not specified through a configuration file (See O(config_file_location)). To get the user's OCID,
|
is not specified through a configuration file (See O(config_file_location)). To get the user's OCID,
|
||||||
please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
|
please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
|
||||||
type: str
|
type: str
|
||||||
api_user_fingerprint:
|
api_user_fingerprint:
|
||||||
description:
|
description:
|
||||||
- Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT
|
- Fingerprint for the key pair being used. If not set, then the value of the E(OCI_USER_FINGERPRINT)
|
||||||
environment variable, if any, is used. This option is required if the key fingerprint is not
|
environment variable, if any, is used. This option is required if the key fingerprint is not
|
||||||
specified through a configuration file (See O(config_file_location)). To get the key pair's
|
specified through a configuration file (See O(config_file_location)). To get the key pair's
|
||||||
fingerprint value please refer
|
fingerprint value please refer
|
||||||
|
|
|
@ -24,7 +24,7 @@ options:
|
||||||
api_password:
|
api_password:
|
||||||
description:
|
description:
|
||||||
- Specify the password to authenticate with.
|
- Specify the password to authenticate with.
|
||||||
- You can use C(PROXMOX_PASSWORD) environment variable.
|
- You can use E(PROXMOX_PASSWORD) environment variable.
|
||||||
type: str
|
type: str
|
||||||
api_token_id:
|
api_token_id:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -33,7 +33,7 @@ options:
|
||||||
type: str
|
type: str
|
||||||
notes:
|
notes:
|
||||||
- This module requires the C(purity_fb) Python library
|
- This module requires the C(purity_fb) Python library
|
||||||
- You must set C(PUREFB_URL) and C(PUREFB_API) environment variables
|
- You must set E(PUREFB_URL) and E(PUREFB_API) environment variables
|
||||||
if O(fb_url) and O(api_token) arguments are not passed to the module directly
|
if O(fb_url) and O(api_token) arguments are not passed to the module directly
|
||||||
requirements:
|
requirements:
|
||||||
- python >= 2.7
|
- python >= 2.7
|
||||||
|
@ -55,7 +55,7 @@ options:
|
||||||
required: true
|
required: true
|
||||||
notes:
|
notes:
|
||||||
- This module requires the C(purestorage) Python library
|
- This module requires the C(purestorage) Python library
|
||||||
- You must set C(PUREFA_URL) and C(PUREFA_API) environment variables
|
- You must set E(PUREFA_URL) and E(PUREFA_API) environment variables
|
||||||
if O(fa_url) and O(api_token) arguments are not passed to the module directly
|
if O(fa_url) and O(api_token) arguments are not passed to the module directly
|
||||||
requirements:
|
requirements:
|
||||||
- python >= 2.7
|
- python >= 2.7
|
||||||
|
|
|
@ -46,12 +46,12 @@ requirements:
|
||||||
- python >= 2.6
|
- python >= 2.6
|
||||||
- pyrax
|
- pyrax
|
||||||
notes:
|
notes:
|
||||||
- The following environment variables can be used, C(RAX_USERNAME),
|
- The following environment variables can be used, E(RAX_USERNAME),
|
||||||
C(RAX_API_KEY), C(RAX_CREDS_FILE), C(RAX_CREDENTIALS), C(RAX_REGION).
|
E(RAX_API_KEY), E(RAX_CREDS_FILE), E(RAX_CREDENTIALS), E(RAX_REGION).
|
||||||
- C(RAX_CREDENTIALS) and C(RAX_CREDS_FILE) points to a credentials file
|
- E(RAX_CREDENTIALS) and E(RAX_CREDS_FILE) point to a credentials file
|
||||||
appropriate for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating)
|
appropriate for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating)
|
||||||
- C(RAX_USERNAME) and C(RAX_API_KEY) obviate the use of a credentials file
|
- E(RAX_USERNAME) and E(RAX_API_KEY) obviate the use of a credentials file
|
||||||
- C(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)
|
- E(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)
|
||||||
'''
|
'''
|
||||||
|
|
||||||
# Documentation fragment including attributes to enable communication
|
# Documentation fragment including attributes to enable communication
|
||||||
|
@ -113,10 +113,10 @@ requirements:
|
||||||
- python >= 2.6
|
- python >= 2.6
|
||||||
- pyrax
|
- pyrax
|
||||||
notes:
|
notes:
|
||||||
- The following environment variables can be used, C(RAX_USERNAME),
|
- The following environment variables can be used, E(RAX_USERNAME),
|
||||||
C(RAX_API_KEY), C(RAX_CREDS_FILE), C(RAX_CREDENTIALS), C(RAX_REGION).
|
E(RAX_API_KEY), E(RAX_CREDS_FILE), E(RAX_CREDENTIALS), E(RAX_REGION).
|
||||||
- C(RAX_CREDENTIALS) and C(RAX_CREDS_FILE) points to a credentials file
|
- E(RAX_CREDENTIALS) and E(RAX_CREDS_FILE) points to a credentials file
|
||||||
appropriate for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating)
|
appropriate for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating)
|
||||||
- C(RAX_USERNAME) and C(RAX_API_KEY) obviate the use of a credentials file
|
- E(RAX_USERNAME) and E(RAX_API_KEY) obviate the use of a credentials file
|
||||||
- C(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)
|
- E(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -45,7 +45,7 @@ notes:
|
||||||
- Also see the API documentation on U(https://developer.scaleway.com/)
|
- Also see the API documentation on U(https://developer.scaleway.com/)
|
||||||
- If O(api_token) is not set within the module, the following
|
- If O(api_token) is not set within the module, the following
|
||||||
environment variables can be used in decreasing order of precedence
|
environment variables can be used in decreasing order of precedence
|
||||||
C(SCW_TOKEN), C(SCW_API_KEY), C(SCW_OAUTH_TOKEN) or C(SCW_API_TOKEN).
|
E(SCW_TOKEN), E(SCW_API_KEY), E(SCW_OAUTH_TOKEN) or E(SCW_API_TOKEN).
|
||||||
- If one wants to use a different O(api_url) one can also set the C(SCW_API_URL)
|
- If one wants to use a different O(api_url) one can also set the E(SCW_API_URL)
|
||||||
environment variable.
|
environment variable.
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -15,27 +15,27 @@ options:
|
||||||
hostname:
|
hostname:
|
||||||
description:
|
description:
|
||||||
- The hostname or IP address of the XenServer host or XenServer pool master.
|
- The hostname or IP address of the XenServer host or XenServer pool master.
|
||||||
- If the value is not specified in the task, the value of environment variable C(XENSERVER_HOST) will be used instead.
|
- If the value is not specified in the task, the value of environment variable E(XENSERVER_HOST) will be used instead.
|
||||||
type: str
|
type: str
|
||||||
default: localhost
|
default: localhost
|
||||||
aliases: [ host, pool ]
|
aliases: [ host, pool ]
|
||||||
username:
|
username:
|
||||||
description:
|
description:
|
||||||
- The username to use for connecting to XenServer.
|
- The username to use for connecting to XenServer.
|
||||||
- If the value is not specified in the task, the value of environment variable C(XENSERVER_USER) will be used instead.
|
- If the value is not specified in the task, the value of environment variable E(XENSERVER_USER) will be used instead.
|
||||||
type: str
|
type: str
|
||||||
default: root
|
default: root
|
||||||
aliases: [ admin, user ]
|
aliases: [ admin, user ]
|
||||||
password:
|
password:
|
||||||
description:
|
description:
|
||||||
- The password to use for connecting to XenServer.
|
- The password to use for connecting to XenServer.
|
||||||
- If the value is not specified in the task, the value of environment variable C(XENSERVER_PASSWORD) will be used instead.
|
- If the value is not specified in the task, the value of environment variable E(XENSERVER_PASSWORD) will be used instead.
|
||||||
type: str
|
type: str
|
||||||
aliases: [ pass, pwd ]
|
aliases: [ pass, pwd ]
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
|
- Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted.
|
||||||
- If the value is not specified in the task, the value of environment variable C(XENSERVER_VALIDATE_CERTS) will be used instead.
|
- If the value is not specified in the task, the value of environment variable E(XENSERVER_VALIDATE_CERTS) will be used instead.
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -72,7 +72,7 @@ DOCUMENTATION = r'''
|
||||||
description:
|
description:
|
||||||
- If an instance has multiple network interfaces, select which one is the prefered as pattern.
|
- If an instance has multiple network interfaces, select which one is the prefered as pattern.
|
||||||
- Combined with the first number that can be found e.g. 'eth' + 0.
|
- Combined with the first number that can be found e.g. 'eth' + 0.
|
||||||
- The option has been renamed from O(ignore:prefered_container_network_interface) to O(prefered_instance_network_interface)
|
- The option has been renamed from O(prefered_container_network_interface) to O(prefered_instance_network_interface)
|
||||||
in community.general 3.8.0. The old name still works as an alias.
|
in community.general 3.8.0. The old name still works as an alias.
|
||||||
type: str
|
type: str
|
||||||
default: eth
|
default: eth
|
||||||
|
|
|
@ -13,7 +13,7 @@ DOCUMENTATION = """
|
||||||
- bw (command line utility)
|
- bw (command line utility)
|
||||||
- be logged into bitwarden
|
- be logged into bitwarden
|
||||||
- bitwarden vault unlocked
|
- bitwarden vault unlocked
|
||||||
- C(BW_SESSION) environment variable set
|
- E(BW_SESSION) environment variable set
|
||||||
short_description: Retrieve secrets from Bitwarden
|
short_description: Retrieve secrets from Bitwarden
|
||||||
version_added: 5.4.0
|
version_added: 5.4.0
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -24,7 +24,7 @@ DOCUMENTATION = '''
|
||||||
required: true
|
required: true
|
||||||
url:
|
url:
|
||||||
description:
|
description:
|
||||||
- Environment variable with the url for the etcd server
|
- Environment variable with the URL for the etcd server
|
||||||
default: 'http://127.0.0.1:4001'
|
default: 'http://127.0.0.1:4001'
|
||||||
env:
|
env:
|
||||||
- name: ANSIBLE_ETCD_URL
|
- name: ANSIBLE_ETCD_URL
|
||||||
|
|
Loading…
Reference in a new issue