cisco.ise.guest_user – Resource module for Guest User
Note
This plugin is part of the cisco.ise collection (version 2.1.0).
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.3.0
python >= 3.5
Parameters
Notes
Note
Does not support
check_modeThe 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
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: