.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.ise.guest_user_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.guest_user -- Resource module for Guest User ++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.ise collection `_ (version 1.0.2). To install it use: :code:`ansible-galaxy collection install cisco.ise`. To use it in a playbook, specify: :code:`cisco.ise.guest_user`. .. version_added .. versionadded:: 1.0.0 of cisco.ise .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Guest User. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk .. Options Parameters ---------- .. raw:: html

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.
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 .. Seealso See Also -------- .. seealso:: `Guest User reference `_ Complete reference of the Guest User object model. .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html

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" } }

.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors