fortinet.fortios.fortios_vpn_certificate_crl – Certificate Revocation List as a PEM file in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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
.
To use it in a playbook, specify: fortinet.fortios.fortios_vpn_certificate_crl
.
New in version 2.10: of fortinet.fortios
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 crl 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.9.0
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | ||
enable_log boolean |
| Enable/Disable logging for task. | |
state string / required |
| Indicates whether to create or remove the object. | |
vdom string | Default: "root" | 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. | |
vpn_certificate_crl dictionary | Certificate Revocation List as a PEM file. | ||
crl string | Certificate Revocation List as a PEM file. | ||
http_url string | HTTP server URL for CRL auto-update. | ||
last_updated integer | Time at which CRL was last updated. | ||
ldap_password string | LDAP server user password. | ||
ldap_server string | LDAP server name for CRL auto-update. | ||
ldap_username string | LDAP server user name. | ||
name string / required | Name. | ||
range string |
| Either global or VDOM IP address range for the certificate. | |
scep_cert string | Local certificate for SCEP communication for CRL auto-update. Source vpn.certificate.local.name. | ||
scep_url string | SCEP server URL for CRL auto-update. | ||
source string |
| Certificate source type. | |
source_ip string | Source IP address for communications to a HTTP or SCEP CA server. | ||
update_interval integer | Time in seconds before the FortiGate checks for an updated CRL. Set to 0 to update only when it expires. | ||
update_vdom string | VDOM for CRL update. Source system.vdom.name. |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Certificate Revocation List as a PEM file. fortios_vpn_certificate_crl: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" vpn_certificate_crl: crl: "<your_own_value>" http_url: "<your_own_value>" last_updated: "5" ldap_password: "<your_own_value>" ldap_server: "<your_own_value>" ldap_username: "<your_own_value>" name: "default_name_9" range: "global" scep_cert: "<your_own_value> (source vpn.certificate.local.name)" scep_url: "<your_own_value>" source: "factory" source_ip: "84.230.14.43" update_interval: "15" update_vdom: "<your_own_value> (source system.vdom.name)"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_vpn_certificate_crl_module.html