cisco.ise.guest_user – Resource module for Guest User

Note

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

To install it use: ansible-galaxy collection install cisco.ise.

To use it in a playbook, specify: cisco.ise.guest_user.

New in version 1.0.0: of cisco.ise

Synopsis

• Manage operations create, update and delete of the resource Guest User.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• ciscoisesdk >= 1.0.0

• python >= 3.5

Parameters

Parameter		Choices/Defaults	Comments
customFields dictionary			Key value map.
description string			Guest User's description.
guestAccessInfo dictionary			Guest User's guestAccessInfo.
	fromDate string		Guest User's fromDate.
	groupTag string		Guest User's groupTag.
	location string		Guest User's location.
	ssid string		Guest User's ssid.
	toDate string		Guest User's toDate.
	validDays integer		Guest User's validDays.
guestInfo dictionary			Guest User's guestInfo.
	company string		Guest User's company.
	creationTime string		Guest User's creationTime.
	emailAddress string		Guest User's emailAddress.
	enabled boolean	Choices: no yes	This field is only for Get operation not applicable for Create, Update operations.
	firstName string		Guest User's firstName.
	lastName string		Guest User's lastName.
	notificationLanguage string		Guest User's notificationLanguage.
	password string		Guest User's password.
	phoneNumber string		Phone number should be E.164 format.
	smsServiceProvider string		Guest User's smsServiceProvider.
	userName string		If account needs be created with mobile number, please provide mobile number here.
guestType string			Guest User's guestType.
id string			Guest User's id.
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_verify boolean		Choices: no yes ←	Flag to enable or disable SSL certificate verification.
ise_version string		Default: "3.0.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.
name string			Guest User's name.
portalId string			Guest User's portalId.
reasonForVisit string			Guest User's reasonForVisit.
sponsorUserId string			Guest User's sponsorUserId.
sponsorUserName string			Guest User's sponsorUserName.
status string			Guest User's status.
statusReason string			Guest User's statusReason.

Notes

Note

• Does not support check_mode

See Also

See also

Guest User reference

Complete reference of the Guest User object model.

Examples

- name: Update by name
  cisco.ise.guest_user:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    customFields: {}
    description: string
    guestAccessInfo:
      fromDate: string
      groupTag: string
      location: string
      ssid: string
      toDate: string
      validDays: 0
    guestInfo:
      company: string
      creationTime: string
      emailAddress: string
      enabled: true
      firstName: string
      lastName: string
      notificationLanguage: string
      password: string
      phoneNumber: string
      smsServiceProvider: string
      userName: string
    guestType: string
    id: string
    name: string
    portalId: string
    reasonForVisit: string
    sponsorUserId: string
    sponsorUserName: string
    status: string
    statusReason: string

- name: Delete by name
  cisco.ise.guest_user:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    name: string

- name: Update by id
  cisco.ise.guest_user:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    customFields: {}
    description: string
    guestAccessInfo:
      fromDate: string
      groupTag: string
      location: string
      ssid: string
      toDate: string
      validDays: 0
    guestInfo:
      company: string
      creationTime: string
      emailAddress: string
      enabled: true
      firstName: string
      lastName: string
      notificationLanguage: string
      password: string
      phoneNumber: string
      smsServiceProvider: string
      userName: string
    guestType: string
    id: string
    name: string
    portalId: string
    reasonForVisit: string
    sponsorUserId: string
    sponsorUserName: string
    status: string
    statusReason: string

- name: Delete by id
  cisco.ise.guest_user:
    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_user:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    customFields: {}
    description: string
    guestAccessInfo:
      fromDate: string
      groupTag: string
      location: string
      ssid: string
      toDate: string
      validDays: 0
    guestInfo:
      company: string
      creationTime: string
      emailAddress: string
      enabled: true
      firstName: string
      lastName: string
      notificationLanguage: string
      password: string
      phoneNumber: string
      smsServiceProvider: string
      userName: string
    guestType: string
    name: string
    portalId: string
    reasonForVisit: string
    sponsorUserId: string
    sponsorUserName: string
    status: string
    statusReason: 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: { "UpdatedFieldsList": { "updatedField": { "field": "string", "oldValue": "string", "newValue": "string" }, "field": "string", "oldValue": "string", "newValue": "string" } }

Authors

• Rafael Campos (@racampos)