cisco.ise.guest_type – Resource module for Guest Type

Note

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

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

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
accessTime
dictionary
Guest Type's accessTime.
allowAccessOnSpecificDaysTimes
boolean
    Choices:
  • no
  • yes
AllowAccessOnSpecificDaysTimes flag.
dayTimeLimits
list / elements=string
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
    Choices:
  • no
  • yes
When Account Duration starts from first login or specified date.
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
    Choices:
  • no
  • yes
Enable Notification settings.
sendEmailNotification
boolean
    Choices:
  • no
  • yes
Enable Email Notification.
sendSmsNotification
boolean
    Choices:
  • no
  • yes
Maximum devices guests can register.
smsText
string
Guest Type's smsText.
id
string
Guest Type's id.
isDefaultType
boolean
    Choices:
  • no
  • yes
IsDefaultType flag.
ise_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Identity Services Engine SDK to enable debugging.
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
    Choices:
  • no
  • yes ←
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).
ise_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
ise_version
string
Default:
"3.1.0"
Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit
boolean
    Choices:
  • no
  • yes ←
Flag for Identity Services Engine SDK to enable automatic rate-limit handling.
loginOptions
dictionary
Guest Type's loginOptions.
allowGuestPortalBypass
boolean
    Choices:
  • no
  • yes
AllowGuestPortalBypass flag.
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
    Choices:
  • no
  • yes
Enable Simultaneous Logins.
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

  • Does not support check_mode

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:

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", "isDefaultType": true, "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" ], "link": { "rel": "string", "href": "string", "type": "string" } }
ise_update_response
dictionary
added in 1.1.0 of cisco.ise
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "UpdatedFieldsList": { "updatedField": { "field": "string", "oldValue": "string", "newValue": "string" }, "field": "string", "oldValue": "string", "newValue": "string" } }


Authors

  • Rafael Campos (@racampos)