cisco.ise.rest_id_store 模块 – REST ID 存储的资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新功能

概要 

管理资源 REST ID 存储的创建、更新和删除操作。
此 API 创建一个 REST ID 存储。
此 API 按名称删除 REST ID 存储。
此 API 删除一个 REST ID 存储。
此 API 允许客户端按名称更新 REST ID 存储。
此 API 允许客户端更新 REST ID 存储。

注意

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

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
description 字符串	REST ID 存储的描述。
ersRESTIDStoreAttributes 字典	REST ID 存储的 ersRESTIDStoreAttributes。
headers 列表 / 元素=字典	REST ID 存储的标头。
key 字符串	REST ID 存储的键。
value 字符串	REST ID 存储的值。
predefined 字符串	连接到 RESTIDStore 的云提供商。选项为 - Azure， - Okta， - None。
rootUrl 字符串	RESTIDStore 根的 URL。
usernameSuffix 字符串	用户名域的后缀。
ersRESTIDStoreUserAttributes 字典	REST ID 存储的 ersRESTIDStoreUserAttributes。
attributes 列表 / 元素=字符串	REST ID 存储的属性。
id 字符串	REST ID 存储的 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 网关发送请求的标志。如果为 true，它将使用 ISE 的 API 网关并将请求发送到 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` ← （默认）
name 字符串	REST ID 存储的名称。

说明 

注意

使用的 SDK 方法是 restid_store.RestidStore.create_rest_id_store，restid_store.RestidStore.delete_rest_id_store_by_id，restid_store.RestidStore.delete_rest_id_store_by_name，restid_store.RestidStore.update_rest_id_store_by_id，restid_store.RestidStore.update_rest_id_store_by_name，
使用的路径为：post /ers/config/restidstore，delete /ers/config/restidstore/name/{name}，delete /ers/config/restidstore/{id}，put /ers/config/restidstore/name/{name}，put /ers/config/restidstore/{id}。
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器。
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接。

示例 

- name: Update by name
  cisco.ise.rest_id_store:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    ersRestIDStoreAttributes:
      headers:
      - key: string
        value: string
      predefined: string
      rootUrl: string
      usernameSuffix: string
    id: string
    name: string

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

- name: Update by id
  cisco.ise.rest_id_store:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    ersRestIDStoreAttributes:
      headers:
      - key: string
        value: string
      predefined: string
      rootUrl: string
      usernameSuffix: string
    id: string
    name: string

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

- name: Create
  cisco.ise.rest_id_store:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    ersRestIDStoreAttributes:
      headers:
      - key: string
        value: string
      predefined: string
      rootUrl: string
      usernameSuffix: string
    ersRestIDStoreUserAttributes:
      attributes:
      - string
    name: string

返回值 

常见返回值记录在这里，以下是此模块独有的字段。

键	描述
ise_response 字典	一个字典或列表，包含 Cisco ISE Python SDK 返回的响应。返回：总是示例： `{"description": "string", "ersRestIDStoreAttributes": {"headers": [{"key": "string", "value": "string"}], "predefined": "string", "rootUrl": "string", "usernameSuffix": "string"}, "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string"}`
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)