cisco.ise.systemcertificate module – Resource module for Systemcertificate

Note

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

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

New in cisco.ise 1.0.0

Synopsis

  • Manage operation create of the resource Systemcertificate.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • ciscoisesdk >= 2.0.1

  • python >= 3.5

Parameters

Parameter

Comments

description

string

Description.

ersLocalCertStub

dictionary

Systemcertificate’s ersLocalCertStub.

allowWildcardCerts

string

AllowWildcardCerts.

certificatePolicies

string

CertificatePolicies.

certificateSanDns

string

CertificateSanDns.

certificateSanIp

string

CertificateSanIp.

certificateSanUri

string

CertificateSanUri.

digest

string

Digest.

expirationTTL

string

ExpirationTTL.

friendlyName

string

FriendlyName.

groupTagDD

string

GroupTagDD.

keyLength

string

KeyLength.

keyType

string

KeyType.

samlCertificate

string

SamlCertificate.

selectedExpirationTTLUnit

string

SelectedExpirationTTLUnit.

subjectStub

dictionary

Systemcertificate’s subjectStub.

commonName

string

Common name.

countryName

string

CountryName.

localityName

string

LocalityName.

organizationalUnitName

string

Organizational UnitName.

organizationName

string

OrganizationName.

stateOrProvinceName

string

StateOrProvinceName.

xgridCertificate

string

XgridCertificate.

id

string

Id.

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:

name

string

Name.

nodeId

string

NodeId of ISE application.

Notes

Note

  • SDK Method used are systemcertificate.Systemcertificate.create_systemcertificate,

  • Paths used are post /systemcertificate/,

  • 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

Examples

---
- 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: <<IP-ADDRESS>>
      certificateSanUri: <<URI>>
      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

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:`{"messages": [{"code": "string", "title": "string", "type": "string"}], "operation": "string"}`

Authors

  • Rafael Campos (@racampos)