cisco.nxos.nxos_aaa_server_host_module.rst

cisco.nxos.nxos_aaa_server_host

Manages AAA server host-specific configuration.

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• Manages AAA server host-specific configuration.

Parameters

Parameter	Choices/Defaults	Comments
acct_port string		Alternate UDP port for RADIUS accounting or keyword 'default'.
address string / required		Address or name of the radius or tacacs host.
auth_port string		Alternate UDP port for RADIUS authentication or keyword 'default'.
encrypt_type string	Choices: 0 7	The state of encryption applied to the entered key. O for clear text, 7 for encrypted. Type-6 encryption is not supported.
host_timeout string		Timeout period for specified host, in seconds or keyword 'default. Range is 1-60.
key string		Shared secret for the specified host or keyword 'default'.
server_type string / required	Choices: radius tacacs	The server type is either radius or tacacs.
state string	Choices: present ← absent	Manage the state of the resource.
tacacs_port string		Alternate TCP port TACACS Server or keyword 'default'.

Notes

Note

• Tested against NXOSv 7.3.(0)D1(1) on VIRL
• Limited Support for Cisco MDS
• Changes to the host key (shared secret) are not idempotent for type 0.
• If state=absent removes the whole host configuration.
• 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 Host Basic settings
- name: Radius Server Host Basic settings
  cisco.nxos.nxos_aaa_server_host:
    state: present
    server_type: radius
    address: 1.2.3.4
    acct_port: 2084
    host_timeout: 10

# Radius Server Host Key Configuration
- name: Radius Server Host Key Configuration
  cisco.nxos.nxos_aaa_server_host:
    state: present
    server_type: radius
    address: 1.2.3.4
    key: hello
    encrypt_type: 7

# TACACS Server Host Configuration
- name: Tacacs Server Host Configuration
  cisco.nxos.nxos_aaa_server_host:
    state: present
    server_type: tacacs
    tacacs_port: 89
    host_timeout: 10
    address: 5.6.7.8

Return Values

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

Key	Returned	Description
changed boolean	always	check to see if a change was made on the device Sample: True
end_state dictionary	always	k/v pairs of configuration after module execution Sample: {'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
existing dictionary	always	k/v pairs of existing configuration
proposed dictionary	always	k/v pairs of parameters passed into module Sample: {'address': '1.2.3.4', 'auth_port': '2084', 'host_timeout': '10', 'server_type': 'radius'}
updates list	always	command sent to the device Sample: ['radius-server host 1.2.3.4 auth-port 2084 timeout 10']

Status

Authors

• Jason Edelman (@jedelman8)