cisco.ise.sponsor_group 模块 – 赞助商组的资源模块
注意
此模块是 cisco.ise 集合（版本 2.9.6）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在剧本中使用它，请指定：cisco.ise.sponsor_group。
cisco.ise 1.0.0 中的新增功能
概要
管理资源赞助商组的创建、更新和删除操作。
此 API 创建一个赞助商组。
此 API 通过 ID 删除赞助商组。
此 API 允许客户端通过 ID 更新赞助商组。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
ciscoisesdk >= 2.2.3
python >= 3.5
参数
参数 |
注释 |
|---|---|
自动通知标志。 选择
|
|
赞助商组的 createPermissions。 |
|
CanCreateRandomAccounts 标志。 选择
|
|
CanImportMultipleAccounts 标志。 选择
|
|
CanSetFutureStartDate 标志。 选择
|
|
CanSpecifyUsernamePrefix 标志。 选择
|
|
赞助商组的 defaultUsernamePrefix。 |
|
赞助商组的 importBatchSizeLimit。 |
|
赞助商组的 randomBatchSizeLimit。 |
|
赞助商组的 startDateFutureLimitDays。 |
|
赞助商组的 description。 |
|
赞助商组的 guestTypes。 |
|
赞助商组的 id。 |
|
IsDefaultGroup 标志。 选择
|
|
用于启用调试的 Identity Services Engine SDK 的标志。 选择
|
|
Identity Services Engine 主机名。 |
|
用于身份验证的 Identity Services Engine 密码。 |
|
RESTful HTTP 请求的超时时间（以秒为单位）。 默认： |
|
用于身份验证的 Identity Services Engine 用户名。 |
|
一个标志，通知 SDK 是否将 CSRF 令牌发送到 ISE 的 ERS API。 如果为 True，则 SDK 假定您的 ISE CSRF 检查已启用。 如果为 True，则假定您需要 SDK 为您自动管理 CSRF 令牌。 选择
|
|
用于启用或禁用 SSL 证书验证的标志。 选择
|
|
通知 SDK 使用哪个版本的 Identity Services Engine。 默认： |
|
用于启用自动速率限制处理的 Identity Services Engine SDK 的标志。 选择
|
|
IsEnabled 标志。 选择
|
|
赞助商组的 locations。 |
|
赞助商组的 managePermission。 |
|
赞助商组的 memberGroups。 |
|
赞助商组的 name。 |
|
赞助商组的 otherPermissions。 |
|
CanAccessViaREST 标志。 选择
|
|
CanApproveSelfregGuests 标志。 选择
|
|
CanDeleteGuestAccounts 标志。 选择
|
|
CanExtendGuestAccounts 标志。 选择
|
|
CanReinstateSuspendedAccounts 标志。 选择
|
|
CanResetGuestPasswords 标志。 选择
|
|
CanSendSMSNotifications 标志。 选择
|
|
CanSuspendGuestAccounts 标志。 选择
|
|
CanUpdateGuestContactInfo 标志。 选择
|
|
CanViewGuestPasswords 标志。 选择
|
|
LimitApprovalToSponsorsGuests 标志。 选择
|
|
RequireSuspensionReason 标志。 选择
|
注释
注意
使用的 SDK 方法为 sponsor_group.SponsorGroup.create_sponsor_group, sponsor_group.SponsorGroup.delete_sponsor_group_by_id, sponsor_group.SponsorGroup.update_sponsor_group_by_id,
使用的路径为 post /ers/config/sponsorgroup, delete /ers/config/sponsorgroup/{id}, put /ers/config/sponsorgroup/{id},
不支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用来自 Cisco ISE SDK 的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接
示例
- name: Update by id
cisco.ise.sponsor_group:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
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
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
- name: Delete by id
cisco.ise.sponsor_group:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
id: string
- name: Create
cisco.ise.sponsor_group:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
autoNotification: true
createPermissions:
canCreateRandomAccounts: true
canImportMultipleAccounts: true
canSetFutureStartDate: true
canSpecifyUsernamePrefix: true
defaultUsernamePrefix: string
importBatchSizeLimit: 0
randomBatchSizeLimit: 0
startDateFutureLimitDays: 0
description: string
guestTypes:
- string
isDefaultGroup: true
isEnabled: true
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
返回值
常见的返回值记录在这里，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，包含 Cisco ISE Python SDK 返回的响应 返回: 总是 示例: |
|
一个字典或列表，包含 Cisco ISE Python SDK 返回的响应 返回: 总是 示例: |