archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs_fragments: Correct spelling mistakes, fix formatting (#16930)

Browse Source 
docs_fragments: Correct spelling mistakes, fix formatting
pull/17348/head
John R Barker 8 years ago committed by GitHub
parent 529950680b
commit 02308ce27b
9 changed files with 73 additions and 74 deletions
Show Stats Download Patch File Download Diff File

30
lib/ansible/utils/module_docs_fragments/asa.py
Unescape Escape View File

@ -31,24 +31,24 @@ options:
required: true required: true
port: port:
description: description:
- Specifies the port to use when buiding the connection to the remote - Specifies the port to use when building the connection to the remote
device. The port value will default to the well known SSH port device. The port value will default to the well known SSH port
of 22 of 22
required: false required: false
default: 22 default: 22
username: username:
description: description:
- Configures the usename to use to authenticate the connection to - Configures the username to use to authenticate the connection to
the remote device. The value of I(username) is used to authenticate the remote device. The value of I(username) is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable ANSIBLE_NET_USERNAME will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
required: false required: false
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. The value of I(password) is used to authenticate the remote device. The value of I(password) is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable ANSIBLE_NET_PASSWORD will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
required: false required: false
default: null default: null
ssh_keyfile: ssh_keyfile:
@ -56,16 +56,16 @@ 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. The value of I(ssh_keyfile) is the path to the the remote device. The value of I(ssh_keyfile) is the path to the
key used to authenticate the SSH session. If the value is not specified key used to authenticate the SSH session. If the value is not specified
in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead. will be used instead.
required: false required: false
authorize: authorize:
description: description:
- Instructs the module to enter priviledged mode on the remote device - Instructs the module to enter privileged mode on the remote device
before sending any commands. If not specified, the device will before sending any commands. If not specified, the device will
attempt to excecute all commands in non-priviledged mode. If the value attempt to execute all commands in non-privileged mode. If the value
is not specified in the task, the value of environment variable is not specified in the task, the value of environment variable
ANSIBLE_NET_AUTHORIZE will be used instead. C(ANSIBLE_NET_AUTHORIZE) will be used instead.
required: false required: false
default: no default: no
choices: ['yes', 'no'] choices: ['yes', 'no']
@ -74,7 +74,7 @@ options:
- Specifies the password to use if required to enter privileged mode - Specifies the password to use if required to enter privileged mode
on the remote device. If I(authorize) is false, then this argument on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of does nothing. If the value is not specified in the task, the value of
environment variable ANSIBLE_NET_AUTH_PASS will be used instead. environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
required: false required: false
default: none default: none
timeout: timeout:
@ -85,7 +85,7 @@ options:
default: 10 default: 10
provider: provider:
description: description:
- Convience method that allows all M(ios) arguments to be passed as - Convenience method that allows all I(ios) arguments to be passed as
a dict object. All constraints (required, choices, etc) must be a dict object. All constraints (required, choices, etc) must be
met either by individual arguments or values in this dict. met either by individual arguments or values in this dict.
required: false required: false
@ -93,12 +93,12 @@ options:
show_command: show_command:
description: description:
- Specifies which command will be used to get the current configuration. - Specifies which command will be used to get the current configuration.
By default the 'show running-config' command will be used, this command By default the C(show running-config) command will be used, this command
masks some passwords. For example ike passwords for VPN. If you need to masks some passwords. For example passwords for VPN. If you need to
match against masked passwords use 'more system:running-config'. match against masked passwords use C(more system:running-config).
Note that the 'more system:running-config' only works in the system Note that the C(more system:running-config) only works in the system
context if you are running the ASA in multiple context mode. context if you are running the ASA in multiple context mode.
before sending any commands. If not specified, the device will before sending any commands.
required: false required: false
default: show running-config default: show running-config
choices: ['show running-config', 'more system:running-config'] choices: ['show running-config', 'more system:running-config']

2
lib/ansible/utils/module_docs_fragments/azure_tags.py
Unescape Escape View File

@ -32,7 +32,7 @@ options:
default: null default: null
append_tags: append_tags:
description: description:
- Use to control if tags field is cannonical or just appends to existing tags. When cannonical, any tags not found in the tags parameter will be removed from the object's metadata. - Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
default: True default: True
required: false required: false
''' '''

32
lib/ansible/utils/module_docs_fragments/eos.py
Unescape Escape View File

@ -30,26 +30,26 @@ options:
required: true required: true
port: port:
description: description:
- Specifies the port to use when buiding the connection to the remote - Specifies the port to use when building the connection to the remote
device. This value applies to either I(cli) or I(eapi). The port device. This value applies to either I(cli) or I(eapi). The port
value will default to the approriate transport common port if value will default to the appropriate transport common port if
none is provided in the task. (cli=22, http=80, https=443). none is provided in the task. (cli=22, http=80, https=443).
required: false required: false
default: 0 (use common port) default: 0 (use common port)
username: username:
description: description:
- Configures the usename to use to authenticate the connection to - Configures the username to use to authenticate the connection to
the remote device. The value of I(username) is used to authenticate the remote device. The value of I(username) is used to authenticate
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. If the value is not specified in the task, the transport is used. If the value is not specified in the task, the
value of environment variable ANSIBLE_NET_USERNAME will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
required: false required: false
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. This is a common argument used for either I(cli) the remote device. This is a common argument used for either I(cli)
or I(eapi) transports. If the value is not specified in the task, the or I(eapi) transports. If the value is not specified in the task, the
value of environment variable ANSIBLE_NET_PASSWORD will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
required: false required: false
default: null default: null
ssh_keyfile: ssh_keyfile:
@ -57,15 +57,15 @@ options:
- Specifies the SSH keyfile to use to authenticate the connection to - Specifies the SSH keyfile to use to authenticate the connection to
the remote device. This argument is only used for I(cli) transports. the remote device. This argument is only used for I(cli) transports.
If the value is not specified in the task, the value of environment If the value is not specified in the task, the value of environment
variable ANSIBLE_NET_SSH_KEYFILE will be used instead. variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
required: false required: false
authorize: authorize:
description: description:
- Instructs the module to enter priviledged mode on the remote device - Instructs the module to enter privileged mode on the remote device
before sending any commands. If not specified, the device will before sending any commands. If not specified, the device will
attempt to excecute all commands in non-priviledged mode. If the value attempt to execute all commands in non-privileged mode. If the value
is not specified in the task, the value of environment variable is not specified in the task, the value of environment variable
ANSIBLE_NET_AUTHORIZE will be used instead. C(ANSIBLE_NET_AUTHORIZE) will be used instead.
required: false required: false
default: no default: no
choices: ['yes', 'no'] choices: ['yes', 'no']
@ -74,27 +74,29 @@ options:
- Specifies the password to use if required to enter privileged mode - Specifies the password to use if required to enter privileged mode
on the remote device. If I(authorize) is false, then this argument on the remote device. If I(authorize) is false, then this argument
does nothing. If the value is not specified in the task, the value of does nothing. If the value is not specified in the task, the value of
environment variable ANSIBLE_NET_AUTH_PASS will be used instead. environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
required: false required: false
default: none default: none
transport: transport:
description: description:
- Configures the transport connection to use when connecting to the - Configures the transport connection to use when connecting to the
remote device. The transport argument supports connectivity to the remote device.
device over cli (ssh) or eapi.
required: true required: true
choices:
- eapi
- cli
default: cli default: cli
use_ssl: use_ssl:
description: description:
- Configures the I(transport) to use SSL if set to true only when the - Configures the I(transport) to use SSL if set to true only when the
I(transport) argument is configured as eapi. If the transport C(transport=eapi). If the transport
argument is not eapi, this value is ignored argument is not eapi, this value is ignored.
required: false required: false
default: yes default: yes
choices: ['yes', 'no'] choices: ['yes', 'no']
provider: provider:
description: description:
- Convience method that allows all M(eos) arguments to be passed as - Convenience method that allows all I(eos) arguments to be passed as
a dict object. All constraints (required, choices, etc) must be a dict object. All constraints (required, choices, etc) must be
met either by individual arguments or values in this dict. met either by individual arguments or values in this dict.
required: false required: false

11
lib/ansible/utils/module_docs_fragments/ios.py
Unescape Escape View File

@ -30,14 +30,13 @@ options:
required: true required: true
port: port:
description: description:
- Specifies the port to use when buiding the connection to the remote - Specifies the port to use when buiding the connection to the remote.
device. The port value will default to the well known SSH port device.
of 22
required: false required: false
default: 22 default: 22
username: username:
description: description:
- Configures the usename to use to authenticate the connection to - Configures the username to use to authenticate the connection to
the remote device. The value of I(username) is used to authenticate the remote device. The value of I(username) is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable ANSIBLE_NET_USERNAME will be used instead. value of environment variable ANSIBLE_NET_USERNAME will be used instead.
@ -60,9 +59,9 @@ options:
required: false required: false
authorize: authorize:
description: description:
- Instructs the module to enter priviledged mode on the remote device - Instructs the module to enter privileged mode on the remote device
before sending any commands. If not specified, the device will before sending any commands. If not specified, the device will
attempt to excecute all commands in non-priviledged mode. If the value attempt to execute all commands in non-privileged mode. If the value
is not specified in the task, the value of environment variable is not specified in the task, the value of environment variable
ANSIBLE_NET_AUTHORIZE will be used instead. ANSIBLE_NET_AUTHORIZE will be used instead.
required: false required: false

15
lib/ansible/utils/module_docs_fragments/iosxr.py
Unescape Escape View File

@ -30,24 +30,23 @@ options:
required: true required: true
port: port:
description: description:
- Specifies the port to use when buiding the connection to the remote - Specifies the port to use when building the connection to the remote
device. The port value will default to the well known SSH port device.
of 22
required: false required: false
default: 22 default: 22
username: username:
description: description:
- Configures the usename to use to authenticate the connection to - Configures the username to use to authenticate the connection to
the remote device. The value of I(username) is used to authenticate the remote device. The value of I(username) is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable ANSIBLE_NET_USERNAME will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
required: false required: false
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. The value of I(password) is used to authenticate the remote device. The value of I(password) is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable ANSIBLE_NET_PASSWORD will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
required: false required: false
default: null default: null
ssh_keyfile: ssh_keyfile:
@ -55,12 +54,12 @@ 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. The value of I(ssh_keyfile) is the path to the the remote device. The value of I(ssh_keyfile) is the path to the
key used to authenticate the SSH session. If the value is not specified key used to authenticate the SSH session. If the value is not specified
in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead. will be used instead.
required: false required: false
provider: provider:
description: description:
- Convience method that allows all M(iosxr) arguments to be passed as - Convenience method that allows all I(iosxr) arguments to be passed as
a dict object. All constraints (required, choices, etc) must be a dict object. All constraints (required, choices, etc) must be
met either by individual arguments or values in this dict. met either by individual arguments or values in this dict.
required: false required: false

7
lib/ansible/utils/module_docs_fragments/junos.py
Unescape Escape View File

@ -30,14 +30,15 @@ options:
required: true required: true
port: port:
description: description:
- Specifies the port to use when buiding the connection to the remote - Specifies the port to use when building the connection to the remote
device. The port value will default to the well known SSH port device. The port value will default to the well known SSH port
of 22 (for C(transport=cli)) or port 830 (for C(transport=netconf)) of 22 (for C(transport=cli)) or port 830 (for C(transport=netconf))
device.
required: false required: false
default: 22 default: 22
username: username:
description: description:
- Configures the usename to use to authenticate the connection to - Configures the username to use to authenticate the connection to
the remote device. The value of I(username) is used to authenticate the remote device. The value of I(username) is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable ANSIBLE_NET_USERNAME will be used instead. value of environment variable ANSIBLE_NET_USERNAME will be used instead.
@ -60,7 +61,7 @@ options:
required: false required: false
provider: provider:
description: description:
- Convience method that allows all M(ios) arguments to be passed as - Convenience method that allows all I(ios) arguments to be passed as
a dict object. All constraints (required, choices, etc) must be a dict object. All constraints (required, choices, etc) must be
met either by individual arguments or values in this dict. met either by individual arguments or values in this dict.
required: false required: false

17
lib/ansible/utils/module_docs_fragments/nxos.py
Unescape Escape View File

@ -30,26 +30,26 @@ options:
required: true required: true
port: port:
description: description:
- Specifies the port to use when buiding the connection to the remote - Specifies the port to use when building the connection to the remote
device. This value applies to either I(cli) or I(nxapi). The port device. This value applies to either I(cli) or I(nxapi). The port
value will default to the approriate transport common port if value will default to the appropriate transport common port if
none is provided in the task. (cli=22, http=80, https=443). none is provided in the task. (cli=22, http=80, https=443).
required: false required: false
default: 0 (use common port) default: 0 (use common port)
username: username:
description: description:
- Configures the usename to use to authenticate the connection to - Configures the username to use to authenticate the connection to
the remote device. The value of I(username) is used to authenticate the remote device. The value of I(username) is used to authenticate
either the CLI login or the nxapi authentication depending on which either the CLI login or the nxapi authentication depending on which
transport is used. If the value is not specified in the task, the transport is used. If the value is not specified in the task, the
value of environment variable ANSIBLE_NET_USERNAME will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
required: false required: false
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. This is a common argument used for either I(cli) the remote device. This is a common argument used for either I(cli)
or I(nxapi) transports. If the value is not specified in the task, the or I(nxapi) transports. If the value is not specified in the task, the
value of environment variable ANSIBLE_NET_PASSWORD will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
required: false required: false
default: null default: null
ssh_keyfile: ssh_keyfile:
@ -57,7 +57,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 the I(cli) the remote device. This argument is only used for the I(cli)
transport. If the value is not specified in the task, the transport. If the value is not specified in the task, the
value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead. value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
required: false required: false
transport: transport:
description: description:
@ -69,14 +69,13 @@ options:
use_ssl: use_ssl:
description: description:
- Configures the I(transport) to use SSL if set to true only when the - Configures the I(transport) to use SSL if set to true only when the
I(transport) argument is configured as nxapi. If the transport C(transport=nxapi), otherwise this value is ignored.
argument is not nxapi, this value is ignored
required: false required: false
default: no default: no
choices: ['yes', 'no'] choices: ['yes', 'no']
provider: provider:
description: description:
- Convience method that allows all M(nxos) arguments to be passed as - Convenience method that allows all I(nxos) arguments to be passed as
a dict object. All constraints (required, choices, etc) must be a dict object. All constraints (required, choices, etc) must be
met either by individual arguments or values in this dict. met either by individual arguments or values in this dict.
required: false required: false

18
lib/ansible/utils/module_docs_fragments/openswitch.py
Unescape Escape View File

@ -31,21 +31,21 @@ options:
required: true required: true
port: port:
description: description:
- Specifies the port to use when buiding the connection to the remote - Specifies the port to use when building the connection to the remote
device. This value applies to either I(cli) or I(). The port device. This value applies to either I(cli) or I(rest). The port
value will default to the approriate transport common port if value will default to the appropriate transport common port if
none is provided in the task. (cli=22, http=80, https=443). Note none is provided in the task. (cli=22, http=80, https=443). Note
this argument does not affect the SSH transport. this argument does not affect the SSH transport.
required: false required: false
default: 0 (use common port) default: 0 (use common port)
username: username:
description: description:
- Configures the usename to use to authenticate the connection to - Configures the username to use to authenticate the connection to
the remote device. The value of I(username) is used to authenticate the remote device. The value of I(username) is used to authenticate
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 ANSIBLE_NET_USERNAME will be used instead. environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
required: false required: false
password: password:
description: description:
@ -53,7 +53,7 @@ options:
the remote device. This is a common argument used for either I(cli) the remote device. This is a common argument used for either I(cli)
or I(rest) transports. Note this argument does not affect the SSH or I(rest) transports. 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 ANSIBLE_NET_PASSWORD will be used instead. environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
required: false required: false
default: null default: null
ssh_keyfile: ssh_keyfile:
@ -61,7 +61,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 the I(cli) the remote device. This argument is only used for the I(cli)
transports. If the value is not specified in the task, the value of transports. If the value is not specified in the task, the value of
environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead. environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
required: false required: false
transport: transport:
description: description:
@ -75,13 +75,13 @@ options:
description: description:
- Configures the I(transport) to use SSL if set to true only when the - Configures the I(transport) to use SSL if set to true only when the
I(transport) argument is configured as rest. If the transport I(transport) argument is configured as rest. If the transport
argument is not rest, this value is ignored argument is not I(rest), this value is ignored.
required: false required: false
default: yes default: yes
choices: ['yes', 'no'] choices: ['yes', 'no']
provider: provider:
description: description:
- Convience method that allows all M(openswitch) arguments to be passed as - Convenience method that allows all I(openswitch) arguments to be passed as
a dict object. All constraints (required, choices, etc) must be a dict object. All constraints (required, choices, etc) must be
met either by individual arguments or values in this dict. met either by individual arguments or values in this dict.
required: false required: false

15
lib/ansible/utils/module_docs_fragments/vyos.py
Unescape Escape View File

@ -30,24 +30,23 @@ options:
required: true required: true
port: port:
description: description:
- Specifies the port to use when buiding the connection to the remote - Specifies the port to use when building the connection to the remote
device. The port value will default to the well known SSH port device.
of 22
required: false required: false
default: 22 default: 22
username: username:
description: description:
- Configures the usename to use to authenticate the connection to - Configures the username to use to authenticate the connection to
the remote device. The value of I(username) is used to authenticate the remote device. The value of I(username) is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable ANSIBLE_NET_USERNAME will be used instead. value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
required: false required: false
password: password:
description: description:
- Specifies the password to use to authenticate the connection to - Specifies the password to use to authenticate the connection to
the remote device. The value of I(password) is used to authenticate the remote device. The value of I(password) is used to authenticate
the SSH session. If the value is not specified in the task, the the SSH session. If the value is not specified in the task, the
value of environment variable ANSIBLE_NET_PASSWORD will be used instead. value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
required: false required: false
default: null default: null
ssh_keyfile: ssh_keyfile:
@ -55,7 +54,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. The value of I(ssh_keyfile) is the path to the the remote device. The value of I(ssh_keyfile) is the path to the
key used to authenticate the SSH session. If the value is not specified key used to authenticate the SSH session. If the value is not specified
in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
will be used instead. will be used instead.
required: false required: false
timeout: timeout:
@ -66,7 +65,7 @@ options:
default: 10 default: 10
provider: provider:
description: description:
- Convience method that allows all M(vyos) arguments to be passed as - Convenience method that allows all I(vyos) arguments to be passed as
a dict object. All constraints (required, choices, etc) must be a dict object. All constraints (required, choices, etc) must be
met either by individual arguments or values in this dict. met either by individual arguments or values in this dict.
required: false required: false

Write Preview
Loading…
Cancel
Save