fortios_firewall_internet_service – Show Internet Service application in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and internet_service 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_firewall_internet_service v6.0.0 -> v7.0.5 v7.2.0 -> v7.2.0

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
  • firewall_internet_service - Show Internet Service application. type: dict more...
    • database - Database name this Internet Service belongs to. type: str choices: isdb, irdb more...
    • direction - How this service may be used in a firewall policy (source, destination or both). type: str choices: src, dst, both more...
    • entry - Entries in the Internet Service database. type: list member_path: entry:id more...
      • id - Entry ID. see Notes. type: int required: true more...
      • ip_number - Total number of IP addresses. type: int more...
      • ip_range_number - Total number of IP ranges. type: int more...
      • port - Integer value for the TCP/IP port (0 - 65535). type: int more...
      • protocol - Integer value for the protocol type as defined by IANA (0 - 255). type: int more...
    • extra_ip_range_number - Extra number of IP ranges. type: int more...
    • icon_id - Icon ID of Internet Service. type: int more...
    • id - Internet Service ID. see Notes. type: int required: true more...
    • ip_number - Total number of IP addresses. type: int more...
    • ip_range_number - Number of IP ranges. type: int more...
    • name - Internet Service name. type: str more...
    • obsolete - Indicates whether the Internet Service can be used. type: int more...
    • offset - Offset of Internet Service ID. type: int more...
    • reputation - Reputation level of the Internet Service. type: int more...
    • singularity - Singular level of the Internet Service. type: int more...
    • sld_id - Second Level Domain. type: int more...

Notes

Note

  • We highly recommend using your own value as the id instead of 0, while ‘0’ is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.

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

Examples

- name: Show Internet Service application.
  fortinet.fortios.fortios_firewall_internet_service:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_internet_service:
          database: "isdb"
          direction: "src"
          entry:
              -
                  id: "6"
                  ip_number: "32767"
                  ip_range_number: "2147483647"
                  port: "32767"
                  protocol: "127"
          extra_ip_range_number: "0"
          icon_id: "0"
          id: "13"
          ip_number: "0"
          ip_range_number: "0"
          name: "default_name_16"
          obsolete: "0"
          offset: "2147483647"
          reputation: "2147483647"
          singularity: "0"
          sld_id: "2147483647"

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.