cisco.ise.internaluser module – Resource module for Internaluser

Note

This module is part of the cisco.ise collection (version 3.0.0).

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.internaluser.

New in cisco.ise 1.0.0

Synopsis

  • Manage operation create of the resource Internaluser.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • ciscoisesdk >= 2.0.1

  • python >= 3.5

Parameters

Parameter

Comments

accountNameAlias

string

The Account Name Alias will be used to send email notifications about password expiration.

changePassword

boolean

ChangePassword flag.

Choices:

customAttributes

string

Key value map.

dateCreated

string

The date of the user creation, formatted as ‘YYYY-MM-DD’. Read-only.

dateModified

string

The date of the last user modification by admin, formatted as ‘YYYY-MM-DD’. Read-only.

daysForPasswordExpiration

float

This field is for read only.

description

string

Description.

email

string

Internaluser’s email.

enabled

boolean

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:

enablePassword

string

EnablePassword field is added in ISE 2.0 to support T+.

expiryDate

string

To store the internal user’s expiry date information. It’s format is = ‘YYYY-MM-DD’.

expiryDateEnabled

boolean

ExpiryDateEnabled flag.

Choices:

firstName

string

Internaluser’s firstName.

id

string

Id.

identityGroups

string

CSV of identity group IDs.

ise_debug

boolean

Flag for Identity Services Engine SDK to enable debugging.

Choices:

ise_hostname

string / required

The Identity Services Engine hostname.

ise_password

string / required

The Identity Services Engine password to authenticate.

ise_single_request_timeout

integer

added in cisco.ise 3.0.0

Timeout (in seconds) for RESTful HTTP requests.

Default: :ansible-option-default:`60`

ise_username

string / required

The Identity Services Engine username to authenticate.

ise_uses_api_gateway

boolean

added in cisco.ise 1.1.0

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:

ise_uses_csrf_token

boolean

added in cisco.ise 3.0.0

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:

ise_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

ise_version

string

Informs the SDK which version of Identity Services Engine to use.

Default: :ansible-option-default:`"3.1\_Patch\_1"`

ise_wait_on_rate_limit

boolean

Flag for Identity Services Engine SDK to enable automatic rate-limit handling.

Choices:

lastName

string

Internaluser’s lastName.

name

string

Name.

password

string

Internaluser’s password.

passwordIDStore

string

The id store where the internal user’s password is kept.

passwordNeverExpires

boolean

Set TRUE to indicate the user password never expires. This will not apply to Users who are also ISE Admins.

Choices:

Notes

Note

  • SDK Method used are internaluser.Internaluser.create_internaluser,

  • Paths used are post /internaluser/,

  • Does not support check_mode

  • The 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: Create
  cisco.ise.internaluser:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    accountNameAlias: accountNameAlias
    changePassword: true
    customAttributes:
      key1: value1
      key2: value3
    dateCreated: '2015-12-15'
    dateModified: '2015-12-20'
    daysForPasswordExpiration: 60
    description: description
    email: email@domain.com
    enablePassword: enablePassword
    enabled: true
    expiryDate: '2016-12-11'
    expiryDateEnabled: false
    firstName: firstName
    id: f75760e7-a4f9-40ef-93bb-88a97e9fb171
    identityGroups: CSV of identity groups IDs
    lastName: lastName
    name: name
    password: password
    passwordIDStore: Internal Users
    passwordNeverExpires: false

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

ise_response

list / elements=dictionary

A dictionary or list with the response returned by the Cisco ISE Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`"[\\n {\\n \\"id\\": \\"string\\",\\n \\"name\\": \\"string\\",\\n \\"description\\": \\"string\\",\\n \\"link\\": {\\n \\"rel\\": \\"string\\",\\n \\"href\\": \\"string\\",\\n \\"type\\": \\"string\\"\\n }\\n }\\n]\\n"`

Authors

  • Rafael Campos (@racampos)