You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

ce_aaa_server - Manages AAA server global configuration on HUAWEI CloudEngine switches.¶

New in version 2.4.

Synopsis
Options
Examples
Return Values
- Status

Synopsis ¶

Manages AAA server global configuration on HUAWEI CloudEngine switches.

Options ¶

parameter	required	default	choices	comments
accounting_mode	no		invalid hwtacacs radius none	Accounting Mode.
acct_scheme_name	no			Accounting scheme name. The value is a string of 1 to 32 characters.
authen_scheme_name	no			Name of an authentication scheme. The value is a string of 1 to 32 characters.
author_scheme_name	no			Name of an authorization scheme. The value is a string of 1 to 32 characters.
domain_name	no			Name of a domain. The value is a string of 1 to 64 characters.
first_authen_mode	no		invalid local hwtacacs radius none	Preferred authentication mode.
first_author_mode	no		invalid local hwtacacs if-authenticated none	Preferred authorization mode.
hwtacas_template	no			Name of a HWTACACS template. The value is a string of 1 to 32 case-insensitive characters.
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.
radius_server_group	no			RADIUS server group's name. The value is a string of 1 to 32 case-insensitive characters.
state	no	present	present absent	Specify desired state of the resource.

Examples ¶

- name: AAA server 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: "Radius authentication Server Basic settings"
    ce_aaa_server:
      state: present
      authen_scheme_name: test1
      first_authen_mode: radius
      radius_server_group: test2
      provider: "{{ cli }}"

  - name: "Undo radius authentication Server Basic settings"
    ce_aaa_server:
      state: absent
      authen_scheme_name: test1
      first_authen_mode: radius
      radius_server_group: test2
      provider: "{{ cli }}"

  - name: "Hwtacacs accounting Server Basic settings"
    ce_aaa_server:
      state: present
      acct_scheme_name: test1
      accounting_mode: hwtacacs
      hwtacas_template: test2
      provider: "{{ cli }}"

  - name: "Undo hwtacacs accounting Server Basic settings"
    ce_aaa_server:
      state: absent
      acct_scheme_name: test1
      accounting_mode: hwtacacs
      hwtacas_template: test2
      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	{'accounting scheme': [['hwtacacs', 'test1']], 'hwtacacs template': ['huawei', 'test2']}
existing	k/v pairs of existing aaa server	always	dict	{'accounting scheme': [['hwtacacs'], ['default']], 'hwtacacs template': ['huawei']}
proposed	k/v pairs of parameters passed into module	always	dict	{'acct_scheme_name': 'test1', 'hwtacas_template': 'test2', 'accounting_mode': 'hwtacacs', 'state': 'present'}
updates	command sent to the device	always	list	['accounting-scheme test1', 'accounting-mode hwtacacs', 'hwtacacs server template test2', 'hwtacacs enable']

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.