fortios_vpn_certificate_crl – Certificate Revocation List as a PEM file in Fortinet’s FortiOS and FortiGate.
New in version 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 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.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- vpn_certificate_crl - Certificate Revocation List as a PEM file. type: dict more...
- crl - Certificate Revocation List as a PEM file. type: str more...
- http_url - HTTP server URL for CRL auto-update. type: str more...
- last_updated - Time at which CRL was last updated. type: int more...
- ldap_password - LDAP server user password. type: str more...
- ldap_server - LDAP server name for CRL auto-update. type: str more...
- ldap_username - LDAP server user name. type: str more...
- name - Name. type: str required: true more...
- range - Either global or VDOM IP address range for the certificate. type: str choices: global, vdom more...
- scep_cert - Local certificate for SCEP communication for CRL auto-update. Source vpn.certificate.local.name. type: str more...
- scep_url - SCEP server URL for CRL auto-update. type: str more...
- source - Certificate source type. type: str choices: factory, user, bundle more...
- source_ip - Source IP address for communications to a HTTP or SCEP CA server. type: str more...
- update_interval - Time in seconds before the FortiGate checks for an updated CRL. Set to 0 to update only when it expires. type: int more...
- update_vdom - VDOM for CRL update. Source system.vdom.name. type: str more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Certificate Revocation List as a PEM file.
fortinet.fortios.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: "2147483647"
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: "0"
update_vdom: "<your_own_value> (source system.vdom.name)"
Return Values
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.