cisco.ise.system_certificate module – Resource module for System Certificate

Note

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

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.system_certificate.

New in version 1.0.0: of cisco.ise

Synopsis

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

  • This API deletes a System Certificate of a particular node based on given HostName and ID.

  • Update a System Certificate.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 2.0.3

  • python >= 3.5

Parameters

Parameter

Comments

admin

boolean

Use certificate to authenticate the Cisco ISE Admin Portal.

Choices:

  • no

  • yes

allowPortalTagTransferForSameSubject

boolean

Allow overwriting the portal tag from matching certificate of same subject.

Choices:

  • no

  • yes

allowReplacementOfPortalGroupTag

boolean

Allow Replacement of Portal Group Tag (required).

Choices:

  • no

  • yes

allowRoleTransferForSameSubject

boolean

Allow transfer of roles for certificate with matching subject.

Choices:

  • no

  • yes

description

string

Description of System Certificate.

eap

boolean

Use certificate for EAP protocols that use SSL/TLS tunneling.

Choices:

  • no

  • yes

expirationTTLPeriod

integer

System Certificate’s expirationTTLPeriod.

expirationTTLUnits

string

System Certificate’s expirationTTLUnits.

hostName

string

HostName path parameter. Name of Host whose certificate needs to be updated.

id

string

Id path parameter. ID of the System Certificate to be updated.

ims

boolean

Use certificate for the Cisco ISE Messaging Service.

Choices:

  • no

  • yes

ise_debug

boolean

Flag for Identity Services Engine SDK to enable debugging.

Choices:

  • no ← (default)

  • yes

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

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:

  • no

  • yes ← (default)

ise_uses_csrf_token

boolean

added in 3.0.0 of cisco.ise

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:

  • no ← (default)

  • yes

ise_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • no

  • yes ← (default)

ise_version

string

Informs the SDK which version of Identity Services Engine to use.

Default: “3.1_Patch_1”

ise_wait_on_rate_limit

boolean

Flag for Identity Services Engine SDK to enable automatic rate-limit handling.

Choices:

  • no

  • yes ← (default)

name

string

Name of the certificate.

portal

boolean

Use for portal.

Choices:

  • no

  • yes

portalGroupTag

string

Set Group tag.

pxgrid

boolean

Use certificate for the pxGrid Controller.

Choices:

  • no

  • yes

radius

boolean

Use certificate for the RADSec server.

Choices:

  • no

  • yes

renewSelfSignedCertificate

boolean

Renew Self-signed Certificate.

Choices:

  • no

  • yes

saml

boolean

Use certificate for SAML Signing.

Choices:

  • no

  • yes

Notes

Note

  • SDK Method used are certificates.Certificates.delete_system_certificate_by_id, certificates.Certificates.update_system_certificate,

  • Paths used are delete /api/v1/certs/system-certificate/{hostName}/{id}, put /api/v1/certs/system-certificate/{hostName}/{id},

  • 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

Cisco ISE documentation for Certificates

Complete reference of the Certificates API.

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
    allowPortalTagTransferForSameSubject: true
    allowReplacementOfPortalGroupTag: true
    allowRoleTransferForSameSubject: 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

Description

ise_response

dictionary

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

Returned: always

Sample: “{\n \”expirationDate\”: \”string\”,\n \”friendlyName\”: \”string\”,\n \”groupTag\”: \”string\”,\n \”id\”: \”string\”,\n \”issuedBy\”: \”string\”,\n \”issuedTo\”: \”string\”,\n \”keySize\”: 0,\n \”link\”: {\n \”href\”: \”string\”,\n \”rel\”: \”string\”,\n \”type\”: \”string\”\n },\n \”portalsUsingTheTag\”: \”string\”,\n \”selfSigned\”: true,\n \”serialNumberDecimalFormat\”: \”string\”,\n \”sha256Fingerprint\”: \”string\”,\n \”signatureAlgorithm\”: \”string\”,\n \”usedBy\”: \”string\”,\n \”validFrom\”: \”string\”\n}\n”

ise_update_response

dictionary

added in 1.1.0 of cisco.ise

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

Returned: always

Sample: “{\n \”response\”: {\n \”id\”: \”string\”,\n \”link\”: {\n \”href\”: \”string\”,\n \”rel\”: \”string\”,\n \”type\”: \”string\”\n },\n \”message\”: \”string\”,\n \”status\”: \”string\”\n },\n \”version\”: \”string\”\n}\n”

Authors

  • Rafael Campos (@racampos)