cisco.ise.endpoints_bulk 模块 – 批量端点资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新增功能

概要

• 管理端点批量资源的创建、更新和删除操作。

注意

此模块具有相应的 操作插件。

要求

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

• ciscoisesdk >= 2.2.3

• python >= 3.5

参数

参数	注释
connectedLinks 字典	批量端点的 connectedLinks。
customAttributes 字典	批量端点的 customAttributes。
description 字符串	批量端点的 description。
deviceType 字符串	批量端点的 deviceType。
groupId 字符串	批量端点的 groupId。
hardwareRevision 字符串	批量端点的 hardwareRevision。
id 字符串	批量端点的 id。
identityStore 字符串	批量端点的 identityStore。
identityStoreId 字符串	批量端点的 identityStoreId。
ipAddress 字符串	批量端点的 ipAddress。
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 ← (默认)
mac 字符串	批量端点的 mac。
mdmAttributes 字典	批量端点的 mdmAttributes。
name 字符串	批量端点的 name。
payload 列表 / 元素=字典	批量端点的 payload。
connectedLinks 字典	批量端点的 connectedLinks。
customAttributes 字典	批量端点的 customAttributes。
description 字符串	批量端点的 description。
deviceType 字符串	批量端点的 deviceType。
groupId 字符串	批量端点的 groupId。
hardwareRevision 字符串	批量端点的 hardwareRevision。
id 字符串	批量端点的 id。
identityStore 字符串	批量端点的 identityStore。
identityStoreId 字符串	批量端点的 identityStoreId。
ipAddress 字符串	批量端点的 ipAddress。
mac 字符串	批量端点的 mac。
mdmAttributes 字典	批量端点的 mdmAttributes。
name 字符串	批量端点的 name。
portalUser 字符串	批量端点的 portalUser。
productId 字符串	批量端点的 productId。
profileId 字符串	批量端点的 profileId。
protocol 字符串	批量端点的 protocol。
serialNumber 字符串	批量端点的 serialNumber。
softwareRevision 字符串	批量端点的 softwareRevision。
staticGroupAssignment 布尔值	StaticGroupAssignment 标志。 选项 false true
staticProfileAssignment 布尔值	StaticProfileAssignment 标志。 选项 false true
vendor 字符串	批量端点的 vendor。
portalUser 字符串	批量端点的 portalUser。
productId 字符串	批量端点的 productId。
profileId 字符串	批量端点的 profileId。
protocol 字符串	批量端点的 protocol。
serialNumber 字符串	批量端点的 serialNumber。
softwareRevision 字符串	批量端点的 softwareRevision。
staticGroupAssignment 布尔值	StaticGroupAssignment 标志。 选项 false true
staticProfileAssignment 布尔值	StaticProfileAssignment 标志。 选项 false true
value 字符串	值路径参数。端点的 ID 或 MAC。
vendor 字符串	批量端点的 vendor。

注释

注意

• 使用的 SDK 方法为 endpoints.Endpoints.create_bulk_end_points、endpoints.Endpoints.delete_endpoint、endpoints.Endpoints.update_bulk_end_points、endpoints.Endpoints.update_endpoint。

• 使用的路径为 post /api/v1/endpoint、post /api/v1/endpoint/bulk、delete /api/v1/endpoint/bulk、delete /api/v1/endpoint/{value}、put /api/v1/endpoint/bulk、put /api/v1/endpoint/{value}。

• 不支持check_mode

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

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

示例

- name: Create
  cisco.ise.endpoints_bulk:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    payload:
    - connectedLinks: {}
      customAttributes: {}
      description: string
      deviceType: string
      groupId: string
      hardwareRevision: string
      id: string
      identityStore: string
      identityStoreId: string
      ipAddress: string
      mac: string
      mdmAttributes: {}
      name: string
      portalUser: string
      productId: string
      profileId: string
      protocol: string
      serialNumber: string
      softwareRevision: string
      staticGroupAssignment: true
      staticProfileAssignment: true
      vendor: string

- name: Update all
  cisco.ise.endpoints_bulk:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    payload:
    - connectedLinks: {}
      customAttributes: {}
      description: string
      deviceType: string
      groupId: string
      hardwareRevision: string
      id: string
      identityStore: string
      identityStoreId: string
      ipAddress: string
      mac: string
      mdmAttributes: {}
      name: string
      portalUser: string
      productId: string
      profileId: string
      protocol: string
      serialNumber: string
      softwareRevision: string
      staticGroupAssignment: true
      staticProfileAssignment: true
      vendor: string

- name: Delete all
  cisco.ise.endpoints_bulk:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent

- name: Update by id
  cisco.ise.endpoints_bulk:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    connectedLinks: {}
    customAttributes: {}
    description: string
    deviceType: string
    groupId: string
    hardwareRevision: string
    id: string
    identityStore: string
    identityStoreId: string
    ipAddress: string
    mac: string
    mdmAttributes: {}
    name: string
    portalUser: string
    productId: string
    profileId: string
    protocol: string
    serialNumber: string
    softwareRevision: string
    staticGroupAssignment: true
    staticProfileAssignment: true
    value: string
    vendor: string

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

返回值

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

键	描述
ise_response 字典	Cisco ISE Python SDK 返回的响应的字典或列表。 返回值：始终返回 示例：{"connectedLinks": {}, "customAttributes": {}, "description": "string", "deviceType": "string", "groupId": "string", "hardwareRevision": "string", "id": "string", "identityStore": "string", "identityStoreId": "string", "ipAddress": "string", "mac": "string", "mdmAttributes": {}, "name": "string", "portalUser": "string", "productId": "string", "profileId": "string", "protocol": "string", "serialNumber": "string", "softwareRevision": "string", "staticGroupAssignment": true, "staticProfileAssignment": true, "vendor": "string"}
ise_update_response 字典 在 cisco.ise 1.1.0 中添加	Cisco ISE Python SDK 返回的响应的字典或列表。 返回值：始终返回 示例：{"connectedLinks": {}, "customAttributes": {}, "description": "string", "deviceType": "string", "groupId": "string", "hardwareRevision": "string", "id": "string", "identityStore": "string", "identityStoreId": "string", "ipAddress": "string", "mac": "string", "mdmAttributes": {}, "name": "string", "portalUser": "string", "productId": "string", "profileId": "string", "protocol": "string", "serialNumber": "string", "softwareRevision": "string", "staticGroupAssignment": true, "staticProfileAssignment": true, "vendor": "string"}

作者

• Rafael Campos (@racampos)

集合链接

• 问题追踪器
• 代码库 (源代码)