cisco.ise.guest_location_info 模块 – 用于访客位置的信息模块

注意

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

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

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

要在剧本中使用它，请指定：cisco.ise.guest_location_info。

cisco.ise 1.0.0 中的新增功能

概要

• 获取所有访客位置。

• 按 ID 获取访客位置。

• 此 API 允许客户端按 ID 获取访客位置。

• 此 API 允许客户端获取所有访客位置。

注意

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

要求

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

• ciscoisesdk >= 2.2.3

• python >= 3.5

参数

参数	注释
filter 列表 / 元素=字符串	筛选器查询参数。**简单筛选**应该可以通过筛选器查询字符串参数使用。筛选器的结构是字段、运算符和值的三元组，以点分隔。可以发送多个筛选器。所有筛选器条件通用的逻辑运算符默认为 AND，可以使用 “filterType=or” 查询字符串参数更改。 每个资源数据模型描述应指定属性是否为筛选字段。 “EQ” 运算符描述“等于”。 “NEQ” 运算符描述“不等于”。 “GT” 运算符描述“大于”。 “LT” 运算符描述“小于”。 “STARTSW” 运算符描述“以开头”。 “NSTARTSW” 运算符描述“不以开头”。 “ENDSW” 运算符描述“以结尾”。 “NENDSW” 运算符描述“不以结尾”。 “CONTAINS” 运算符描述“包含”。 “NCONTAINS” 运算符描述“不包含”。
filterType 字符串	FilterType 查询参数。所有筛选器条件通用的逻辑运算符默认为 AND，可以使用该参数更改。
id 字符串	Id 路径参数。
ise_debug 布尔值	用于标识服务引擎 SDK 以启用调试的标志。 选择 false ← (默认) true
ise_hostname 字符串 / 必填	标识服务引擎主机名。
ise_password 字符串 / 必填	用于身份验证的标识服务引擎密码。
ise_single_request_timeout 整数 在 cisco.ise 3.0.0 中添加	RESTful HTTP 请求的超时（以秒为单位）。 默认值： 60
ise_username 字符串 / 必填	用于身份验证的标识服务引擎用户名。
ise_uses_api_gateway 布尔值 在 cisco.ise 1.1.0 中添加	通知 SDK 是否使用标识服务引擎的 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 要使用的标识服务引擎版本。 默认值： "3.1_Patch_1"
ise_wait_on_rate_limit 布尔值	用于标识服务引擎 SDK 以启用自动速率限制处理的标志。 选择 false true ← (默认)
page 整数	Page 查询参数。页码。
size 整数	Size 查询参数。每页返回的对象数。
sortasc 字符串	Sortasc 查询参数。升序排序。
sortdsc 字符串	Sortdsc 查询参数。降序排序。

说明

注意

• 使用的 SDK 方法是 guest_location.GuestLocation.get_guest_location_by_id、guest_location.GuestLocation.get_guest_location_generator。

• 使用的路径是 get /ers/config/guestlocation、get /ers/config/guestlocation/{id}。

• 支持 check_mode。

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

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

示例

- name: Get all Guest Location
  cisco.ise.guest_location_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
    sortasc: string
    sortdsc: string
    filter: []
    filterType: AND
  register: result

- name: Get Guest Location by id
  cisco.ise.guest_location_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

返回值

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

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

作者

• Rafael Campos (@racampos)

集合链接

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