cisco.ise.csr_generate module – Resource module for CSR Generate

Note

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

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

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operation create of the resource CSR Generate.

  • Generate a certificate signing request for Multi-Use, Admin, EAP.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 2.0.3

  • python >= 3.5

Parameters

Parameter

Comments

allowWildCardCert

boolean

AllowWildCardCert flag.

Choices:

  • no

  • yes

certificatePolicies

string

CSR Generate’s certificatePolicies.

digestType

string

CSR Generate’s digestType.

hostnames

list / elements=string

CSR Generate’s hostnames.

ise_debug

boolean

Flag for Identity Services Engine SDK to enable debugging.

Choices:

  • no ← (default)

  • yes

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

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:

  • no

  • yes ← (default)

ise_uses_csrf_token

boolean

added in 3.0.0 of cisco.ise

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:

  • no ← (default)

  • yes

ise_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • no

  • yes ← (default)

ise_version

string

Informs the SDK which version of Identity Services Engine to use.

Default: “3.1_Patch_1”

ise_wait_on_rate_limit

boolean

Flag for Identity Services Engine SDK to enable automatic rate-limit handling.

Choices:

  • no

  • yes ← (default)

keyLength

string

CSR Generate’s keyLength.

keyType

string

CSR Generate’s keyType.

portalGroupTag

string

CSR Generate’s portalGroupTag.

sanDir

list / elements=string

CSR Generate’s sanDir.

sanDNS

list / elements=string

CSR Generate’s sanDNS.

sanIP

list / elements=string

CSR Generate’s sanIP.

sanURI

list / elements=string

CSR Generate’s sanURI.

subjectCity

string

CSR Generate’s subjectCity.

subjectCommonName

string

CSR Generate’s subjectCommonName.

subjectCountry

string

CSR Generate’s subjectCountry.

subjectOrg

string

CSR Generate’s subjectOrg.

subjectOrgUnit

string

CSR Generate’s subjectOrgUnit.

subjectState

string

CSR Generate’s subjectState.

usedFor

string

CSR Generate’s usedFor.

Notes

Note

  • SDK Method used are certificates.Certificates.generate_csr,

  • Paths used are post /api/v1/certs/certificate-signing-request,

  • 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

Cisco ISE documentation for Certificates

Complete reference of the Certificates API.

Examples

- name: Create
  cisco.ise.csr_generate:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    allowWildCardCert: true
    certificatePolicies: string
    digestType: string
    hostnames:
    - string
    keyLength: string
    keyType: string
    portalGroupTag: string
    sanDNS:
    - string
    sanDir:
    - string
    sanIP:
    - string
    sanURI:
    - string
    subjectCity: string
    subjectCommonName: string
    subjectCountry: string
    subjectOrg: string
    subjectOrgUnit: string
    subjectState: string
    usedFor: string

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: “{\n \”response\”: [\n {\n \”id\”: \”string\”,\n \”link\”: {\n \”href\”: \”string\”,\n \”rel\”: \”string\”,\n \”type\”: \”string\”\n },\n \”message\”: \”string\”\n }\n ],\n \”version\”: \”string\”\n}\n”

Authors

  • Rafael Campos (@racampos)