fortios_vpn_certificate_ca – CA certificate 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 ca category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_vpn_certificate_ca | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
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_ca - CA certificate. type: dict more...
- auto_update_days - Number of days to wait before requesting an updated CA certificate (0 - 4294967295, 0 = disabled). type: int more...
- auto_update_days_warning - Number of days before an expiry-warning message is generated (0 - 4294967295, 0 = disabled). type: int more...
- ca - CA certificate as a PEM file. type: str more...
- ca_identifier - CA identifier of the SCEP server. type: str more...
- last_updated - Time at which CA was last updated. type: int more...
- name - Name. type: str required: true more...
- obsolete - Enable/disable this CA as obsoleted. type: str choices: disable, enable more...
- range - Either global or VDOM IP address range for the CA certificate. type: str choices: global, vdom more...
- scep_url - URL of the SCEP server. type: str more...
- source - CA certificate source type. type: str choices: factory, user, bundle more...
- source_ip - Source IP address for communications to the SCEP server. type: str more...
- ssl_inspection_trusted - Enable/disable this CA as a trusted CA for SSL inspection. type: str choices: enable, disable more...
- trusted - Enable/disable as a trusted CA. type: str choices: enable, disable more...
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: CA certificate.
fortios_vpn_certificate_ca:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_certificate_ca:
auto_update_days: "0"
auto_update_days_warning: "0"
ca: "<your_own_value>"
ca_identifier: "myId_6"
last_updated: "2147483647"
name: "default_name_8"
obsolete: "disable"
range: "global"
scep_url: "<your_own_value>"
source: "factory"
source_ip: "84.230.14.43"
ssl_inspection_trusted: "enable"
trusted: "enable"
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