cisco.ise.system_certificate_create – Resource module for System Certificate Create

Note

This plugin is part of the cisco.ise collection (version 2.1.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 ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.ise.

To use it in a playbook, specify: cisco.ise.system_certificate_create.

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operation create of the resource System Certificate Create.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 1.3.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
ersLocalCertStub
dictionary
Inputs for certificate creation.
allowWildcardCerts
string
System Certificate Create's allowWildcardCerts.
certificatePolicies
string
System Certificate Create's certificatePolicies.
certificateSanDns
string
System Certificate Create's certificateSanDns.
certificateSanIp
string
System Certificate Create's certificateSanIp.
certificateSanUri
string
System Certificate Create's certificateSanUri.
digest
string
System Certificate Create's digest.
ersSubjectStub
dictionary
Subject data of certificate.
commonName
string
System Certificate Create's commonName.
countryName
string
System Certificate Create's countryName.
localityName
string
System Certificate Create's localityName.
organizationalUnitName
string
System Certificate Create's organizationalUnitName.
organizationName
string
System Certificate Create's organizationName.
stateOrProvinceName
string
System Certificate Create's stateOrProvinceName.
expirationTTL
integer
System Certificate Create's expirationTTL.
friendlyName
string
System Certificate Create's friendlyName.
groupTagDD
string
System Certificate Create's groupTagDD.
keyLength
string
System Certificate Create's keyLength.
keyType
string
System Certificate Create's keyType.
samlCertificate
string
System Certificate Create's samlCertificate.
selectedExpirationTTLUnit
string
System Certificate Create's selectedExpirationTTLUnit.
xgridCertificate
string
System Certificate Create's xgridCertificate.
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.
nodeId
string
NodeId of Cisco ISE application.

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

See Also

See also

System Certificate Create reference

Complete reference of the System Certificate Create object model.

Examples

- name: Create
  cisco.ise.system_certificate_create:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    ersLocalCertStub:
      allowWildcardCerts: string
      certificatePolicies: string
      certificateSanDns: string
      certificateSanIp: string
      certificateSanUri: string
      digest: string
      ersSubjectStub:
        commonName: string
        countryName: string
        localityName: string
        organizationName: string
        organizationalUnitName: string
        stateOrProvinceName: string
      expirationTTL: 0
      friendlyName: string
      groupTagDD: string
      keyLength: string
      keyType: string
      samlCertificate: string
      selectedExpirationTTLUnit: string
      xgridCertificate: string
    nodeId: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
ise_response
dictionary
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{}


Authors

  • Rafael Campos (@racampos)