cisco.ise.endpoint_register 模块 – 端点注册资源模块

注意

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

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

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

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

cisco.ise 1.0.0 中的新增功能

概要 

管理端点注册资源的操作更新。
此 API 允许客户端注册端点。

注意

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

要求 

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

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.register_endpoint，
使用的路径是 put /ers/config/endpoint/register，
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

示例 

- name: Update all
  cisco.ise.endpoint_register:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    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

返回值 

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

键	描述
ise_response 字典	包含 Cisco ISE Python SDK 返回的响应的字典或列表返回：始终示例： `{}`

作者

Rafael Campos (@racampos)