cisco.ise.aci_settings – Resource module for Aci Settings

Note

This plugin is part of the cisco.ise collection (version 1.2.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 cisco.ise.

To use it in a playbook, specify: cisco.ise.aci_settings.

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operation update of the resource Aci Settings.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • ciscoisesdk >= 1.1.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
aci50
boolean
    Choices:
  • no
  • yes
Enable 5.0 ACI Version.
aci51
boolean
    Choices:
  • no
  • yes
Enable 5.1 ACI Version.
aciipaddress
string
ACI Domain manager Ip Address.
acipassword
string
ACI Domain manager Password.
aciuserName
string
ACI Domain manager Username.
adminName
string
ACI Cluster Admin name.
adminPassword
string
ACI Cluster Admin password.
allSxpDomain
boolean
    Choices:
  • no
  • yes
AllSxpDomain flag.
defaultSgtName
string
Aci Settings's defaultSgtName.
enableAci
boolean
    Choices:
  • no
  • yes
Enable ACI Integration.
enableDataPlane
boolean
    Choices:
  • no
  • yes
EnableDataPlane flag.
enableElementsLimit
boolean
    Choices:
  • no
  • yes
EnableElementsLimit flag.
id
string
Resource UUID value.
ipAddressHostName
string
ACI Cluster IP Address / Host name.
ise_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Identity Services Engine SDK to enable debugging.
ise_hostname
string / required
The Identity Services Engine hostname.
ise_password
string / required
The Identity Services Engine password to authenticate.
ise_username
string / required
The Identity Services Engine username to authenticate.
ise_uses_api_gateway
boolean
added in 1.1.0 of cisco.ise
    Choices:
  • no
  • yes ←
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).
ise_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
ise_version
string
Default:
"3.1.0"
Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit
boolean
    Choices:
  • no
  • yes ←
Flag for Identity Services Engine SDK to enable automatic rate-limit handling.
l3RouteNetwork
string
Aci Settings's l3RouteNetwork.
maxNumIepgFromAci
integer
Aci Settings's maxNumIepgFromAci.
maxNumSgtToAci
integer
Aci Settings's maxNumSgtToAci.
specificSxpDomain
boolean
    Choices:
  • no
  • yes
SpecificSxpDomain flag.
specifixSxpDomainList
list / elements=string
Aci Settings's specifixSxpDomainList.
suffixToEpg
string
Aci Settings's suffixToEpg.
suffixToSgt
string
Aci Settings's suffixToSgt.
tenantName
string
Aci Settings's tenantName.
untaggedPacketIepgName
string
Aci Settings's untaggedPacketIepgName.

Notes

Note

  • Does not support check_mode

See Also

See also

Aci Settings reference

Complete reference of the Aci Settings object model.

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 Returned Description
ise_response
dictionary
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "id": "string", "enableAci": true, "ipAddressHostName": "string", "adminName": "string", "adminPassword": "string", "aciipaddress": "string", "aciuserName": "string", "acipassword": "string", "tenantName": "string", "l3RouteNetwork": "string", "suffixToEpg": "string", "suffixToSgt": "string", "allSxpDomain": true, "specificSxpDomain": true, "specifixSxpDomainList": [ "string" ], "enableDataPlane": true, "untaggedPacketIepgName": "string", "defaultSgtName": "string", "enableElementsLimit": true, "maxNumIepgFromAci": 0, "maxNumSgtToAci": 0, "aci50": true, "aci51": true }
ise_update_response
dictionary
added in 1.1.0 of cisco.ise
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "UpdatedFieldsList": { "updatedField": { "field": "string", "oldValue": "string", "newValue": "string" }, "field": "string", "oldValue": "string", "newValue": "string" } }


Authors

  • Rafael Campos (@racampos)