cisco.ise.endpoint 模块 – Endpoint 的资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新增功能

概要

• 管理资源 Endpoint 的创建、更新和删除操作。

• 此 API 创建一个端点。

• 此 API 删除一个端点。

• 此 API 允许客户端更新端点。

注意

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

要求

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

• ciscoisesdk >= 2.2.3

• python >= 3.5

参数

参数	注释
customAttributes 字典	端点的 customAttributes。
customAttributes 字典	键值映射。
description 字符串	端点的描述。
groupId 字符串	端点的 groupId。
id 字符串	端点的 id。
identityStore 字符串	端点的 identityStore。
identityStoreId 字符串	端点的 identityStoreId。
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。
mdmComplianceStatus 布尔值	MdmComplianceStatus 标志。 选项 false true
mdmEncrypted 布尔值	MdmEncrypted 标志。 选项 false true
mdmEnrolled 布尔值	MdmEnrolled 标志。 选项 false true
mdmIMEI 字符串	端点的 mdmIMEI。
mdmJailBroken 布尔值	MdmJailBroken 标志。 选项 false true
mdmManufacturer 字符串	端点的 mdmManufacturer。
mdmModel 字符串	端点的 mdmModel。
mdmOS 字符串	端点的 mdmOS。
mdmPhoneNumber 字符串	端点的 mdmPhoneNumber。
mdmPinlock 布尔值	MdmPinlock 标志。 选项 false true
mdmReachable 布尔值	MdmReachable 标志。 选项 false true
mdmSerial 字符串	端点的 mdmSerial。
mdmServerName 字符串	端点的 mdmServerName。
name 字符串	端点的名称。
portalUser 字符串	端点的 portalUser。
profileId 字符串	端点的 profileId。
staticGroupAssignment 布尔值	StaticGroupAssignment 标志。 选项 false true
staticProfileAssignment 布尔值	StaticProfileAssignment 标志。 选项 false true

备注

注意

• 使用的 SDK 方法是 endpoint.Endpoint.create_endpoint、endpoint.Endpoint.delete_endpoint_by_id、endpoint.Endpoint.update_endpoint_by_id。

• 使用的路径是 post /ers/config/endpoint、delete /ers/config/endpoint/{id}、put /ers/config/endpoint/{id}。

• 不支持 check_mode

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

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

示例

- name: Update by id
  cisco.ise.endpoint:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    customAttributes:
      customAttributes: {}
    description: string
    groupId: string
    id: string
    identityStore: string
    identityStoreId: string
    mac: string
    mdmAttributes:
      mdmComplianceStatus: true
      mdmEncrypted: true
      mdmEnrolled: true
      mdmIMEI: string
      mdmJailBroken: true
      mdmManufacturer: string
      mdmModel: string
      mdmOS: string
      mdmPhoneNumber: string
      mdmPinlock: true
      mdmReachable: true
      mdmSerial: string
      mdmServerName: string
    name: string
    portalUser: string
    profileId: string
    staticGroupAssignment: true
    staticProfileAssignment: true

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

- name: Create
  cisco.ise.endpoint:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    customAttributes:
      customAttributes: {}
    description: string
    groupId: string
    identityStore: string
    identityStoreId: string
    mac: string
    mdmAttributes:
      mdmComplianceStatus: true
      mdmEncrypted: true
      mdmEnrolled: true
      mdmIMEI: string
      mdmJailBroken: true
      mdmManufacturer: string
      mdmModel: string
      mdmOS: string
      mdmPhoneNumber: string
      mdmPinlock: true
      mdmReachable: true
      mdmSerial: string
      mdmServerName: string
    name: string
    portalUser: string
    profileId: string
    staticGroupAssignment: true
    staticProfileAssignment: true

返回值

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

键	描述
ise_response 字典	一个字典或列表，包含 Cisco ISE Python SDK 返回的响应。 返回：始终 示例: {"customAttributes": {"customAttributes": {}}, "description": "string", "groupId": "string", "id": "string", "identityStore": "string", "identityStoreId": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "mac": "string", "mdmAttributes": {"mdmComplianceStatus": true, "mdmEncrypted": true, "mdmEnrolled": true, "mdmIMEI": "string", "mdmJailBroken": true, "mdmManufacturer": "string", "mdmModel": "string", "mdmOS": "string", "mdmPhoneNumber": "string", "mdmPinlock": true, "mdmReachable": true, "mdmSerial": "string", "mdmServerName": "string"}, "name": "string", "portalUser": "string", "profileId": "string", "staticGroupAssignment": true, "staticProfileAssignment": true}
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)

集合链接

• 问题跟踪器
• 存储库（源代码）