Parameter |
Choices/Defaults |
Comments |
provider
|
|
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli .
This option is only required if you are using NX-API.
A dict object containing connection details.
|
|
host
required |
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
|
|
port
|
Default:
0 (use common port)
|
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
|
|
username
|
|
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
|
|
password
|
|
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
|
|
authorize
bool
(added in 2.5.3) |
|
Instructs the module to enter privileged mode on the remote device 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.
|
|
auth_pass
(added in 2.5.3) |
Default:
none
|
Specifies the password to use if required to enter privileged mode on the remote device. If 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.
|
|
timeout
(added in 2.3) |
Default:
10
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
|
|
ssh_keyfile
|
|
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
|
|
transport
required |
Default:
cli
|
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
|
|
use_ssl
bool |
|
Configures the transport to use SSL if set to true only when the transport=nxapi , otherwise this value is ignored.
|
|
validate_certs
bool |
|
If no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored.
|
|
use_proxy
bool
(added in 2.5) |
|
If no , the environment variables http_proxy and https_proxy will be ignored.
|
state
required |
Choices:
present ←
- absent
|
Specify desired state of the resource.
|
system_mode_maintenance
bool |
|
When system_mode_maintenance=true it puts all enabled protocols in maintenance mode (using the isolate command). When system_mode_maintenance=false it puts all enabled protocols in normal mode (using the no isolate command).
|
system_mode_maintenance_dont_generate_profile
bool |
|
When system_mode_maintenance_dont_generate_profile=true it prevents the dynamic searching of enabled protocols and executes commands configured in a maintenance-mode profile. Use this option if you want the system to use a maintenance-mode profile that you have created. When system_mode_maintenance_dont_generate_profile=false it prevents the dynamic searching of enabled protocols and executes commands configured in a normal-mode profile. Use this option if you want the system to use a normal-mode profile that you have created.
|
system_mode_maintenance_on_reload_reset_reason
|
Choices:
- hw_error
- svc_failure
- kern_failure
- wdog_timeout
- fatal_error
- lc_failure
- match_any
- manual_reload
- any_other
- maintenance
|
Boots the switch into maintenance mode automatically in the event of a specified system crash. Note that not all reset reasons are applicable for all platforms. Also if reset reason is set to match_any, it is not idempotent as it turns on all reset reasons. If reset reason is match_any and state is absent, it turns off all the reset reasons.
|
system_mode_maintenance_shutdown
bool |
|
Shuts down all protocols, vPC domains, and interfaces except the management interface (using the shutdown command). This option is disruptive while system_mode_maintenance (which uses the isolate command) is not.
|
system_mode_maintenance_timeout
|
|
Keeps the switch in maintenance mode for a specified number of minutes. Range is 5-65535.
|