You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

cisco.nxos.nxos_aaa_server_host module – Manages AAA server host-specific configuration.

Note

This module is part of the cisco.nxos collection (version 3.2.0).

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 cisco.nxos 1.0.0

Synopsis

• Manages AAA server host-specific configuration.

Note

This module has a corresponding action plugin.

Parameters

Parameter	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	The state of encryption applied to the entered key. O for clear text, 7 for encrypted. Type-6 encryption is not supported. Choices: "0" "7"
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’.
provider dictionary	Deprecated Starting with Ansible 2.5 we recommend using connection: network_cli. Starting with Ansible 2.6 we recommend using connection: httpapi for NX-API. 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.
auth_pass string	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	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. Choices: false ← (default) true
host string	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	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	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	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: "cli" ← (default) "nxapi"
use_proxy boolean	If no, the environment variables http_proxy and https_proxy will be ignored. Choices: false true ← (default)
use_ssl boolean	Configures the transport to use SSL if set to yes only when the transport=nxapi, otherwise this value is ignored. Choices: false ← (default) true
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. Choices: false ← (default) true
server_type string / required	The server type is either radius or tacacs. Choices: "radius" "tacacs"
state string	Manage the state of the resource. Choices: "present" ← (default) "absent"
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 <https://www.ansible.com/integrations/networks/cisco>`_.

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
changed boolean	check to see if a change was made on the device Returned: always Sample: true
end_state dictionary	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"}
existing dictionary	k/v pairs of existing configuration Returned: always Sample: {}
proposed dictionary	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"}
updates list / elements=string	command sent to the device Returned: always Sample: ["radius-server host 1.2.3.4 auth-port 2084 timeout 10"]

Authors

• Jason Edelman (@jedelman8)

Collection links

Issue Tracker Repository (Sources)