cisco.ise.guest_user – Resource module for Guest User

Note

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

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

Parameters

Parameter		Choices/Defaults	Comments
guestAccessInfo dictionary			Guest User's guestAccessInfo.
	fromDate string		Guest User's fromDate.
	location string		Guest User's location.
	toDate string		Guest User's toDate.
	validDays integer		Guest User's validDays.
guestInfo dictionary			Guest User's guestInfo.
	emailAddress string		Guest User's emailAddress.
	enabled string		Guest User's enabled.
	firstName string		Guest User's firstName.
	lastName string		Guest User's lastName.
	password string		Guest User's password.
	userName string		Guest User's userName.
guestType string			Guest User's guestType.
id string			Guest User's id.
name string			Name path parameter.
portalId string			Guest User's portalId.
reasonForVisit string			Guest User's reasonForVisit.

See Also

See also

cisco.ise.plugins.module_utils.definitions.guest_user

The official documentation on the cisco.ise.plugins.module_utils.definitions.guest_user module.

Guest User reference

Complete reference of the Guest User object model.

Examples

- name: Create
  cisco.ise.guest_user:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    guestAccessInfo:
      fromDate: 04/27/2021 17:40
      location: San Jose
      toDate: 04/28/2021 17:40
      validDays: 1
    guestInfo:
      emailAddress: thomas@cisco.com
      enabled: 'true'
      firstName: Thomas
      lastName: Howard
      password: C1sco12345
      userName: 1homas
    guestType: Daily (default)
    portalId: bd48c1a1-9477-4746-8e40-e43d20c9f429
    reasonForVisit: ISE Guest Services

- 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
    guestInfo:
      enabled: true
    guestType: Daily (default)
    id: 4cea2c31-605c-42d2-92d1-1e999b61aad0
    portalId: bd48c1a1-9477-4746-8e40-e43d20c9f429

- 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: 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
    guestInfo:
      enabled: true
    guestType: Daily (default)
    id: 4cea2c31-605c-42d2-92d1-1e999b61aad0
    name: string
    portalId: bd48c1a1-9477-4746-8e40-e43d20c9f429

- 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

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: {}

Authors

• Rafael Campos (@racampos)