cisco.ise.csr_generate – Resource module for Csr Generate

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

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 1.2.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
allowWildCardCert
boolean
    Choices:
  • no
  • yes
AllowWildCardCert flag.
certificatePolicies
string
Csr Generate's certificatePolicies.
digestType
string
Csr Generate's digestType.
hostnames
list / elements=string
Csr Generate's hostnames.
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.
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

  • 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

Csr Generate reference

Complete reference of the Csr Generate object model.

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 Returned Description
ise_response
list / elements=dictionary
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
[ { "friendlyName": "string", "groupTag": "string", "hostName": "string", "id": "string", "keySize": "string", "link": { "href": "string", "rel": "string", "type": "string" }, "signatureAlgorithm": "string", "subject": "string", "timeStamp": "string", "usedFor": "string" } ]


Authors

  • Rafael Campos (@racampos)