cisco.ise.guest_type – Resource module for Guest Type

Note

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

To install it use: ansible-galaxy collection install cisco.ise.

To use it in a playbook, specify: cisco.ise.guest_type.

New in version 1.0.0: of cisco.ise

Synopsis

• Manage operations create, update and delete of the resource Guest Type.

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
accessTime dictionary				Guest Type's accessTime.
	allowAccessOnSpecificDaysTimes boolean		Choices: no yes	AllowAccessOnSpecificDaysTimes flag.
	dayTimeLimits list / elements=string			Guest Type's dayTimeLimits.
		days list / elements=string		Guest Type's days.
		endTime string		Guest Type's endTime.
		startTime string		Guest Type's startTime.
	defaultDuration integer			Guest Type's defaultDuration.
	durationTimeUnit string			Guest Type's durationTimeUnit.
	fromFirstLogin boolean		Choices: no yes	FromFirstLogin flag.
	maxAccountDuration integer			Guest Type's maxAccountDuration.
description string				Guest Type's description.
expirationNotification dictionary				Guest Type's expirationNotification.
	advanceNotificationDuration integer			Guest Type's advanceNotificationDuration.
	advanceNotificationUnits string			Guest Type's advanceNotificationUnits.
	emailText string			Guest Type's emailText.
	enableNotification boolean		Choices: no yes	EnableNotification flag.
	sendEmailNotification boolean		Choices: no yes	SendEmailNotification flag.
	sendSmsNotification boolean		Choices: no yes	SendSmsNotification flag.
	smsText string			Guest Type's smsText.
id string				Guest Type's id.
loginOptions dictionary				Guest Type's loginOptions.
	allowGuestPortalBypass boolean		Choices: no yes	AllowGuestPortalBypass flag.
	failureAction string			Guest Type's failureAction.
	identityGroupId string			Guest Type's identityGroupId.
	limitSimultaneousLogins boolean		Choices: no yes	LimitSimultaneousLogins flag.
	maxRegisteredDevices integer			Guest Type's maxRegisteredDevices.
	maxSimultaneousLogins integer			Guest Type's maxSimultaneousLogins.
name string				Guest Type's name.
sponsorGroups list / elements=string				Guest Type's sponsorGroups.

See Also

See also

cisco.ise.plugins.module_utils.definitions.guest_type

The official documentation on the cisco.ise.plugins.module_utils.definitions.guest_type module.

Guest Type reference

Complete reference of the Guest Type object model.

Examples

- name: Create
  cisco.ise.guest_type:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accessTime:
      allowAccessOnSpecificDaysTimes: false
      dayTimeLimits:
      - days:
        - Sunday
        - Tuesday
        endTime: '16:00'
        startTime: '12:00'
      defaultDuration: 90
      durationTimeUnit: DAYS
      fromFirstLogin: true
      maxAccountDuration: 365
    description: Description
    expirationNotification:
      advanceNotificationDuration: 3
      advanceNotificationUnits: DAYS
      emailText: EmailText
      enableNotification: false
      sendEmailNotification: false
      sendSmsNotification: false
      smsText: SMS Text
    id: id
    loginOptions:
      allowGuestPortalBypass: false
      failureAction: Disconnect_Oldest_Connection
      identityGroupId: generatedID
      limitSimultaneousLogins: true
      maxRegisteredDevices: 5
      maxSimultaneousLogins: 3
    name: Name
    sponsorGroups:
    - Group1
    - Group2

- name: Update by id
  cisco.ise.guest_type:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accessTime:
      allowAccessOnSpecificDaysTimes: false
      dayTimeLimits:
      - days:
        - Sunday
        - Tuesday
        endTime: '16:00'
        startTime: '12:00'
      defaultDuration: 90
      durationTimeUnit: DAYS
      fromFirstLogin: true
      maxAccountDuration: 365
    description: Description
    expirationNotification:
      advanceNotificationDuration: 3
      advanceNotificationUnits: DAYS
      emailText: EmailText
      enableNotification: false
      sendEmailNotification: false
      sendSmsNotification: false
      smsText: SMS Text
    id: id
    loginOptions:
      allowGuestPortalBypass: false
      failureAction: Disconnect_Oldest_Connection
      identityGroupId: generatedID
      limitSimultaneousLogins: true
      maxRegisteredDevices: 5
      maxSimultaneousLogins: 3
    name: Name
    sponsorGroups:
    - Group1
    - Group2

- name: Delete by id
  cisco.ise.guest_type:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string

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: { "id": "string", "name": "string", "description": "string", "accessTime": { "fromFirstLogin": true, "maxAccountDuration": 0, "durationTimeUnit": "string", "defaultDuration": 0, "allowAccessOnSpecificDaysTimes": true, "dayTimeLimits": [ { "startTime": "string", "endTime": "string", "days": [ "string" ] } ] }, "loginOptions": { "limitSimultaneousLogins": true, "maxSimultaneousLogins": 0, "failureAction": "string", "maxRegisteredDevices": 0, "identityGroupId": "string", "allowGuestPortalBypass": true }, "expirationNotification": { "enableNotification": true, "advanceNotificationDuration": 0, "advanceNotificationUnits": "string", "sendEmailNotification": true, "emailText": "string", "sendSmsNotification": true, "smsText": "string" }, "sponsorGroups": [ "string" ] }

Authors

• Rafael Campos (@racampos)