cisco.ise.duo_mfa module – Resource module for Duo Mfa
Note
This module is part of the cisco.ise collection (version 2.9.5).
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_mfa
.
New in cisco.ise 1.0.0
Synopsis
Manage operations create, update and delete of the resource Duo Mfa.
Duo-MFA - Create a new Duo-MFA configuration.
Duo-MFA - Delete the Duo-MFA configuration specified in the connectionName.
Duo-MFA - Update the Duo-MFA configuration specified in the connectionName.
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 Mfa’s accountConfigurations. |
|
API type. |
|
Integration Key. |
|
Secret Key. |
|
Duo API HostName. |
|
API type. |
|
Integration Key. |
|
Secret Key. |
|
Name of the Duo-MFA configuration. |
|
Description of the Duo-MFA configuration. |
|
Name of the Identity Sync configuration. |
|
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: :ansible-option-default:`60` |
|
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: |
|
Protocol type for which this Duo-MFA can be used. |
Notes
Note
SDK Method used are duo_mfa.DuoMfa.create_mfa, duo_mfa.DuoMfa.delete_mfa_by_connection_name, duo_mfa.DuoMfa.update_m_fa_by_connection_name,
Paths used are post /api/v1/duo-mfa/mfa, delete /api/v1/duo-mfa/mfa/{connectionName}, put /api/v1/duo-mfa/mfa/{connectionName},
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_mfa:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
accountConfigurations:
adminApi:
ikey: string
sKey: string
apiHostName: string
authenticationApi:
ikey: string
sKey: string
connectionName: string
description: string
identitySync: string
type: string
- name: Update by name
cisco.ise.duo_mfa:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
accountConfigurations:
adminApi:
ikey: string
sKey: string
apiHostName: string
authenticationApi:
ikey: string
sKey: string
connectionName: string
description: string
identitySync: string
type: string
- name: Delete by name
cisco.ise.duo_mfa:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
connectionName: 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 |