fortinet.fortios.fortios_vpn_certificate_setting module – VPN certificate setting in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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_vpn_certificate_setting
.
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 vpn_certificate feature and setting 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. |
|
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:
|
|
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: |
|
VPN certificate setting. |
|
Number of days before a certificate expires to send a warning. Set to 0 to disable sending of the warning (0 - 100). |
|
1024 bit DSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
|
2048 bit DSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
|
256 bit ECDSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
|
384 bit ECDSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
|
521 bit ECDSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
|
253 bit EdDSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
|
456 bit EdDSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
|
1024 bit RSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
|
2048 bit RSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
|
4096 bit RSA key certificate for re-signing server certificates for SSL inspection. Source vpn.certificate.local.name. |
|
Enable/disable verification of the user certificate and pass authentication if any CA in the chain is trusted . Choices:
|
|
Enable/disable verification of the entire certificate chain and pass authentication only if the chain is complete and all of the CAs in the chain are trusted . Choices:
|
|
Enable/disable server certificate key usage checking in CMP mode . Choices:
|
|
Enable/disable saving extra certificates in CMP mode . Choices:
|
|
When searching for a matching certificate, allow multiple CN fields in certificate subject name . Choices:
|
|
When searching for a matching certificate, control how to do CN value matching with certificate subject name . Choices:
|
|
CRL verification options. |
|
CRL verification option when CRL of any certificate in chain is absent . Choices:
|
|
CRL verification option when CRL is expired . Choices:
|
|
CRL verification option when leaf CRL is absent . Choices:
|
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
Default OCSP server. Source vpn.certificate.ocsp-server.name. |
|
Specify whether the OCSP URL is from certificate or configured OCSP server. Choices:
|
|
Enable/disable receiving certificates using the OCSP. Choices:
|
|
Proxy server FQDN or IP for OCSP/CA queries during certificate verification. |
|
Proxy server password. |
|
Proxy server port (1 - 65535). |
|
Proxy server user name. |
|
Source IP address for dynamic AIA and OCSP queries. |
|
Minimum supported protocol version for SSL/TLS connections . Choices:
|
|
Specify whether the OCSP URL is from the certificate or the default OCSP server. Choices:
|
|
Source IP address to use to communicate with the OCSP server. |
|
Enable/disable SSL OCSP. Choices:
|
|
Enable/disable strict mode CRL checking. Choices:
|
|
Enable/disable strict mode OCSP checking. Choices:
|
|
When searching for a matching certificate, control how to do RDN value matching with certificate subject name . Choices:
|
|
When searching for a matching certificate, control how to do RDN set matching with certificate subject name . Choices:
|
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: VPN certificate setting.
fortinet.fortios.fortios_vpn_certificate_setting:
vdom: "{{ vdom }}"
vpn_certificate_setting:
cert_expire_warning: "14"
certname_dsa1024: "<your_own_value> (source vpn.certificate.local.name)"
certname_dsa2048: "<your_own_value> (source vpn.certificate.local.name)"
certname_ecdsa256: "<your_own_value> (source vpn.certificate.local.name)"
certname_ecdsa384: "<your_own_value> (source vpn.certificate.local.name)"
certname_ecdsa521: "<your_own_value> (source vpn.certificate.local.name)"
certname_ed25519: "<your_own_value> (source vpn.certificate.local.name)"
certname_ed448: "<your_own_value> (source vpn.certificate.local.name)"
certname_rsa1024: "<your_own_value> (source vpn.certificate.local.name)"
certname_rsa2048: "<your_own_value> (source vpn.certificate.local.name)"
certname_rsa4096: "<your_own_value> (source vpn.certificate.local.name)"
check_ca_cert: "enable"
check_ca_chain: "enable"
cmp_key_usage_checking: "enable"
cmp_save_extra_certs: "enable"
cn_allow_multi: "disable"
cn_match: "substring"
crl_verification:
chain_crl_absence: "ignore"
expiry: "ignore"
leaf_crl_absence: "ignore"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ocsp_default_server: "<your_own_value> (source vpn.certificate.ocsp-server.name)"
ocsp_option: "certificate"
ocsp_status: "enable"
proxy: "<your_own_value>"
proxy_password: "<your_own_value>"
proxy_port: "8080"
proxy_username: "<your_own_value>"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
ssl_ocsp_option: "certificate"
ssl_ocsp_source_ip: "<your_own_value>"
ssl_ocsp_status: "enable"
strict_crl_check: "enable"
strict_ocsp_check: "enable"
subject_match: "substring"
subject_set: "subset"
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: |