cisco.ise.trusted_certificate – Resource module for Trusted Certificate

Note

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

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

Parameters

Parameter	Choices/Defaults	Comments
authenticateBeforeCRLReceived boolean	Choices: no yes	Switch to enable/disable CRL Verification if CRL is not Received.
automaticCRLUpdate boolean	Choices: no yes	Switch to enable/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/disable download of CRL.
enableOCSPValidation boolean	Choices: no yes	Switch to enable/disable OCSP Validation.
enableServerIdentityCheck boolean	Choices: no yes	Switch to enable/disable verification if HTTPS or LDAP server certificate name fits the configured server URL.
id string		Id path parameter. The ID of the Trusted Certificate to be deleted.
ignoreCRLExpiration boolean	Choices: no yes	Switch to enable/disable ignore CRL Expiration.
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 ISE.

See Also

See also

cisco.ise.plugins.module_utils.definitions.trusted_certificate

The official documentation on the cisco.ise.plugins.module_utils.definitions.trusted_certificate module.

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: { "response": { "message": "string", "id": "string", "link": { "rel": "string", "href": "string", "type": "string" } }, "version": "string" }

Authors

• Rafael Campos (@racampos)