.. 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 0.0.9). 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
Internal User's customAttributes.
key1
string
Internal User's key1.
key2
string
Internal User's key2.
description
string
Internal User's description.
email
string
Internal User's email.
enabled
boolean
    Choices:
  • no
  • yes
Enabled flag.
enablePassword
string
Internal User's enablePassword.
expiryDate
string
Internal User's expiryDate.
expiryDateEnabled
boolean
    Choices:
  • no
  • yes
ExpiryDateEnabled flag.
firstName
string
Internal User's firstName.
id
string
Internal User's id.
identityGroups
string
Internal User's identityGroups.
lastName
string
Internal User's lastName.
name
string
Internal User's name.
password
string
Internal User's password.
passwordIDStore
string
Internal User's passwordIDStore.

.. Notes .. Seealso See Also -------- .. seealso:: :ref:`cisco.ise.plugins.module_utils.definitions.internal_user ` The official documentation on the **cisco.ise.plugins.module_utils.definitions.internal_user** module. `Internal User reference `_ Complete reference of the Internal User object model. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.ise.internal_user: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present description: '{{description}}' name: '{{username}}' password: '{{password}}' - 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 description: New description id: 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: 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 name: string password: Ch@ngedP@55w0rd - 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 .. 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:
{}


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