cisco.ise.duo_identity_sync_status module – Resource module for Duo Identity Sync Status
Note
This module is part of the cisco.ise collection (version 2.9.5).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.ise.duo_identity_sync_status
.
New in cisco.ise 1.0.0
Synopsis
Manage operation update of the resource Duo Identity Sync Status.
Duo-identitysync - update sync status.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 2.2.3
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Duo Identity Sync Status’s errorList. |
|
Reason user failed sync. |
|
User to be synced to Duo. |
|
Active directory that duo user is contained in. |
|
Email of Duo user. |
|
First name of Duo user. |
|
Acrive directory group that duo user is contained in. |
|
Last name of duo user. |
|
Notes of Duo user. |
|
Realname of Duo user. |
|
Status of Duo user. |
|
Username of Duo user. |
|
Flag for Identity Services Engine SDK to enable debugging. Choices:
|
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
Timeout (in seconds) for RESTful HTTP requests. Default: |
|
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. Default: |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices:
|
|
Status of sync. |
|
SyncName path parameter. Sync connection to be updated. |
Notes
Note
SDK Method used are duo_identity_sync.DuoIdentitySync.update_status,
Paths used are put /api/v1/duo-identitysync/identitysync/status/{syncName},
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: Update by name
cisco.ise.duo_identity_sync_status:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
errorList:
- reason: string
user:
directoryname: string
email: string
firstname: string
groupname: string
lastname: string
notes: string
realname: string
status: string
username: string
status: string
syncName: 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 Sample: |