fortinet.fortios.fortios_firewall_internet_service_custom module – Configure custom Internet Services in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.3.8).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: fortinet.fortios.fortios_firewall_internet_service_custom.

New in fortinet.fortios 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_custom 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.15

Parameters

Parameter	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
firewall_internet_service_custom dictionary	Configure custom Internet Services.
comment string	Comment.
disable_entry list / elements=dictionary	Disable entries in the Internet Service database.
id integer / required	Disable entry ID. see <a href=’#notes’>Notes</a>.
ip_range list / elements=dictionary	IP ranges in the disable entry.
end_ip string	End IP address.
id integer / required	Disable entry range ID. see <a href=’#notes’>Notes</a>.
start_ip string	Start IP address.
port integer	Integer value for the TCP/IP port (0 - 65535).
protocol integer	Integer value for the protocol type as defined by IANA (0 - 255).
entry list / elements=dictionary	Entries added to the Internet Service database and custom database.
addr_mode string	Address mode (IPv4 or IPv6). Choices: "ipv4" "ipv6"
dst list / elements=dictionary	Destination address or address group name.
name string / required	Select the destination address or address group object from available options. Source firewall.address.name firewall .addrgrp.name.
dst6 list / elements=dictionary	Destination address6 or address6 group name.
name string / required	Select the destination address6 or address group object from available options. Source firewall.address6.name firewall .addrgrp6.name.
id integer / required	Entry ID(1-255). see <a href=’#notes’>Notes</a>.
port_range list / elements=dictionary	Port ranges in the custom entry.
end_port integer	Integer value for ending TCP/UDP/SCTP destination port in range (0 to 65535).
id integer / required	Custom entry port range ID. see <a href=’#notes’>Notes</a>.
start_port integer	Integer value for starting TCP/UDP/SCTP destination port in range (0 to 65535).
protocol integer	Integer value for the protocol type as defined by IANA (0 - 255).
master_service_id integer	Internet Service ID in the Internet Service database. Source firewall.internet-service.id.
name string / required	Internet Service name.
reputation integer	Reputation level of the custom Internet Service. Source firewall.internet-service-reputation.id.
member_path string	Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: "present" "absent"
state string / required	Indicates whether to create or remove the object. Choices: "present" "absent"
vdom string	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. Default: "root"

Notes

Note

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

• The module supports check_mode.

Examples

- name: Configure custom Internet Services.
  fortinet.fortios.fortios_firewall_internet_service_custom:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_internet_service_custom:
          comment: "Comment."
          disable_entry:
              -
                  id: "5"
                  ip_range:
                      -
                          end_ip: "<your_own_value>"
                          id: "8"
                          start_ip: "<your_own_value>"
                  port: "32767"
                  protocol: "127"
          entry:
              -
                  addr_mode: "ipv4"
                  dst:
                      -
                          name: "default_name_15 (source firewall.address.name firewall.addrgrp.name)"
                  dst6:
                      -
                          name: "default_name_17 (source firewall.address6.name firewall.addrgrp6.name)"
                  id: "18"
                  port_range:
                      -
                          end_port: "65535"
                          id: "21"
                          start_port: "1"
                  protocol: "0"
          master_service_id: "2147483647"
          name: "default_name_25"
          reputation: "3"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
build string	Build number of the fortigate image Returned: always Sample: "1547"
http_method string	Last method used to provision the content into FortiGate Returned: always Sample: "PUT"
http_status string	Last result given by FortiGate on last operation applied Returned: always Sample: "200"
mkey string	Master key (id) used in the last call to FortiGate Returned: success Sample: "id"
name string	Name of the table used to fulfill the request Returned: always Sample: "urlfilter"
path string	Path of the table used to fulfill the request Returned: always Sample: "webfilter"
revision string	Internal revision number Returned: always Sample: "17.0.2.10658"
serial string	Serial number of the unit Returned: always Sample: "FGVMEVYYQT3AB5352"
status string	Indication of the operation’s result Returned: always Sample: "success"
vdom string	Virtual domain used Returned: always Sample: "root"
version string	Version of the FortiGate Returned: always Sample: "v5.6.3"

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Hongbin Lu (@fgtdev-hblu)

• Frank Shen (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)