cisco.ise.internal_user module – Resource module for Internal User
Note
This module is part of the cisco.ise collection (version 2.5.7).
To install it, use: ansible-galaxy collection install cisco.ise.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.ise.internal_user.
New in cisco.ise 1.0.0
Synopsis
Manage operations create, update and delete of the resource Internal User.
This API creates an internal user.
This API deletes an internal user by ID.
This API deletes an internal user by name.
This API allows the client to update an internal user by ID.
This API allows the client to update an internal user by name.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 2.0.5
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
ChangePassword flag. Choices: |
|
Key value map. |
|
Internal User’s description. |
|
Internal User’s email. |
|
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’. Choices: |
|
Internal User’s enablePassword. |
|
To store the internal user’s expiry date information. It’s format is = ‘YYYY-MM-DD’. |
|
ExpiryDateEnabled flag. Choices: |
|
Internal User’s firstName. |
|
Internal User’s id. |
|
CSV of identity group IDs. |
|
Flag for Identity Services Engine SDK to enable debugging. Choices: |
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
The Identity Services Engine username to authenticate. |
|
Flag that informs the SDK whether to use the Identity Services Engine’s API Gateway to send requests. If it is true, it uses the ISE’s API Gateway and sends requests to https://{{ise_hostname}}. If it is false, it sends the requests to https://{{ise_hostname}}:{{port}}, where the port value depends on the Service used (ERS, Mnt, UI, PxGrid). Choices: |
|
Flag that informs the SDK whether we send the CSRF token to ISE’s ERS APIs. If it is True, the SDK assumes that your ISE CSRF Check is enabled. If it is True, it assumes you need the SDK to manage the CSRF token automatically for you. Choices: |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Identity Services Engine to use. |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: |
|
Internal User’s lastName. |
|
Internal User’s name. |
|
Internal User’s password. |
|
The id store where the internal user’s password is kept. |
Notes
Note
SDK Method used are internal_user.InternalUser.create_internal_user, internal_user.InternalUser.delete_internal_user_by_id, internal_user.InternalUser.delete_internal_user_by_name, internal_user.InternalUser.update_internal_user_by_id, internal_user.InternalUser.update_internal_user_by_name,
Paths used are post /ers/config/internaluser, delete /ers/config/internaluser/name/{name}, delete /ers/config/internaluser/{id}, put /ers/config/internaluser/name/{name}, put /ers/config/internaluser/{id},
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
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:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always |
|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always |