cisco.ise.guest_type module – Resource module for Guest Type

Note

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

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.guest_type.

New in version 1.0.0: of cisco.ise

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis 

Manage operations create, update and delete of the resource Guest Type.
This API creates a guest type.
This API deletes a guest type.

Note

This module has a corresponding action plugin.

Requirements 

The below requirements are needed on the host that executes this module.

ciscoisesdk >= 2.0.1
python >= 3.5

Parameters 

Parameter	Comments
accessTime dictionary	Guest Type’s accessTime.
allowAccessOnSpecificDaysTimes boolean	AllowAccessOnSpecificDaysTimes flag. Choices: no yes
dayTimeLimits list / elements=dictionary	List of Time Ranges for account access.
days list / elements=string	List of Days Values should be one of Week day. Allowed values are - Sunday, - Monday, - Tuesday, - Wednesday, - Thursday, - Friday, - Saturday.
endTime string	End time in HH mm format.
startTime string	Start time in HH mm format.
defaultDuration integer	Guest Type’s defaultDuration.
durationTimeUnit string	Allowed values are - DAYS, - HOURS, - MINUTES.
fromFirstLogin boolean	When Account Duration starts from first login or specified date. Choices: no yes
maxAccountDuration integer	Maximum value of Account Duration.
description string	Guest Type’s description.
expirationNotification dictionary	Expiration Notification Settings.
advanceNotificationDuration integer	Send Account Expiration Notification Duration before ( Days, Hours, Minutes ).
advanceNotificationUnits string	Allowed values are - DAYS, - HOURS, - MINUTES.
emailText string	Guest Type’s emailText.
enableNotification boolean	Enable Notification settings. Choices: no yes
sendEmailNotification boolean	Enable Email Notification. Choices: no yes
sendSmsNotification boolean	Maximum devices guests can register. Choices: no yes
smsText string	Guest Type’s smsText.
id string	Guest Type’s id.
isDefaultType boolean	IsDefaultType 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.1”
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: no yes ← (default)
loginOptions dictionary	Guest Type’s loginOptions.
allowGuestPortalBypass boolean	AllowGuestPortalBypass flag. Choices: no yes
failureAction string	When Guest Exceeds limit this action will be invoked. Allowed values are - Disconnect_Oldest_Connection, - Disconnect_Newest_Connection.
identityGroupId string	Guest Type’s identityGroupId.
limitSimultaneousLogins boolean	Enable Simultaneous Logins. Choices: no yes
maxRegisteredDevices integer	Maximum devices guests can register.
maxSimultaneousLogins integer	Number of Simultaneous Logins.
name string	Guest Type’s name.
sponsorGroups list / elements=string	Guest Type’s sponsorGroups.

Notes 

Note

SDK Method used are guest_type.GuestType.create_guest_type, guest_type.GuestType.delete_guest_type_by_id, guest_type.GuestType.update_guest_type_by_id,
Paths used are post /ers/config/guesttype, delete /ers/config/guesttype/{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.guest_type:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accessTime:
      allowAccessOnSpecificDaysTimes: true
      dayTimeLimits:
      - days:
        - string
        endTime: string
        startTime: string
      defaultDuration: 0
      durationTimeUnit: string
      fromFirstLogin: true
      maxAccountDuration: 0
    description: string
    expirationNotification:
      advanceNotificationDuration: 0
      advanceNotificationUnits: string
      emailText: string
      enableNotification: true
      sendEmailNotification: true
      sendSmsNotification: true
      smsText: string
    id: string
    isDefaultType: true
    loginOptions:
      allowGuestPortalBypass: true
      failureAction: string
      identityGroupId: string
      limitSimultaneousLogins: true
      maxRegisteredDevices: 0
      maxSimultaneousLogins: 0
    name: string
    sponsorGroups:
    - string

- 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

- 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: true
      dayTimeLimits:
      - days:
        - string
        endTime: string
        startTime: string
      defaultDuration: 0
      durationTimeUnit: string
      fromFirstLogin: true
      maxAccountDuration: 0
    description: string
    expirationNotification:
      advanceNotificationDuration: 0
      advanceNotificationUnits: string
      emailText: string
      enableNotification: true
      sendEmailNotification: true
      sendSmsNotification: true
      smsText: string
    isDefaultType: true
    loginOptions:
      allowGuestPortalBypass: true
      failureAction: string
      identityGroupId: string
      limitSimultaneousLogins: true
      maxRegisteredDevices: 0
      maxSimultaneousLogins: 0
    name: string
    sponsorGroups:
    - string

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

Collection links

Issue Tracker Repository (Sources)

cisco.ise.guest_type module – Resource module for Guest Type

Synopsis

Requirements

Parameters

Notes

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

Examples 

Return Values 