ansible / ansible.builtin / v2.8.20 / module / fortios_firewall_service_custom Configure custom services in Fortinet's FortiOS and FortiGate. | "added in version" 2.8 of ansible.builtin" Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico) preview | supported by communityansible.builtin.fortios_firewall_service_custom (v2.8.20) — module
pip
Install with pip install ansible==2.8.20
This module is able to configure a FortiGate or FortiOS by allowing the user to configure firewall_service feature and custom category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2
- hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" tasks: - name: Configure custom services. fortios_firewall_service_custom: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" firewall_service_custom: state: "present" 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: "10" comment: "Comment." fqdn: "<your_own_value>" helper: "auto" icmpcode: "14" icmptype: "15" iprange: "<your_own_value>" name: "default_name_17" protocol: "TCP/UDP/SCTP" protocol-number: "19" proxy: "enable" sctp-portrange: "<your_own_value>" session-ttl: "22" tcp-halfclose-timer: "23" tcp-halfopen-timer: "24" tcp-portrange: "<your_own_value>" tcp-timewait-timer: "26" udp-idle-timer: "27" udp-portrange: "<your_own_value>" visibility: "enable"
host: description: - FortiOS or FortiGate ip adress. required: true vdom: default: root description: - 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. https: default: true description: - Indicates if the requests towards FortiGate must use HTTPS protocol type: bool password: default: '' description: - FortiOS or FortiGate password. username: description: - FortiOS or FortiGate username. required: true firewall_service_custom: default: null description: - Configure custom services. suboptions: app-category: description: - Application category ID. suboptions: id: description: - Application category id. required: true app-service-type: choices: - disable - app-id - app-category description: - Application service type. application: description: - Application ID. suboptions: id: description: - Application id. required: true category: description: - Service category. Source firewall.service.category.name. check-reset-range: choices: - disable - strict - default description: - Configure the type of ICMP error message verification. color: description: - Color of icon on the GUI. comment: description: - Comment. fqdn: description: - Fully qualified domain name. helper: 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 description: - Helper name. icmpcode: description: - ICMP code. icmptype: description: - ICMP type. iprange: description: - Start and end of the IP range associated with service. name: description: - Custom service name. required: true protocol: choices: - TCP/UDP/SCTP - ICMP - ICMP6 - IP - HTTP - FTP - CONNECT - SOCKS-TCP - SOCKS-UDP - ALL description: - Protocol type based on IANA numbers. protocol-number: description: - IP protocol number. proxy: choices: - enable - disable description: - Enable/disable web proxy service. sctp-portrange: description: - Multiple SCTP port ranges. session-ttl: description: - Session TTL (300 - 604800, 0 = default). state: choices: - present - absent description: - Indicates whether to create or remove the object tcp-halfclose-timer: description: - Wait time to close a TCP session waiting for an unanswered FIN packet (1 - 86400 sec, 0 = default). tcp-halfopen-timer: description: - Wait time to close a TCP session waiting for an unanswered open session packet (1 - 86400 sec, 0 = default). tcp-portrange: description: - Multiple TCP port ranges. tcp-timewait-timer: description: - Set the length of the TCP TIME-WAIT state in seconds (1 - 300 sec, 0 = default). udp-idle-timer: description: - UDP half close timeout (0 - 86400 sec, 0 = default). udp-portrange: description: - Multiple UDP port ranges. visibility: choices: - enable - disable description: - Enable/disable the visibility of the service on the GUI.
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str