ce_aaa_server_host - Manages AAA server host configuration on HUAWEI CloudEngine switches.
New in version 2.4.
Synopsis
- Manages AAA server host configuration on HUAWEI CloudEngine switches.
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| hwtacacs_is_public_net | no |
| Set the public-net. | |
| hwtacacs_is_secondary_server | no |
| Whether the server is secondary. | |
| hwtacacs_server_host_name | no | Hwtacacs server host name. | ||
| hwtacacs_server_ip | no | 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 | no | Server IPv6 address. Must be a valid unicast IP address. The total length is 128 bits. | ||
| hwtacacs_server_type | no |
| Hwtacacs server type. | |
| hwtacacs_template | no | Name of a HWTACACS template. The value is a string of 1 to 32 case-insensitive characters. | ||
| hwtacacs_vpn_name | no | VPN instance name. | ||
| local_ftp_dir | no | FTP user directory. The value is a string of 1 to 255 characters. | ||
| local_password | no | 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 | no | The type of local user login through, such as ftp ssh snmp telnet. | ||
| local_user_group | no | 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 | no | Login level of a local user. The value is an integer ranging from 0 to 15. | ||
| local_user_name | no | Name of a local user. The value is a string of 1 to 253 characters. | ||
| radius_group_name | no | RADIUS server group's name. The value is a string of 1 to 32 case-insensitive characters. | ||
| radius_server_ip | no | IPv4 address of configured server. The value is a string of 0 to 255 characters, in dotted decimal notation. | ||
| radius_server_ipv6 | no | IPv6 address of configured server. The total length is 128 bits. | ||
| radius_server_mode | no |
| Configured primary or secondary server for a particular server. | |
| radius_server_name | no | Hostname of configured server. The value is a string of 0 to 255 case-sensitive characters. | ||
| radius_server_port | no | Configured server port for a particular server. The value is an integer ranging from 1 to 65535. | ||
| radius_server_type | no |
| Type of Radius Server. | |
| radius_vpn_name | no | Set VPN instance. The value is a string of 1 to 31 case-sensitive characters. | ||
| state | no | present |
| Specify desired state of the resource. |
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"
ce_aaa_server_host:
state: present
local_user_name: user1
local_password: 123456
provider: "{{ cli }}"
- name: "Undo local user when use local scheme"
ce_aaa_server_host:
state: absent
local_user_name: user1
local_password: 123456
provider: "{{ cli }}"
- name: "Config radius server ip"
ce_aaa_server_host:
state: present
radius_group_name: group1
raduis_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"
ce_aaa_server_host:
state: absent
radius_group_name: group1
raduis_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"
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"
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 Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| changed | check to see if a change was made on the device | always | boolean | True |
| end_state | k/v pairs of aaa params after module execution | always | dict | {'radius server ipv4': [['10.1.10.1', 'Authentication', '2000', 'Primary-server', '_public_']]} |
| existing | k/v pairs of existing aaa server host | always | dict | {'radius server ipv4': []} |
| proposed | k/v pairs of parameters passed into module | always | dict | {'hwtacacs_server_ip': '10.135.182.157', 'hwtacacs_vpn_name': '_public_', 'hwtacacs_is_secondary_server': 'false', 'hwtacacs_template': 'wdz', 'local_password': '******', 'state': 'present', 'hwtacacs_server_type': 'Authorization', 'hwtacacs_is_public_net': 'false'} |
| updates | command sent to the device | always | list | ['hwtacacs server template test', 'hwtacacs server authorization 10.135.182.157 vpn-instance test_vpn public-net'] |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ce_aaa_server_host_module.html