fortios_firewall_service_custom – Configure custom services 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_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
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
v7.2.4 |
v7.4.0 |
|
fortios_firewall_service_custom | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
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_service_custom - Configure custom services. type: dict more...
- app_category - Application category ID. type: list member_path: app_category:id more...
- id - Application category id. type: int required: true more...
- app_service_type - Application service type. type: str choices: disable, app-id, app-category more...
- application - Application ID. type: list member_path: application:id more...
- id - Application id. type: int required: true more...
- category - Service category. Source firewall.service.category.name. type: str more...
- check_reset_range - Configure the type of ICMP error message verification. type: str choices: disable, strict, default more...
- color - Color of icon on the GUI. type: int more...
- comment - Comment. type: str more...
- fabric_object - Security Fabric global object setting. type: str choices: enable, disable more...
- fqdn - Fully qualified domain name. type: str more...
- helper - Helper name. type: str choices: auto, disable, ftp, tftp, ras, h323, tns, mms, sip, pptp, rtsp, dns-udp, dns-tcp, pmap, rsh, dcerpc, mgcp, gtp-c, gtp-u, gtp-b, pfcp more...
- icmpcode - ICMP code. type: int more...
- icmptype - ICMP type. type: int more...
- iprange - Start and end of the IP range associated with service. type: str more...
- name - Custom service name. type: str required: true more...
- protocol - Protocol type based on IANA numbers. type: str choices: TCP/UDP/SCTP, ICMP, ICMP6, IP, HTTP, FTP, CONNECT, SOCKS-TCP, SOCKS-UDP, ALL more...
- protocol_number - IP protocol number. type: int more...
- proxy - Enable/disable web proxy service. type: str choices: enable, disable more...
- sctp_portrange - Multiple SCTP port ranges. type: str more...
- session_ttl - Session TTL (300 - 2764800, 0 = default). type: str more...
- tcp_halfclose_timer - Wait time to close a TCP session waiting for an unanswered FIN packet (1 - 86400 sec, 0 = default). type: int more...
- tcp_halfopen_timer - Wait time to close a TCP session waiting for an unanswered open session packet (1 - 86400 sec, 0 = default). type: int more...
- tcp_portrange - Multiple TCP port ranges. type: str more...
- tcp_rst_timer - Set the length of the TCP CLOSE state in seconds (5 - 300 sec, 0 = default). type: int more...
- tcp_timewait_timer - Set the length of the TCP TIME-WAIT state in seconds (1 - 300 sec, 0 = default). type: int more...
- udp_idle_timer - Number of seconds before an idle UDP connection times out (0 - 86400 sec, 0 = default). type: int more...
- udp_portrange - Multiple UDP port ranges. type: str more...
- visibility - Enable/disable the visibility of the service on the GUI. type: str choices: enable, disable more...
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 services.
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/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>"
visibility: "enable"
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