nxos_aaa_server – Manages AAA server global configuration¶
New in version 2.2.
Synopsis¶
Manages AAA server global configuration
Parameters¶
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
|
deadtime
-
|
Duration for which a non-reachable AAA server is skipped, in minutes or keyword 'default. Range is 1-1440. Device default is 0.
|
||
|
directed_request
-
|
|
Enables direct authentication requests to AAA server or keyword 'default' Device default is disabled.
|
|
|
encrypt_type
-
|
|
The state of encryption applied to the entered global key. O clear text, 7 encrypted. Type-6 encryption is not supported.
|
|
|
global_key
-
|
Global AAA shared secret or keyword 'default'.
|
||
|
provider
dictionary
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli.This option is only required if you are using NX-API.
For more information please see the NXOS Platform Options guide.
A dict object containing connection details.
|
||
|
auth_pass
string
added in 2.5.3 |
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. |
||
|
authorize
boolean
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. |
|
|
host
string
/ 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.
|
||
|
password
string
|
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. |
||
|
port
integer
|
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).
|
|
|
ssh_keyfile
string
|
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. |
||
|
timeout
integer
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).
|
|
|
transport
string
/ required
|
|
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_proxy
boolean
added in 2.5 |
|
If
no, the environment variables http_proxy and https_proxy will be ignored. |
|
|
use_ssl
boolean
|
|
Configures the transport to use SSL if set to
yes only when the transport=nxapi, otherwise this value is ignored. |
|
|
username
string
|
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. |
||
|
validate_certs
boolean
|
|
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. |
|
|
server_timeout
-
|
Global AAA server timeout period, in seconds or keyword 'default. Range is 1-60. Device default is 5.
|
||
|
server_type
-
/ required
|
|
The server type is either radius or tacacs.
|
|
|
state
-
|
|
Manage the state of the resource.
|
|
Notes¶
Note
Tested against NXOSv 7.3.(0)D1(1) on VIRL
The server_type parameter is always required.
If encrypt_type is not supplied, the global AAA server key will be stored as encrypted (type 7).
Changes to the global AAA server key with encrypt_type=0 are not idempotent.
state=default will set the supplied parameters to their default values. The parameters that you want to default must also be set to default. If global_key=default, the global key will be removed.
For information on using CLI and NX-API see the NXOS Platform Options guide
For more information on using Ansible to manage network devices see the Ansible Network Guide
For more information on using Ansible to manage Cisco devices see the Cisco integration page.
Examples¶
# Radius Server Basic settings
- name: "Radius Server Basic settings"
nxos_aaa_server:
server_type: radius
server_timeout: 9
deadtime: 20
directed_request: enabled
# Tacacs Server Basic settings
- name: "Tacacs Server Basic settings"
nxos_aaa_server:
server_type: tacacs
server_timeout: 8
deadtime: 19
directed_request: disabled
# Setting Global Key
- name: "AAA Server Global Key"
nxos_aaa_server:
server_type: radius
global_key: test_key
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
commands
list
|
always |
command sent to the device
Sample:
['radius-server deadtime 22', 'radius-server timeout 11', 'radius-server directed-request']
|
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Network Team. [network]
Red Hat Support¶
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.