fortinet.fortios.fortios_firewall_service_custom module – Configure custom 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_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_service feature and 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 |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure custom services. |
|
Application category ID. |
|
Application category id. see <a href=’#notes’>Notes</a>. |
|
Application service type. Choices:
|
|
Application ID. |
|
Application id. see <a href=’#notes’>Notes</a>. |
|
Service category. Source firewall.service.category.name. |
|
Configure the type of ICMP error message verification. Choices:
|
|
Color of icon on the GUI. |
|
Comment. |
|
Security Fabric global object setting. Choices:
|
|
Fully qualified domain name. |
|
Helper name. Choices:
|
|
ICMP code. |
|
ICMP type. |
|
Start and end of the IP range associated with service. |
|
Custom service name. |
|
Protocol type based on IANA numbers. Choices:
|
|
IP protocol number. |
|
Enable/disable web proxy service. Choices:
|
|
Multiple SCTP port ranges. |
|
Session TTL (300 - 2764800, 0 = default). |
|
Wait time to close a TCP session waiting for an unanswered FIN packet (1 - 86400 sec, 0 = default). |
|
Wait time to close a TCP session waiting for an unanswered open session packet (1 - 86400 sec, 0 = default). |
|
Multiple TCP port ranges. |
|
Set the length of the TCP CLOSE state in seconds (5 - 300 sec, 0 = default). |
|
Set the length of the TCP TIME-WAIT state in seconds (1 - 300 sec, 0 = default). |
|
Number of seconds before an idle UDP/UDP-Lite connection times out (0 - 86400 sec, 0 = default). |
|
Multiple UDP port ranges. |
|
Multiple UDP-Lite port ranges. |
|
Universally Unique Identifier (UUID; automatically assigned but can be manually reset). |
|
Enable/disable the visibility of the service on the GUI. Choices:
|
|
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
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure custom services.
fortinet.fortios.fortios_firewall_service_custom:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_service_custom:
app_category:
-
id: "4"
app_service_type: "disable"
application:
-
id: "7"
category: "<your_own_value> (source firewall.service.category.name)"
check_reset_range: "disable"
color: "0"
comment: "Comment."
fabric_object: "enable"
fqdn: "<your_own_value>"
helper: "auto"
icmpcode: ""
icmptype: ""
iprange: "<your_own_value>"
name: "default_name_18"
protocol: "TCP/UDP/UDP-Lite/SCTP"
protocol_number: "0"
proxy: "enable"
sctp_portrange: "<your_own_value>"
session_ttl: "<your_own_value>"
tcp_halfclose_timer: "0"
tcp_halfopen_timer: "0"
tcp_portrange: "<your_own_value>"
tcp_rst_timer: "0"
tcp_timewait_timer: "0"
udp_idle_timer: "0"
udp_portrange: "<your_own_value>"
udplite_portrange: "<your_own_value>"
uuid: "<your_own_value>"
visibility: "enable"
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: |