mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-23 21:30:22 -07:00
docs_fragments formatting and typo improvements (#17981)
This commit is contained in:
parent
0ef3ff6a9d
commit
9183bb6391
18 changed files with 133 additions and 136 deletions
|
@ -30,31 +30,31 @@ options:
|
|||
required: true
|
||||
port:
|
||||
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.
|
||||
required: false
|
||||
default: 22
|
||||
username:
|
||||
description:
|
||||
- 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. This value is used to authenticate
|
||||
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
|
||||
password:
|
||||
description:
|
||||
- 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. This value is used to authenticate
|
||||
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
|
||||
default: null
|
||||
ssh_keyfile:
|
||||
description:
|
||||
- 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. This value is the path to the
|
||||
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.
|
||||
required: false
|
||||
authorize:
|
||||
|
@ -63,7 +63,7 @@ options:
|
|||
before sending any commands. If not specified, the device will
|
||||
attempt to execute all commands in non-privileged mode. If the value
|
||||
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
|
||||
default: no
|
||||
choices: ['yes', 'no']
|
||||
|
@ -72,18 +72,18 @@ options:
|
|||
- Specifies the password to use if required to enter privileged mode
|
||||
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
|
||||
environment variable ANSIBLE_NET_AUTH_PASS will be used instead.
|
||||
environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead.
|
||||
required: false
|
||||
default: none
|
||||
timeout:
|
||||
description:
|
||||
- Specifies idle timeout for the connection. Useful if the console
|
||||
- Specifies idle timeout for the connection, in seconds. Useful if the console
|
||||
freezes before continuing. For example when saving configurations.
|
||||
required: false
|
||||
default: 10
|
||||
provider:
|
||||
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
|
||||
met either by individual arguments or values in this dict.
|
||||
required: false
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue