cisco.ise.duo_identity_sync module – Resource module for Duo Identity Sync

Note

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

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.

New in cisco.ise 1.0.0

Synopsis

  • Manage operations create, update and delete of the resource Duo Identity Sync.

  • Duo-IdentitySync - Create a new IdentitySync configuration.

  • Duo-Identitysync - Delete the Identitysync configuration specified in the syncName.

  • Duo-Identitysync - Update the Identitysync configuration specified in the syncName.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 2.2.1

  • python >= 3.5

Parameters

Parameter

Comments

adGroups

list / elements=dictionary

Duo Identity Sync’s adGroups.

name

string

Active Directory Group ID.

source

string

Source of the Active Directory Group.

configurations

dictionary

Duo Identity Sync’s configurations.

activeDirectories

list / elements=dictionary

Duo Identity Sync’s activeDirectories.

directoryID

string

Active Directory ID.

domain

string

Active Directory domain name.

name

string

Name of the Active Directory.

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:

lastSync

string

Time of the last Sync.

syncName

string

Name of the Identitysync configuration.

syncSchedule

dictionary

Duo Identity Sync’s syncSchedule.

interval

integer

Frequency of the sync schedule.

intervalUnit

string

Unit of the time interval.

schedulerSync

string

Type of Sync Schedule - If “Recurring”, please specify schedule details.

startDate

string

Start date and start time of the sync schedule.

syncStatus

string

Duo Identity Sync’s syncStatus.

Notes

Note

  • SDK Method used are duo_identity_sync.DuoIdentitySync.create_identitysync, duo_identity_sync.DuoIdentitySync.delete_identity_sync_by_sync_name, duo_identity_sync.DuoIdentitySync.update_identitysync_by_sync_name,

  • Paths used are post /api/v1/duo-identitysync/identitysync, delete /api/v1/duo-identitysync/identitysync/{syncName}, put /api/v1/duo-identitysync/identitysync/{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: Create
  cisco.ise.duo_identity_sync:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    adGroups:
    - name: string
      source: string
    configurations:
      activeDirectories:
      - directoryID: string
        domain: string
        name: string
    lastSync: string
    syncName: string
    syncSchedule:
      interval: 0
      intervalUnit: string
      schedulerSync: string
      startDate: string
    syncStatus: string

- name: Update by name
  cisco.ise.duo_identity_sync:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    adGroups:
    - name: string
      source: string
    configurations:
      activeDirectories:
      - directoryID: string
        domain: string
        name: string
    lastSync: string
    syncName: string
    syncSchedule:
      interval: 0
      intervalUnit: string
      schedulerSync: string
      startDate: string
    syncStatus: string

- name: Delete by name
  cisco.ise.duo_identity_sync:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    syncName: string

Return Values

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

Key

Description

ise_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"identitySync": {"adGroups": [{"name": "string", "sid": "string", "source": "string"}], "configurations": {"activeDirectories": [{"directoryID": "string", "domain": "string", "name": "string"}]}, "lastSync": "string", "syncName": "string", "syncSchedule": {"interval": 0, "intervalUnit": "string", "schedulerSync": "string", "startDate": "string"}, "syncStatus": "string"}}`

ise_update_response

string

added in cisco.ise 1.1.0

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

Returned: always

Sample: :ansible-rv-sample-value:`"\\"'string'\\"\\n"`

Authors

  • Rafael Campos (@racampos)