fortinet.fortios.fortios_certificate_local module – Local keys and certificates in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.6).
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 fortinet.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_certificate_local.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify certificate feature and local category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Local keys and certificates. |
|
The URL for the ACME CA server (Let”s Encrypt is the ). |
|
A valid domain that resolves to this FortiGate unit. |
|
Contact email address that is required by some CAs like LetsEncrypt. |
|
Beginning of the renewal window (in days before certificate expiration, 30 by default). |
|
Length of the RSA private key of the generated cert (Minimum 2048 bits). |
|
Number of days to wait before expiry of an updated local certificate is requested (0 = disabled). |
|
Number of days to wait before an expiry warning message is generated (0 = disabled). |
|
CA identifier of the CA server for signing via SCEP. |
|
PEM format certificate. |
|
Path location inside CMP server. |
|
CMP auto-regeneration method. Choices:
|
|
Address and port for CMP server (format = address:port). |
|
CMP server certificate. Source certificate.ca.name certificate.remote.name. |
|
Comment. |
|
Certificate Signing Request. |
|
Certificate enrollment protocol. Choices:
|
|
CA identifier of the CA server for signing via EST. |
|
Certificate used to authenticate this FortiGate to EST server. Source certificate.local.name. |
|
HTTP Authentication password for signing via EST. |
|
HTTP Authentication username for signing via EST. |
|
Address and port for EST server (e.g. https://example.com:1234). |
|
EST server”s certificate must be verifiable by this certificate to be authenticated. Source certificate.ca.name certificate.remote.name. |
|
EST SRP authentication password. |
|
EST SRP authentication username. |
|
Local ID the FortiGate uses for authentication as a VPN client. |
|
IKE local ID type. Choices:
|
|
Time at which certificate was last updated. |
|
Name. |
|
Name encoding method for auto-regeneration. Choices:
|
|
Password as a PEM file. |
|
PEM format key encrypted with a password. |
|
Enable/disable retention of private key during SCEP renewal . Choices:
|
|
Either a global or VDOM IP address range for the certificate. Choices:
|
|
SCEP server challenge password for auto-regeneration. |
|
SCEP server URL. |
|
Certificate source type. Choices:
|
|
Source IP address for communications to the SCEP server. |
|
Certificate Signing Request State. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Local keys and certificates.
fortinet.fortios.fortios_certificate_local:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
certificate_local:
acme_ca_url: "<your_own_value>"
acme_domain: "<your_own_value>"
acme_email: "<your_own_value>"
acme_renew_window: "30"
acme_rsa_key_size: "2048"
auto_regenerate_days: "0"
auto_regenerate_days_warning: "0"
ca_identifier: "myId_10"
certificate: "<your_own_value>"
cmp_path: "<your_own_value>"
cmp_regeneration_method: "keyupate"
cmp_server: "<your_own_value>"
cmp_server_cert: "<your_own_value> (source certificate.ca.name certificate.remote.name)"
comments: "<your_own_value>"
csr: "<your_own_value>"
enroll_protocol: "none"
est_ca_id: "<your_own_value>"
est_client_cert: "<your_own_value> (source certificate.local.name)"
est_http_password: "<your_own_value>"
est_http_username: "<your_own_value>"
est_server: "<your_own_value>"
est_server_cert: "<your_own_value> (source certificate.ca.name certificate.remote.name)"
est_srp_password: "<your_own_value>"
est_srp_username: "<your_own_value>"
ike_localid: "<your_own_value>"
ike_localid_type: "asn1dn"
last_updated: "2147483647"
name: "default_name_30"
name_encoding: "printable"
password: "<your_own_value>"
private_key: "<your_own_value>"
private_key_retain: "enable"
range: "global"
scep_password: "<your_own_value>"
scep_url: "<your_own_value>"
source: "factory"
source_ip: "84.230.14.43"
state: "<your_own_value>"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |