cisco.ise.user_equipment_info 模块 – 用户设备信息的信息模块

注意

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

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

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

要在 Playbook 中使用它，请指定：cisco.ise.user_equipment_info。

cisco.ise 1.0.0 中的新增功能

概要 

获取所有用户设备信息。
按 ID 获取用户设备信息。

注意

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

要求 

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

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
filter 字符串	过滤器查询参数。.. 容器简单过滤应该可以通过过滤器查询字符串参数获得。过滤器的结构是一个字段运算符和值的三元组，用点分隔。可以发送多个过滤器。所有过滤条件通用的逻辑运算符默认将是 AND，并且可以使用 “filterType=or” 查询字符串参数进行更改。每个资源数据模型描述都应指定属性是否为过滤字段。 “EQ”运算符描述“等于”。 “NEQ”运算符描述“不等于”。 “GT”运算符描述“大于”。 “LT”运算符描述“小于”。 “STARTSW”运算符描述“以…开头”。 “NSTARTSW”运算符描述“不以…开头”。 “ENDSW”运算符描述“以…结尾”。 “NENDSW”运算符描述“不以…结尾”。 “CONTAINS”运算符描述“包含”。 “NCONTAINS”运算符描述“不包含”。
filterType 字符串	FilterType 查询参数。所有过滤条件通用的逻辑运算符默认将是 AND，并且可以使用参数进行更改。
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` ← (默认)
page 整数	页面查询参数。页码。
size 整数	大小查询参数。每页返回的对象数。
sort 字符串	排序查询参数。排序类型 - asc 或 desc。
sortBy 字符串	SortBy 查询参数。需要排序的对象的排序依据列。
userEquipmentId 字符串	UserEquipmentId 路径参数。用户设备对象的唯一 ID。

注释 

注意

使用的 SDK 方法是 user_equipment.UserEquipment.get_user_equipment_by_id, user_equipment.UserEquipment.get_user_equipments_generator,
使用的路径是 get /api/v1/fiveg/user-equipment, get /api/v1/fiveg/user-equipment/{userEquipmentId},
支持 check_mode
该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

示例 

- name: Get all User Equipment Info
  cisco.ise.user_equipment_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 0
    size: 0
    filter: string
    filterType: string
    sort: string
    sortBy: string
  register: result

- name: Get User Equipment Info by id
  cisco.ise.user_equipment_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    userEquipmentId: 7c9484cf-0ebc-47ad-a9ef-bc12729ed73b
  register: result

返回值 

通用返回值记录在此处，以下是此模块特有的字段

键	描述
ise_response 字典	包含 Cisco ISE Python SDK 返回的响应的字典或列表已返回：始终示例： `{}`
ise_responses 列表 / 元素=字典在 cisco.ise 1.1.0 中添加	包含 Cisco ISE Python SDK 返回的响应的字典或列表已返回：始终示例: `"[\n {}\n]\n"`

作者

Rafael Campos (@racampos)