cisco.ise.radiusserversequence module – Resource module for RADIUSserversequence

Note

This module is part of the cisco.ise collection (version 3.0.0).

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.radiusserversequence.

New in cisco.ise 1.0.0

Synopsis

  • Manage operation create of the resource RADIUSserversequence.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 2.0.1

  • python >= 3.5

Parameters

Parameter

Comments

BeforeAcceptAttrManipulatorsList

list / elements=dictionary

The beforeAcceptAttrManipulators is required only if useAttrSetBeforeAcc is true.

continueAuthorzPolicy

boolean

ContinueAuthorzPolicy flag.

Choices:

description

string

Description.

id

string

Id.

ise_debug

boolean

Flag for Identity Services Engine SDK to enable debugging.

Choices:

ise_hostname

string / required

The Identity Services Engine hostname.

ise_password

string / required

The Identity Services Engine password to authenticate.

ise_single_request_timeout

integer

added in cisco.ise 3.0.0

Timeout (in seconds) for RESTful HTTP requests.

Default: :ansible-option-default:`60`

ise_username

string / required

The Identity Services Engine username to authenticate.

ise_uses_api_gateway

boolean

added in cisco.ise 1.1.0

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:

ise_uses_csrf_token

boolean

added in cisco.ise 3.0.0

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:

ise_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

ise_version

string

Informs the SDK which version of Identity Services Engine to use.

Default: :ansible-option-default:`"3.1\_Patch\_1"`

ise_wait_on_rate_limit

boolean

Flag for Identity Services Engine SDK to enable automatic rate-limit handling.

Choices:

localAccounting

boolean

LocalAccounting flag.

Choices:

name

string

Name.

OnRequestAttrManipulatorList

list / elements=dictionary

The onRequestAttrManipulators is required only if useAttrSetOnRequest is true.

prefixSeparator

string

The prefixSeparator is required only if stripPrefix is true. The maximum length is 1 character.

RADIUSServerList

list / elements=string

List with names of external radius server. The order of the names in the list is the order of servers that will be used during authentication.

remoteAccounting

boolean

RemoteAccounting flag.

Choices:

stripPrefix

boolean

StripPrefix flag.

Choices:

stripSuffix

boolean

StripSuffix flag.

Choices:

suffixSeparator

string

The suffixSeparator is required only if stripSuffix is true. The maximum length is 1 character.

useAttrSetBeforeAcc

boolean

UseAttrSetBeforeAcc flag.

Choices:

useAttrSetOnRequest

boolean

UseAttrSetOnRequest flag.

Choices:

Notes

Note

  • SDK Method used are radiusserversequence.Radiusserversequence.create_radiusserversequence,

  • Paths used are post /radiusserversequence/,

  • 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: Create
  cisco.ise.radiusserversequence:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    BeforeAcceptAttrManipulatorsList:
      - action: ADD
        attributeName: cisco-prev-hop-ip
        changedVal: test2
        dictionaryName: Cisco
        value: test1
      - action: UPDATE
        attributeName: Cisco:cisco-ppp-vj-slot-comp
        changedVal: '13'
        dictionaryName: Cisco
        value: '12'
    OnRequestAttrManipulatorList:
      - action: ADD
        attributeName: cisco-prev-hop-ip
        changedVal: test2
        dictionaryName: Cisco
        value: test1
      - action: UPDATE
        attributeName: Cisco:cisco-ppp-vj-slot-comp
        changedVal: '13'
        dictionaryName: Cisco
        value: '12'
    RadiusServerList:
      - externalRadiusServer1
      - externalRadiusServer2
    continueAuthorzPolicy: false
    description: description
    id: f75760e7-a4f9-40ef-93bb-88a97e9fb171
    localAccounting: false
    name: name
    prefixSeparator: \
    remoteAccounting: true
    stripPrefix: false
    stripSuffix: false
    suffixSeparator: '@'
    useAttrSetBeforeAcc: false
    useAttrSetOnRequest: false

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

ise_response

list / elements=dictionary

A dictionary or list with the response returned by the Cisco ISE Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`"[\\n {\\n \\"id\\": \\"string\\",\\n \\"name\\": \\"string\\",\\n \\"description\\": \\"string\\",\\n \\"link\\": {\\n \\"rel\\": \\"string\\",\\n \\"href\\": \\"string\\",\\n \\"type\\": \\"string\\"\\n }\\n }\\n]\\n"`

Authors

  • Rafael Campos (@racampos)