cisco.ise.endpoint_certificate module – Resource module for Endpoint Certificate
Note
This module is part of the cisco.ise collection (version 1.2.1).
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.endpoint_certificate
.
New in version 1.0.0: of cisco.ise
Synopsis
Manage operation update of the resource Endpoint Certificate.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 1.1.0
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Key value map. Must have CN and SAN entries. |
|
Matches the requester’s User Name, unless the Requester is an ERS Admin. ERS Admins are allowed to create requests for any CN. |
|
Valid MAC Address, delimited by ‘-‘. |
|
Name of an Internal CA template. |
|
Directory absolute path. Defaults to the current working directory. |
|
Allowed values - PKCS12, - PKCS12_CHAIN, - PKCS8, - PKCS8_CHAIN. |
|
Flag for Identity Services Engine SDK to enable debugging. Choices:
|
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
The Identity Services Engine username to authenticate. |
|
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:
|
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Identity Services Engine to use. Default: “3.1.0” |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices:
|
|
Protects the private key. Must have more than 8 characters, less than 15 characters, at least one upper case letter, at least one lower case letter, at least one digit, and can only contain A-Za-z0-9_#. |
|
Enable or disable automatic file creation of raw response. Choices:
|
See Also
See also
- Endpoint Certificate reference
Complete reference of the Endpoint Certificate object model.
Examples
- name: Create
cisco.ise.endpoint_certificate:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
certTemplateName: string
certificateRequest:
cn: string
san: string
dirPath: /tmp/downloads/
format: string
password: string
saveFile: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: “{}\n” |
Authors
Rafael Campos (@racampos)