cisco.ise.guesttype module – Resource module for Guesttype

Note

This module is part of the cisco.ise collection (version 3.0.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.guesttype.

New in cisco.ise 1.0.0

Synopsis

  • Manage operation create of the resource Guesttype.

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

Guesttype’s accessTime.

allowAccessOnSpecificDaysTimes

boolean

Enable Specific Day Time Limits.

Choices:

dayTimeLimits

list / elements=dictionary

List of Time Ranges for account access.

defaultDuration

float

Guesttype’s defaultDuration.

durationTimeUnit

string

Allowed values are Days or Hours or Minutes.

fromFirstLogin

boolean

When Account Duration starts from first login or specified date.

Choices:

maxAccountDuration

float

Maximum value of Account Duration.

allowDynamicIdentityGroups

boolean

Enable the DynamicGroups Option.

Choices:

description

string

Description.

dynamicGroups

list / elements=dictionary

List of Dynamic Groups.

expirationNotification

dictionary

Guesttype’s expirationNotification.

advanceNotificationDuration

float

Send Account Expiration Notification Duration before ( Days, Hours, Minutes ).

advanceNotificationUnits

string

Allowed values are Days, Hours, Minutes.

enableNotification

boolean

Enable Notification settings.

Choices:

sendEmailNotification

boolean

Enable Email Notification.

Choices:

sendSMSNotification

float

Maximum devices guests can register.

id

string

Id.

ise_debug

boolean

Flag for Identity Services Engine SDK to enable debugging.

Choices:

ise_hostname

string / required

The Identity Services Engine hostname.

ise_password

string / required

The Identity Services Engine password to authenticate.

ise_single_request_timeout

integer

added in cisco.ise 3.0.0

Timeout (in seconds) for RESTful HTTP requests.

Default: :ansible-option-default:`60`

ise_username

string / required

The Identity Services Engine username to authenticate.

ise_uses_api_gateway

boolean

added in cisco.ise 1.1.0

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:

ise_uses_csrf_token

boolean

added in cisco.ise 3.0.0

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:

ise_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

ise_version

string

Informs the SDK which version of Identity Services Engine to use.

Default: :ansible-option-default:`"3.1\_Patch\_1"`

ise_wait_on_rate_limit

boolean

Flag for Identity Services Engine SDK to enable automatic rate-limit handling.

Choices:

loginOptions

dictionary

Guesttype’s loginOptions.

allowGuestPortalBypass

boolean

AllowGuestPortalBypass flag.

Choices:

failureAction

string

When Guest Exceeds limit this action will be invoked, Allowed values are Disconnect_Oldest_Connection or Disconnect_Newest_Connection.

identityGroupId

string

ID of Guest Identity Group.

limitSimultaneousLogins

boolean

Enable Simultaneous Logins.

Choices:

maxRegisteredDevices

float

Maximum devices guests can register.

maxSimultaneousLogins

float

Number of Simultaneous Logins.

name

string

Name.

sponsorGroups

list / elements=string

List of Sponsor Groups.

Notes

Note

  • SDK Method used are guesttype.Guesttype.create_guesttype,

  • Paths used are post /guesttype/,

  • 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: Create
  cisco.ise.guesttype:
    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
    allowDynamicIdentityGroups: true
    description: Description
    dynamicGroups:
      - endpointIdentityGroupId: generatedID
        externalGroupName: ExternalServerName:GroupName
    expirationNotification:
      advanceNotificationDuration: 3
      advanceNotificationUnits: DAYS
      emailText: EmailText
      enableNotification: false
      sendEmailNotification: false
      sendSmsNotification: false
      smsText: SMS Text
    id: f75760e7-a4f9-40ef-93bb-88a97e9fb171
    loginOptions:
      allowGuestPortalBypass: false
      failureAction: Disconnect_Oldest_Connection
      identityGroupId: generatedID
      limitSimultaneousLogins: true
      maxRegisteredDevices: 5
      maxSimultaneousLogins: 3
    name: Name
    sponsorGroups:
      - Group1
      - Group2

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

ise_response

list / elements=dictionary

A dictionary or list with the response returned by the Cisco ISE Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`"[\\n {\\n \\"id\\": \\"string\\",\\n \\"name\\": \\"string\\",\\n \\"description\\": \\"string\\",\\n \\"link\\": {\\n \\"rel\\": \\"string\\",\\n \\"href\\": \\"string\\",\\n \\"type\\": \\"string\\"\\n }\\n }\\n]\\n"`

Authors

  • Rafael Campos (@racampos)