fortios_certificate_local – Local keys and certificates in Fortinet’s FortiOS and FortiGate.¶
New in version 2.9.
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.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- certificate_local - Local keys and certificates. type: dict
- auto_regenerate_days - Number of days to wait before expiry of an updated local certificate is requested (0 = disabled). type: int
- auto_regenerate_days_warning - Number of days to wait before an expiry warning message is generated (0 = disabled). type: int
- ca_identifier - CA identifier of the CA server for signing via SCEP. type: str
- certificate - PEM format certificate. type: str
- cmp_path - Path location inside CMP server. type: str
- cmp_regeneration_method - CMP auto-regeneration method. type: str choices: keyupate, renewal
- cmp_server - "ADDRESS:PORT" for CMP server. type: str
- cmp_server_cert - CMP server certificate. Source certificate.ca.name. type: str
- comments - Comment. type: str
- csr - Certificate Signing Request. type: str
- enroll_protocol - Certificate enrollment protocol. type: str choices: none, scep, cmpv2
- ike_localid - Local ID the FortiGate uses for authentication as a VPN client. type: str
- ike_localid_type - IKE local ID type. type: str choices: asn1dn, fqdn
- last_updated - Time at which certificate was last updated. type: int
- name - Name. type: str required: True
- name_encoding - Name encoding method for auto-regeneration. type: str choices: printable, utf8
- password - Password as a PEM file. type: str
- private_key - PEM format key, encrypted with a password. type: str
- range - Either a global or VDOM IP address range for the certificate. type: str choices: global, vdom
- scep_password - SCEP server challenge password for auto-regeneration. type: str
- scep_url - SCEP server URL. type: str
- source - Certificate source type. type: str choices: factory, user, bundle, fortiguard
- source_ip - Source IP address for communications to the SCEP server. type: str
- state - Certificate Signing Request State. type: str
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: Local keys and certificates.
fortios_certificate_local:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
certificate_local:
auto_regenerate_days: "3"
auto_regenerate_days_warning: "4"
ca_identifier: "myId_5"
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)"
comments: "<your_own_value>"
csr: "<your_own_value>"
enroll_protocol: "none"
ike_localid: "<your_own_value>"
ike_localid_type: "asn1dn"
last_updated: "16"
name: "default_name_17"
name_encoding: "printable"
password: "<your_own_value>"
private_key: "<your_own_value>"
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: 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