.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. Anchors .. _ansible_collections.cisco.ise.selfsigned_certificate_generate_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.selfsigned_certificate_generate -- Resource module for Selfsigned Certificate Generate ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.ise collection `_ (version 2.1.1). 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 :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.ise`. To use it in a playbook, specify: :code:`cisco.ise.selfsigned_certificate_generate`. .. version_added .. versionadded:: 2.1.0 of cisco.ise .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Selfsigned Certificate Generate. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk >= 1.3.0 - python >= 3.5 .. Options Parameters ---------- .. raw:: html
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).

.. Attributes .. Notes 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 .. Seealso See Also -------- .. seealso:: `Selfsigned Certificate Generate reference `_ Complete reference of the Selfsigned Certificate Generate object model. .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
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" }


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors