cisco.ise.selfsigned_certificate_generate – Resource module for Selfsigned Certificate Generate

Note

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

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

New in version 2.1.0: of cisco.ise

Synopsis

• Manage operation create of the resource Selfsigned Certificate Generate.

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.
allowExtendedValidity boolean	Choices: no yes	Allow generation of self-signed certificate with validity greater than 398 days.
allowPortalTagTransferForSameSubject boolean	Choices: no yes	Allow overwriting the portal tag from matching certificate of same subject.
allowReplacementOfCertificates boolean	Choices: no yes	Allow Replacement of certificates.
allowReplacementOfPortalGroupTag boolean	Choices: no yes	Allow Replacement of Portal Group Tag.
allowRoleTransferForSameSubject boolean	Choices: no yes	Allow transfer of roles for certificate with matching subject.
allowSanDnsBadName boolean	Choices: no yes	Allow usage of SAN DNS Bad name.
allowSanDnsNonResolvable boolean	Choices: no yes	Allow use of non resolvable Common Name or SAN Values.
allowWildCardCertificates boolean	Choices: no yes	Allow Wildcard Certificates.
certificatePolicies string		Certificate Policies.
digestType string		Digest to sign with.
eap boolean	Choices: no yes	Use certificate for EAP protocols that use SSL/TLS tunneling.
expirationTTL integer		Certificate expiration value.
expirationTTLUnit string		Certificate expiration unit.
hostName string		Hostname of the Cisco ISE node in which self-signed certificate should be generated.
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.
keyLength string		Bit size of public key.
keyType string		Algorithm to use for certificate public key creation.
name string		Friendly 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.
saml boolean	Choices: no yes	Use certificate for SAML Signing.
sanDNS list / elements=string		Array of SAN (Subject Alternative Name) DNS entries.
sanIP list / elements=string		Array of SAN IP entries.
sanURI list / elements=string		Array of SAN URI entries.
subjectCity string		Certificate city or locality (L).
subjectCommonName string		Certificate common name (CN).
subjectCountry string		Certificate country (C).
subjectOrg string		Certificate organization (O).
subjectOrgUnit string		Certificate organizational unit (OU).
subjectState string		Certificate state (ST).

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

Selfsigned Certificate Generate reference

Complete reference of the Selfsigned Certificate Generate object model.

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	Returned	Description
ise_response dictionary	always	A dictionary or list with the response returned by the Cisco ISE Python SDK Sample: { "response": { "id": "string", "message": "string", "status": "string" }, "version": "string" }

Authors

• Rafael Campos (@racampos)