cisco.ise.external_radius_server 模块 – 外部 RADIUS 服务器资源模块

注意

此模块是 cisco.ise 集合 (版本 2.9.6) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块，请参阅要求获取详细信息。

要在 playbook 中使用它，请指定： cisco.ise.external_radius_server。

cisco.ise 1.0.0 中的新增功能

概要 

管理外部 RADIUS 服务器资源的创建、更新和删除操作。
此 API 创建一个外部 RADIUS 服务器。
此 API 删除一个外部 RADIUS 服务器。
此 API 允许客户端更新外部 RADIUS 服务器。

注意

此模块具有相应的 action 插件。

要求 

执行此模块的主机需要以下要求。

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
accountingPort 整数	有效范围 1 到 65535。
authenticationPort 整数	有效范围 1 到 65535。
authenticatorKey 字符串	仅当 enableKeyWrap 为 true 时才需要 authenticatorKey，否则必须忽略或为空。最大长度为 20 个 ASCII 字符或 40 个十六进制字符（取决于“keyInputFormat”字段中的选择）。
description 字符串	外部 RADIUS 服务器的描述。
enableKeyWrap 布尔值	仅当设备支持时才能启用 KeyWrap。在 FIPS 模式下运行时，应为此类设备启用此选项。选项 `false` `true`
encryptionKey 字符串	仅当 enableKeyWrap 为 true 时才需要 encryptionKey，否则必须忽略或为空。最大长度为 16 个 ASCII 字符或 32 个十六进制字符（取决于“keyInputFormat”字段中的选择）。
hostIP 字符串	主机的 IP 地址 - 必须是有效的 IPv4 地址。
id 字符串	外部 RADIUS 服务器的 ID。
ise_debug 布尔值	用于 Identity Services Engine SDK 的标志，用于启用调试。选项 `false` ← (默认) `true`
ise_hostname 字符串 / 必需	Identity Services Engine 主机名。
ise_password 字符串 / 必需	用于身份验证的 Identity Services Engine 密码。
ise_single_request_timeout 整数在 cisco.ise 3.0.0 中添加	RESTful HTTP 请求的超时时间（以秒为单位）。默认值： `60`
ise_username 字符串 / 必需	用于身份验证的 Identity Services Engine 用户名。
ise_uses_api_gateway 布尔值在 cisco.ise 1.1.0 中添加	告知 SDK 是否使用 Identity Services Engine 的 API Gateway 发送请求的标志。如果为 true，则使用 ISE 的 API Gateway 并将请求发送到 https://{{ise_hostname}}。如果为 false，则将请求发送到 https://{{ise_hostname}}:{{port}}，其中端口值取决于使用的服务（ERS、Mnt、UI、PxGrid）。选项 `false` `true` ← (默认)
ise_uses_csrf_token 布尔值在 cisco.ise 3.0.0 中添加	告知 SDK 我们是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。如果为 True，则 SDK 假设您的 ISE CSRF 检查已启用。如果为 True，则假定您需要 SDK 自动为您管理 CSRF 令牌。选项 `false` ← (默认) `true`
ise_verify 布尔值	启用或禁用 SSL 证书验证的标志。选项 `false` `true` ← (默认)
ise_version 字符串	告知 SDK 使用哪个版本的 Identity Services Engine。默认值： `"3.1_Patch_1"`
ise_wait_on_rate_limit 布尔值	用于 Identity Services Engine SDK 的标志，用于启用自动速率限制处理。选项 `false` `true` ← (默认)
keyInputFormat 字符串	指定“encryptionKey”和“authenticatorKey”字段的输入格式。允许的值 - ASCII - 十六进制。
name 字符串	资源名称。允许的字符是字母数字和 _（下划线）。
proxyTimeout 整数	有效范围 1 到 600。
retries 整数	有效范围 1 到 9。
sharedSecret 字符串	共享密钥最大长度为 128 个字符。
timeout 整数	有效范围 1 到 120。

注释 

注意

使用的SDK方法包括：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。
使用的路径包括：post /ers/config/externalradiusserver、delete /ers/config/externalradiusserver/{id}、put /ers/config/externalradiusserver/{id}。
不支持check_mode
该插件在控制节点上运行，不使用任何Ansible连接插件，而是使用Cisco ISE SDK的嵌入式连接管理器。
以`ise_`开头的参数由Cisco ISE Python SDK用于建立连接。

示例 

- 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

返回值 

常用的返回值已在此处记录，以下是此模块独有的字段。

键

描述

ise_response

字典

包含Cisco ISE Python SDK返回的响应的字典或列表。

返回值：始终返回

示例：{"accountingPort": 0, "authenticationPort": 0, "authenticatorKey": "string", "description": "string", "enableKeyWrap": true, "encryptionKey": "string", "hostIP": "string", "id": "string", "keyInputFormat": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "proxyTimeout": 0, "retries": 0, "sharedSecret": "string", "timeout": 0}

ise_update_response

字典

在 cisco.ise 1.1.0 中添加

包含Cisco ISE Python SDK返回的响应的字典或列表。

返回值：始终返回

示例：{"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}

作者

Rafael Campos (@racampos)