community.network.ce_aaa_server_host – Manages AAA server host configuration on HUAWEI CloudEngine switches.

Note

This plugin is part of the community.network collection (version 3.0.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 community.network.

To use it in a playbook, specify: community.network.ce_aaa_server_host.

Synopsis

Manages AAA server host configuration on HUAWEI CloudEngine switches.

Parameters

Parameter	Choices/Defaults	Comments
hwtacacs_is_public_net boolean	Choices: no ← yes	Set the public-net.
hwtacacs_is_secondary_server boolean	Choices: no ← yes	Whether the server is secondary.
hwtacacs_server_host_name string		Hwtacacs server host name.
hwtacacs_server_ip string		Server IPv4 address. Must be a valid unicast IP address. The value is a string of 0 to 255 characters, in dotted decimal notation.
hwtacacs_server_ipv6 string		Server IPv6 address. Must be a valid unicast IP address. The total length is 128 bits.
hwtacacs_server_type string	Choices: Authentication Authorization Accounting Common	Hwtacacs server type.
hwtacacs_template string		Name of a HWTACACS template. The value is a string of 1 to 32 case-insensitive characters.
hwtacacs_vpn_name string		VPN instance name.
local_ftp_dir string		FTP user directory. The value is a string of 1 to 255 characters.
local_password string		Login password of a user. The password can contain letters, numbers, and special characters. The value is a string of 1 to 255 characters.
local_service_type string		The type of local user login through, such as ftp ssh snmp telnet.
local_user_group string		Name of the user group where the user belongs. The user inherits all the rights of the user group. The value is a string of 1 to 32 characters.
local_user_level string		Login level of a local user. The value is an integer ranging from 0 to 15.
local_user_name string		Name of a local user. The value is a string of 1 to 253 characters.
radius_group_name string		RADIUS server group's name. The value is a string of 1 to 32 case-insensitive characters.
radius_server_ip string		IPv4 address of configured server. The value is a string of 0 to 255 characters, in dotted decimal notation.
radius_server_ipv6 string		IPv6 address of configured server. The total length is 128 bits.
radius_server_mode string	Choices: Secondary-server Primary-server	Configured primary or secondary server for a particular server.
radius_server_name string		Hostname of configured server. The value is a string of 0 to 255 case-sensitive characters.
radius_server_port string		Configured server port for a particular server. The value is an integer ranging from 1 to 65535.
radius_server_type string	Choices: Authentication Accounting	Type of Radius Server.
radius_vpn_name string		Set VPN instance. The value is a string of 1 to 31 case-sensitive characters.
state string	Choices: present ← absent	Specify desired state of the resource.

Notes

Note

This module requires the netconf system service be enabled on the remote device being managed.
Recommended connection is netconf.
This module also works with local connections for legacy playbooks.

Examples

- name: AAA server host test
  hosts: cloudengine
  connection: local
  gather_facts: no
  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: "{{ ansible_ssh_port }}"
      username: "{{ username }}"
      password: "{{ password }}"
      transport: cli

  tasks:

  - name: "Config local user when use local scheme"
    community.network.ce_aaa_server_host:
      state: present
      local_user_name: user1
      local_password: 123456
      provider: "{{ cli }}"

  - name: "Undo local user when use local scheme"
    community.network.ce_aaa_server_host:
      state: absent
      local_user_name: user1
      local_password: 123456
      provider: "{{ cli }}"

  - name: "Config radius server ip"
    community.network.ce_aaa_server_host:
      state: present
      radius_group_name: group1
      radius_server_type: Authentication
      radius_server_ip: 10.1.10.1
      radius_server_port: 2000
      radius_server_mode: Primary-server
      radius_vpn_name: _public_
      provider: "{{ cli }}"

  - name: "Undo radius server ip"
    community.network.ce_aaa_server_host:
      state: absent
      radius_group_name: group1
      radius_server_type: Authentication
      radius_server_ip: 10.1.10.1
      radius_server_port: 2000
      radius_server_mode: Primary-server
      radius_vpn_name: _public_
      provider: "{{ cli }}"

  - name: "Config hwtacacs server ip"
    community.network.ce_aaa_server_host:
      state: present
      hwtacacs_template: template
      hwtacacs_server_ip: 10.10.10.10
      hwtacacs_server_type: Authorization
      hwtacacs_vpn_name: _public_
      provider: "{{ cli }}"

  - name: "Undo hwtacacs server ip"
    community.network.ce_aaa_server_host:
      state: absent
      hwtacacs_template: template
      hwtacacs_server_ip: 10.10.10.10
      hwtacacs_server_type: Authorization
      hwtacacs_vpn_name: _public_
      provider: "{{ cli }}"

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 aaa params after module execution Sample: {'radius server ipv4': [['10.1.10.1', 'Authentication', '2000', 'Primary-server', '_public_']]}
existing dictionary	always	k/v pairs of existing aaa server host Sample: {'radius server ipv4': []}
proposed dictionary	always	k/v pairs of parameters passed into module Sample: {'hwtacacs_is_public_net': 'false', 'hwtacacs_is_secondary_server': 'false', 'hwtacacs_server_ip': '10.135.182.157', 'hwtacacs_server_type': 'Authorization', 'hwtacacs_template': 'wdz', 'hwtacacs_vpn_name': '_public_', 'local_password': '******', 'state': 'present'}
updates list / elements=string	always	command sent to the device Sample: ['hwtacacs server template test', 'hwtacacs server authorization 10.135.182.157 vpn-instance test_vpn public-net']

Authors

wangdezhuang (@QijunPan)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/ce_aaa_server_host_module.html

Docs

Docs4dev

Title here