fortios_system_external_resource – Configure external resource in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.


  • 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


The below requirements are needed on the host that executes this module.

  • ansible>=2.9


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

FortiOS Version Compatibility

v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
fortios_system_external_resource yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes


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



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


- hosts: fortigates
    - fortinet.fortios
  connection: httpapi
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  - name: Configure external resource.
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
        category: "0"
        comments: "<your_own_value>"
        interface: "<your_own_value> (source"
        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: ""
        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:, 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:
  • 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


  • This module is not guaranteed to have a backwards compatible interface.


  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)


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