You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

cisco.ise.sponsor_group module – Resource module for Sponsor Group

Note

This module is part of the cisco.ise collection (version 2.5.9).

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. 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 boolean	AutoNotification flag. Choices: `false` `true`
createPermissions dictionary	Sponsor Group’s createPermissions.
canCreateRandomAccounts boolean	CanCreateRandomAccounts flag. Choices: `false` `true`
canImportMultipleAccounts boolean	CanImportMultipleAccounts flag. Choices: `false` `true`
canSetFutureStartDate boolean	CanSetFutureStartDate flag. Choices: `false` `true`
canSpecifyUsernamePrefix boolean	CanSpecifyUsernamePrefix flag. Choices: `false` `true`
defaultUsernamePrefix string	Sponsor Group’s defaultUsernamePrefix.
importBatchSizeLimit integer	Sponsor Group’s importBatchSizeLimit.
randomBatchSizeLimit integer	Sponsor Group’s randomBatchSizeLimit.
startDateFutureLimitDays integer	Sponsor Group’s startDateFutureLimitDays.
description string	Sponsor Group’s description.
guestTypes list / elements=string	Sponsor Group’s guestTypes.
id string	Sponsor Group’s id.
isDefaultGroup boolean	IsDefaultGroup flag. Choices: `false` `true`
ise_debug boolean	Flag for Identity Services Engine SDK to enable debugging. Choices: `false` ← (default) `true`
ise_hostname string / required	The Identity Services Engine hostname.
ise_password string / required	The Identity Services Engine password to authenticate.
ise_username string / required	The Identity Services Engine username to authenticate.
ise_uses_api_gateway boolean added in cisco.ise 1.1.0	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: `false` `true` ← (default)
ise_uses_csrf_token boolean added in cisco.ise 3.0.0	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: `false` ← (default) `true`
ise_verify boolean	Flag to enable or disable SSL certificate verification. Choices: `false` `true` ← (default)
ise_version string	Informs the SDK which version of Identity Services Engine to use. Default: `"3.1_Patch_1"`
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: `false` `true` ← (default)
isEnabled boolean	IsEnabled flag. Choices: `false` `true`
locations list / elements=string	Sponsor Group’s locations.
managePermission string	Sponsor Group’s managePermission.
memberGroups list / elements=string	Sponsor Group’s memberGroups.
name string	Sponsor Group’s name.
otherPermissions dictionary	Sponsor Group’s otherPermissions.
canAccessViaREST boolean	CanAccessViaREST flag. Choices: `false` `true`
canApproveSelfregGuests boolean	CanApproveSelfregGuests flag. Choices: `false` `true`
canDeleteGuestAccounts boolean	CanDeleteGuestAccounts flag. Choices: `false` `true`
canExtendGuestAccounts boolean	CanExtendGuestAccounts flag. Choices: `false` `true`
canReinstateSuspendedAccounts boolean	CanReinstateSuspendedAccounts flag. Choices: `false` `true`
canResetGuestPasswords boolean	CanResetGuestPasswords flag. Choices: `false` `true`
canSendSMSNotifications boolean	CanSendSMSNotifications flag. Choices: `false` `true`
canSuspendGuestAccounts boolean	CanSuspendGuestAccounts flag. Choices: `false` `true`
canUpdateGuestContactInfo boolean	CanUpdateGuestContactInfo flag. Choices: `false` `true`
canViewGuestPasswords boolean	CanViewGuestPasswords flag. Choices: `false` `true`
limitApprovalToSponsorsGuests boolean	LimitApprovalToSponsorsGuests flag. Choices: `false` `true`
requireSuspensionReason boolean	RequireSuspensionReason flag. Choices: `false` `true`

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_mode
The 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

dictionary

A dictionary or list with the response returned by the Cisco ISE Python SDK

Returned: always

Sample: {"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}}

dictionary

added in cisco.ise 1.1.0

A dictionary or list with the response returned by the Cisco ISE Python SDK

Returned: always

Sample: {"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}

Authors

Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)

cisco.ise.sponsor_group module – Resource module for Sponsor Group

Synopsis

Requirements

Parameters

Notes

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

Examples 

Return Values 