cisco.ise.guest_type module – Resource module for Guest Type
Note
This module is part of the cisco.ise collection (version 2.8.0).
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.guest_type.
New in cisco.ise 1.0.0
Synopsis
Manage operations create, update and delete of the resource Guest Type.
This API creates a guest type.
This API deletes a guest type.
This API allows the client to update 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.1.1
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Guest Type’s accessTime. |
|
AllowAccessOnSpecificDaysTimes flag. Choices: |
|
List of Time Ranges for account access. |
|
List of Days Values should be one of Week day. Allowed values are - Sunday, - Monday, - Tuesday, - Wednesday, - Thursday, - Friday, - Saturday. |
|
End time in HH mm format. |
|
Start time in HH mm format. |
|
Guest Type’s defaultDuration. |
|
Allowed values are - DAYS, - HOURS, - MINUTES. |
|
When Account Duration starts from first login or specified date. Choices: |
|
Maximum value of Account Duration. |
|
Guest Type’s description. |
|
Expiration Notification Settings. |
|
Send Account Expiration Notification Duration before ( Days, Hours, Minutes ). |
|
Allowed values are - DAYS, - HOURS, - MINUTES. |
|
Guest Type’s emailText. |
|
Enable Notification settings. Choices: |
|
Enable Email Notification. Choices: |
|
Maximum devices guests can register. Choices: |
|
Guest Type’s smsText. |
|
Guest Type’s id. |
|
IsDefaultType flag. Choices: |
|
Flag for Identity Services Engine SDK to enable debugging. Choices: |
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
Timeout (in seconds) for RESTful HTTP requests. Default: :ansible-option-default:`60` |
|
The Identity Services Engine username to authenticate. |
|
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: |
|
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: |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Identity Services Engine to use. |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: |
|
Guest Type’s loginOptions. |
|
AllowGuestPortalBypass flag. Choices: |
|
When Guest Exceeds limit this action will be invoked. Allowed values are - Disconnect_Oldest_Connection, - Disconnect_Newest_Connection. |
|
Guest Type’s identityGroupId. |
|
Enable Simultaneous Logins. Choices: |
|
Maximum devices guests can register. |
|
Number of Simultaneous Logins. |
|
Guest Type’s name. |
|
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}, put /ers/config/guesttype/{id},
Does not support
check_modeThe 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 |
|---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always |
|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always |