| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| acct_port - | Alternate UDP port for RADIUS accounting or keyword 'default'. | ||
| address - / required | Address or name of the radius or tacacs host. | ||
| auth_port - | Alternate UDP port for RADIUS authentication or keyword 'default'. | ||
| encrypt_type - |
| The state of encryption applied to the entered key. O for clear text, 7 for encrypted. Type-6 encryption is not supported. | |
| host_timeout - | Timeout period for specified host, in seconds or keyword 'default. Range is 1-60. | ||
| key - | Shared secret for the specified host or keyword 'default'. | ||
| provider dictionary | Deprecated Starting with Ansible 2.5 we recommend using connection: network_cli.This option is only required if you are using NX-API. For more information please see the NXOS Platform Options guide. A dict object containing connection details. | ||
| auth_pass string added in 2.5.3 | 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 added in 2.5.3 |
| 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. | |
| host string / required | 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 | Default: "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). | |
| 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 | Default: 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 string / required |
| 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_proxy boolean added in 2.5 |
| If no, the environment variables http_proxy and https_proxy will be ignored. | |
| use_ssl boolean |
| Configures the transport to use SSL if set to yes only when the transport=nxapi, otherwise this value is ignored. | |
| 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. | |
| server_type - / required |
| The server type is either radius or tacacs. | |
| state - |
| Manage the state of the resource. | |
| tacacs_port - | Alternate TCP port TACACS Server or keyword 'default'. | ||
Note
state=absent removes the whole host configuration.# Radius Server Host Basic settings
- name: "Radius Server Host Basic settings"
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"
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"
nxos_aaa_server_host:
state: present
server_type: tacacs
tacacs_port: 89
host_timeout: 10
address: 5.6.7.8
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'] |
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/nxos_aaa_server_host_module.html