cisco.ise.guest_type – Resource module for Guest Type
Note
This plugin is part of the cisco.ise collection (version 2.1.1).
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
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 >= 1.3.0
python >= 3.5
Parameters
Notes
Note
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
See Also
See also
- Guest Type reference
Complete reference of the Guest Type object model.
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: