community.fortios.fmgr_fwobj_service module – Manages FortiManager Firewall Service Objects.
Note
This module is part of the community.fortios collection (version 1.0.0).
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 community.fortios
.
To use it in a playbook, specify: community.fortios.fmgr_fwobj_service
.
Synopsis
Manages FortiManager Firewall Service Objects.
Parameters
Parameter |
Comments |
---|---|
-The ADOM the configuration should belong to. Default: |
|
Application category ID. |
|
Application service type. |
|
Application ID. |
|
Service category. |
|
Enable disable RST check. |
|
GUI icon color. Default: |
|
Comment. |
|
Tells module what kind of custom service to be added. Choices:
|
|
Enable/disable explicit web proxy service. Choices:
|
|
Fully qualified domain name. Default: |
|
Comma-Seperated list of members’ names. |
|
Name of the Service Group. |
|
ICMP code. |
|
ICMP type. |
|
Start IP-End IP. Default: |
|
Sets one of three modes for managing the object. Choices:
|
|
Custom service name. |
|
Tells module if we are adding a custom service, category, or group. Choices:
|
|
Protocol type. |
|
IP protocol number. |
|
Multiple SCTP port ranges. Comma separated list of destination ports to add (i.e. ‘443,80’). Syntax is <destPort:sourcePort> If no sourcePort is defined, it assumes all of them. Ranges can be defined with a hyphen - Examples – ‘443’ (destPort 443 only) ‘443:1000-2000’ (destPort 443 from source ports 1000-2000). String multiple together in same quotes, comma separated. (‘443:1000-2000, 80:1000-2000’). |
|
Session TTL (300 - 604800, 0 = default). Default: |
|
TCP half close timeout (1 - 86400 sec, 0 = default). Default: |
|
TCP half close timeout (1 - 86400 sec, 0 = default). Default: |
|
Comma separated list of destination ports to add (i.e. ‘443,80’). Syntax is <destPort:sourcePort> If no sourcePort is defined, it assumes all of them. Ranges can be defined with a hyphen - Examples – ‘443’ (destPort 443 only) ‘443:1000-2000’ (destPort 443 from source ports 1000-2000). String multiple together in same quotes, comma separated. (‘443:1000-2000, 80:1000-2000’). |
|
TCP half close timeout (1 - 300 sec, 0 = default). Default: |
|
TCP half close timeout (0 - 86400 sec, 0 = default). Default: |
|
Comma separated list of destination ports to add (i.e. ‘443,80’). Syntax is <destPort:sourcePort> If no sourcePort is defined, it assumes all of them. Ranges can be defined with a hyphen - Examples – ‘443’ (destPort 443 only) ‘443:1000-2000’ (destPort 443 from source ports 1000-2000). String multiple together in same quotes, comma separated. (‘443:1000-2000, 80:1000-2000’). |
|
Enable/disable service visibility. Choices:
|
Notes
Note
Full Documentation at https://ftnt-ansible-docs.readthedocs.io/en/latest/.
Examples
- name: ADD A CUSTOM SERVICE FOR TCP/UDP/SCP
community.fortios.fmgr_fwobj_service:
adom: "ansible"
name: "ansible_custom_service"
object_type: "custom"
custom_type: "tcp_udp_sctp"
tcp_portrange: "443"
udp_portrange: "51"
sctp_portrange: "100"
- name: ADD A CUSTOM SERVICE FOR TCP/UDP/SCP WITH SOURCE RANGES AND MULTIPLES
community.fortios.fmgr_fwobj_service:
adom: "ansible"
name: "ansible_custom_serviceWithSource"
object_type: "custom"
custom_type: "tcp_udp_sctp"
tcp_portrange: "443:2000-1000,80-82:10000-20000"
udp_portrange: "51:100-200,162:200-400"
sctp_portrange: "100:2000-2500"
- name: ADD A CUSTOM SERVICE FOR ICMP
community.fortios.fmgr_fwobj_service:
adom: "ansible"
name: "ansible_custom_icmp"
object_type: "custom"
custom_type: "icmp"
icmp_type: "8"
icmp_code: "3"
- name: ADD A CUSTOM SERVICE FOR ICMP6
community.fortios.fmgr_fwobj_service:
adom: "ansible"
name: "ansible_custom_icmp6"
object_type: "custom"
custom_type: "icmp6"
icmp_type: "5"
icmp_code: "1"
- name: ADD A CUSTOM SERVICE FOR IP - GRE
community.fortios.fmgr_fwobj_service:
adom: "ansible"
name: "ansible_custom_icmp6"
object_type: "custom"
custom_type: "ip"
protocol_number: "47"
- name: ADD A CUSTOM PROXY FOR ALL WITH SOURCE RANGES AND MULTIPLES
community.fortios.fmgr_fwobj_service:
adom: "ansible"
name: "ansible_custom_proxy_all"
object_type: "custom"
custom_type: "all"
explicit_proxy: "enable"
tcp_portrange: "443:2000-1000,80-82:10000-20000"
iprange: "www.ansible.com"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
full API response, includes status code and message Returned: always |