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

Note

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

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.

  • 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.3

  • python >= 3.5

Parameters

Parameter

Comments

autoNotification

boolean

AutoNotification flag.

Choices:

  • no

  • yes

createPermissions

dictionary

Sponsor Group’s createPermissions.

canCreateRandomAccounts

boolean

CanCreateRandomAccounts flag.

Choices:

  • no

  • yes

canImportMultipleAccounts

boolean

CanImportMultipleAccounts flag.

Choices:

  • no

  • yes

canSetFutureStartDate

boolean

CanSetFutureStartDate flag.

Choices:

  • no

  • yes

canSpecifyUsernamePrefix

boolean

CanSpecifyUsernamePrefix flag.

Choices:

  • no

  • yes

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:

  • no

  • yes

ise_debug

boolean

Flag for Identity Services Engine SDK to enable debugging.

Choices:

  • no ← (default)

  • yes

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 1.1.0 of cisco.ise

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:

  • no

  • yes ← (default)

ise_uses_csrf_token

boolean

added in 3.0.0 of cisco.ise

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:

  • no ← (default)

  • yes

ise_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • no

  • yes ← (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:

  • no

  • yes ← (default)

isEnabled

boolean

IsEnabled flag.

Choices:

  • no

  • yes

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:

  • no

  • yes

canApproveSelfregGuests

boolean

CanApproveSelfregGuests flag.

Choices:

  • no

  • yes

canDeleteGuestAccounts

boolean

CanDeleteGuestAccounts flag.

Choices:

  • no

  • yes

canExtendGuestAccounts

boolean

CanExtendGuestAccounts flag.

Choices:

  • no

  • yes

canReinstateSuspendedAccounts

boolean

CanReinstateSuspendedAccounts flag.

Choices:

  • no

  • yes

canResetGuestPasswords

boolean

CanResetGuestPasswords flag.

Choices:

  • no

  • yes

canSendSMSNotifications

boolean

CanSendSMSNotifications flag.

Choices:

  • no

  • yes

canSuspendGuestAccounts

boolean

CanSuspendGuestAccounts flag.

Choices:

  • no

  • yes

canUpdateGuestContactInfo

boolean

CanUpdateGuestContactInfo flag.

Choices:

  • no

  • yes

canViewGuestPasswords

boolean

CanViewGuestPasswords flag.

Choices:

  • no

  • yes

limitApprovalToSponsorsGuests

boolean

LimitApprovalToSponsorsGuests flag.

Choices:

  • no

  • yes

requireSuspensionReason

boolean

RequireSuspensionReason flag.

Choices:

  • no

  • yes

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

ise_response

dictionary

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

Returned: always

Sample: “{\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”

ise_update_response

dictionary

added in 1.1.0 of cisco.ise

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

Returned: always

Sample: “{\n \”UpdatedFieldsList\”: {\n \”updatedField\”: [\n {\n \”field\”: \”string\”,\n \”oldValue\”: \”string\”,\n \”newValue\”: \”string\”\n }\n ],\n \”field\”: \”string\”,\n \”oldValue\”: \”string\”,\n \”newValue\”: \”string\”\n }\n}\n”

Authors

  • Rafael Campos (@racampos)