cisco.ise.trusted_certificate – Resource module for Trusted Certificate

Note

This plugin is part of the cisco.ise collection (version 2.1.2).

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.

To use it in a playbook, specify: cisco.ise.trusted_certificate.

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operations update and delete of the resource Trusted Certificate.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 1.3.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
authenticateBeforeCRLReceived
boolean
    Choices:
  • no
  • yes
Switch to enable or disable CRL verification if CRL is not received.
automaticCRLUpdate
boolean
    Choices:
  • no
  • yes
Switch to enable or disable automatic CRL update.
automaticCRLUpdatePeriod
integer
Automatic CRL update period.
automaticCRLUpdateUnits
string
Unit of time for automatic CRL update.
crlDistributionUrl
string
CRL Distribution URL.
crlDownloadFailureRetries
integer
If CRL download fails, wait time before retry.
crlDownloadFailureRetriesUnits
string
Unit of time before retry if CRL download fails.
description
string
Description for trust certificate.
downloadCRL
boolean
    Choices:
  • no
  • yes
Switch to enable or disable download of CRL.
enableOCSPValidation
boolean
    Choices:
  • no
  • yes
Switch to enable or disable OCSP Validation.
enableServerIdentityCheck
boolean
    Choices:
  • no
  • yes
Switch to enable or disable verification if HTTPS or LDAP server certificate name fits the configured server URL.
id
string
Id path parameter. ID of the trust certificate.
ignoreCRLExpiration
boolean
    Choices:
  • no
  • yes
Switch to enable or disable ignore CRL expiration.
ise_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Identity Services Engine SDK to enable debugging.
ise_hostname
string / required
The Identity Services Engine hostname.
ise_password
string / required
The Identity Services Engine password to authenticate.
ise_username
string / required
The Identity Services Engine username to authenticate.
ise_uses_api_gateway
boolean
added in 1.1.0 of cisco.ise
    Choices:
  • no
  • yes ←
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).
ise_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
ise_version
string
Default:
"3.1.1"
Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit
boolean
    Choices:
  • no
  • yes ←
Flag for Identity Services Engine SDK to enable automatic rate-limit handling.
name
string
Friendly name of the certificate.
nonAutomaticCRLUpdatePeriod
integer
Non automatic CRL update period.
nonAutomaticCRLUpdateUnits
string
Unit of time of non automatic CRL update.
rejectIfNoStatusFromOCSP
boolean
    Choices:
  • no
  • yes
Switch to reject certificate if there is no status from OCSP.
rejectIfUnreachableFromOCSP
boolean
    Choices:
  • no
  • yes
Switch to reject certificate if unreachable from OCSP.
selectedOCSPService
string
Name of selected OCSP Service.
status
string
Trusted Certificate's status.
trustForCertificateBasedAdminAuth
boolean
    Choices:
  • no
  • yes
Trust for Certificate based Admin authentication.
trustForCiscoServicesAuth
boolean
    Choices:
  • no
  • yes
Trust for authentication of Cisco Services.
trustForClientAuth
boolean
    Choices:
  • no
  • yes
Trust for client authentication and Syslog.
trustForIseAuth
boolean
    Choices:
  • no
  • yes
Trust for authentication within Cisco ISE.

Notes

Note

  • 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

See Also

See also

Trusted Certificate reference

Complete reference of the Trusted Certificate object model.

Examples

- name: Update by id
  cisco.ise.trusted_certificate:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    authenticateBeforeCRLReceived: true
    automaticCRLUpdate: true
    automaticCRLUpdatePeriod: 0
    automaticCRLUpdateUnits: string
    crlDistributionUrl: string
    crlDownloadFailureRetries: 0
    crlDownloadFailureRetriesUnits: string
    description: string
    downloadCRL: true
    enableOCSPValidation: true
    enableServerIdentityCheck: true
    id: string
    ignoreCRLExpiration: true
    name: string
    nonAutomaticCRLUpdatePeriod: 0
    nonAutomaticCRLUpdateUnits: string
    rejectIfNoStatusFromOCSP: true
    rejectIfUnreachableFromOCSP: true
    selectedOCSPService: string
    status: string
    trustForCertificateBasedAdminAuth: true
    trustForCiscoServicesAuth: true
    trustForClientAuth: true
    trustForIseAuth: true

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

Return Values

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

Key Returned Description
ise_response
dictionary
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "authenticateBeforeCRLReceived": "string", "automaticCRLUpdate": "string", "automaticCRLUpdatePeriod": "string", "automaticCRLUpdateUnits": "string", "crlDistributionUrl": "string", "crlDownloadFailureRetries": "string", "crlDownloadFailureRetriesUnits": "string", "description": "string", "downloadCRL": "string", "enableOCSPValidation": "string", "enableServerIdentityCheck": "string", "expirationDate": "string", "friendlyName": "string", "id": "string", "ignoreCRLExpiration": "string", "internalCA": true, "isReferredInPolicy": true, "issuedBy": "string", "issuedTo": "string", "keySize": "string", "link": { "href": "string", "rel": "string", "type": "string" }, "nonAutomaticCRLUpdatePeriod": "string", "nonAutomaticCRLUpdateUnits": "string", "rejectIfNoStatusFromOCSP": "string", "rejectIfUnreachableFromOCSP": "string", "selectedOCSPService": "string", "serialNumberDecimalFormat": "string", "sha256Fingerprint": "string", "signatureAlgorithm": "string", "status": "string", "subject": "string", "trustedFor": "string", "validFrom": "string" }
ise_update_response
dictionary
added in 1.1.0 of cisco.ise
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "response": { "id": "string", "link": { "href": "string", "rel": "string", "type": "string" }, "message": "string" }, "version": "string" }


Authors

  • Rafael Campos (@racampos)