cisco.ise.sponsor_group_info 模块 – 赞助商组信息模块

注意

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

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

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

要在 playbook 中使用它,请指定:cisco.ise.sponsor_group_info

cisco.ise 1.0.0 中的新功能

概要

  • 获取所有赞助商组。

  • 按 ID 获取赞助商组。

  • 此 API 允许客户端按 ID 获取赞助商组。

  • 此 API 允许客户端获取所有赞助商组。

注意

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

要求

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

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

filter

list / elements=string

过滤器查询参数。**简单的过滤**应该可以通过过滤器查询字符串参数获得。过滤器的结构是一个由点分隔的字段运算符和值的三元组。可以发送多个过滤器。默认情况下,所有过滤器条件通用的逻辑运算符将是 AND,并且可以使用 “filterType=or” 查询字符串参数进行更改。

每个资源数据模型描述应指定属性是否为过滤字段。

“EQ” 运算符描述 “等于”。

“NEQ” 运算符描述 “不等于”。

“GT” 运算符描述 “大于”。

“LT” 运算符描述 “小于”。

“STARTSW” 运算符描述 “以…开头”。

“NSTARTSW” 运算符描述 “不以…开头”。

“ENDSW” 运算符描述 “以…结尾”。

“NENDSW” 运算符描述 “不以…结尾”。

“CONTAINS” 运算符描述 “包含”。

“NCONTAINS” 运算符描述 “不包含”。

filterType

字符串

FilterType 查询参数。默认情况下,所有过滤器条件通用的逻辑运算符将是 AND,并且可以使用该参数进行更改。

id

字符串

Id 路径参数。

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

整数

大小查询参数。每页返回的对象数。

sortasc

字符串

Sortasc 查询参数。升序排序。

sortdsc

字符串

Sortdsc 查询参数。降序排序。

注意

注意

  • 使用的 SDK 方法是 sponsor_group.SponsorGroup.get_sponsor_group_by_id、sponsor_group.SponsorGroup.get_sponsor_group_generator,

  • 使用的路径是 get /ers/config/sponsorgroup、get /ers/config/sponsorgroup/{id},

  • 支持 check_mode

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

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

示例

- name: Get all Sponsor Group
  cisco.ise.sponsor_group_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 Sponsor Group by id
  cisco.ise.sponsor_group_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 返回的响应的字典或列表

返回: 总是

示例: {"autoNotification": true, "createPermissions": {"canCreateRandomAccounts": true, "canImportMultipleAccounts": true, "canSetFutureStartDate": true, "canSpecifyUsernamePrefix": true, "defaultUsernamePrefix": "string", "importBatchSizeLimit": 0, "randomBatchSizeLimit": 0, "startDateFutureLimitDays": 0}, "description": "string", "guestTypes": ["string"], "id": "string", "isDefaultGroup": true, "isEnabled": true, "link": {"href": "string", "rel": "string", "type": "string"}, "locations": ["string"], "managePermission": "string", "memberGroups": ["string"], "name": "string", "otherPermissions": {"canAccessViaRest": true, "canApproveSelfregGuests": true, "canDeleteGuestAccounts": true, "canExtendGuestAccounts": true, "canReinstateSuspendedAccounts": true, "canResetGuestPasswords": true, "canSendSmsNotifications": true, "canSuspendGuestAccounts": true, "canUpdateGuestContactInfo": true, "canViewGuestPasswords": true, "limitApprovalToSponsorsGuests": true, "requireSuspensionReason": true}}

ise_responses

列表 / 元素=字典

在 cisco.ise 1.1.0 中添加

包含 Cisco ISE Python SDK 返回的响应的字典或列表

返回: 总是

示例: "[\n  {\n    \"id\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"isEnabled\": true,\n    \"isDefaultGroup\": true,\n    \"memberGroups\": [\n      \"string\"\n    ],\n    \"guestTypes\": [\n      \"string\"\n    ],\n    \"locations\": [\n      \"string\"\n    ],\n    \"autoNotification\": true,\n    \"createPermissions\": {\n      \"canImportMultipleAccounts\": true,\n      \"importBatchSizeLimit\": 0,\n      \"canCreateRandomAccounts\": true,\n      \"randomBatchSizeLimit\": 0,\n      \"defaultUsernamePrefix\": \"string\",\n      \"canSpecifyUsernamePrefix\": true,\n      \"canSetFutureStartDate\": true,\n      \"startDateFutureLimitDays\": 0\n    },\n    \"managePermission\": \"string\",\n    \"otherPermissions\": {\n      \"canUpdateGuestContactInfo\": true,\n      \"canViewGuestPasswords\": true,\n      \"canSendSmsNotifications\": true,\n      \"canResetGuestPasswords\": true,\n      \"canExtendGuestAccounts\": true,\n      \"canDeleteGuestAccounts\": true,\n      \"canSuspendGuestAccounts\": true,\n      \"requireSuspensionReason\": true,\n      \"canReinstateSuspendedAccounts\": true,\n      \"canApproveSelfregGuests\": true,\n      \"limitApprovalToSponsorsGuests\": true,\n      \"canAccessViaRest\": true\n    },\n    \"link\": {\n      \"rel\": \"string\",\n      \"href\": \"string\",\n      \"type\": \"string\"\n    }\n  }\n]\n"

作者

  • Rafael Campos (@racampos)