fortios_vpn_certificate_ca.rst

source:	fortios_vpn_certificate_ca.py
orphan:

fortios_vpn_certificate_ca -- CA certificate 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 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

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_vpn_certificate_ca	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
• vpn_certificate_ca - CA certificate. type: dict more...

  	Supported Version Ranges
  vpn_certificate_ca	v6.0.0 -> latest

• auto_update_days - Number of days to wait before requesting an updated CA certificate (0 - 4294967295, 0 = disabled). type: int more...

  	Supported Version Ranges
  auto_update_days	v6.0.0 -> latest

• auto_update_days_warning - Number of days before an expiry-warning message is generated (0 - 4294967295, 0 = disabled). type: int more...

  	Supported Version Ranges
  auto_update_days_warning	v6.0.0 -> latest

• ca - CA certificate as a PEM file. type: str more...

  	Supported Version Ranges
  ca	v6.0.0 -> latest

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

  	Supported Version Ranges
  ca_identifier	v7.0.2 -> latest

• est_url - URL of the EST server. type: str more...

  	Supported Version Ranges
  est_url	v7.4.1 -> latest

• last_updated - Time at which CA 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

• obsolete - Enable/disable this CA as obsoleted. type: str choices: disable, enable more...

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

• range - Either global or VDOM IP address range for the CA 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_url - URL of the SCEP server. type: str more...

  	Supported Version Ranges
  scep_url	v6.0.0 -> latest

• source - CA 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

• ssl_inspection_trusted - Enable/disable this CA as a trusted CA for SSL inspection. type: str choices: enable, disable more...

  	Supported Version Ranges
  ssl_inspection_trusted	v6.2.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• trusted - Enable/disable as a trusted CA. type: str choices: enable, disable more...

  	Supported Version Ranges
  trusted	v6.0.0 -> v6.0.11
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

Notes

Note

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

Examples

- name: CA certificate.
  fortinet.fortios.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"
          est_url: "<your_own_value>"
          last_updated: "2147483647"
          name: "default_name_9"
          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

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.