.. 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 .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.ise.systemcertificate_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.systemcertificate module -- Resource module for Systemcertificate +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.ise collection `_ (version 3.0.0). To install it, use: :code:`ansible-galaxy collection install cisco.ise`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.ise.systemcertificate`. .. version_added .. rst-class:: ansible-version-added New in cisco.ise 1.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Systemcertificate. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.ise.systemcertificate_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk \>= 2.0.1 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub: .. rst-class:: ansible-option-title **ersLocalCertStub** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Systemcertificate's ersLocalCertStub. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/allowwildcardcerts: .. rst-class:: ansible-option-title **allowWildcardCerts** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
AllowWildcardCerts. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/certificatepolicies: .. rst-class:: ansible-option-title **certificatePolicies** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
CertificatePolicies. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/certificatesandns: .. rst-class:: ansible-option-title **certificateSanDns** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
CertificateSanDns. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/certificatesanip: .. rst-class:: ansible-option-title **certificateSanIp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
CertificateSanIp. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/certificatesanuri: .. rst-class:: ansible-option-title **certificateSanUri** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
CertificateSanUri. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/digest: .. rst-class:: ansible-option-title **digest** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Digest. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/expirationttl: .. rst-class:: ansible-option-title **expirationTTL** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ExpirationTTL. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/friendlyname: .. rst-class:: ansible-option-title **friendlyName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
FriendlyName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/grouptagdd: .. rst-class:: ansible-option-title **groupTagDD** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
GroupTagDD. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/keylength: .. rst-class:: ansible-option-title **keyLength** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
KeyLength. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/keytype: .. rst-class:: ansible-option-title **keyType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
KeyType. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/samlcertificate: .. rst-class:: ansible-option-title **samlCertificate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SamlCertificate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/selectedexpirationttlunit: .. rst-class:: ansible-option-title **selectedExpirationTTLUnit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SelectedExpirationTTLUnit. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/subjectstub: .. rst-class:: ansible-option-title **subjectStub** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Systemcertificate's subjectStub. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/subjectstub/commonname: .. rst-class:: ansible-option-title **commonName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Common name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/subjectstub/countryname: .. rst-class:: ansible-option-title **countryName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
CountryName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/subjectstub/localityname: .. rst-class:: ansible-option-title **localityName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
LocalityName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/subjectstub/organizationalunitname: .. rst-class:: ansible-option-title **organizationalUnitName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Organizational UnitName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/subjectstub/organizationname: .. rst-class:: ansible-option-title **organizationName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
OrganizationName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/subjectstub/stateorprovincename: .. rst-class:: ansible-option-title **stateOrProvinceName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
StateOrProvinceName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-erslocalcertstub/xgridcertificate: .. rst-class:: ansible-option-title **xgridCertificate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
XgridCertificate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-ise_debug: .. rst-class:: ansible-option-title **ise_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-ise_hostname: .. rst-class:: ansible-option-title **ise_hostname** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-ise_password: .. rst-class:: ansible-option-title **ise_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-ise_single_request_timeout: .. rst-class:: ansible-option-title **ise_single_request_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` :ansible-option-versionadded:`added in cisco.ise 3.0.0` .. raw:: html
- .. raw:: html
Timeout (in seconds) for RESTful HTTP requests. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-ise_username: .. rst-class:: ansible-option-title **ise_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine username to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-ise_uses_api_gateway: .. rst-class:: ansible-option-title **ise_uses_api_gateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in cisco.ise 1.1.0` .. raw:: html
- .. raw:: html
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). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-ise_uses_csrf_token: .. rst-class:: ansible-option-title **ise_uses_csrf_token** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in cisco.ise 3.0.0` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-ise_verify: .. rst-class:: ansible-option-title **ise_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-ise_version: .. rst-class:: ansible-option-title **ise_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Identity Services Engine to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1\_Patch\_1"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-ise_wait_on_rate_limit: .. rst-class:: ansible-option-title **ise_wait_on_rate_limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__parameter-nodeid: .. rst-class:: ansible-option-title **nodeId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
NodeId of ISE application. .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are systemcertificate.Systemcertificate.create\_systemcertificate, - Paths used are post /systemcertificate/, - Does not support \ :literal:`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 .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create cisco.ise.systemcertificate: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" ersLocalCertStub: allowWildcardCerts: on OR off certificatePolicies: certificate policies certificateSanDns: cisco.com certificateSanIp: <> certificateSanUri: <> digest: SHA-256 OR SHA-384 OR SHA-512 ersSubjectStub: commonName: $FQDN$ countryName: Country localityName: City organizationName: HCL organizationalUnitName: HCL-SAMLCert stateOrProvinceName: State expirationTTL: '2' friendlyName: HCL groupTagDD: add-group-tag keyLength: 512 OR 1024 OR 2048 OR 4096 keyType: RSA OR ECDSA samlCertificate: on OR off selectedExpirationTTLUnit: days OR weeks OR months OR years xgridCertificate: on OR off nodeId: ISE-01 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.ise.systemcertificate_module__return-ise_response: .. rst-class:: ansible-option-title **ise_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco ISE Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"messages": [{"code": "string", "title": "string", "type": "string"}], "operation": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors