cisco.ise.network_access_dictionary_attribute_info 模块 – 网络访问字典属性信息模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新增功能

概要

  • 获取所有网络访问字典属性。

  • 按名称获取网络访问字典属性。

  • 获取字典属性。

  • 返回现有字典的字典属性列表。

注意

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

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

dictionaryName

字符串

DictionaryName 路径参数。字典属性所属的字典的名称。

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 网关发送请求的标志。

如果为真，则使用 ISE 的 API 网关并将请求发送到 https://{{ise_hostname}}。

如果为假，则将请求发送到 https://{{ise_hostname}}:{{port}}，其中端口值取决于使用的服务 (ERS、Mnt、UI、PxGrid)。

选项

  • false

  • true ← (默认)

ise_uses_csrf_token

布尔值

在 cisco.ise 3.0.0 中添加

通知 SDK 我们是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。

如果为真，则 SDK 假设您的 ISE CSRF 检查已启用。

如果为真，则假设您需要 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 ← (默认)

name

字符串

名称路径参数。字典属性名称。

备注

注意

  • 使用的 SDK 方法为 network_access_dictionary_attribute.NetworkAccessDictionaryAttribute.get_network_access_dictionary_attribute_by_name, network_access_dictionary_attribute.NetworkAccessDictionaryAttribute.get_network_access_dictionary_attributes_by_dictionary_name,

  • 使用的路径为 get /network-access/dictionaries/{dictionaryName}/attribute, get /network-access/dictionaries/{dictionaryName}/attribute/{name},

  • 支持 check_mode

  • 插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器

  • 以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

另请参阅

另请参阅

Cisco ISE 网络访问 - 字典属性文档

网络访问 - 字典属性 API 的完整参考。

示例

- name: Get all Network Access Dictionary Attribute
  cisco.ise.network_access_dictionary_attribute_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    dictionaryName: string
  register: result

- name: Get Network Access Dictionary Attribute by name
  cisco.ise.network_access_dictionary_attribute_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    name: string
    dictionaryName: string
  register: result

返回值

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

键

描述

ise_response

字典

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

返回值：始终返回

示例： {"allowedValues": [{"isDefault": true, "key": "string", "value": "string"}], "dataType": "string", "description": "string", "dictionaryName": "string", "directionType": "string", "id": "string", "internalName": "string", "name": "string"}

作者

  • Rafael Campos (@racampos)