cisco.ise.guestuser module – Resource module for Guestuser

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

New in cisco.ise 1.0.0

Synopsis

  • Manage operation create of the resource Guestuser.

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

customFields

dictionary

Key value map.

description

string

Description.

guestAccessInfo

dictionary

Guestuser’s guestAccessInfo.

fromDate

string

Guestuser’s fromDate.

groupTag

string

Guestuser’s groupTag.

location

string

Guestuser’s location.

ssid

string

Guestuser’s ssid.

toDate

string

Guestuser’s toDate.

validDays

dictionary

Number of days guest user is valid. To validate validDays property, ISE consider only date(not time) between fromDate and toDate properites.

guestInfo

dictionary

Guestuser’s guestInfo.

company

string

Guestuser’s company.

creationTime

string

Guestuser’s creationTime.

emailAddress

string

Guestuser’s emailAddress.

enabled

boolean

This field is only for Get operation not applicable for Create, Update operations.

Choices:

firstName

string

Guestuser’s firstName.

lastName

string

Guestuser’s lastName.

notificationLanguage

string

Guestuser’s notificationLanguage.

password

string

Guestuser’s password.

phoneNumber

string

Phone number should be E.164 format.

smsServiceProvider

string

Guestuser’s smsServiceProvider.

userName

string

This field is applicable for Get and Create operations not applicable for Update operation.If account needs be created with mobile number, please provide mobile number here.

guestType

string

Guestuser’s guestType.

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:

name

string

Name.

personBeingVisited

string

Guestuser’s personBeingVisited.

portalId

string

This field is applicable only for Create and Update operations not applicable for Get operation.Portal ID will be used to fetch configuration from Portal if missing from the Payload. For example Notification Language will be fetched from Portal if missing.

reasonForVisit

string

Guestuser’s reasonForVisit.

sponsorUserId

string

This field is applicable only for Get operation not applicable for Create and Update operations.

sponsorUserName

string

This field is applicable for Get and Create operations not applicable for Update operation.

status

string

This field is applicable only for Get operation not applicable for Create and Update operations.

statusReason

string

Guestuser’s statusReason.

Notes

Note

  • SDK Method used are guestuser.Guestuser.create_guestuser,

  • Paths used are post /guestuser/,

  • 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.guestuser:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    customFields:
      another key: and its value
      some key: some value
    description: 'ERS Example user '
    guestAccessInfo:
      fromDate: 07/29/2014 14:44
      location: San Jose
      toDate: 10/29/2014 17:30
      validDays: 90
    guestInfo:
      emailAddress: email@some.uri.com
      enabled: true
      password: asdlkj324ew
      phoneNumber: '+13211239034'
      smsServiceProvider: GLobal Default
      userName: DS3ewdsa34wWE
    guestType: Contractor
    id: f75760e7-a4f9-40ef-93bb-88a97e9fb171
    name: guestUser
    portalId: '23423432523'
    sponsorUserName: Mr Spons

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)