cisco.ise.internal_user – Resource module for Internal 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.internal_user.

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operations create, update and delete of the resource Internal 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
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.

See Also

See also

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

- 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

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)