cisco.ise.aci_settings module – Resource module for ACI Settings
Note
This module is part of the cisco.ise collection (version 2.5.12).
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 cisco.ise
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.ise.aci_settings
.
New in cisco.ise 1.0.0
Synopsis
Manage operation update of the resource ACI Settings.
This API allows the client to update ACI settings.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 2.0.8
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Enable 5.0 ACI Version. Choices:
|
|
Enable 5.1 ACI Version. Choices:
|
|
ACI Domain manager Ip Address. |
|
ACI Domain manager Password. |
|
ACI Domain manager Username. |
|
ACI Cluster Admin name. |
|
ACI Cluster Admin password. |
|
AllSXPDomain flag. Choices:
|
|
ACI Settings’s defaultSGtName. |
|
Enable ACI Integration. Choices:
|
|
EnableDataPlane flag. Choices:
|
|
EnableElementsLimit flag. Choices:
|
|
Resource UUID value. |
|
ACI Cluster IP Address / Host name. |
|
Flag for Identity Services Engine SDK to enable debugging. Choices:
|
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
The Identity Services Engine username to authenticate. |
|
Flag that informs the SDK whether to use the Identity Services Engine’s API Gateway to send requests. If it is true, it uses the ISE’s API Gateway and sends requests to https://{{ise_hostname}}. If it is false, it sends the requests to https://{{ise_hostname}}:{{port}}, where the port value depends on the Service used (ERS, Mnt, UI, PxGrid). Choices:
|
|
Flag that informs the SDK whether we send the CSRF token to ISE’s ERS APIs. If it is True, the SDK assumes that your ISE CSRF Check is enabled. If it is True, it assumes you need the SDK to manage the CSRF token automatically for you. Choices:
|
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Identity Services Engine to use. Default: |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices:
|
|
ACI Settings’s l3RouteNetwork. |
|
ACI Settings’s maxNumIepgFromACI. |
|
ACI Settings’s maxNumSGtToACI. |
|
SpecificSXPDomain flag. Choices:
|
|
ACI Settings’s specifixSXPDomainList. |
|
ACI Settings’s suffixToEpg. |
|
ACI Settings’s suffixToSGt. |
|
ACI Settings’s tenantName. |
|
ACI Settings’s untaggedPacketIepgName. |
Notes
Note
SDK Method used are aci_settings.AciSettings.update_aci_settings_by_id,
Paths used are put /ers/config/acisettings/{id},
Does not support
check_mode
The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco ISE SDK
The parameters starting with ise_ are used by the Cisco ISE Python SDK to establish the connection
Examples
- name: Update by id
cisco.ise.aci_settings:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
aci50: true
aci51: true
aciipaddress: string
acipassword: string
aciuserName: string
adminName: string
adminPassword: string
allSxpDomain: true
defaultSgtName: string
enableAci: true
enableDataPlane: true
enableElementsLimit: true
id: string
ipAddressHostName: string
l3RouteNetwork: string
maxNumIepgFromAci: 0
maxNumSgtToAci: 0
specificSxpDomain: true
specifixSxpDomainList:
- string
suffixToEpg: string
suffixToSgt: string
tenantName: string
untaggedPacketIepgName: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |
|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |