.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.ise.guest_type_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.guest_type -- Resource module for Guest Type ++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.ise collection `_ (version 0.0.9). To install it use: :code:`ansible-galaxy collection install cisco.ise`. To use it in a playbook, specify: :code:`cisco.ise.guest_type`. .. version_added .. versionadded:: 1.0.0 of cisco.ise .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Guest Type. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk .. Options Parameters ---------- .. raw:: html
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.

.. Notes .. Seealso See Also -------- .. seealso:: :ref:`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 Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
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" ] }


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors