fortios_certificate_local.rst

source:	fortios_certificate_local.py
orphan:

fortios_certificate_local -- Local keys and certificates in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_certificate_local	v6.0.0 -> latest

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
• certificate_local - Local keys and certificates. type: dict more...

  	Supported Version Ranges
  certificate_local	v6.0.0 -> latest

• acme_ca_url - The URL for the ACME CA server (Let"s Encrypt is the ). type: str more...

  	Supported Version Ranges
  acme_ca_url	v7.0.0 -> latest

• acme_domain - A valid domain that resolves to this FortiGate unit. type: str more...

  	Supported Version Ranges
  acme_domain	v7.0.0 -> latest

• acme_email - Contact email address that is required by some CAs like LetsEncrypt. type: str more...

  	Supported Version Ranges
  acme_email	v7.0.0 -> latest

• acme_renew_window - Beginning of the renewal window (in days before certificate expiration, 30 by default). type: int more...

  	Supported Version Ranges
  acme_renew_window	v7.0.0 -> latest

• acme_rsa_key_size - Length of the RSA private key of the generated cert (Minimum 2048 bits). type: int more...

  	Supported Version Ranges
  acme_rsa_key_size	v7.0.0 -> latest

• auto_regenerate_days - Number of days to wait before expiry of an updated local certificate is requested (0 = disabled). type: int more...

  	Supported Version Ranges
  auto_regenerate_days	v6.0.0 -> latest

• auto_regenerate_days_warning - Number of days to wait before an expiry warning message is generated (0 = disabled). type: int more...

  	Supported Version Ranges
  auto_regenerate_days_warning	v6.0.0 -> latest

• ca_identifier - CA identifier of the CA server for signing via SCEP. type: str more...

  	Supported Version Ranges
  ca_identifier	v6.0.0 -> latest

• certificate - PEM format certificate. type: str more...

  	Supported Version Ranges
  certificate	v6.0.0 -> latest

• cmp_path - Path location inside CMP server. type: str more...

  	Supported Version Ranges
  cmp_path	v6.0.0 -> latest

• cmp_regeneration_method - CMP auto-regeneration method. type: str choices: keyupate, renewal more...

  	Supported Version Ranges
  cmp_regeneration_method	v6.0.0 -> latest
  [keyupate]	v6.0.0 -> latest
  [renewal]	v6.0.0 -> latest

• cmp_server - Address and port for CMP server (format = address:port). type: str more...

  	Supported Version Ranges
  cmp_server	v6.0.0 -> latest

• cmp_server_cert - CMP server certificate. Source certificate.ca.name certificate.remote.name. type: str more...

  	Supported Version Ranges
  cmp_server_cert	v6.0.0 -> latest

• comments - Comment. type: str more...

  	Supported Version Ranges
  comments	v6.0.0 -> latest

• csr - Certificate Signing Request. type: str more...

  	Supported Version Ranges
  csr	v6.0.0 -> latest

• enroll_protocol - Certificate enrollment protocol. type: str choices: none, scep, cmpv2, acme2, est more...

  	Supported Version Ranges
  enroll_protocol	v6.0.0 -> latest
  [none]	v6.0.0 -> latest
  [scep]	v6.0.0 -> latest
  [cmpv2]	v6.0.0 -> latest
  [acme2]	v7.0.0 -> latest
  [est]	v7.4.1 -> latest

• est_ca_id - CA identifier of the CA server for signing via EST. type: str more...

  	Supported Version Ranges
  est_ca_id	v7.4.1 -> latest

• est_client_cert - Certificate used to authenticate this FortiGate to EST server. Source certificate.local.name. type: str more...

  	Supported Version Ranges
  est_client_cert	v7.4.1 -> latest

• est_http_password - HTTP Authentication password for signing via EST. type: str more...

  	Supported Version Ranges
  est_http_password	v7.4.1 -> latest

• est_http_username - HTTP Authentication username for signing via EST. type: str more...

  	Supported Version Ranges
  est_http_username	v7.4.1 -> latest

• est_server - Address and port for EST server (e.g. https://example.com:1234). type: str more...

  	Supported Version Ranges
  est_server	v7.4.1 -> latest

• est_server_cert - EST server"s certificate must be verifiable by this certificate to be authenticated. Source certificate.ca.name certificate.remote.name. type: str more...

  	Supported Version Ranges
  est_server_cert	v7.4.1 -> latest

• est_srp_password - EST SRP authentication password. type: str more...

  	Supported Version Ranges
  est_srp_password	v7.4.1 -> latest

• est_srp_username - EST SRP authentication username. type: str more...

  	Supported Version Ranges
  est_srp_username	v7.4.1 -> latest

• ike_localid - Local ID the FortiGate uses for authentication as a VPN client. type: str more...

  	Supported Version Ranges
  ike_localid	v6.0.0 -> latest

• ike_localid_type - IKE local ID type. type: str choices: asn1dn, fqdn more...

  	Supported Version Ranges
  ike_localid_type	v6.0.0 -> latest
  [asn1dn]	v6.0.0 -> latest
  [fqdn]	v6.0.0 -> latest

• last_updated - Time at which certificate was last updated. type: int more...

  	Supported Version Ranges
  last_updated	v6.0.0 -> v6.0.11	v6.2.3 -> v6.2.3

• name - Name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• name_encoding - Name encoding method for auto-regeneration. type: str choices: printable, utf8 more...

  	Supported Version Ranges
  name_encoding	v6.0.0 -> latest
  [printable]	v6.0.0 -> latest
  [utf8]	v6.0.0 -> latest

• password - Password as a PEM file. type: str more...

  	Supported Version Ranges
  password	v6.0.0 -> latest

• private_key - PEM format key encrypted with a password. type: str more...

  	Supported Version Ranges
  private_key	v6.0.0 -> latest

• private_key_retain - Enable/disable retention of private key during SCEP renewal . type: str choices: enable, disable more...

  	Supported Version Ranges
  private_key_retain	v7.2.1 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• range - Either a global or VDOM IP address range for the certificate. type: str choices: global, vdom more...

  	Supported Version Ranges
  range	v6.0.0 -> latest
  [global]	v6.0.0 -> latest
  [vdom]	v6.0.0 -> latest

• scep_password - SCEP server challenge password for auto-regeneration. type: str more...

  	Supported Version Ranges
  scep_password	v6.0.0 -> latest

• scep_url - SCEP server URL. type: str more...

  	Supported Version Ranges
  scep_url	v6.0.0 -> latest

• source - Certificate source type. type: str choices: factory, user, bundle more...

  	Supported Version Ranges
  source	v6.0.0 -> latest
  [factory]	v6.0.0 -> latest
  [user]	v6.0.0 -> latest
  [bundle]	v6.0.0 -> latest

• source_ip - Source IP address for communications to the SCEP server. type: str more...

  	Supported Version Ranges
  source_ip	v6.0.0 -> latest

• state - Certificate Signing Request State. type: str more...

  	Supported Version Ranges
  state	v6.0.0 -> v7.0.5	v7.2.0 -> v7.2.0

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Local keys and certificates.
  fortinet.fortios.fortios_certificate_local:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      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 certificate.ca.name 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 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 certificate.ca.name 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.

Authors

• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Hongbin Lu (@fgtdev-hblu)
• Frank Shen (@frankshen01)
• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.