You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

cisco.ise.guest_user module – Resource module for Guest User

Note

This module is part of the cisco.ise collection (version 1.2.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

• python >= 3.5

Parameters

Parameter	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	This field is only for Get operation not applicable for Create, Update operations. Choices: no yes
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	Flag for Identity Services Engine SDK to enable debugging. Choices: no ← (default) yes
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	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: no yes ← (default)
ise_verify boolean	Flag to enable or disable SSL certificate verification. Choices: no yes ← (default)
ise_version string	Informs the SDK which version of Identity Services Engine to use. Default: “3.1.0”
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: no yes ← (default)
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	Description
ise_response dictionary	A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: “{\n \”id\”: \”string\”,\n \”name\”: \”string\”,\n \”description\”: \”string\”,\n \”guestType\”: \”string\”,\n \”status\”: \”string\”,\n \”statusReason\”: \”string\”,\n \”reasonForVisit\”: \”string\”,\n \”sponsorUserId\”: \”string\”,\n \”sponsorUserName\”: \”string\”,\n \”guestInfo\”: {\n \”firstName\”: \”string\”,\n \”lastName\”: \”string\”,\n \”company\”: \”string\”,\n \”creationTime\”: \”string\”,\n \”notificationLanguage\”: \”string\”,\n \”userName\”: \”string\”,\n \”emailAddress\”: \”string\”,\n \”phoneNumber\”: \”string\”,\n \”password\”: \”string\”,\n \”enabled\”: true,\n \”smsServiceProvider\”: \”string\”\n },\n \”guestAccessInfo\”: {\n \”validDays\”: 0,\n \”fromDate\”: \”string\”,\n \”toDate\”: \”string\”,\n \”location\”: \”string\”,\n \”ssid\”: \”string\”,\n \”groupTag\”: \”string\”\n },\n \”portalId\”: \”string\”,\n \”customFields\”: {},\n \”link\”: {\n \”rel\”: \”string\”,\n \”href\”: \”string\”,\n \”type\”: \”string\”\n }\n}\n”
ise_update_response dictionary added in 1.1.0 of cisco.ise	A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: “{\n \”UpdatedFieldsList\”: {\n \”updatedField\”: {\n \”field\”: \”string\”,\n \”oldValue\”: \”string\”,\n \”newValue\”: \”string\”\n },\n \”field\”: \”string\”,\n \”oldValue\”: \”string\”,\n \”newValue\”: \”string\”\n }\n}\n”

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)