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

Note

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

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

  • python >= 3.5

Parameters

Parameter

Comments

admin

boolean

Use certificate to authenticate the Cisco ISE Admin Portal.

Choices:

allowExtendedValidity

boolean

Allow generation of self-signed certificate with validity greater than 398 days.

Choices:

allowPortalTagTransferForSameSubject

boolean

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

Choices:

allowReplacementOfCertificates

boolean

Allow Replacement of certificates.

Choices:

allowReplacementOfPortalGroupTag

boolean

Allow Replacement of Portal Group Tag.

Choices:

allowRoleTransferForSameSubject

boolean

Allow transfer of roles for certificate with matching subject.

Choices:

allowSanDnsBadName

boolean

Allow usage of SAN DNS Bad name.

Choices:

allowSanDnsNonResolvable

boolean

Allow use of non resolvable Common Name or SAN Values.

Choices:

allowWildCardCertificates

boolean

Allow Wildcard Certificates.

Choices:

certificatePolicies

string

Certificate Policies.

digestType

string

Digest to sign with.

eap

boolean

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

Choices:

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

Flag for Identity Services Engine SDK to enable debugging.

Choices:

ise_hostname

string / required

The Identity Services Engine hostname.

ise_password

string / required

The Identity Services Engine password to authenticate.

ise_single_request_timeout

integer

added in cisco.ise 3.0.0

Timeout (in seconds) for RESTful HTTP requests.

Default: :ansible-option-default:`60`

ise_username

string / required

The Identity Services Engine username to authenticate.

ise_uses_api_gateway

boolean

added in cisco.ise 1.1.0

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:

ise_uses_csrf_token

boolean

added in cisco.ise 3.0.0

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:

ise_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

ise_version

string

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

Default: :ansible-option-default:`"3.1\_Patch\_1"`

ise_wait_on_rate_limit

boolean

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

Choices:

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

Use for portal.

Choices:

portalGroupTag

string

Set Group tag.

pxgrid

boolean

Use certificate for the pxGrid Controller.

Choices:

radius

boolean

Use certificate for the RADSec server.

Choices:

saml

boolean

Use certificate for SAML Signing.

Choices:

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

  • 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

ise_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"id": "string", "message": "string", "status": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)