cisco.ise.internal_user – Resource module for Internal User
Note
This plugin is part of the cisco.ise collection (version 2.1.2).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
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 >= 1.3.0
python >= 3.5
Parameters
Notes
Note
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco ISE SDK
The parameters starting with ise_ are used by the Cisco ISE Python SDK to establish the connection
See Also
See also
- Internal User reference
Complete reference of the Internal User object model.
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module: