Documentation

nxos_aaa_server - Manages AAA server global configuration.

New in version 2.2.

Synopsis

  • Manages AAA server global configuration

Options

parameter required default choices comments
deadtime
no
Duration for which a non-reachable AAA server is skipped, in minutes. Range is 1-1440. Device default is 0.
directed_request
no
  • enabled
  • disabled
Enables direct authentication requests to AAA server. Device default is disabled.
encrypt_type
no
  • 0
  • 7
The state of encryption applied to the entered global key. O clear text, 7 encrypted. Type-6 encryption is not supported.
global_key
no
Global AAA shared secret.
host
yes
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
no
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
no 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).
provider
no
Convenience method that allows all nxos 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.
server_timeout
no
Global AAA server timeout period, in seconds. Range is 1-60. Device default is 5.
server_type
yes
  • radius
  • tacacs
The server type is either radius or tacacs.
ssh_keyfile
no
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.
state
yes present
  • present
  • default
Manage the state of the resource.
timeout
(added in 2.3)
no 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
yes 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
no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
username
no
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
no
  • yes
  • no
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.

Examples

# Radius Server Basic settings
  - name: "Radius Server Basic settings"
    nxos_aaa_server:
        server_type: radius
        server_timeout: 9
        deadtime: 20
        directed_request: enabled
        host:  inventory_hostname }}
        username:  un }}
        password:  pwd }}

# Tacacs Server Basic settings
  - name: "Tacacs Server Basic settings"
    nxos_aaa_server:
        server_type: tacacs
        server_timeout: 8
        deadtime: 19
        directed_request: disabled
        host:  inventory_hostname }}
        username:  un }}
        password:  pwd }}

# Setting Global Key
  - name: "AAA Server Global Key"
    nxos_aaa_server:
        server_type: radius
        global_key: test_key
        host:  inventory_hostname }}
        username:  un }}
        password:  pwd }}

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
state state as sent in from the playbook always string present
updates command sent to the device always list ['radius-server deadtime 22', 'radius-server timeout 11', 'radius-server directed-request']
proposed k/v pairs of parameters passed into module always dict {'server_timeout': '11', 'deadtime': '22', 'directed_request': 'enabled', 'server_type': 'radius'}
end_state k/v pairs of aaa params after module execution always dict {'server_timeout': '11', 'deadtime': '22', 'directed_request': 'enabled', 'global_key': 'unknown'}
changed check to see if a change was made on the device always boolean True
existing ['k/v pairs of existing aaa server'] always dict {'server_timeout': '5', 'deadtime': '0', 'directed_request': 'disabled', 'global_key': 'unknown'}


Notes

Note

  • 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.
  • If global AAA server key is not found, it’s shown as “unknown”
  • 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.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.