cisco.ise.externalradiusserver module – Resource module for Externalradiusserver

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

New in cisco.ise 1.0.0

Synopsis

  • Manage operation create of the resource Externalradiusserver.

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

accountingPort

dictionary

Valid Range 1 to 65535.

authenticationPort

dictionary

Valid Range 1 to 65535.

authenticatorKey

string

The authenticatorKey is required only if enableKeyWrap is true, otherwise it must be ignored or empty. The maximum length is 20 ASCII characters or 40 HEXADECIMAL characters (depend on selection in field ‘keyInputFormat’).

description

string

Description.

enableKeyWrap

boolean

KeyWrap may only be enabled if it is supported on the device. When running in FIPS mode this option should be enabled for such devices.

Choices:

encryptionKey

string

The encryptionKey is required only if enableKeyWrap is true, otherwise it must be ignored or empty. The maximum length is 16 ASCII characters or 32 HEXADECIMAL characters (depend on selection in field ‘keyInputFormat’).

hostIP

string

The IP of the host - must be a valid IPV4 address.

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:

keyInputFormat

string

Specifies the format of the input for fields ‘encryptionKey’ and ‘authenticatorKey’. Allowed Values ASCII or HEXADECIMAL.

msgAuthIsRequiredOnResponse

boolean

Should ISE validate the existence of Message-Authenticator on responses from the eternal RADIUS server.

Choices:

name

string

Name.

proxyTimeout

dictionary

Valid Range 1 to 600.

retries

dictionary

Valid Range 1 to 9.

sharedSecret

string

Shared secret maximum length is 128 characters.

timeout

dictionary

Valid Range 1 to 120.

Notes

Note

  • SDK Method used are externalradiusserver.Externalradiusserver.create_externalradiusserver,

  • Paths used are post /externalradiusserver/,

  • 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.externalradiusserver:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accountingPort: 1813
    authenticationPort: 1812
    authenticatorKey: '20202020202020202020'
    description: example external radius server
    enableKeyWrap: true
    encryptionKey: '1616161616161616'
    hostIP: 1.1.1.1
    id: f75760e7-a4f9-40ef-93bb-88a97e9fb171
    keyInputFormat: ASCII
    msgAuthIsRequiredOnResponse: true
    name: externalRadiusServer1
    proxyTimeout: 300
    retries: 3
    sharedSecret: sharedSecret
    timeout: 5

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)