Skip to content

Latest commit

 

History

History
441 lines (397 loc) · 18.9 KB

fortios_system_external_resource.rst

File metadata and controls

441 lines (397 loc) · 18.9 KB
Raw
source:fortios_system_external_resource.py
orphan:

fortios_system_external_resource -- Configure external resource 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 external_resource 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_external_resource 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
  • system_external_resource - Configure external resource. type: dict more...
    Supported Version Ranges
    system_external_resource v6.0.0 -> latest
    • category - User resource category. type: int more...
      Supported Version Ranges
      category v6.0.0 -> latest
    • comments - Comment. type: str more...
      Supported Version Ranges
      comments v6.0.0 -> latest
    • interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...
      Supported Version Ranges
      interface v6.4.0 -> v6.4.0 v6.4.4 -> latest
    • interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...
      Supported Version Ranges
      interface_select_method v6.4.0 -> v6.4.0 v6.4.4 -> latest
      [auto] v6.0.0 -> latest
      [sdwan] v6.0.0 -> latest
      [specify] v6.0.0 -> latest
    • name - External resource name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> latest
    • password - HTTP basic authentication password. type: str more...
      Supported Version Ranges
      password v6.2.0 -> latest
    • refresh_rate - Time interval to refresh external resource (1 - 43200 min). type: int more...
      Supported Version Ranges
      refresh_rate v6.0.0 -> latest
    • resource - URL of external resource. type: str more...
      Supported Version Ranges
      resource v6.0.0 -> latest
    • server_identity_check - Certificate verification option. type: str choices: none, basic, full more...
      Supported Version Ranges
      server_identity_check v7.0.8 -> v7.0.12 v7.2.4 -> latest
      [none] v6.0.0 -> latest
      [basic] v6.0.0 -> latest
      [full] v6.0.0 -> latest
    • source_ip - Source IPv4 address used to communicate with server. type: str more...
      Supported Version Ranges
      source_ip v6.2.0 -> latest
    • status - Enable/disable user resource. type: str choices: enable, disable more...
      Supported Version Ranges
      status v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • type - User resource type. type: str choices: category, address, domain, malware, mac-address more...
      Supported Version Ranges
      type v6.0.0 -> latest
      [category] v6.0.0 -> latest
      [address] v6.0.0 -> latest
      [domain] v6.0.0 -> latest
      [malware] v6.2.0 -> latest
      [mac-address] v7.4.0 -> latest
    • update_method - External resource update method. type: str choices: feed, push more...
      Supported Version Ranges
      update_method v7.2.1 -> latest
      [feed] v6.0.0 -> latest
      [push] v6.0.0 -> latest
    • user_agent - HTTP User-Agent header . type: str more...
      Supported Version Ranges
      user_agent v6.4.0 -> v6.4.0 v6.4.4 -> latest
    • username - HTTP basic authentication user name. type: str more...
      Supported Version Ranges
      username v6.2.0 -> latest
    • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
      Supported Version Ranges
      uuid v7.0.0 -> latest

Notes

Note

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

Examples

- name: Configure external resource.
  fortinet.fortios.fortios_system_external_resource:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_external_resource:
          category: "0"
          comments: "<your_own_value>"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          name: "default_name_7"
          password: "<your_own_value>"
          refresh_rate: "5"
          resource: "<your_own_value>"
          server_identity_check: "none"
          source_ip: "84.230.14.43"
          status: "enable"
          type: "category"
          update_method: "feed"
          user_agent: "<your_own_value>"
          username: "<your_own_value>"
          uuid: "<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.