.. 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 .. Anchors .. _ansible_collections.cisco.ise.radius_server_sequence_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.radius_server_sequence -- Resource module for Radius Server Sequence ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.ise collection `_ (version 2.0.0). 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 :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.ise`. To use it in a playbook, specify: :code:`cisco.ise.radius_server_sequence`. .. version_added .. versionadded:: 1.0.0 of cisco.ise .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Radius Server Sequence. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk >= 1.2.0 - python >= 3.5 .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
BeforeAcceptAttrManipulatorsList
list / elements=string
The beforeAcceptAttrManipulators is required only if useAttrSetBeforeAcc is true.
action
string
Allowed Values - ADD, - UPDATE, - REMOVE, - REMOVEANY.
attributeName
string
Radius Server Sequence's attributeName.
changedVal
string
The changedVal is required only if the action equals to 'UPDATE'.
dictionaryName
string
Radius Server Sequence's dictionaryName.
value
string
Radius Server Sequence's value.
continueAuthorzPolicy
boolean
    Choices:
  • no
  • yes
ContinueAuthorzPolicy flag.
description
string
Radius Server Sequence's description.
id
string
Radius Server Sequence's id.
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.
localAccounting
boolean
    Choices:
  • no
  • yes
LocalAccounting flag.
name
string
Radius Server Sequence's name.
OnRequestAttrManipulatorList
list / elements=string
The onRequestAttrManipulators is required only if useAttrSetOnRequest is true.
action
string
Allowed Values - ADD, - UPDATE, - REMOVE, - REMOVEANY.
attributeName
string
Radius Server Sequence's attributeName.
changedVal
string
The changedVal is required only if the action equals to 'UPDATE'.
dictionaryName
string
Radius Server Sequence's dictionaryName.
value
string
Radius Server Sequence's value.
prefixSeparator
string
The prefixSeparator is required only if stripPrefix is true. The maximum length is 1 character.
RadiusServerList
list / elements=string
Radius Server Sequence's RadiusServerList.
remoteAccounting
boolean
    Choices:
  • no
  • yes
RemoteAccounting flag.
stripPrefix
boolean
    Choices:
  • no
  • yes
StripPrefix flag.
stripSuffix
boolean
    Choices:
  • no
  • yes
StripSuffix flag.
suffixSeparator
string
The suffixSeparator is required only if stripSuffix is true. The maximum length is 1 character.
useAttrSetBeforeAcc
boolean
    Choices:
  • no
  • yes
UseAttrSetBeforeAcc flag.
useAttrSetOnRequest
boolean
    Choices:
  • no
  • yes
UseAttrSetOnRequest flag.

.. Attributes .. Notes Notes ----- .. note:: - 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 .. Seealso See Also -------- .. seealso:: `Radius Server Sequence reference `_ Complete reference of the Radius Server Sequence object model. .. 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: .. raw:: html
Key Returned Description
ise_response
dictionary
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "id": "string", "name": "string", "description": "string", "stripPrefix": true, "stripSuffix": true, "prefixSeparator": "string", "suffixSeparator": "string", "remoteAccounting": true, "localAccounting": true, "useAttrSetOnRequest": true, "useAttrSetBeforeAcc": true, "continueAuthorzPolicy": true, "RadiusServerList": [ "string" ], "OnRequestAttrManipulatorList": [ { "action": "string", "dictionaryName": "string", "attributeName": "string", "value": "string", "changedVal": "string" } ], "BeforeAcceptAttrManipulatorsList": [ { "action": "string", "dictionaryName": "string", "attributeName": "string", "value": "string", "changedVal": "string" } ], "link": { "rel": "string", "href": "string", "type": "string" } }
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" } }


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors