.. 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.radius_server_sequence_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.radius_server_sequence module -- Resource module for RADIUS Server Sequence +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. 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.radius_server_sequence`. .. version_added .. rst-class:: ansible-version-added New in cisco.ise 1.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource RADIUS Server Sequence. - This API creates a RADIUS server sequence. - This API deletes a RADIUS server sequence. - This API allows the client to update a RADIUS server sequence. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.ise.radius_server_sequence_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.radius_server_sequence_module__parameter-beforeacceptattrmanipulatorslist: .. rst-class:: ansible-option-title **BeforeAcceptAttrManipulatorsList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The beforeAcceptAttrManipulators is required only if useAttrSetBeforeAcc is true. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-beforeacceptattrmanipulatorslist/action: .. rst-class:: ansible-option-title **action** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Allowed Values - ADD, - UPDATE, - REMOVE, - REMOVEANY. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-beforeacceptattrmanipulatorslist/attributename: .. rst-class:: ansible-option-title **attributeName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
RADIUS Server Sequence's attributeName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-beforeacceptattrmanipulatorslist/changedval: .. rst-class:: ansible-option-title **changedVal** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The changedVal is required only if the action equals to 'UPDATE'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-beforeacceptattrmanipulatorslist/dictionaryname: .. rst-class:: ansible-option-title **dictionaryName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
RADIUS Server Sequence's dictionaryName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-beforeacceptattrmanipulatorslist/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
RADIUS Server Sequence's value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-continueauthorzpolicy: .. rst-class:: ansible-option-title **continueAuthorzPolicy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
ContinueAuthorzPolicy 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.radius_server_sequence_module__parameter-description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
RADIUS Server Sequence's description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_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
RADIUS Server Sequence's id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_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.radius_server_sequence_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.radius_server_sequence_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.radius_server_sequence_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.radius_server_sequence_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.radius_server_sequence_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.radius_server_sequence_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.radius_server_sequence_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.radius_server_sequence_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.radius_server_sequence_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.radius_server_sequence_module__parameter-localaccounting: .. rst-class:: ansible-option-title **localAccounting** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
LocalAccounting 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.radius_server_sequence_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
RADIUS Server Sequence's name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-onrequestattrmanipulatorlist: .. rst-class:: ansible-option-title **OnRequestAttrManipulatorList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The onRequestAttrManipulators is required only if useAttrSetOnRequest is true. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-onrequestattrmanipulatorlist/action: .. rst-class:: ansible-option-title **action** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Allowed Values - ADD, - UPDATE, - REMOVE, - REMOVEANY. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-onrequestattrmanipulatorlist/attributename: .. rst-class:: ansible-option-title **attributeName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
RADIUS Server Sequence's attributeName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-onrequestattrmanipulatorlist/changedval: .. rst-class:: ansible-option-title **changedVal** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The changedVal is required only if the action equals to 'UPDATE'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-onrequestattrmanipulatorlist/dictionaryname: .. rst-class:: ansible-option-title **dictionaryName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
RADIUS Server Sequence's dictionaryName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-onrequestattrmanipulatorlist/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
RADIUS Server Sequence's value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-prefixseparator: .. rst-class:: ansible-option-title **prefixSeparator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The prefixSeparator is required only if stripPrefix is true. The maximum length is 1 character. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-radiusserverlist: .. rst-class:: ansible-option-title **RADIUSServerList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
RADIUS Server Sequence's RADIUSServerList. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-remoteaccounting: .. rst-class:: ansible-option-title **remoteAccounting** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
RemoteAccounting 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.radius_server_sequence_module__parameter-stripprefix: .. rst-class:: ansible-option-title **stripPrefix** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
StripPrefix 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.radius_server_sequence_module__parameter-stripsuffix: .. rst-class:: ansible-option-title **stripSuffix** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
StripSuffix 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.radius_server_sequence_module__parameter-suffixseparator: .. rst-class:: ansible-option-title **suffixSeparator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The suffixSeparator is required only if stripSuffix is true. The maximum length is 1 character. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_module__parameter-useattrsetbeforeacc: .. rst-class:: ansible-option-title **useAttrSetBeforeAcc** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
UseAttrSetBeforeAcc 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.radius_server_sequence_module__parameter-useattrsetonrequest: .. rst-class:: ansible-option-title **useAttrSetOnRequest** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
UseAttrSetOnRequest flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are radius\_server\_sequence.RadiusServerSequence.create\_radius\_server\_sequence, radius\_server\_sequence.RadiusServerSequence.delete\_radius\_server\_sequence\_by\_id, radius\_server\_sequence.RadiusServerSequence.update\_radius\_server\_sequence\_by\_id, - Paths used are post /ers/config/radiusserversequence, delete /ers/config/radiusserversequence/{id}, put /ers/config/radiusserversequence/{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.radius_server_sequence: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present BeforeAcceptAttrManipulatorsList: - action: string attributeName: string changedVal: string dictionaryName: string value: string OnRequestAttrManipulatorList: - action: string attributeName: string changedVal: string dictionaryName: string value: string RadiusServerList: - string continueAuthorzPolicy: true description: string id: string localAccounting: true name: string prefixSeparator: string remoteAccounting: true stripPrefix: true stripSuffix: true suffixSeparator: string useAttrSetBeforeAcc: true useAttrSetOnRequest: true - name: Delete by id cisco.ise.radius_server_sequence: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: absent id: string - name: Create cisco.ise.radius_server_sequence: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present BeforeAcceptAttrManipulatorsList: - action: string attributeName: string changedVal: string dictionaryName: string value: string OnRequestAttrManipulatorList: - action: string attributeName: string changedVal: string dictionaryName: string value: string RadiusServerList: - string continueAuthorzPolicy: true description: string localAccounting: true name: string prefixSeparator: string remoteAccounting: true stripPrefix: true stripSuffix: true suffixSeparator: string useAttrSetBeforeAcc: true useAttrSetOnRequest: true .. 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.radius_server_sequence_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:`{"BeforeAcceptAttrManipulatorsList": [{"action": "string", "attributeName": "string", "changedVal": "string", "dictionaryName": "string", "value": "string"}], "OnRequestAttrManipulatorList": [{"action": "string", "attributeName": "string", "changedVal": "string", "dictionaryName": "string", "value": "string"}], "RadiusServerList": ["string"], "continueAuthorzPolicy": true, "description": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "localAccounting": true, "name": "string", "prefixSeparator": "string", "remoteAccounting": true, "stripPrefix": true, "stripSuffix": true, "suffixSeparator": "string", "useAttrSetBeforeAcc": true, "useAttrSetOnRequest": true}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.radius_server_sequence_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