cisco.ise.sponsor_group module – Resource module for Sponsor Group
Note
This module is part of the cisco.ise collection (version 2.5.12).
To install it, use: ansible-galaxy collection install cisco.ise.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.ise.sponsor_group.
New in cisco.ise 1.0.0
Synopsis
Manage operations create, update and delete of the resource Sponsor Group.
This API creates a sponsor group.
This API deletes a sponsor group by ID.
This API allows the client to update a sponsor group by ID.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 2.0.8
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
AutoNotification flag. Choices: |
|
Sponsor Group’s createPermissions. |
|
CanCreateRandomAccounts flag. Choices: |
|
CanImportMultipleAccounts flag. Choices: |
|
CanSetFutureStartDate flag. Choices: |
|
CanSpecifyUsernamePrefix flag. Choices: |
|
Sponsor Group’s defaultUsernamePrefix. |
|
Sponsor Group’s importBatchSizeLimit. |
|
Sponsor Group’s randomBatchSizeLimit. |
|
Sponsor Group’s startDateFutureLimitDays. |
|
Sponsor Group’s description. |
|
Sponsor Group’s guestTypes. |
|
Sponsor Group’s id. |
|
IsDefaultGroup flag. Choices: |
|
Flag for Identity Services Engine SDK to enable debugging. Choices: |
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
The Identity Services Engine username to authenticate. |
|
Flag that informs the SDK whether to use the Identity Services Engine’s API Gateway to send requests. If it is true, it uses the ISE’s API Gateway and sends requests to https://{{ise_hostname}}. If it is false, it sends the requests to https://{{ise_hostname}}:{{port}}, where the port value depends on the Service used (ERS, Mnt, UI, PxGrid). Choices: |
|
Flag that informs the SDK whether we send the CSRF token to ISE’s ERS APIs. If it is True, the SDK assumes that your ISE CSRF Check is enabled. If it is True, it assumes you need the SDK to manage the CSRF token automatically for you. Choices: |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Identity Services Engine to use. |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: |
|
Sponsor Group’s locations. |
|
Sponsor Group’s managePermission. |
|
Sponsor Group’s memberGroups. |
|
Sponsor Group’s name. |
|
Sponsor Group’s otherPermissions. |
|
CanAccessViaREST flag. Choices: |
|
CanApproveSelfregGuests flag. Choices: |
|
CanDeleteGuestAccounts flag. Choices: |
|
CanExtendGuestAccounts flag. Choices: |
|
CanReinstateSuspendedAccounts flag. Choices: |
|
CanResetGuestPasswords flag. Choices: |
|
CanSendSMSNotifications flag. Choices: |
|
CanSuspendGuestAccounts flag. Choices: |
|
CanUpdateGuestContactInfo flag. Choices: |
|
CanViewGuestPasswords flag. Choices: |
|
LimitApprovalToSponsorsGuests flag. Choices: |
|
RequireSuspensionReason flag. Choices: |
Notes
Note
SDK Method used are sponsor_group.SponsorGroup.create_sponsor_group, sponsor_group.SponsorGroup.delete_sponsor_group_by_id, sponsor_group.SponsorGroup.update_sponsor_group_by_id,
Paths used are post /ers/config/sponsorgroup, delete /ers/config/sponsorgroup/{id}, put /ers/config/sponsorgroup/{id},
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco ISE SDK
The parameters starting with ise_ are used by the Cisco ISE Python SDK to establish the connection
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always |