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.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| hwtacacs_is_public_net
bool
|
|
Set the public-net.
|
| hwtacacs_is_secondary_server
bool
|
|
Whether the server is secondary.
|
| hwtacacs_server_host_name |
Hwtacacs server host name.
|
|
| hwtacacs_server_ip |
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 |
Server IPv6 address. Must be a valid unicast IP address. The total length is 128 bits.
|
|
| hwtacacs_server_type |
|
Hwtacacs server type.
|
| hwtacacs_template |
Name of a HWTACACS template. The value is a string of 1 to 32 case-insensitive characters.
|
|
| hwtacacs_vpn_name |
VPN instance name.
|
|
| local_ftp_dir |
FTP user directory. The value is a string of 1 to 255 characters.
|
|
| local_password |
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 |
The type of local user login through, such as ftp ssh snmp telnet.
|
|
| local_user_group |
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 |
Login level of a local user. The value is an integer ranging from 0 to 15.
|
|
| local_user_name |
Name of a local user. The value is a string of 1 to 253 characters.
|
|
| radius_group_name |
RADIUS server group's name. The value is a string of 1 to 32 case-insensitive characters.
|
|
| radius_server_ip |
IPv4 address of configured server. The value is a string of 0 to 255 characters, in dotted decimal notation.
|
|
| radius_server_ipv6 |
IPv6 address of configured server. The total length is 128 bits.
|
|
| radius_server_mode |
|
Configured primary or secondary server for a particular server.
|
| radius_server_name |
Hostname of configured server. The value is a string of 0 to 255 case-sensitive characters.
|
|
| radius_server_port |
Configured server port for a particular server. The value is an integer ranging from 1 to 65535.
|
|
| radius_server_type |
|
Type of Radius Server.
|
| radius_vpn_name |
Set VPN instance. The value is a string of 1 to 31 case-sensitive characters.
|
|
| state |
|
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
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"
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"
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, 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
dict
|
always |
k/v pairs of aaa params after module execution
Sample:
{'radius server ipv4': [['10.1.10.1', 'Authentication', '2000', 'Primary-server', '_public_']]}
|
| existing
dict
|
always |
k/v pairs of existing aaa server host
Sample:
{'radius server ipv4': []}
|
| proposed
dict
|
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
|
always |
command sent to the device
Sample:
['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.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- wangdezhuang (@CloudEngine-Ansible)
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.6/modules/ce_aaa_server_host_module.html