cisco.ise.external_radius_server module – Resource module for External RADIUS Server
Note
This module is part of the cisco.ise collection (version 2.5.9).
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 ansible-galaxy collection list.
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.external_radius_server.
New in cisco.ise 1.0.0
Synopsis
Manage operations create, update and delete of the resource External RADIUS Server.
This API creates an external RADIUS server.
This API deletes an external RADIUS server.
This API allows the client to update an external RADIUS server.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 2.0.8
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Valid Range 1 to 65535. |
|
Valid Range 1 to 65535. |
|
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’). |
|
External RADIUS Server’s description. |
|
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:
|
|
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’). |
|
The IP of the host - must be a valid IPV4 address. |
|
External RADIUS Server’s id. |
|
Flag for Identity Services Engine SDK to enable debugging. Choices:
|
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
The Identity Services Engine username to authenticate. |
|
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:
|
|
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:
|
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Identity Services Engine to use. Default: |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices:
|
|
Specifies the format of the input for fields ‘encryptionKey’ and ‘authenticatorKey’. Allowed Values - ASCII - HEXADECIMAL. |
|
Resource Name. Allowed charactera are alphanumeric and _ (underscore). |
|
Valid Range 1 to 600. |
|
Valid Range 1 to 9. |
|
Shared secret maximum length is 128 characters. |
|
Valid Range 1 to 120. |
Notes
Note
SDK Method used are external_radius_server.ExternalRadiusServer.create_external_radius_server, external_radius_server.ExternalRadiusServer.delete_external_radius_server_by_id, external_radius_server.ExternalRadiusServer.update_external_radius_server_by_id,
Paths used are post /ers/config/externalradiusserver, delete /ers/config/externalradiusserver/{id}, put /ers/config/externalradiusserver/{id},
Does not support
check_modeThe 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: Update by id
cisco.ise.external_radius_server:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
accountingPort: 0
authenticationPort: 0
authenticatorKey: string
description: string
enableKeyWrap: true
encryptionKey: string
hostIP: string
id: string
keyInputFormat: string
name: string
proxyTimeout: 0
retries: 0
sharedSecret: string
timeout: 0
- name: Delete by id
cisco.ise.external_radius_server:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
id: string
- name: Create
cisco.ise.external_radius_server:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
accountingPort: 0
authenticationPort: 0
authenticatorKey: string
description: string
enableKeyWrap: true
encryptionKey: string
hostIP: string
keyInputFormat: string
name: string
proxyTimeout: 0
retries: 0
sharedSecret: string
timeout: 0
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |
|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |