cisco.ise.selfsigned_certificate_generate module – Resource module for Selfsigned Certificate Generate
Note
This module is part of the cisco.ise collection (version 2.5.9).
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.selfsigned_certificate_generate
.
New in cisco.ise 2.1.0
Synopsis
Manage operation create of the resource Selfsigned Certificate Generate.
Generate Self-signed 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 generation of self-signed certificate with validity greater than 398 days. Choices:
|
|
Allow overwriting the portal tag from matching certificate of same subject. Choices:
|
|
Allow Replacement of certificates. Choices:
|
|
Allow Replacement of Portal Group Tag. Choices:
|
|
Allow transfer of roles for certificate with matching subject. Choices:
|
|
Allow usage of SAN DNS Bad name. Choices:
|
|
Allow use of non resolvable Common Name or SAN Values. Choices:
|
|
Allow Wildcard Certificates. Choices:
|
|
Certificate Policies. |
|
Digest to sign with. |
|
Use certificate for EAP protocols that use SSL/TLS tunneling. Choices:
|
|
Certificate expiration value. |
|
Certificate expiration unit. |
|
Hostname of the Cisco ISE node in which self-signed certificate should be generated. |
|
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:
|
|
Bit size of public key. |
|
Algorithm to use for certificate public key creation. |
|
Friendly 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:
|
|
Use certificate for SAML Signing. Choices:
|
|
Array of SAN (Subject Alternative Name) DNS entries. |
|
Array of SAN IP entries. |
|
Array of SAN URI entries. |
|
Certificate city or locality (L). |
|
Certificate common name (CN). |
|
Certificate country (C). |
|
Certificate organization (O). |
|
Certificate organizational unit (OU). |
|
Certificate state (ST). |
Notes
Note
SDK Method used are certificates.Certificates.generate_self_signed_certificate,
Paths used are post /api/v1/certs/system-certificate/generate-selfsigned-certificate,
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: Create
cisco.ise.selfsigned_certificate_generate:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
admin: true
allowExtendedValidity: true
allowPortalTagTransferForSameSubject: true
allowReplacementOfCertificates: true
allowReplacementOfPortalGroupTag: true
allowRoleTransferForSameSubject: true
allowSanDnsBadName: true
allowSanDnsNonResolvable: true
allowWildCardCertificates: true
certificatePolicies: string
digestType: string
eap: true
expirationTTL: 0
expirationTTLUnit: string
hostName: string
keyLength: string
keyType: string
name: string
portal: true
portalGroupTag: string
pxgrid: true
radius: true
saml: true
sanDNS:
- string
sanIP:
- string
sanURI:
- string
subjectCity: string
subjectCommonName: string
subjectCountry: string
subjectOrg: string
subjectOrgUnit: string
subjectState: 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: |