Skip to content

Latest commit

 

History

History
344 lines (300 loc) · 14.5 KB

fortios_system_acme.rst

File metadata and controls

344 lines (300 loc) · 14.5 KB
Raw
source:fortios_system_acme.py
orphan:

fortios_system_acme -- Configure ACME client in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and acme 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_system_acme v7.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
  • system_acme - Configure ACME client. type: dict more...
    Supported Version Ranges
    system_acme v7.0.0 -> latest
    • accounts - ACME accounts list. type: list member_path: accounts:id more...
      Supported Version Ranges
      accounts v7.0.0 -> latest
      • ca_url - Account ca_url. type: str more...
        Supported Version Ranges
        ca_url v7.0.0 -> latest
      • email - Account email. type: str more...
        Supported Version Ranges
        email v7.0.0 -> latest
      • id - Account id. type: str required: true more...
        Supported Version Ranges
        id v7.0.0 -> latest
      • privatekey - Account Private Key. type: str more...
        Supported Version Ranges
        privatekey v7.0.0 -> latest
      • status - Account status. type: str more...
        Supported Version Ranges
        status v7.0.0 -> latest
      • url - Account url. type: str more...
        Supported Version Ranges
        url v7.0.0 -> latest
    • interface - Interface(s) on which the ACME client will listen for challenges. type: list member_path: interface:interface_name more...
      Supported Version Ranges
      interface v7.0.0 -> latest
      • interface_name - Interface name. Source system.interface.name. type: str required: true more...
        Supported Version Ranges
        interface_name v7.0.0 -> latest
    • source_ip - Source IPv4 address used to connect to the ACME server. type: str more...
      Supported Version Ranges
      source_ip v7.0.6 -> latest
    • source_ip6 - Source IPv6 address used to connect to the ACME server. type: str more...
      Supported Version Ranges
      source_ip6 v7.0.6 -> latest
    • use_ha_direct - Enable the use of "ha-mgmt" interface to connect to the ACME server when "ha-direct" is enabled in HA configuration type: str choices: enable, disable more...
      Supported Version Ranges
      use_ha_direct v7.4.0 -> latest
      [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: Configure ACME client.
  fortinet.fortios.fortios_system_acme:
      vdom: "{{ vdom }}"
      system_acme:
          accounts:
              -
                  ca_url: "<your_own_value>"
                  email: "<your_own_value>"
                  id: "6"
                  privatekey: "<your_own_value>"
                  status: "<your_own_value>"
                  url: "myurl.com"
          interface:
              -
                  interface_name: "<your_own_value> (source system.interface.name)"
          source_ip: "84.230.14.43"
          source_ip6: "<your_own_value>"
          use_ha_direct: "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.