fortios_vpn_certificate_local – Local keys and certificates 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 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.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_local - Local keys and certificates. type: dict more...
- acme_ca_url - The URL for the ACME CA server (Let"s Encrypt is the ). type: str more...
- acme_domain - A valid domain that resolves to this FortiGate unit. type: str more...
- acme_email - Contact email address that is required by some CAs like LetsEncrypt. type: str more...
- acme_renew_window - Beginning of the renewal window (in days before certificate expiration, 30 by default). type: int more...
- acme_rsa_key_size - Length of the RSA private key of the generated cert (Minimum 2048 bits). type: int more...
- auto_regenerate_days - Number of days to wait before expiry of an updated local certificate is requested (0 = disabled). type: int more...
- auto_regenerate_days_warning - Number of days to wait before an expiry warning message is generated (0 = disabled). type: int more...
- ca_identifier - CA identifier of the CA server for signing via SCEP. type: str more...
- certificate - PEM format certificate. type: str more...
- cmp_path - Path location inside CMP server. type: str more...
- cmp_regeneration_method - CMP auto-regeneration method. type: str choices: keyupate, renewal more...
- cmp_server - Address and port for CMP server (format = address:port). type: str more...
- cmp_server_cert - CMP server certificate. Source vpn.certificate.ca.name vpn.certificate.remote.name. type: str more...
- comments - Comment. type: str more...
- csr - Certificate Signing Request. type: str more...
- enroll_protocol - Certificate enrollment protocol. type: str choices: none, scep, cmpv2, acme2, est more...
- est_ca_id - CA identifier of the CA server for signing via EST. type: str more...
- est_client_cert - Certificate used to authenticate this FortiGate to EST server. Source vpn.certificate.local.name. type: str more...
- est_http_password - HTTP Authentication password for signing via EST. type: str more...
- est_http_username - HTTP Authentication username for signing via EST. type: str more...
- est_server - Address and port for EST server (e.g. https://example.com:1234). type: str more...
- est_server_cert - EST server"s certificate must be verifiable by this certificate to be authenticated. Source vpn.certificate.ca.name vpn.certificate .remote.name. type: str more...
- est_srp_password - EST SRP authentication password. type: str more...
- est_srp_username - EST SRP authentication username. type: str more...
- ike_localid - Local ID the FortiGate uses for authentication as a VPN client. type: str more...
- ike_localid_type - IKE local ID type. type: str choices: asn1dn, fqdn more...
- last_updated - Time at which certificate was last updated. type: int more...
- name - Name. type: str required: true more...
- name_encoding - Name encoding method for auto-regeneration. type: str choices: printable, utf8 more...
- password - Password as a PEM file. type: str more...
- private_key - PEM format key encrypted with a password. type: str more...
- private_key_retain - Enable/disable retention of private key during SCEP renewal . type: str choices: enable, disable more...
- range - Either a global or VDOM IP address range for the certificate. type: str choices: global, vdom more...
- scep_password - SCEP server challenge password for auto-regeneration. type: str more...
- scep_url - SCEP server URL. type: str more...
- source - Certificate source type. type: str choices: factory, user, bundle more...
- source_ip - Source IP address for communications to the SCEP server. type: str more...
- state - Certificate Signing Request State. type: str more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Local keys and certificates.
fortinet.fortios.fortios_vpn_certificate_local:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_certificate_local:
acme_ca_url: "<your_own_value>"
acme_domain: "<your_own_value>"
acme_email: "<your_own_value>"
acme_renew_window: "30"
acme_rsa_key_size: "2048"
auto_regenerate_days: "0"
auto_regenerate_days_warning: "0"
ca_identifier: "myId_10"
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 vpn.certificate.ca.name vpn.certificate.remote.name)"
comments: "<your_own_value>"
csr: "<your_own_value>"
enroll_protocol: "none"
est_ca_id: "<your_own_value>"
est_client_cert: "<your_own_value> (source vpn.certificate.local.name)"
est_http_password: "<your_own_value>"
est_http_username: "<your_own_value>"
est_server: "<your_own_value>"
est_server_cert: "<your_own_value> (source vpn.certificate.ca.name vpn.certificate.remote.name)"
est_srp_password: "<your_own_value>"
est_srp_username: "<your_own_value>"
ike_localid: "<your_own_value>"
ike_localid_type: "asn1dn"
last_updated: "2147483647"
name: "default_name_30"
name_encoding: "printable"
password: "<your_own_value>"
private_key: "<your_own_value>"
private_key_retain: "enable"
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
Status
This module is not guaranteed to have a backwards compatible interface.