cisco.ise.system_certificate module – Resource module for System Certificate
Note
This module is part of the cisco.ise collection (version 2.5.12).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.ise.system_certificate.
New in cisco.ise 1.0.0
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.8
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Use certificate to authenticate the Cisco ISE Admin Portal. Choices:
|
|
Allow overwriting the portal tag from matching certificate of same subject. Choices:
|
|
Allow Replacement of Portal Group Tag (required). Choices:
|
|
Allow transfer of roles for certificate with matching subject. Choices:
|
|
If the given certificate to be deleted is a wildcard certificate, corresponding certificate gets deleted on rest of the nodes in the deployment as well. Choices:
|
|
Description of System Certificate. |
|
Use certificate for EAP protocols that use SSL/TLS tunneling. Choices:
|
|
System Certificate’s expirationTTLPeriod. |
|
System Certificate’s expirationTTLUnits. |
|
HostName path parameter. Name of Host whose certificate needs to be updated. |
|
Id path parameter. ID of the System Certificate to be updated. |
|
Use certificate for the Cisco ISE Messaging Service. Choices:
|
|
Flag for Identity Services Engine SDK to enable debugging. Choices:
|
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
The Identity Services Engine username to authenticate. |
|
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:
|
|
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:
|
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Identity Services Engine to use. Default: |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices:
|
|
Name of the certificate. |
|
Use for portal. Choices:
|
|
Set Group tag. |
|
Use certificate for the pxGrid Controller. Choices:
|
|
Use certificate for the RADSec server. Choices:
|
|
Renew Self-signed Certificate. Choices:
|
|
Use certificate for SAML Signing. Choices:
|
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_modeThe 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
allowWildcardDelete: true
hostName: string
id: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |
|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |