cisco.nxos.nxos_aaa_server_host – Manages AAA server host-specific configuration.
Note
This plugin is part of the cisco.nxos collection (version 2.8.2).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.nxos
.
To use it in a playbook, specify: cisco.nxos.nxos_aaa_server_host
.
New in version 1.0.0: of cisco.nxos
Synopsis
Manages AAA server host-specific configuration.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
Alternate UDP port for RADIUS accounting or keyword ‘default’. |
|
Address or name of the radius or tacacs host. |
|
Alternate UDP port for RADIUS authentication or keyword ‘default’. |
|
The state of encryption applied to the entered key. O for clear text, 7 for encrypted. Type-6 encryption is not supported. Choices:
|
|
Timeout period for specified host, in seconds or keyword ‘default. Range is 1-60. |
|
Shared secret for the specified host or keyword ‘default’. |
|
Deprecated Starting with Ansible 2.5 we recommend using Starting with Ansible 2.6 we recommend using This option will be removed in a release after 2022-06-01. For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html. A dict object containing connection details. |
|
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 |
|
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 Choices:
|
|
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. |
|
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 |
|
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). |
|
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 |
|
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). |
|
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. Choices:
|
|
If Choices:
|
|
Configures the transport to use SSL if set to Choices:
|
|
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 |
|
If Choices:
|
|
The server type is either radius or tacacs. Choices:
|
|
Manage the state of the resource. Choices:
|
|
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 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 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 |
Description |
---|---|
check to see if a change was made on the device Returned: always Sample: true |
|
k/v pairs of configuration after module execution Returned: always Sample: {“address”: “1.2.3.4”, “auth_port”: “2084”, “host_timeout”: “10”, “server_type”: “radius”} |
|
k/v pairs of existing configuration Returned: always Sample: {} |
|
k/v pairs of parameters passed into module Returned: always Sample: {“address”: “1.2.3.4”, “auth_port”: “2084”, “host_timeout”: “10”, “server_type”: “radius”} |
|
command sent to the device Returned: always Sample: [“radius-server host 1.2.3.4 auth-port 2084 timeout 10”] |
Authors
Jason Edelman (@jedelman8)