cisco.ise.external_radius_server – Resource module for External Radius Server

Note

This plugin is part of the cisco.ise collection (version 1.1.0).

To install it use: ansible-galaxy collection install cisco.ise.

To use it in a playbook, specify: cisco.ise.external_radius_server.

New in version 1.0.0: of cisco.ise

Synopsis

• Manage operations create, update and delete of the resource 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 >= 1.0.0

• python >= 3.5

Parameters

Parameter	Choices/Defaults	Comments
accountingPort integer		Valid Range 1 to 65535.
authenticationPort integer		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		External Radius Server's description.
enableKeyWrap boolean	Choices: no yes	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.
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		External Radius Server'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_verify boolean	Choices: no yes ←	Flag to enable or disable SSL certificate verification.
ise_version string	Default: "3.0.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.
keyInputFormat string		Specifies the format of the input for fields 'encryptionKey' and 'authenticatorKey'. Allowed Values - ASCII - HEXADECIMAL.
name string		Resource Name. Allowed charactera are alphanumeric and _ (underscore).
proxyTimeout integer		Valid Range 1 to 600.
retries integer		Valid Range 1 to 9.
sharedSecret string		Shared secret maximum length is 128 characters.
timeout integer		Valid Range 1 to 120.

Notes

Note

• Does not support check_mode

See Also

See also

External Radius Server reference

Complete reference of the External Radius Server object model.

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	Returned	Description
ise_response dictionary	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" } }

Authors

• Rafael Campos (@racampos)