Docs4dev
Docs
ansible / latest / collections / fortinet / fortios / fortios_firewall_internet_service_custom_module.html

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

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

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.

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

New in version 2.10: of fortinet.fortios

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.9.0

Parameters

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
firewall_internet_service_custom
dictionary
Configure custom Internet Services.
comment
string
Comment.
disable_entry
list / elements=string
Disable entries in the Internet Service database.
id
integer / required
Disable entry ID.
ip_range
list / elements=string
IP ranges in the disable entry.
end_ip
string
End IP address.
id
integer / required
Disable entry range ID.
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=string
Entries added to the Internet Service database and custom database.
dst
list / elements=string
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.
id
integer / required
Entry ID(1-255).
port_range
list / elements=string
Port ranges in the custom entry.
end_port
integer
Integer value for ending TCP/UDP/SCTP destination port in range (1 to 65535).
id
integer / required
Custom entry port range ID.
start_port
integer
Integer value for starting TCP/UDP/SCTP destination port in range (1 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.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
vdom
string
Default:
"root"
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.

Notes

Note

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

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure custom Internet Services.
    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: "10"
            protocol: "11"
        entry:
         -
            dst:
             -
                name: "default_name_14 (source firewall.address.name firewall.addrgrp.name)"
            id:  "15"
            port_range:
             -
                end_port: "17"
                id:  "18"
                start_port: "19"
            protocol: "20"
        master_service_id: "21 (source firewall.internet-service.id)"
        name: "default_name_22"
        reputation: "23 (source firewall.internet-service-reputation.id)"

Return Values

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

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_firewall_internet_service_custom_module.html