cisco.ise.system_certificate – Resource module for System 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.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.3.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
admin
boolean
    Choices:
  • no
  • yes
Use certificate to authenticate the Cisco ISE Admin Portal.
allowPortalTagTransferForSameSubject
boolean
    Choices:
  • no
  • yes
Allow overwriting the portal tag from matching certificate of same subject.
allowReplacementOfPortalGroupTag
boolean
    Choices:
  • no
  • yes
Allow Replacement of Portal Group Tag (required).
allowRoleTransferForSameSubject
boolean
    Choices:
  • no
  • yes
Allow transfer of roles for certificate with matching subject.
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 Host whose certificate needs to be updated.
id
string
Id path parameter. ID of the System Certificate to be updated.
ims
boolean
    Choices:
  • no
  • yes
Use certificate for the Cisco 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_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
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

  • 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

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
    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 Returned Description
ise_response
dictionary
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "expirationDate": "string", "friendlyName": "string", "groupTag": "string", "id": "string", "issuedBy": "string", "issuedTo": "string", "keySize": 0, "link": { "href": "string", "rel": "string", "type": "string" }, "portalsUsingTheTag": "string", "selfSigned": true, "serialNumberDecimalFormat": "string", "sha256Fingerprint": "string", "signatureAlgorithm": "string", "usedBy": "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", "status": "string" }, "version": "string" }


Authors

  • Rafael Campos (@racampos)