cisco.ise.sponsor_group – Resource module for Sponsor Group
Note
This plugin is part of the cisco.ise collection (version 2.1.1).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.ise.
To use it in a playbook, specify: cisco.ise.sponsor_group.
New in version 1.0.0: of cisco.ise
Synopsis
Manage operations create, update and delete of the resource Sponsor Group.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 1.3.0
python >= 3.5
Parameters
Notes
Note
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
See Also
See also
- Sponsor Group reference
Complete reference of the Sponsor Group object model.
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: