cisco.ise.network_access_dictionary_attribute 模块 – 网络访问字典属性资源模块

注意

此模块是 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。

cisco.ise 1.0.0 中的新增功能

概要 

管理网络访问字典属性资源的创建、更新和删除操作。
为现有字典创建一个新的字典属性。
删除字典属性。
更新字典属性。

注意

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

需求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
allowedValues 列表 / 元素=字典	字典属性的所有允许值。
isDefault 布尔值	如果此键值是字典属性允许值中的默认值，则为 True。选项 `false` `true`
key 字符串	网络访问字典属性的键。
value 字符串	网络访问字典属性的值。
dataType 字符串	字典属性的数据类型。
description 字符串	字典属性的描述。
dictionaryName 字符串	字典属性所属的字典名称。
directionType 字符串	字典属性用法的方向。
id 字符串	字典属性的标识符。
internalName 字符串	字典属性的内部名称。
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.create_network_access_dictionary_attribute、network_access_dictionary_attribute.NetworkAccessDictionaryAttribute.delete_network_access_dictionary_attribute_by_name、network_access_dictionary_attribute.NetworkAccessDictionaryAttribute.update_network_access_dictionary_attribute_by_name，
使用的路径是 post /network-access/dictionaries/{dictionaryName}/attribute、delete /network-access/dictionaries/{dictionaryName}/attribute/{name}、put /network-access/dictionaries/{dictionaryName}/attribute/{name}，
不支持 check_mode
该插件运行在控制节点上，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器。
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接。

参见 

另请参见

Cisco ISE 文档，关于网络访问 - 字典属性。: 网络访问 - 字典属性 API 的完整参考。

示例 

- name: Create
  cisco.ise.network_access_dictionary_attribute:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    allowedValues:
    - isDefault: true
      key: string
      value: string
    dataType: string
    description: string
    dictionaryName: string
    directionType: string
    id: string
    internalName: string
    name: string

- name: Update by name
  cisco.ise.network_access_dictionary_attribute:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    allowedValues:
    - isDefault: true
      key: string
      value: string
    dataType: string
    description: string
    dictionaryName: string
    directionType: string
    id: string
    internalName: string
    name: string

- name: Delete by name
  cisco.ise.network_access_dictionary_attribute:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    dictionaryName: string
    name: string

返回值 

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

键	描述
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"}`
ise_update_response 字典在 cisco.ise 1.1.0 中添加	包含 Cisco ISE Python SDK 返回的响应的字典或列表。返回值：始终返回示例： `{"response": {"allowedValues": [{"isDefault": true, "key": "string", "value": "string"}], "dataType": "string", "description": "string", "dictionaryName": "string", "directionType": "string", "id": "string", "internalName": "string", "name": "string"}, "version": "string"}`

作者

Rafael Campos (@racampos)