cisco.ise.sponsor_group – Resource module for Sponsor Group

Note

This plugin is part of the cisco.ise collection (version 1.0.2).

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

Parameters

Parameter		Choices/Defaults	Comments
autoNotification boolean		Choices: no yes	AutoNotification flag.
createPermissions dictionary			Sponsor Group's createPermissions.
	canCreateRandomAccounts boolean	Choices: no yes	CanCreateRandomAccounts flag.
	canImportMultipleAccounts boolean	Choices: no yes	CanImportMultipleAccounts flag.
	canSetFutureStartDate boolean	Choices: no yes	CanSetFutureStartDate flag.
	canSpecifyUsernamePrefix boolean	Choices: no yes	CanSpecifyUsernamePrefix flag.
	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		Choices: no yes	IsDefaultGroup flag.
isEnabled boolean		Choices: no yes	IsEnabled flag.
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	Choices: no yes	CanAccessViaRest flag.
	canApproveSelfregGuests boolean	Choices: no yes	CanApproveSelfregGuests flag.
	canDeleteGuestAccounts boolean	Choices: no yes	CanDeleteGuestAccounts flag.
	canExtendGuestAccounts boolean	Choices: no yes	CanExtendGuestAccounts flag.
	canReinstateSuspendedAccounts boolean	Choices: no yes	CanReinstateSuspendedAccounts flag.
	canResetGuestPasswords boolean	Choices: no yes	CanResetGuestPasswords flag.
	canSendSmsNotifications boolean	Choices: no yes	CanSendSmsNotifications flag.
	canSuspendGuestAccounts boolean	Choices: no yes	CanSuspendGuestAccounts flag.
	canUpdateGuestContactInfo boolean	Choices: no yes	CanUpdateGuestContactInfo flag.
	canViewGuestPasswords boolean	Choices: no yes	CanViewGuestPasswords flag.
	limitApprovalToSponsorsGuests boolean	Choices: no yes	LimitApprovalToSponsorsGuests flag.
	requireSuspensionReason boolean	Choices: no yes	RequireSuspensionReason flag.

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:

Key	Returned	Description
ise_response dictionary	always	A dictionary or list with the response returned by the Cisco ISE Python SDK Sample: { "UpdatedFieldsList": { "updatedField": { "field": "string", "oldValue": "string", "newValue": "string" }, "field": "string", "oldValue": "string", "newValue": "string" } }

Authors

• Rafael Campos (@racampos)