fortinet.fortios.fortios_firewall_internet_service_extension module – Configure Internet Services Extension in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.4).
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_extension.
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_extension 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
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure Internet Services Extension. |
|
Comment. |
|
Disable entries in the Internet Service database. |
|
Address mode (IPv4 or IPv6). Choices:
|
|
Disable entry ID. see <a href=’#notes’>Notes</a>. |
|
IPv6 ranges in the disable entry. |
|
End IPv6 address. |
|
Disable entry range ID. see <a href=’#notes’>Notes</a>. |
|
Start IPv6 address. |
|
IPv4 ranges in the disable entry. |
|
End IPv4 address. |
|
Disable entry range ID. see <a href=’#notes’>Notes</a>. |
|
Start IPv4 address. |
|
Port ranges in the disable entry. |
|
Ending TCP/UDP/SCTP destination port (0 to 65535). |
|
Custom entry port range ID. see <a href=’#notes’>Notes</a>. |
|
Starting TCP/UDP/SCTP destination port (0 to 65535). |
|
Integer value for the protocol type as defined by IANA (0 - 255). |
|
Entries added to the Internet Service extension database. |
|
Address mode (IPv4 or IPv6). Choices:
|
|
Destination address or address group name. |
|
Select the destination address or address group object from available options. Source firewall.address.name firewall .addrgrp.name. |
|
Destination address6 or address6 group name. |
|
Select the destination address6 or address group object from available options. Source firewall.address6.name firewall .addrgrp6.name. |
|
Entry ID(1-255). see <a href=’#notes’>Notes</a>. |
|
Port ranges in the custom entry. |
|
Integer value for ending TCP/UDP/SCTP destination port in range (0 to 65535). |
|
Custom entry port range ID. see <a href=’#notes’>Notes</a>. |
|
Integer value for starting TCP/UDP/SCTP destination port in range (0 to 65535). |
|
Integer value for the protocol type as defined by IANA (0 - 255). |
|
Internet Service ID in the Internet Service database. see <a href=’#notes’>Notes</a>. Source firewall.internet-service.id. |
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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: |
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
- 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 Internet Services Extension.
fortios_firewall_internet_service_extension:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_internet_service_extension:
comment: "Comment."
disable_entry:
-
addr_mode: "ipv4"
id: "6"
ip_range:
-
end_ip: "<your_own_value>"
id: "9"
start_ip: "<your_own_value>"
ip6_range:
-
end_ip6: "<your_own_value>"
id: "13"
start_ip6: "<your_own_value>"
port_range:
-
end_port: "65535"
id: "17"
start_port: "1"
protocol: "0"
entry:
-
addr_mode: "ipv4"
dst:
-
name: "default_name_23 (source firewall.address.name firewall.addrgrp.name)"
dst6:
-
name: "default_name_25 (source firewall.address6.name firewall.addrgrp6.name)"
id: "26"
port_range:
-
end_port: "65535"
id: "29"
start_port: "1"
protocol: "0"
id: "32 (source firewall.internet-service.id)"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |