.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.ise.aci_settings_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.aci_settings module -- Resource module for ACI Settings +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.ise collection `_ (version 2.10.0). To install it, use: :code:`ansible-galaxy collection install cisco.ise`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.ise.aci_settings`. .. version_added .. rst-class:: ansible-version-added New in cisco.ise 1.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation update of the resource ACI Settings. - This API allows the client to update ACI settings. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.ise.aci_settings_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk \>= 2.2.3 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-aci50: .. rst-class:: ansible-option-title **aci50** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable 5.0 ACI Version. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-aci51: .. rst-class:: ansible-option-title **aci51** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable 5.1 ACI Version. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-aciipaddress: .. rst-class:: ansible-option-title **aciipaddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ACI Domain manager Ip Address. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-acipassword: .. rst-class:: ansible-option-title **acipassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ACI Domain manager Password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-aciusername: .. rst-class:: ansible-option-title **aciuserName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ACI Domain manager Username. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-adminname: .. rst-class:: ansible-option-title **adminName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ACI Cluster Admin name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-adminpassword: .. rst-class:: ansible-option-title **adminPassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ACI Cluster Admin password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-allsxpdomain: .. rst-class:: ansible-option-title **allSXPDomain** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
AllSXPDomain flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-defaultsgtname: .. rst-class:: ansible-option-title **defaultSGtName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ACI Settings's defaultSGtName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-enableaci: .. rst-class:: ansible-option-title **enableACI** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable ACI Integration. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-enabledataplane: .. rst-class:: ansible-option-title **enableDataPlane** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
EnableDataPlane flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-enableelementslimit: .. rst-class:: ansible-option-title **enableElementsLimit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
EnableElementsLimit flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Resource UUID value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-ipaddresshostname: .. rst-class:: ansible-option-title **ipAddressHostName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ACI Cluster IP Address / Host name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-ise_debug: .. rst-class:: ansible-option-title **ise_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-ise_hostname: .. rst-class:: ansible-option-title **ise_hostname** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-ise_password: .. rst-class:: ansible-option-title **ise_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-ise_single_request_timeout: .. rst-class:: ansible-option-title **ise_single_request_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` :ansible-option-versionadded:`added in cisco.ise 3.0.0` .. raw:: html
- .. raw:: html
Timeout (in seconds) for RESTful HTTP requests. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-ise_username: .. rst-class:: ansible-option-title **ise_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine username to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-ise_uses_api_gateway: .. rst-class:: ansible-option-title **ise_uses_api_gateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in cisco.ise 1.1.0` .. raw:: html
- .. raw:: html
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). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-ise_uses_csrf_token: .. rst-class:: ansible-option-title **ise_uses_csrf_token** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in cisco.ise 3.0.0` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-ise_verify: .. rst-class:: ansible-option-title **ise_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-ise_version: .. rst-class:: ansible-option-title **ise_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Identity Services Engine to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1\_Patch\_1"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-ise_wait_on_rate_limit: .. rst-class:: ansible-option-title **ise_wait_on_rate_limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-l3routenetwork: .. rst-class:: ansible-option-title **l3RouteNetwork** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ACI Settings's l3RouteNetwork. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-maxnumiepgfromaci: .. rst-class:: ansible-option-title **maxNumIepgFromACI** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
ACI Settings's maxNumIepgFromACI. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-maxnumsgttoaci: .. rst-class:: ansible-option-title **maxNumSGtToACI** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
ACI Settings's maxNumSGtToACI. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-specificsxpdomain: .. rst-class:: ansible-option-title **specificSXPDomain** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
SpecificSXPDomain flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-specifixsxpdomainlist: .. rst-class:: ansible-option-title **specifixSXPDomainList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
ACI Settings's specifixSXPDomainList. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-suffixtoepg: .. rst-class:: ansible-option-title **suffixToEpg** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ACI Settings's suffixToEpg. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-suffixtosgt: .. rst-class:: ansible-option-title **suffixToSGt** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ACI Settings's suffixToSGt. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-tenantname: .. rst-class:: ansible-option-title **tenantName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ACI Settings's tenantName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__parameter-untaggedpacketiepgname: .. rst-class:: ansible-option-title **untaggedPacketIepgName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ACI Settings's untaggedPacketIepgName. .. raw:: html
.. Attributes .. Notes 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 \ :literal:`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 .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__return-ise_response: .. rst-class:: ansible-option-title **ise_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco ISE Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"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"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.aci_settings_module__return-ise_update_response: .. rst-class:: ansible-option-title **ise_update_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in cisco.ise 1.1.0` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco ISE Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors