FortiGate

FortiGate provides flawless convergence that can scale to any location: remote office, branch, campus, data center, and cloud. FortiGate always delivered on the concept of hybrid mesh firewalls with FortiManager for unified management and consistent security across complex hybrid environments. The Fortinet FortiOS operating system provides deep visibility and security across a variety of form factors.
This integration was integrated and tested with version 7.2.5 of FortiGate.

Configure FortiGate in Cortex

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

fortigate-list-firewall-address-ipv4s

Retrieve firewall IPv4 addresses. Addresses define sources and destinations of network traffic and can be used in many functions such as firewall policies, ZTNA, etc.

Base Command

fortigate-list-firewall-address-ipv4s

Input

Context Output

Command example

!fortigate-list-firewall-address-ipv4s name=playbook-address-ipv4

Context Example

{
    "Fortigate": {
        "Address": {
            "AllowRouting": "disable",
            "AssociatedInterface": "",
            "CacheTTL": 0,
            "ClearpassSPT": "unknown",
            "Comment": "",
            "Country": "IL",
            "Dirty": "dirty",
            "FabricObject": "disable",
            "Interface": "",
            "Name": "playbook-address-ipv4",
            "ObjectType": "ip",
            "SDN": "",
            "SDNAddressType": "private",
            "SubType": "sdn",
            "TagDetectionLevel": "",
            "TagType": "",
            "Type": "geography",
            "UUID": "d30118b0-aa22-51ee-8e1b-bd78f7129431",
            "VDOM": "root"
        }
    }
}

Human Readable Output

Firewall Address IPv4s

Name	Details	Type	Routable
playbook-address-ipv4	IL	geography	disable

fortigate-create-firewall-address-ipv4

Create firewall IPv4 addresses. Addresses define sources and destinations of network traffic and can be used in many functions such as firewall policies, ZTNA, etc. The command parameters can be used only in the following combinations: All-[vdom,name,comment,associated_interface], Subnet-[address,mask,allow_routing], IP Range-[start_ip,end_ip], FQDN-[fqdn,allow_routing], Geography-[country], Device (Mac Address)-[mac_addresses].

Base Command

fortigate-create-firewall-address-ipv4

Input

Context Output

Command example

!fortigate-create-firewall-address-ipv4 name=playbook-address-ipv4 country=IL

Context Example

{
    "Fortigate": {
        "Address": {
            "Country": "IL",
            "Name": "playbook-address-ipv4"
        }
    }
}

Human Readable Output

The firewall address ‘playbook-address-ipv4’ was successfully created

fortigate-update-firewall-address-ipv4

Update firewall IPv4 addresses. Addresses define sources and destinations of network traffic and can be used in many functions such as firewall policies, ZTNA, etc. The command parameters can be used only in the following combinations: All-[vdom,name,comment,associated_interface,type], Subnet-[address,mask,allow_routing], IP Range-[start_ip,end_ip], FQDN-[fqdn,allow_routing], Geography-[country], Device (Mac Address)-[mac_addresses].

Base Command

fortigate-update-firewall-address-ipv4

Input

Context Output

Command example

!fortigate-update-firewall-address-ipv4 name=playbook-address-ipv4 comment=helloworld

Context Example

{
    "Fortigate": {
        "Address": {
            "Name": "playbook-address-ipv4"
        }
    }
}

Human Readable Output

The firewall address ‘playbook-address-ipv4’ was successfully updated

fortigate-delete-firewall-address-ipv4

Delete firewall IPv4 addresses. Addresses define sources and destinations of network traffic and can be used in many functions such as firewall policies, ZTNA, etc.

Base Command

fortigate-delete-firewall-address-ipv4

Input

Context Output

Command example

!fortigate-delete-firewall-address-ipv4 name=playbook-address-ipv4

Context Example

{
    "Fortigate": {
        "Address": {
            "Deleted": true,
            "Name": "playbook-address-ipv4"
        }
    }
}

Human Readable Output

The firewall address ‘playbook-address-ipv4’ was successfully deleted

fortigate-list-firewall-address-ipv6s

Retrieve firewall IPv6 addresses. Addresses define sources and destinations of network traffic and can be used in many functions such as firewall policies, ZTNA, etc.

Base Command

fortigate-list-firewall-address-ipv6s

Input

Context Output

Command example

!fortigate-list-firewall-address-ipv6s name=playbook-address-ipv6 comment=helloworld

Context Example

{
    "Fortigate": {
        "Address6": {
            "CacheTTL": 0,
            "Comment": "",
            "Country": "IL",
            "EndIP": "::",
            "FQDN": "",
            "FabricObject": "disable",
            "HostType": "any",
            "Name": "playbook-address-ipv6",
            "SDN": "",
            "SDNTag": "",
            "Template": "",
            "Tenant": "",
            "Type": "geography",
            "UUID": "d827aafc-aa22-51ee-2088-2123aa731857",
            "VDOM": "root"
        }
    }
}

Human Readable Output

Firewall Address IPv6s

Name	Details	Type
playbook-address-ipv6	IL	geography

fortigate-create-firewall-address-ipv6

Create firewall IPv6 addresses. Addresses define sources and destinations of network traffic and can be used in many functions such as firewall policies, ZTNA, etc. The command parameters can be used only in the following combinations: All-[vdom,name,comment], Subnet-[address,mask], IP Range-[start_ip,end_ip], FQDN-[fqdn], Geography-[country], Fabric Connector Address-[sdn_connector], Device (Mac Address)-[mac_addresses].

Base Command

fortigate-create-firewall-address-ipv6

Input

Context Output

Command example

!fortigate-create-firewall-address-ipv6 name=playbook-address-ipv6 country=IL

Context Example

{
    "Fortigate": {
        "Address6": {
            "Country": "IL",
            "Name": "playbook-address-ipv6"
        }
    }
}

Human Readable Output

The firewall address ‘playbook-address-ipv6’ was successfully created

fortigate-update-firewall-address-ipv6

Update firewall IPv6 addresses. Addresses define sources and destinations of network traffic and can be used in many functions such as firewall policies, ZTNA, etc. The command parameters can be used only in the following combinations: All-[vdom,name,comment,associated_interface], Subnet-[address,mask], IP Range-[start_ip,end_ip], FQDN-[fqdn], Geography-[country], Fabric Connector Address-[sdn_connector], Device (Mac Address)-[mac_addresses].

Base Command

fortigate-update-firewall-address-ipv6

Input

Context Output

Command example

!fortigate-update-firewall-address-ipv6 name=playbook-address-ipv6

Context Example

{
    "Fortigate": {
        "Address6": {
            "Name": "playbook-address-ipv6"
        }
    }
}

Human Readable Output

The firewall address ‘playbook-address-ipv6’ was successfully updated

fortigate-delete-firewall-address-ipv6

Delete firewall IPv6 addresses. Addresses define sources and destinations of network traffic and can be used in many functions such as firewall policies, ZTNA, etc.

Base Command

fortigate-delete-firewall-address-ipv6

Input

Context Output

Command example

!fortigate-delete-firewall-address-ipv6 name=playbook-address-ipv6

Context Example

{
    "Fortigate": {
        "Address6": {
            "Deleted": true,
            "Name": "playbook-address-ipv6"
        }
    }
}

Human Readable Output

The firewall address ‘playbook-address-ipv6’ was successfully deleted

fortigate-list-firewall-address-ipv4-multicasts

Retrieve firewall IPv4 multicast addresses. Multicasting allows a single source to send data to multiple receivers efficiently, conserving bandwidth and minimizing network traffic. It is suitable for media streaming, news feeds, financial updates, and certain dynamic routing protocols like RIPv2, OSPF, and EIGRP.

Base Command

fortigate-list-firewall-address-ipv4-multicasts

Input

Context Output

Command example

!fortigate-list-firewall-address-ipv4-multicasts name=playbook-address-ipv4-multicast

Context Example

{
    "Fortigate": {
        "AddressMulticast": {
            "AssociatedInterface": "",
            "Comment": "",
            "Name": "playbook-address-ipv4-multicast",
            "Subnet": "0.0.0.0-0.0.0.0",
            "Type": "broadcastmask",
            "VDOM": "root"
        }
    }
}

Human Readable Output

Firewall Address IPv4 Multicasts

Name	Details	Type
playbook-address-ipv4-multicast	0.0.0.0-0.0.0.0	broadcastmask

fortigate-create-firewall-address-ipv4-multicast

Create firewall IPv4 multicast addresses. Multicasting allows a single source to send data to multiple receivers efficiently, conserving bandwidth and minimizing network traffic. It`s suitable for media streaming, news feeds, financial updates, and certain dynamic routing protocols like RIPv2, OSPF, and EIGRP.

Base Command

fortigate-create-firewall-address-ipv4-multicast

Input

Context Output

Command example

!fortigate-create-firewall-address-ipv4-multicast name=playbook-address-ipv4-multicast type="Broadcast Subnet" first_ip=0.0.0.0 final_ip=0.0.0.0

Context Example

{
    "Fortigate": {
        "AddressMulticast": {
            "FinalIP": "0.0.0.0",
            "FirstIP": "0.0.0.0",
            "Name": "playbook-address-ipv4-multicast",
            "Type": "Broadcast Subnet"
        }
    }
}

Human Readable Output

The firewall address multicast IPv4 ‘playbook-address-ipv4-multicast’ was successfully created

fortigate-update-firewall-address-ipv4-multicast

Update firewall IPv4 multicast addresses. Multicasting allows a single source to send data to multiple receivers efficiently, conserving bandwidth and minimizing network traffic. It`s suitable for media streaming, news feeds, financial updates, and certain dynamic routing protocols like RIPv2, OSPF, and EIGRP.

Base Command

fortigate-update-firewall-address-ipv4-multicast

Input

Context Output

Command example

!fortigate-update-firewall-address-ipv4-multicast name=playbook-address-ipv4-multicast comment=helloworld

Context Example

{
    "Fortigate": {
        "AddressMulticast": {
            "Name": "playbook-address-ipv4-multicast"
        }
    }
}

Human Readable Output

The firewall address multicast IPv4 ‘playbook-address-ipv4-multicast’ was successfully updated

fortigate-delete-firewall-address-ipv4-multicast

Delete firewall IPv4 multicast addresses. Multicasting allows a single source to send data to multiple receivers efficiently, conserving bandwidth and minimizing network traffic. It is suitable for media streaming, news feeds, financial updates, and certain dynamic routing protocols like RIPv2, OSPF, and EIGRP.

Base Command

fortigate-delete-firewall-address-ipv4-multicast

Input

Context Output

Command example

!fortigate-delete-firewall-address-ipv4-multicast name=playbook-address-ipv4-multicast

Context Example

{
    "Fortigate": {
        "AddressMulticast": {
            "Deleted": true,
            "Name": "playbook-address-ipv4-multicast"
        }
    }
}

Human Readable Output

The firewall address multicast IPv4 ‘playbook-address-ipv4-multicast’ was successfully deleted

fortigate-list-firewall-address-ipv6-multicasts

Retrieve firewall IPv6 multicast addresses. Multicasting allows a single source to send data to multiple receivers efficiently, conserving bandwidth and minimizing network traffic. It is suitable for media streaming, news feeds, financial updates, and certain dynamic routing protocols like RIPv2, OSPF, and EIGRP.

Base Command

fortigate-list-firewall-address-ipv6-multicasts

Input

Context Output

Command example

!fortigate-list-firewall-address-ipv6-multicasts name=playbook-address-ipv6-multicast

Context Example

{
    "Fortigate": {
        "Address6Multicast": {
            "Comment": "",
            "IPv6": "ff00::/8",
            "Name": "playbook-address-ipv6-multicast",
            "VDOM": "root"
        }
    }
}

Human Readable Output

Firewall Address IPv6 Multicasts

Name	Details
playbook-address-ipv6-multicast	ff00::/8

fortigate-create-firewall-address-ipv6-multicast

Create firewall IPv6 multicast addresses. Multicasting allows a single source to send data to multiple receivers efficiently, conserving bandwidth and minimizing network traffic. It is suitable for media streaming, news feeds, financial updates, and certain dynamic routing protocols like RIPv2, OSPF, and EIGRP.

Base Command

fortigate-create-firewall-address-ipv6-multicast

Input

Context Output

Command example

!fortigate-create-firewall-address-ipv6-multicast name=playbook-address-ipv6-multicast address=ff00:: mask=8

Context Example

{
    "Fortigate": {
        "Address6Multicast": {
            "IPAddress": "ff00::",
            "Mask": "8",
            "Name": "playbook-address-ipv6-multicast"
        }
    }
}

Human Readable Output

The firewall address multicast IPv6 ‘playbook-address-ipv6-multicast’ was successfully created

fortigate-update-firewall-address-ipv6-multicast

Update firewall IPv6 multicast addresses. Multicasting allows a single source to send data to multiple receivers efficiently, conserving bandwidth and minimizing network traffic. It is suitable for media streaming, news feeds, financial updates, and certain dynamic routing protocols like RIPv2, OSPF, and EIGRP.

Base Command

fortigate-update-firewall-address-ipv6-multicast

Input

Context Output

Command example

!fortigate-update-firewall-address-ipv6-multicast name=playbook-address-ipv6-multicast comment=helloworld

Context Example

{
    "Fortigate": {
        "Address6Multicast": {
            "Name": "playbook-address-ipv6-multicast"
        }
    }
}

Human Readable Output

The firewall address multicast IPv6 ‘playbook-address-ipv6-multicast’ was successfully updated

fortigate-delete-firewall-address-ipv6-multicast

Delete firewall IPv6 multicast addresses. Multicasting allows a single source to send data to multiple receivers efficiently, conserving bandwidth and minimizing network traffic. It is suitable for media streaming, news feeds, financial updates, and certain dynamic routing protocols like RIPv2, OSPF, and EIGRP.

Base Command

fortigate-delete-firewall-address-ipv6-multicast

Input

Context Output

Command example

!fortigate-delete-firewall-address-ipv6-multicast name=playbook-address-ipv6-multicast

Context Example

{
    "Fortigate": {
        "Address6Multicast": {
            "Deleted": true,
            "Name": "playbook-address-ipv6-multicast"
        }
    }
}

Human Readable Output

The firewall address multicast IPv6 ‘playbook-address-ipv6-multicast’ was successfully deleted

fortigate-list-firewall-address-ipv4-groups

Retrieve firewall IPv4 address groups. Address groups are designed for ease of use in the administration of the device.

Base Command

fortigate-list-firewall-address-ipv4-groups

Input

Context Output

Command example

!fortigate-list-firewall-address-ipv4-groups groupName=playbook-address-ipv4-group

Context Example

{
    "Fortigate": {
        "AddressGroup": {
            "AllowRouting": "disable",
            "Category": "default",
            "Comment": "",
            "Exclude": "disable",
            "FabricObject": "disable",
            "Member": {
                "Name": [
                    "playbook-address-ipv4-1"
                ]
            },
            "Name": "playbook-address-ipv4-group",
            "Type": "default",
            "UUID": "e7adb0ca-aa22-51ee-b304-c7fc8ce5e274",
            "VDOM": "root"
        }
    }
}

Human Readable Output

Firewall Address IPv4 Groups

Name	Details	Type	Routable
playbook-address-ipv4-group	playbook-address-ipv4-1	default	disable

fortigate-create-firewall-address-ipv4-group

Create firewall IPv4 address groups. Address groups are designed for ease of use in the administration of the device.

Base Command

fortigate-create-firewall-address-ipv4-group

Input

Context Output

Command example

!fortigate-create-firewall-address-ipv4-group groupName=playbook-address-ipv4-group address=playbook-address-ipv4-1

Context Example

{
    "Fortigate": {
        "AddressGroup": {
            "Address": "playbook-address-ipv4-1",
            "Name": "playbook-address-ipv4-group"
        }
    }
}

Human Readable Output

The firewall address IPv4 group ‘playbook-address-ipv4-group’ was successfully created

fortigate-update-firewall-address-ipv4-group

Update firewall IPv4 address groups. Address groups are designed for ease of use in the administration of the device. New members will override the existing members within the group incase of a conflict.

Base Command

fortigate-update-firewall-address-ipv4-group

Input

Context Output

Command example

!fortigate-update-firewall-address-ipv4-group groupName=playbook-address-ipv4-group address=playbook-address-ipv4-2 action=add

Context Example

{
    "Fortigate": {
        "AddressGroup": {
            "Address": {
                "Name": [
                    "playbook-address-ipv4-1",
                    "playbook-address-ipv4-2"
                ]
            },
            "Name": "playbook-address-ipv4-group",
            "UUID": "e7adb0ca-aa22-51ee-b304-c7fc8ce5e274"
        }
    }
}

Human Readable Output

The firewall address IPv4 group ‘playbook-address-ipv4-group’ was successfully updated

fortigate-delete-firewall-address-ipv4-group

Delete firewall IPv4 address groups. Address groups are designed for ease of use in the administration of the device.

Base Command

fortigate-delete-firewall-address-ipv4-group

Input

Context Output

Command example

!fortigate-delete-firewall-address-ipv4-group name=playbook-address-ipv4-group

Context Example

{
    "Fortigate": {
        "AddressGroup": {
            "Deleted": true,
            "Name": "playbook-address-ipv4-group"
        }
    }
}

Human Readable Output

The firewall address IPv4 group ‘playbook-address-ipv4-group’ was successfully deleted

fortigate-list-firewall-address-ipv6-groups

Retrieve firewall IPv6 address groups. Address groups are designed for ease of use in the administration of the device.

Base Command

fortigate-list-firewall-address-ipv6-groups

Input

Context Output

Command example

!fortigate-list-firewall-address-ipv6-groups name=playbook-address-ipv6-group

Context Example

{
    "Fortigate": {
        "Address6Group": {
            "Comment": "",
            "FabricObject": "disable",
            "Name": "playbook-address-ipv6-group",
            "UUID": "ecd06d9a-aa22-51ee-a0a1-29b8ccdf7714",
            "VDOM": "root"
        }
    }
}

Human Readable Output

Firewall Address IPv6 Groups

Name
playbook-address-ipv6-group

fortigate-create-firewall-address-ipv6-group

Create firewall IPv6 address groups. Address groups are designed for ease of use in the administration of the device.

Base Command

fortigate-create-firewall-address-ipv6-group

Input

Context Output

Command example

!fortigate-create-firewall-address-ipv6-group name=playbook-address-ipv6-group

Context Example

{
    "Fortigate": {
        "Address6Group": {
            "Address": null,
            "Name": "playbook-address-ipv6-group"
        }
    }
}

Human Readable Output

The firewall address IPv6 group ‘playbook-address-ipv6-group’ was successfully created

fortigate-update-firewall-address-ipv6-group

Update firewall IPv6 address groups. Address groups are designed for ease of use in the administration of the device. New members will override the existing members within the group incase of a conflict.

Base Command

fortigate-update-firewall-address-ipv6-group

Input

Context Output

Command example

!fortigate-update-firewall-address-ipv6-group name=playbook-address-ipv6-group members=playbook-address-ipv6-1 action=add

Context Example

{
    "Fortigate": {
        "Address6Group": {
            "Address": {
                "Name": [
                    "playbook-address-ipv6-1"
                ]
            },
            "Name": "playbook-address-ipv6-group"
        }
    }
}

Human Readable Output

The firewall address IPv6 group ‘playbook-address-ipv6-group’ was successfully updated

fortigate-delete-firewall-address-ipv6-group

Delete firewall IPv6 address groups. Address groups are designed for ease of use in the administration of the device.

Base Command

fortigate-delete-firewall-address-ipv6-group

Input

Context Output

Command example

!fortigate-delete-firewall-address-ipv6-group name=playbook-address-ipv6-group

Context Example

{
    "Fortigate": {
        "Address6Group": {
            "Deleted": true,
            "Name": "playbook-address-ipv6-group"
        }
    }
}

Human Readable Output

The firewall address IPv6 group ‘playbook-address-ipv6-group’ was successfully deleted

fortigate-list-firewall-services

Retrieve firewall services. A service is the combination of network protocols and port numbers that define traffic sources or destinations.

Base Command

fortigate-list-firewall-services

Input

Context Output

Command example

!fortigate-list-firewall-services serviceName=playbook-service

Context Example

{
    "Fortigate": {
        "Service": {
            "AppServiceType": "disable",
            "Category": "",
            "CheckResetRange": "default",
            "Comment": "",
            "FQDN": "",
            "FabricObject": "disable",
            "Helper": "auto",
            "IPRange": "0.0.0.0",
            "Name": "playbook-service",
            "Ports": {
                "SCTP": "5-6",
                "TCP": "1-2",
                "UDP": "3-4"
            },
            "Protocol": "TCP/UDP/SCTP",
            "Proxy": "disable",
            "SessionTTL": "0",
            "TCPHalfcloseTimer": 0,
            "TCPHalfopenTimer": 0,
            "TCPRSTTimer": 0,
            "TCPTimewaitTimer": 0,
            "UDPIdleTimer": 0,
            "VDOM": "root"
        }
    }
}

Human Readable Output

Firewall Services

Name	Details	IP/FQDN	Protocol
playbook-service	TCP/1-2 UDP/3-4 SCTP/5-6	0.0.0.0	TCP/UDP/SCTP

fortigate-create-firewall-service

Create firewall services. A service is the combination of network protocols and port numbers that define traffic sources or destinations. The command parameters can be used only in the following combinations: All-[vdom,name,comment,category], TCP/UDP/SCTP-[(start_ip,end_ip or fqdn),tcpRange,udpRange,sctpRange], IP-[ip_protocol], ICMP/ICMP6-[icmp_version,icmp_code,icmp_type].

Base Command

fortigate-create-firewall-service

Input

Context Output

Command example

!fortigate-create-firewall-service serviceName=playbook-service tcpRange=1-2 udpRange=3-4 sctpRange=5-6

Context Example

{
    "Fortigate": {
        "Service": {
            "Name": "playbook-service",
            "Ports": {
                "SCTP": "5-6",
                "TCP": "1-2",
                "UDP": "3-4"
            }
        }
    }
}

Human Readable Output

The firewall service ‘playbook-service’ was successfully created

fortigate-update-firewall-service

Update firewall services. A service is the combination of network protocols and port numbers that define traffic sources or destinations. The command parameters can be used only in the following combinations: All-[vdom,name,comment,category], TCP/UDP/SCTP-[(start_ip,end_ip or fqdn),tcpRange,udpRange,sctpRange], IP-[ip_protocol], ICMP/ICMP6-[icmp_version,icmp_code,icmp_type].

Base Command

fortigate-update-firewall-service

Input

Context Output

Command example

!fortigate-update-firewall-service name=playbook-service comment=helloworld

Context Example

{
    "Fortigate": {
        "Service": {
            "Name": "playbook-service",
            "Ports": {
                "SCTP": "",
                "TCP": "",
                "UDP": ""
            }
        }
    }
}

Human Readable Output

The firewall service ‘playbook-service’ was successfully updated

fortigate-delete-firewall-service

Delete firewall services. A service is the combination of network protocols and port numbers that define traffic sources or destinations.

Base Command

fortigate-delete-firewall-service

Input

Context Output

Command example

!fortigate-delete-firewall-service name=playbook-service

Context Example

{
    "Fortigate": {
        "Service": {
            "Deleted": true,
            "Name": "playbook-service"
        }
    }
}

Human Readable Output

The firewall service ‘playbook-service’ was successfully deleted

fortigate-list-firewall-service-groups

Retrieve firewall service groups. Service groups are collections of predefined services. Service groups can be used as the source and destination of the policy.

Base Command

fortigate-list-firewall-service-groups

Input

Context Output

Command example

!fortigate-list-firewall-service-groups name=playbook-service-group

Context Example

{
    "Fortigate": {
        "ServiceGroup": {
            "Comment": "",
            "FabricObject": "disable",
            "Member": {
                "Name": [
                    "playbook-service-1"
                ]
            },
            "Name": "playbook-service-group",
            "Proxy": "disable",
            "VDOM": "root"
        }
    }
}

Human Readable Output

Firewall Service Groups

Name	Members
playbook-service-group	playbook-service-1

fortigate-create-firewall-service-group

Create firewall service groups. Service groups are collections of predefined services. Service groups can be used as the source and destination of the policy.

Base Command

fortigate-create-firewall-service-group

Input

Context Output

Command example

!fortigate-create-firewall-service-group name=playbook-service-group members=playbook-service-1

Context Example

{
    "Fortigate": {
        "ServiceGroup": {
            "Members": "playbook-service-1",
            "Name": "playbook-service-group"
        }
    }
}

Human Readable Output

The firewall service group ‘playbook-service-group’ was successfully created

fortigate-update-firewall-service-group

Update firewall service groups. Service groups are collections of predefined services. Service groups can be used as the source and destination of the policy. New members will override the existing members within the group incase of a conflict.

Base Command

fortigate-update-firewall-service-group

Input

Context Output

Command example

!fortigate-update-firewall-service-group groupName=playbook-service-group comment=helloworld

Context Example

{
    "Fortigate": {
        "ServiceGroup": {
            "Name": "playbook-service-group",
            "Service": {
                "Name": [
                    "playbook-service-1"
                ]
            }
        }
    }
}

Human Readable Output

The firewall service group ‘playbook-service-group’ was successfully updated

fortigate-delete-firewall-service-group

Delete firewall service groups. Service groups are collections of predefined services. Service groups can be used as the source and destination of the policy.

Base Command

fortigate-delete-firewall-service-group

Input

Context Output

Command example

!fortigate-delete-firewall-service-group groupName=playbook-service-group

Context Example

{
    "Fortigate": {
        "ServiceGroup": {
            "Deleted": true,
            "Name": "playbook-service-group"
        }
    }
}

Human Readable Output

The firewall service group ‘playbook-service-group’ was successfully deleted

fortigate-list-firewall-policies

Retrieve firewall policies. Firewall policies dictate the traffic flow and its processing. They are integral to most of the firewall functions, ensuring that every piece of traffic passing through the unit adheres to a specific policy. These policies determine the direction of the traffic, processing method, and its permission to traverse the firewall.

Base Command

fortigate-list-firewall-policies

Input

Context Output

Command example

!fortigate-list-firewall-policies policyName=playbook-policy-123456789

Context Example

{
    "Fortigate": {
        "Policy": {
            "Action": "accept",
            "Description": "",
            "Destination": "playbook-address-ipv4-1",
            "Destination6Negate": "disable",
            "DestinationInterface": [
                "port2"
            ],
            "DestinationNegate": "disable",
            "ID": 18,
            "Log": "utm",
            "LogStart": "disable",
            "NAT": "enable",
            "Name": "playbook-policy-123456789",
            "Schedule": "always",
            "Security": [
                "no-inspection",
                "default",
                "single"
            ],
            "Service": [
                "playbook-service-1"
            ],
            "ServiceNegate": "disable",
            "Source": "playbook-address-ipv4-1",
            "Source6Negate": "disable",
            "SourceInterface": [
                "port1"
            ],
            "SourceNegate": "disable",
            "Status": "enable",
            "UUID": "cb72f302-aa22-51ee-eef0-cce9ba5b7ad3",
            "VDOM": "root"
        }
    }
}

Human Readable Output

Firewall Policies

ID	Name	From	To	Source	Destination	Schedule	Service	Action	NAT	Security Profiles	Log
18	playbook-policy-123456789	port1	port2	playbook-address-ipv4-1	playbook-address-ipv4-1	always	playbook-service-1	accept	enable	no-inspection, default, single	utm

fortigate-create-firewall-policy

Create firewall policies. Firewall policies dictate the traffic flow and its processing. They are integral to most of the firewall functions, ensuring that every piece of traffic passing through the unit adheres to a specific policy. These policies determine the direction of the traffic, processing method, and its permission to traverse the firewall.

Base Command

fortigate-create-firewall-policy

Input

Context Output

Command example

!fortigate-create-firewall-policy policyName=playbook-policy sourceIntf=port1 dstIntf=port2 action=accept service=playbook-service-1 source=playbook-address-ipv4-1 destination=playbook-address-ipv4-2

Context Example

{
    "Fortigate": {
        "Policy": {
            "Action": "accept",
            "Description": null,
            "Destination": {
                "Address": [
                    {
                        "name": "playbook-address-ipv4-2"
                    }
                ],
                "Address6": [
                    {
                        "name": ""
                    }
                ],
                "Interface": "port2"
            },
            "Log": "enable",
            "NAT": "enable",
            "Name": "playbook-policy",
            "Service": "playbook-service-1",
            "Source": {
                "Address": [
                    {
                        "name": "playbook-address-ipv4-1"
                    }
                ],
                "Address6": [
                    {
                        "name": ""
                    }
                ],
                "Interface": "port1"
            },
            "Status": "enable"
        }
    }
}

Human Readable Output

The firewall policy ‘playbook-policy’ was successfully created

fortigate-update-firewall-policy

Update firewall policies. Firewall policies dictate the traffic flow and its processing. They are integral to most of the firewall functions, ensuring that every piece of traffic passing through the unit adheres to a specific policy. These policies determine the direction of the traffic, processing method, and its permission to traverse the firewall.

Base Command

fortigate-update-firewall-policy

Input

Context Output

Command example

!fortigate-update-firewall-policy policyID=123456789 field=description value=helloworld

Context Example

{
    "Fortigate": {
        "Policy": {
            "Action": "accept",
            "Description": "helloworld",
            "Destination": "playbook-address-ipv4-2",
            "Destination6Negate": "disable",
            "DestinationInterface": [
                "port2"
            ],
            "DestinationNegate": "disable",
            "ID": 123456789,
            "Log": "utm",
            "LogStart": "disable",
            "NAT": "enable",
            "Name": "playbook-policy-222",
            "Schedule": "always",
            "Security": [
                "no-inspection",
                "default",
                "single"
            ],
            "Service": [
                "playbook-service-1"
            ],
            "ServiceNegate": "disable",
            "Source": "playbook-address-ipv4-1",
            "Source6Negate": "disable",
            "SourceInterface": [
                "port1"
            ],
            "SourceNegate": "disable",
            "Status": "enable",
            "UUID": "8aaa8c5e-aa22-51ee-b28a-472e6447ac59"
        }
    }
}

Human Readable Output

The firewall policy ‘123456789’ was successfully updated

fortigate-move-firewall-policy

Move the position of firewall policies. Firewall policies dictate the traffic flow and its processing. They are integral to most of the firewall functions, ensuring that every piece of traffic passing through the unit adheres to a specific policy. These policies determine the direction of the traffic, processing method, and its permission to traverse the firewall.

Base Command

fortigate-move-firewall-policy

Input

Context Output

Command example

!fortigate-move-firewall-policy policyID=123456789 position=after neighbor=1010101

Context Example

{
    "Fortigate": {
        "Policy": {
            "ID": "123456789",
            "Moved": true
        }
    }
}

Human Readable Output

The firewall policy ‘123456789’ was successfully moved

fortigate-delete-firewall-policy

Delete firewall policies. Firewall policies dictate the traffic flow and its processing. They are integral to most of the firewall functions, ensuring that every piece of traffic passing through the unit adheres to a specific policy. These policies determine the direction of the traffic, processing method, and its permission to traverse the firewall.

Base Command

fortigate-delete-firewall-policy

Input

Context Output

Command example

!fortigate-delete-firewall-policy policyID=123456789

Context Example

{
    "Fortigate": {
        "Policy": {
            "Deleted": true,
            "ID": "123456789"
        }
    }
}

Human Readable Output

The firewall policy ‘123456789’ was successfully deleted

fortigate-list-system-vdoms

Retrieve system VDOMs. Virtual Domains (VDOMs) are used to divide a FortiGate into two or more virtual units that function independently. VDOMs can provide separate security policies and, in NAT mode, completely separate configurations for routing and VPN services for each connected network. Multiple VDOMs can be created and managed as independent units in multi VDOM mode.

Base Command

fortigate-list-system-vdoms

Input

Context Output

Command example

#### Context Example

```json
{
    "Fortigate": {
        "VDOM": {
            "Name": "root",
            "ShortName": "root",
            "VClusterID": 0,
            "VDOM": "root"
        }
    }
}

Human Readable Output

Virtual Domains

Name	ShortName	VClusterID
root	root	0

fortigate-list-banned-ips

Retrieve Banned IPs. Banned IPs are IP addresses that have been quarantined for a variety of reasons, such as administrative decisions or due to security alerts from services like intrusion prevention systems (IPS), antivirus (AV), and denial-of-service (DoS) mitigation.

Base Command

fortigate-list-banned-ips

Input

Context Output

Command example

#### Context Example

```json
{
    "Fortigate": {
        "BannedIP": [
            {
                "Created": "2023-12-06 17:44:09",
                "Expires": "1970-01-01 00:00:00",
                "IP": "0.0.0.0",
                "IsV6": 0,
                "Source": "Administrative",
                "VDOM": "root"
            },
            {
                "Created": "2023-11-27 05:33:32",
                "Expires": "1970-01-01 00:00:00",
                "IP": "2.2.2.2",
                "IsV6": 0,
                "Source": "IPS",
                "VDOM": "root"
            },
            {
                "Created": "2023-11-27 05:33:41",
                "Expires": "1970-01-01 00:00:00",
                "IP": "3.3.3.3",
                "IsV6": 0,
                "Source": "AV",
                "VDOM": "root"
            },
            {
                "Created": "2023-11-27 05:33:49",
                "Expires": "1970-01-01 00:00:00",
                "IP": "4.4.4.4",
                "IsV6": 0,
                "Source": "DOS",
                "VDOM": "root"
            },
            {
                "Created": "2023-11-27 05:34:00",
                "Expires": "1970-01-01 00:00:00",
                "IP": "5.5.5.5",
                "IsV6": 0,
                "Source": "Administrative",
                "VDOM": "root"
            }
        ]
    }
}

Human Readable Output

Banned IPs

IP	IsV6	Created	Expires	Source
0.0.0.0	0	2023-12-06 17:44:09	1970-01-01 00:00:00	Administrative
2.2.2.2	0	2023-11-27 05:33:32	1970-01-01 00:00:00	IPS
3.3.3.3	0	2023-11-27 05:33:41	1970-01-01 00:00:00	AV
4.4.4.4	0	2023-11-27 05:33:49	1970-01-01 00:00:00	DOS
5.5.5.5	0	2023-11-27 05:34:00	1970-01-01 00:00:00	Administrative

fortigate-ban-ip

Ban IPs. Banned IPs are IP addresses that have been quarantined for a variety of reasons, such as administrative decisions or due to security alerts from services like intrusion prevention systems (IPS), antivirus (AV), and denial-of-service (DoS) mitigations.

Base Command

fortigate-ban-ip

Input

Context Output

There is no context output for this command.

Command example

!fortigate-ban-ip ip_address=0.0.0.0 expiry=0

Human Readable Output

The IPs ‘0.0.0.0’ were successfully banned

fortigate-unban-ip

Unban IPs. Banned IPs are IP addresses that have been quarantined for a variety of reasons, such as administrative decisions or due to security alerts from services like intrusion prevention systems (IPS), antivirus (AV), and denial-of-service (DoS) mitigations.

Base Command

fortigate-unban-ip

Input

Context Output

There is no context output for this command.

Command example

!fortigate-unban-ip ip_address=0.0.0.0

Human Readable Output

The IPs ‘0.0.0.0’ were successfully unbanned