Skip to content

Latest commit

 

History

History
248 lines (214 loc) · 9.07 KB

cisco.nxos.nxos_aaa_server_module.rst

File metadata and controls

248 lines (214 loc) · 9.07 KB
Raw

cisco.nxos.nxos_aaa_server

Manages AAA server global configuration.

Version added: 1.0.0

Synopsis

  • Manages AAA server global configuration

Parameters

Parameter Choices/Defaults Comments
deadtime
string
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
string
    Choices:
  • enabled
  • disabled
  • default
Enables direct authentication requests to AAA server or keyword 'default' Device default is disabled.
encrypt_type
string
    Choices:
  • 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
string
Global AAA shared secret or keyword 'default'.
server_timeout
string
Global AAA server timeout period, in seconds or keyword 'default. Range is 1-60. Device default is 5.
server_type
string / required
    Choices:
  • radius
  • tacacs
The server type is either radius or tacacs.
state
string
    Choices:
  • present ←
  • default
Manage the state of the resource.

Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL
  • Limited Support for Cisco MDS
  • 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 :ref:`NXOS Platform Options guide <nxos_platform_options>`
  • For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <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
  cisco.nxos.nxos_aaa_server:
    server_type: radius
    server_timeout: 9
    deadtime: 20
    directed_request: enabled

# Tacacs Server Basic settings
- name: Tacacs Server Basic settings
  cisco.nxos.nxos_aaa_server:
    server_type: tacacs
    server_timeout: 8
    deadtime: 19
    directed_request: disabled

# Setting Global Key
- name: AAA Server Global Key
  cisco.nxos.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

Authors

  • Jason Edelman (@jedelman8)