cisco.ise.system_certificate – Resource module for System Certificate

Note

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

To install it use: ansible-galaxy collection install cisco.ise.

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

New in version 1.0.0: of cisco.ise

Synopsis

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

Note

This module has a corresponding action plugin.

Requirements

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

• ciscoisesdk >= 1.0.0

• python >= 3.5

Parameters

Parameter	Choices/Defaults	Comments
admin boolean	Choices: no yes	Use certificate to authenticate the ISE Admin Portal.
allowReplacementOfPortalGroupTag boolean	Choices: no yes	Allow Replacement of Portal Group Tag (required).
description string		Description of System Certificate.
eap boolean	Choices: no yes	Use certificate for EAP protocols that use SSL/TLS tunneling.
expirationTTLPeriod integer		System Certificate's expirationTTLPeriod.
expirationTTLUnits string		System Certificate's expirationTTLUnits.
hostName string		HostName path parameter. Name of the host from which the System Certificate needs to be deleted.
id string		Id path parameter. The ID of the System Certificate to be deleted.
ims boolean	Choices: no yes	Use certificate for the ISE Messaging Service.
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_verify boolean	Choices: no yes ←	Flag to enable or disable SSL certificate verification.
ise_version string	Default: "3.0.0"	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		Name of the certificate.
portal boolean	Choices: no yes	Use for portal.
portalGroupTag string		Set Group tag.
pxgrid boolean	Choices: no yes	Use certificate for the pxGrid Controller.
radius boolean	Choices: no yes	Use certificate for the RADSec server.
renewSelfSignedCertificate boolean	Choices: no yes	Renew Self Signed Certificate.
saml boolean	Choices: no yes	Use certificate for SAML Signing.

Notes

Note

• Does not support check_mode

See Also

See also

System Certificate reference

Complete reference of the System Certificate object model.

Examples

- name: Update by id
  cisco.ise.system_certificate:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    admin: true
    allowReplacementOfPortalGroupTag: true
    description: string
    eap: true
    expirationTTLPeriod: 0
    expirationTTLUnits: string
    hostName: string
    id: string
    ims: true
    name: string
    portal: true
    portalGroupTag: string
    pxgrid: true
    radius: true
    renewSelfSignedCertificate: true
    saml: true

- name: Delete by id
  cisco.ise.system_certificate:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    hostName: string
    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": { "id": "string", "link": { "href": "string", "rel": "string", "type": "string" }, "message": "string", "status": "string" }, "version": "string" }

Authors

• Rafael Campos (@racampos)