cisco.ise.guest_user module – Resource module for Guest User
Note
This module is part of the cisco.ise collection (version 2.9.3).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.ise.guest_user
.
New in cisco.ise 1.0.0
Synopsis
Manage operations create, update and delete of the resource Guest User.
This API creates a guest user.
This API deletes a guest user by ID.
This API deletes a guest user.
This API allows the client to update a guest user by ID.
This API allows the client to update a guest user by name.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 2.2.3
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Key value map. |
|
Guest User’s description. |
|
Guest User’s guestAccessInfo. |
|
Guest User’s fromDate. |
|
Guest User’s groupTag. |
|
Guest User’s location. |
|
Guest User’s ssid. |
|
Guest User’s toDate. |
|
Guest User’s validDays. |
|
Guest User’s guestInfo. |
|
Guest User’s company. |
|
Guest User’s creationTime. |
|
Guest User’s emailAddress. |
|
This field is only for Get operation not applicable for Create, Update operations. Choices:
|
|
Guest User’s firstName. |
|
Guest User’s lastName. |
|
Guest User’s notificationLanguage. |
|
Guest User’s password. |
|
Phone number should be E.164 format. |
|
Guest User’s smsServiceProvider. |
|
If account needs be created with mobile number, please provide mobile number here. |
|
Guest User’s guestType. |
|
Guest User’s id. |
|
Flag for Identity Services Engine SDK to enable debugging. Choices:
|
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
Timeout (in seconds) for RESTful HTTP requests. Default: |
|
The Identity Services Engine username to authenticate. |
|
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:
|
|
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:
|
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Identity Services Engine to use. Default: |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices:
|
|
Guest User’s name. |
|
Guest User’s portalId. |
|
Guest User’s reasonForVisit. |
|
Guest User’s sponsorUserId. |
|
Guest User’s sponsorUserName. |
|
Guest User’s status. |
|
Guest User’s statusReason. |
Notes
Note
SDK Method used are guest_user.GuestUser.create_guest_user, guest_user.GuestUser.delete_guest_user_by_id, guest_user.GuestUser.delete_guest_user_by_name, guest_user.GuestUser.update_guest_user_by_id, guest_user.GuestUser.update_guest_user_by_name,
Paths used are post /ers/config/guestuser, delete /ers/config/guestuser/name/{name}, delete /ers/config/guestuser/{id}, put /ers/config/guestuser/name/{name}, put /ers/config/guestuser/{id},
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: 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 |
---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |
|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |