dellemc.enterprise_sonic.sonic_aaa module – Manage AAA and its parameters
Note
This module is part of the dellemc.enterprise_sonic collection (version 2.5.1).
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 dellemc.enterprise_sonic
.
To use it in a playbook, specify: dellemc.enterprise_sonic.sonic_aaa
.
New in dellemc.enterprise_sonic 1.1.0
Synopsis
This module is used for configuration management of aaa parameters on devices running Enterprise SONiC.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
Specifies the aaa related configurations |
|
Specifies the configurations required for aaa authentication |
|
Specifies the data required for aaa authentication |
|
Specifies the state of failthrough Choices:
|
|
Specifies the method of aaa authentication Choices:
|
|
Enable or Disable local authentication Choices:
|
|
Specifies the operation to be performed on the aaa parameters configured on the device. In case of merged, the input configuration will be merged with the existing aaa configuration on the device. In case of deleted the existing aaa configuration will be removed from the device. In case of replaced, the existing aaa configuration will be replaced with provided configuration. In case of overridden, the existing aaa configuration will be overridden with the provided configuration. Choices:
|
Notes
Note
Tested against Enterprise SONiC Distribution by Dell Technologies.
Supports
check_mode
.
Examples
# Using deleted
#
# Before state:
# -------------
#
# do show aaa
# AAA Authentication Information
# ---------------------------------------------------------
# failthrough : True
# login-method : local
- name: Delete aaa configurations
dellemc.enterprise_sonic.sonic_aaa:
config:
authentication:
data:
local: True
state: deleted
# After state:
# ------------
#
# do show aaa
# AAA Authentication Information
# ---------------------------------------------------------
# failthrough : True
# login-method :
# Using deleted
#
# Before state:
# -------------
#
# do show aaa
# AAA Authentication Information
# ---------------------------------------------------------
# failthrough : True
# login-method : local
- name: Delete aaa configurations
dellemc.enterprise_sonic.sonic_aaa:
config:
state: deleted
# After state:
# ------------
#
# do show aaa
# AAA Authentication Information
# ---------------------------------------------------------
# failthrough :
# login-method :
# Using merged
#
# Before state:
# -------------
#
# do show aaa
# AAA Authentication Information
# ---------------------------------------------------------
# failthrough : False
# login-method :
- name: Merge aaa configurations
dellemc.enterprise_sonic.sonic_aaa:
config:
authentication:
data:
local: true
fail_through: true
state: merged
# After state:
# ------------
#
# do show aaa
# AAA Authentication Information
# ---------------------------------------------------------
# failthrough : True
# login-method : local
# Using replaced
#
# Before state:
# -------------
#
# do show aaa
# AAA Authentication Information
# ---------------------------------------------------------
# failthrough : False
# login-method : local, radius
- name: Replace aaa configurations
dellemc.enterprise_sonic.sonic_aaa:
config:
authentication:
data:
group: ldap
fail_through: true
state: replaced
# After state:
# ------------
#
# do show aaa
# AAA Authentication Information
# ---------------------------------------------------------
# failthrough : True
# login-method : local, ldap
# Using overridden
#
# Before state:
# -------------
#
# do show aaa
# AAA Authentication Information
# ---------------------------------------------------------
# failthrough : False
# login-method : local, radius
- name: Override aaa configurations
dellemc.enterprise_sonic.sonic_aaa:
config:
authentication:
data:
group: tacacs+
fail_through: true
state: overridden
# After state:
# ------------
#
# do show aaa
# AAA Authentication Information
# ---------------------------------------------------------
# failthrough : True
# login-method : tacacs+
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The resulting configuration model invocation. Returned: when changed Sample: |
|
The generated configuration model invocation. Returned: when Sample: |
|
The configuration prior to the model invocation. Returned: always Sample: |
|
The set of commands pushed to the remote device. Returned: always Sample: |