.. 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.system_certificate_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.system_certificate -- Resource module for System Certificate ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.ise collection `_ (version 2.0.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 :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.system_certificate`. .. version_added .. versionadded:: 1.0.0 of cisco.ise .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations update and delete of the resource System Certificate. .. 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.2.0 - python >= 3.5 .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
admin
boolean
    Choices:
  • no
  • yes
Use certificate to authenticate the ISE Admin Portal.
allowReplacementOfPortalGroupTag
boolean
    Choices:
  • no
  • yes
Allow Replacement of Portal Group Tag (required).
description
string
Description of System Certificate.
eap
boolean
    Choices:
  • no
  • yes
Use certificate for EAP protocols that use SSL/TLS tunneling.
expirationTTLPeriod
integer
System Certificate's expirationTTLPeriod.
expirationTTLUnits
string
System Certificate's expirationTTLUnits.
hostName
string
HostName path parameter. Name of Host whose certificate needs to be updated.
id
string
Id path parameter. The ID of the System Certificate to be updated.
ims
boolean
    Choices:
  • no
  • yes
Use certificate for the ISE Messaging Service.
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.0"
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.
name
string
Name of the certificate.
portal
boolean
    Choices:
  • no
  • yes
Use for portal.
portalGroupTag
string
Set Group tag.
portalTagTransferForSameSubject
boolean
    Choices:
  • no
  • yes
Allow overwriting the portal tag from matching certificate of same subject.
pxgrid
boolean
    Choices:
  • no
  • yes
Use certificate for the pxGrid Controller.
radius
boolean
    Choices:
  • no
  • yes
Use certificate for the RADSec server.
renewSelfSignedCertificate
boolean
    Choices:
  • no
  • yes
Renew Self Signed Certificate.
roleTransferForSameSubject
boolean
    Choices:
  • no
  • yes
Allow transfer of roles for certificate with matching subject.
saml
boolean
    Choices:
  • no
  • yes
Use certificate for SAML Signing.

.. 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:: `System Certificate reference `_ Complete reference of the System Certificate object model. .. Examples Examples -------- .. code-block:: yaml+jinja - 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 allowReplacementOfPortalGroupTag: true description: string eap: true expirationTTLPeriod: 0 expirationTTLUnits: string hostName: string id: string ims: true name: string portal: true portalGroupTag: string portalTagTransferForSameSubject: true pxgrid: true radius: true renewSelfSignedCertificate: true roleTransferForSameSubject: 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 hostName: string id: 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:
{ "expirationDate": "string", "friendlyName": "string", "groupTag": "string", "id": "string", "issuedBy": "string", "issuedTo": "string", "keySize": 0, "link": { "href": "string", "rel": "string", "type": "string" }, "portalsUsingTheTag": "string", "selfSigned": true, "serialNumberDecimalFormat": "string", "sha256Fingerprint": "string", "signatureAlgorithm": "string", "usedBy": "string", "validFrom": "string" }
ise_update_response
dictionary
added in 1.1.0 of cisco.ise
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "response": { "id": "string", "link": { "href": "string", "rel": "string", "type": "string" }, "message": "string", "status": "string" }, "version": "string" }


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