W3cubDocs

/Ansible

nxos_aaa_server_host - Manages AAA server host-specific configuration.

New in version 2.2.

Synopsis

Manages AAA server host-specific configuration.

Options

parameter required default choices comments
acct_port
 no
Alternate UDP port for RADIUS accounting.
address
 yes
Address or name of the radius or tacacs host.
auth_port
 no
Alternate UDP port for RADIUS authentication.
encrypt_type
 no
  • 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
 yes
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.
host_timeout
 no
Timeout period for specified host, in seconds. Range is 1-60.
key
 no
Shared secret for the specified host.
password
 no
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
 no 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).
provider
 no
Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
server_type
 yes
  • radius
  • tacacs
The server type is either radius or tacacs.
ssh_keyfile
 no
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.
state
 no present
  • present
  • absent
Manage the state of the resource.
tacacs_port
 no
Alternate TCP port TACACS Server.
transport
 yes cli
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_ssl
 no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
username
 no
Configures the username to use to authenticate the connection to the remote device. The value of username 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.

Examples

# 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
        host: {{ inventory_hostname }}
        username: {{ un }}
        password: {{ pwd }}

# 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
        host:  inventory_hostname }}
        username: {{ un }}
        password: {{ pwd }}

# 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
        host:  inventory_hostname }}
        username:  un }}
        password:  pwd }}

Return Values

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

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

Notes

Note

Changes to the AAA server host key (shared secret) are not idempotent.

Note

If state=absent removes the whole host configuration.

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/nxos_aaa_server_host_module.html