.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.ise.internal_user_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.internal_user -- Resource module for Internal 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.internal_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 Internal 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
changePassword boolean	Choices: no yes	ChangePassword flag.
customAttributes dictionary		Key value map.
description string		Internal User's description.
email string		Internal User's email.
enabled boolean	Choices: no yes	Whether the user is enabled/disabled. To use it as filter, the values should be 'Enabled' or 'Disabled'. The values are case sensitive. For example, 'ERSObjectURL?filter=enabled.EQ.Enabled'.
enablePassword string		Internal User's enablePassword.
expiryDate string		To store the internal user's expiry date information. It's format is = 'YYYY-MM-DD'.
expiryDateEnabled boolean	Choices: no yes	ExpiryDateEnabled flag.
firstName string		Internal User's firstName.
id string		Internal User's id.
identityGroups string		CSV of identity group IDs.
lastName string		Internal User's lastName.
name string		Internal User's name.
password string		Internal User's password.
passwordIDStore string		The id store where the internal user's password is kept.

.. Notes .. Seealso See Also -------- .. seealso:: `Internal User reference `_ Complete reference of the Internal User object model. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Update by name cisco.ise.internal_user: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present changePassword: true customAttributes: {} description: string email: string enablePassword: string enabled: true expiryDate: string expiryDateEnabled: true firstName: string id: string identityGroups: string lastName: string name: string password: string passwordIDStore: string - name: Delete by name cisco.ise.internal_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.internal_user: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present changePassword: true customAttributes: {} description: string email: string enablePassword: string enabled: true expiryDate: string expiryDateEnabled: true firstName: string id: string identityGroups: string lastName: string name: string password: string passwordIDStore: string - name: Delete by id cisco.ise.internal_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.internal_user: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present changePassword: true customAttributes: {} description: string email: string enablePassword: string enabled: true expiryDate: string expiryDateEnabled: true firstName: string identityGroups: string lastName: string name: string password: string passwordIDStore: 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