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.

Network Security · FortiGate

Details

IDFortiGate
ProviderFortinet
CategoryNetwork Security
From Version5.0.0
Docker Imagedemisto/python3:3.12.13.10116658
Supported ModulesAgentix XSIAM EDR Cortex Cloud Cloud Runtime Security

README

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

Parameter Required
Server URL (e.g. https://192.168.0.1) True
Account username False
Password False
API Key False
API Key False
Trust any certificate (not secure) False
Use system proxy settings False

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

Argument Name Description Required
name Name of a specific address to return. Optional
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
filter_field Specifies the field to be searched, such as name or comment, to narrow down the search criteria within the objects. Fields must be written as they are in the raw_response. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/220620/config-firewall-address. Optional
filter_value Indicates the value or partial value, for example Sales, that the API should look for within the specified field to find matching objects. Optional
format_fields Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the raw_response, for example: name or comment. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/220620/config-firewall-address. Optional

Context Output

Path Type Description
Fortigate.Address.Name String Address name.
Fortigate.Address.Subnet String IP address and subnet mask of address.
Fortigate.Address.StartIP String First IP address (inclusive) in the range for the address.
Fortigate.Address.EndIP String Final IP address (inclusive) in the range for the address.
Fortigate.Address.FQDN String Fully Qualified Domain Name address.
Fortigate.Address.MACAddresses String Multiple MAC address ranges <start>[-<end>] separated by a space.
Fortigate.Address.Type String Type of the address. Can be: `ipmask`, `iprange`, `fqdn`, `geography`, `wildcard`, `dynamic`, `interface-subnet` or `mac`.
Fortigate.Address.FabricObject String Security Fabric global object setting. Can be `enable` or `disable`. If `enable`, the object is set as a security fabric-wide global object, otherwise the object is local to this security fabric member.
Fortigate.Address.AllowRouting String Enable/disable use of this address in the static route configuration.
Fortigate.Address.Tagging String List of tags associated to the object.
Fortigate.Address.IPs String List of IP addresses.
Fortigate.Address.SDNAddressType String Type of addresses to collect. Can be: `private`, `public`, or `all`.
Fortigate.Address.AssociatedInterface String Network interface associated with the address.
Fortigate.Address.Comment String The object`s comment.
Fortigate.Address.Dirty String Whether the object is clean.
Fortigate.Address.TagType String Tag type of dynamic address object.
Fortigate.Address.TagDetectionLevel String Tag detection level of dynamic address object.
Fortigate.Address.ObjectType String IP or MAC address.
Fortigate.Address.Interface String Name of the interface whose IP address is to be used.
Fortigate.Address.FSSOGroup String Fortinet Single Sign-On group name.
Fortigate.Address.SDN String Software-defined networking.
Fortigate.Address.SDNTag String Software-defined networking tag.
Fortigate.Address.CacheTTL Number Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
Fortigate.Address.Country String IP addresses associated to a specific country.
Fortigate.Address.ClearpassSPT String System Posture Token value. Can be: `unknown`, `healthy`, `quarantine`, `checkup`, `transient` or `infected`.
Fortigate.Address.SubType String Sub-type of address. Can be: `sdn`, `clearpass-spt`, `fsso`, `ems-tag`, `fortivoice-tag`, `fortinac-tag`, `fortipolicy-tag` or `swc-tag`.
Fortigate.Address.UUID String Universally Unique Identifier.
Fortigate.Address.ObjectTag String Tag of dynamic address object.
Fortigate.Address.VDOM String Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
name The name of the address to create. Required
address The IP address. Optional
mask The subnet mask as an IP address. Default value: 255.255.255.255. Optional
fqdn Fully Qualified Domain Name address. Optional
start_ip First IP address (inclusive) in the range for the address. Optional
end_ip Final IP address (inclusive) in the range for the address. Optional
country IP addresses associated to a specific country. Input must be according to the two-letter counter codes, for example: IL. Optional
mac_addresses Comma-separated list of MAC addresses. Can be single or range. Range must be separated by -, for examlpe: 00:00:00:00:00:00 or 00:00:00:00:00:00-FF:FF:FF:FF:FF:FF. Optional
associated_interface Network interface associated with address. Optional
allow_routing Enable/disable use of this address in the static route configuration. Possible values are: enable, disable. Optional
comment A comment for the address. Optional

Context Output

Path Type Description
Frotigate.Address.Name String The name of the updated address.
Frotigate.Address.IPAddress String The IP address.
Frotigate.Address.Mask String The subnet mask of the address.
Frotigate.Address.FQDN String The Fully Qualified Domain Name address.
Frotigate.Address.StartIP String First IP address (inclusive) in the range for the address.
Frotigate.Address.EndIP String Final IP address (inclusive) in the range for the address.
Frotigate.Address.Country String IP addresses associated to a specific country.
Frotigate.Address.MAC String MAC addresses.

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

Argument Name Description Required
name The name of the address to update. Names can be retrieved with the command fortigate-list-firewall-address-ipv4s. Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
address The IP address. Optional
mask The subnet mask of the address. Optional
fqdn Fully Qualified Domain Name address. Optional
start_ip First IP address (inclusive) in the range for the address. Optional
end_ip Final IP address (inclusive) in the range for the address. Optional
country IP addresses associated to a specific country. Input must be according to the two-letter counter codes, for example: IL. Optional
mac_addresses Comma-separated list of MAC addresses. Can be single or range. Range must be separated by -, for example: 00:00:00:00:00:00 or 00:00:00:00:00:00-FF:FF:FF:FF:FF:FF. Optional
associated_interface Network interface associated with address. Optional
allow_routing Enable/disable use of this address in the static route configuration. Possible values are: enable, disable. Optional
comment A comment for the address. Optional

Context Output

Path Type Description
Frotigate.Address.Name String The name of the created address.
Frotigate.Address.IPAddress String The IP address.
Frotigate.Address.Mask String The subnet mask of the address.
Frotigate.Address.FQDN String The Fully Qualified Domain Name address.
Frotigate.Address.StartIP String First IP address (inclusive) in the range for the address.
Frotigate.Address.EndIP String Final IP address (inclusive) in the range for the address.
Frotigate.Address.Country String IP addresses associated to a specific country.
Frotigate.Address.MAC String MAC addresses.

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

Argument Name Description Required
name Name of the address to delete. Names can be retrieved with the command fortigate-list-firewall-address-ipv4s. Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional

Context Output

Path Type Description
Frotigate.Address.Name String The name of the deleted address.
Frotigate.Address.Deleted Boolean Whether the address was deleted.

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

Argument Name Description Required
name Name of a specific address to return. Optional
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
filter_field Specifies the field to be searched, such as name or comment, to narrow down the search criteria within the objects. Fields must be written as they are in the raw_response. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/223620/config-firewall-address6. Optional
filter_value Indicates the value or partial value, for example Sales, that the API should look for within the specified field to find matching objects. Optional
format_fields Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the raw_response, for example: name or comment. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/223620/config-firewall-address6. Optional

Context Output

Path Type Description
Fortigate.Address6.FabricObject String Security Fabric global object setting. Can be `enable` or `disable`. If `enable`, the object is set as a security fabric-wide global object, otherwise the object is local to this security fabric member.
Fortigate.Address6.SDNTag String Software-defined networking tag.
Fortigate.Address6.Tenant String Specifies the instance or environment in a multi-tenancy setup for configuring address objects.
Fortigate.Address6.HostType String Can be a wildcard or a specific host address.
Fortigate.Address6.SubnetSegment.Name String The subnet segment name.
Fortigate.Address6.SubnetSegment.Type String The subnet segment type. Can be a wildcard or a specific address.
Fortigate.Address6.SubnetSegment.Value String The subnet segment value.
Fortigate.Address6.Template String IPv6 address template.
Fortigate.Address6.Comment String The object`s comment.
Fortigate.Address6.Tagging String List of tags associated to the object.
Fortigate.Address6.IPs String List of IP addresses.
Fortigate.Address6.Country String IP addresses associated to a specific country.
Fortigate.Address6.FQDN String Fully Qualified Domain Name address.
Fortigate.Address6.StartIP String First IP address (inclusive) in the range for the address.
Fortigate.Address6.EndIP String Final IP address (inclusive) in the range for the address.
Fortigate.Address6.IPv6 String IPv6 address prefix.
Fortigate.Address6.SDN String Software-defined networking.
Fortigate.Address6.MACAddresses Unknown Multiple MAC address ranges <start>[-<end>] separated by a space.
Fortigate.Address6.Type String Type of IPv6 address object. Can be: `ipprefix`, `iprange`, `fqdn`, `geography`, `dynamic`, `template`, `mac`.
Fortigate.Address6.UUID String Universally Unique Identifier.
Fortigate.Address6.Name String Address name.
Fortigate.Address6.Host String Host address.
Fortigate.Address6.CacheTTL Number Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
Fortigate.Address6.VDOM String Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
name Name of the address to create. Required
address IPv6 address prefix. Can be in short form (e.g., 2001:db8::) or long form (e.g., 0000:0000:0000:0000:0000:0000:0000:0000). Optional
mask Subnet mask indicating the prefix length (format: xxx, range: 0-128). Optional
fqdn Fully Qualified Domain Name address. Optional
start_ip First IP address (inclusive) in the range for the address. Optional
end_ip Final IP address (inclusive) in the range for the address. Optional
country IP addresses associated to a specific country. Input must be according to the two-letter counter codes, for example: IL. Optional
mac_addresses Comma-separated list of MAC addresses. Can be single or range. Range must be separated by -, for example: 00:00:00:00:00:00 or 00:00:00:00:00:00-FF:FF:FF:FF:FF:FF. Optional
sdn_connector Software-defined networking connector enables to interact with SDN controllers. For more information, go to: https://docs.fortinet.com/document/fortigate/7.2.5/administration-guide/753961/public-and-private-sdn-connectors. Optional
comment A comment for the address. Optional

Context Output

Path Type Description
Frotigate.Address6.Name String The name of the updated address.
Frotigate.Address6.IPAddress String The IP address.
Frotigate.Address6.Mask String The subnet mask of the address.
Frotigate.Address6.FQDN String The Fully Qualified Domain Name address.
Frotigate.Address6.StartIP String First IP address (inclusive) in the range for the address.
Frotigate.Address6.EndIP String Final IP address (inclusive) in the range for the address.
Frotigate.Address6.Country String IP addresses associated to a specific country.
Frotigate.Address6.MAC String MAC addresses.
Frotigate.Address6.SDN String Software-defined networking.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
name Name of the address to update. Names can be retrieved with the command fortigate-list-firewall-address-ipv6s. Required
type The type of the address to update. Possible values are: Subnet, IP Range, FQDN, Geography, Device (Mac Address), Fabric Connector Address. Optional
address The IP address. Optional
mask The subnet mask of the address. Optional
fqdn Fully Qualified Domain Name address. Optional
start_ip First IP address (inclusive) in the range for the address. Optional
end_ip Final IP address (inclusive) in the range for the address. Optional
country IP addresses associated to a specific country. Input must be according to the two-letter counter codes, for example: IL. Optional
mac_addresses Comma-separated list of MAC addresses. Can be single or range. Range must be separated by -, for example: 00:00:00:00:00:00 or 00:00:00:00:00:00-FF:FF:FF:FF:FF:FF. Optional
sdn_connector Software-defined networking connector enables to interact with SDN controllers. For more information, go to: https://docs.fortinet.com/document/fortigate/7.2.5/administration-guide/753961/public-and-private-sdn-connectors. Optional
comment A comment for the address. Optional

Context Output

Path Type Description
Frotigate.Address6.Name String The name of the updated address.
Frotigate.Address6.IPAddress String The IP address.
Frotigate.Address6.Mask String The subnet mask of the address.
Frotigate.Address6.FQDN String The Fully Qualified Domain Name address.
Frotigate.Address6.StartIP String First IP address (inclusive) in the range for the address.
Frotigate.Address6.EndIP String Final IP address (inclusive) in the range for the address.
Frotigate.Address6.Country String IP addresses associated to a specific country.
Frotigate.Address6.MAC String MAC addresses.
Frotigate.Address6.SDN String Software-defined networking.

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

Argument Name Description Required
name Name of the address to delete. Names can be retrieved with the command fortigate-list-firewall-address-ipv6s. Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional

Context Output

Path Type Description
Fortigate.Address6.Name String The name of the address.
Fortigate.Address6.Deleted Boolean Whether the address was deleted.

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

Argument Name Description Required
name Name of a specific address to return. Optional
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
filter_field Specifies the field to be searched, such as name or comment, to narrow down the search criteria within the objects. Fields must be written as they are in the raw_response. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/221620/config-firewall-multicast-address. Optional
filter_value Indicates the value or partial value, for example Sales, that the API should look for within the specified field to find matching objects. Optional
format_fields Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the raw_response, for example: name or comment. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/221620/config-firewall-multicast-address. Optional

Context Output

Path Type Description
Fortigate.AddressMulticast.Tagging String List of tags associated to the object.
Fortigate.AddressMulticast.AssociatedInterface String Network interface associated with address.
Fortigate.AddressMulticast.Comment String The object`s comment.
Fortigate.AddressMulticast.EndIP String Final IP address (inclusive) in the range for the address.
Fortigate.AddressMulticast.StartIP String First IP address (inclusive) in the range for the address.
Fortigate.AddressMulticast.Subnet String Broadcast address and subnet.
Fortigate.AddressMulticast.Type String Type of the address multicast. Can be: `multicastrange` or `broadcastmask`.
Fortigate.AddressMulticast.Name String Address multicast name.
Fortigate.AddressMulticast.VDOM String Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
name Name of the address multicast to create. Required
comment A comment for the address. Optional
associated_interface Network interface associated with address. Optional
type Specifies the format of the multicast address. Possible values are: Broadcast Subnet, Multicast IP Range. Required
first_ip For Broadcast Subnet, this is the network address. For Multicast IP Range, (inclusive) this is the beginning of the IP range. Required
final_ip For Broadcast Subnet this should be the network mask as an IP address. For Multicast IP Range, (inclusive) this is the end of the IP range. Required

Context Output

Path Type Description
Frotigate.AddressMulticast.Name String The name of the updated address multicast.
Frotigate.AddressMulticast.Type String Specifies the format of the multicast address.
Frotigate.AddressMulticast.FirstIP String First input IP address.
Frotigate.AddressMulticast.FinalIP String Final input IP address.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
name Name of the address multicast to update. Names can be retrieved with the command fortigate-list-firewall-address-ipv4-multicasts. Required
comment A comment for the address. Optional
associated_interface Network interface associated with address. Optional
type Specifies the format of the multicast address. Possible values are: Broadcast Subnet, Multicast IP Range. Optional
first_ip For ‘Broadcast Subnet’, this is the network address. For ‘Multicast IP Range’, (inclusive) this is the beginning of the IP range. Optional
final_ip For ‘Broadcast Subnet’ this should be the network mask as an IP address. For Multicast IP Range, (inclusive) this is the end of the IP range. Optional

Context Output

Path Type Description
Frotigate.AddressMulticast.Name String The name of the updated address multicast.
Frotigate.AddressMulticast.Type String Specifies the format of the multicast address.
Frotigate.AddressMulticast.FirstIP String First input IP address.
Frotigate.AddressMulticast.FinalIP String Final input IP address.

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

Argument Name Description Required
name Name of the address multicast to delete. Names can be retrieved with the command fortigate-list-firewall-address-ipv4-multicasts. Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional

Context Output

Path Type Description
Fortigate.AddressMulticast.Name String The name of the address multicast.
Fortigate.AddressMulticast.Deleted Boolean Whether the address multicast was deleted.

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

Argument Name Description Required
name Name of a specific address multicast to return. Optional
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
filter_field Specifies the field to be searched, such as name or comment, to narrow down the search criteria within the objects. Fields must be written as they are in the raw_response. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/224620/config-firewall-multicast-address6. Optional
filter_value Indicates the value or partial value, for example Sales, that the API should look for within the specified field to find matching objects. Optional
format_fields Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the raw_response, for example: name or comment. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/224620/config-firewall-multicast-address6. Optional

Context Output

Path Type Description
Fortigate.Address6Multicast.Tagging String List of tags associated to the object.
Fortigate.Address6Multicast.Comment String The object`s comment.
Fortigate.Address6Multicast.IPv6 String Broadcast address and subnet.
Fortigate.Address6Multicast.Name String Address multicast name.
Fortigate.Address6Multicast.VDOM String Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
name Name of the address multicast to create. Required
comment A comment for the address. Optional
address IPv6 address prefix. Can be in short form (e.g., 2001:db8::) or long form (e.g., 0000:0000:0000:0000:0000:0000:0000:0000). Required
mask Subnet mask indicating the prefix length (format: xxx, range: 0-128). Required

Context Output

Path Type Description
Frotigate.Address6Multicast.Name String The name of the updated address multicast.
Frotigate.Address6Multicast.IPAddress String The IP address.
Frotigate.Address6Multicast.Mask String The subnet mask of the address.

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

Argument Name Description Required
name Name of the address multicast to update. Names can be retrieved with the command fortigate-list-firewall-address-ipv6-multicasts. Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
comment A comment for the address. Optional
address IPv6 address prefix. Can be in short form (e.g., 2001:db8::) or long form (e.g., 0000:0000:0000:0000:0000:0000:0000:0000). Optional
mask Subnet mask indicating the prefix length (format: xxx, range: 0-128). Optional

Context Output

Path Type Description
Frotigate.Address6Multicast.Name String The name of the updated address multicast.
Frotigate.Address6Multicast.IPAddress String The IP address.
Frotigate.Address6Multicast.Mask String The subnet mask of the address.

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

Argument Name Description Required
name Name of the address multicast to delete. Names can be retrieved with the command fortigate-list-firewall-address-ipv6-multicasts. Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional

Context Output

Path Type Description
Fortigate.Address6Multicast.Name String The name of the address multicast.
Fortigate.Address6Multicast.Deleted Boolean Whether the address multicast was deleted.

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

Argument Name Description Required
groupName Name of a specific address group to return. Optional
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
filter_field Specifies the field to be searched, such as name or comment, to narrow down the search criteria within the objects. Fields must be written as they are in the raw_response. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/225620/config-firewall-addrgrp. Optional
filter_value Indicates the value or partial value, for example Sales, that the API should look for within the specified field to find matching objects. Optional
format_fields Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the raw_response, for example: name or comment. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/225620/config-firewall-addrgrp. Optional

Context Output

Path Type Description
Frotigate.AddressGroup.FabricObject String Security Fabric global object setting. Can be `enable` or `disable`. If `enable`, the object is set as a security fabric-wide global object, otherwise the object is local to this security fabric member.
Frotigate.AddressGroup.AllowRouting String Enable/disable use of this address in the static route configuration.
Frotigate.AddressGroup.Tagging String List of tags associated to the object.
Frotigate.AddressGroup.ExcludeMember String Address name exclusion member.
Frotigate.AddressGroup.Exclude String Enable/disable address exclusion.
Frotigate.AddressGroup.Comment String The object`s comment.
Frotigate.AddressGroup.Member.Name String Address objects contained within the group.
Frotigate.AddressGroup.UUID String Universally Unique Identifier.
Frotigate.AddressGroup.Category String Address group category. `default`: Default address group category (cannot be used as ztna-ems-tag/ztna-geo-tag in policy). `ztna-ems-tag`: Members must be ztna-ems-tag group or ems-tag address. Can be used as ztna-ems-tag in policy. `ztna-geo-tag`: Members must be ztna-geo-tag group or geographic address. Can be used as ztna-geo-tag in policy.
Frotigate.AddressGroup.Type String Address group type. Default address group type (address may belong to multiple groups). Address folder group (members may not belong to any other group).
Frotigate.AddressGroup.Name String Address group name.
Fortigate.AddressGroup.VDOM String Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
groupName Name of the address group to create. Required
type Address group type. group: Default address group type (address may belong to multiple groups). folder: Address folder group (members may not belong to any other group). Possible values are: group, folder. Default is group. Optional
address Comma-separated list of address names. Names can be retrieved with the commands fortigate-list-firewall-address-ipv4s, fortigate-list-firewall-address-ipv4-multicasts and fortigate-list-firewall-address-ipv4-groups. Optional
excluded_addresses Comma-separated list of address names to exclude. Names can be retrieved with the commands fortigate-list-firewall-address-ipv4s, fortigate-list-firewall-address-ipv4-multicasts and fortigate-list-firewall-address-ipv4-groups. Optional
allow_routing Enable/disable use of this address in the static route configuration. Possible values are: enable, disable. Optional
comment A comment for the address group. Optional

Context Output

Path Type Description
Fortigate.AddressGroup.Name String The address group name.
Fortigate.AddressGroup.Address String The address group members.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
groupName Name of the address group to update. Names can be retrieved with the command fortigate-list-firewall-address-ipv4-groups. Required
address Comma-separated list of address names. Names can be retrieved with the commands fortigate-list-firewall-address-ipv4s, fortigate-list-firewall-address-ipv4-multicasts and fortigate-list-firewall-address-ipv4-groups. Optional
excluded_addresses Comma-separated list of address names to exclude. Names can be retrieved with the commands fortigate-list-firewall-address-ipv4s, fortigate-list-firewall-address-ipv4-multicasts and fortigate-list-firewall-address-ipv4-groups. Optional
allow_routing Enable/disable use of this address in the static route configuration. Possible values are: enable, disable. Optional
comment A comment for the address group. Optional
action Whether to add or remove members or excluded_members from address group. Possible values are: add, remove. Optional

Context Output

Path Type Description
Fortigate.AddressGroup.Name String The address group name.
Fortigate.AddressGroup.Address.Name String The address group members.
Frotigate.AddressGroup.UUID String Universally Unique Identifier.

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

Argument Name Description Required
name Name of the address group to delete. Names can be retrieved with the command fortigate-list-firewall-address-ipv4-groups. Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional

Context Output

Path Type Description
Fortigate.AddressGroup.Name String The name of the address group.
Fortigate.AddressGroup.Deleted Boolean Whether the address group was deleted.

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

Argument Name Description Required
name Name of a specific address group to return. Optional
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
filter_field Specifies the field to be searched, such as name or comment, to narrow down the search criteria within the objects. Fields must be written as they are in the raw_response. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/226620/config-firewall-addrgrp6. Optional
filter_value Indicates the value or partial value, for example Sales, that the API should look for within the specified field to find matching objects. Optional
format_fields Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the raw_response, for example: name or comment. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/226620/config-firewall-addrgrp6. Optional

Context Output

Path Type Description
Frotigate.Address6Group.FabricObject String Security Fabric global object setting. Can be `enable` or `disable`. If `enable`, the object is set as a security fabric-wide global object, otherwise the object is local to this security fabric member.
Frotigate.Address6Group.Tagging String List of tags associated to the object.
Frotigate.Address6Group.Member.Name String Address objects contained within the group.
Frotigate.Address6Group.Comment String The object`s comment.
Frotigate.Address6Group.UUID String Universally Unique Identifier.
Frotigate.Address6Group.Name String Address group name.
Fortigate.Address6Group.VDOM String Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
name Name of the address group to create. Required
members Comma-separated list of address names. Names can be retrieved with the commands fortigate-list-firewall-address-ipv6s, fortigate-list-firewall-address-ipv6-multicasts and fortigate-list-firewall-address-ipv6-groups. Optional
comment A comment for the address group. Optional

Context Output

Path Type Description
Fortigate.Address6Group.Name String The address group name.
Fortigate.Address6Group.Address String The address group members.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
name Name of the address group to update. Names can be retrieved with the command fortigate-list-firewall-address-ipv6-groups. Required
members Comma-separated list of address names. Names can be retrieved with the commands fortigate-list-firewall-address-ipv6s, fortigate-list-firewall-address-ipv6-multicasts and fortigate-list-firewall-address-ipv6-groups. Optional
comment A comment for the address group. Optional
action Whether to add or remove members from address group. Possible values are: add, remove. Optional

Context Output

Path Type Description
Fortigate.Address6Group.Name String The address group name.
Fortigate.Address6Group.Address String The address group members.

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

Argument Name Description Required
name Name of the address group to delete. Names can be retrieved with the command fortigate-list-firewall-address-ipv6-groups. Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional

Context Output

Path Type Description
Fortigate.Address6Group.Name String The name of the deleted address group.
Fortigate.Address6Group.Deleted Boolean Whether the address group was deleted.

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

Argument Name Description Required
serviceName Name of a specific service to return. Optional
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
filter_field Specifies the field to be searched, such as name or comment, to narrow down the search criteria within the objects. Fields must be written as they are in the raw_response. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/231620/config-firewall-service-custom. Optional
filter_value Indicates the value or partial value, for example Sales, that the API should look for within the specified field to find matching objects. Optional
format_fields Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the raw_response, for example: name or comment. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/231620/config-firewall-service-custom. Optional

Context Output

Path Type Description
Fortigate.Service.FabricObject String Security Fabric global object setting. Can be `enable` or `disable`. If `enable`, the object is set as a security fabric-wide global object, otherwise the object is local to this security fabric member.
Fortigate.Service.Application Number The application ID.
Fortigate.Service.AppCategory Number Application category ID.
Fortigate.Service.AppServiceType String Application service type. Can be: `disable`, `app-id` or `app-category`.
Fortigate.Service.Comment String The object`s comment.
Fortigate.Service.CheckResetRange String The configuration type of ICMP error message verification.
Fortigate.Service.SessionTTL String Session time to live.
Fortigate.Service.UDPIdleTimer Number Number of seconds before an idle UDP connection times out.
Fortigate.Service.TCPRSTTimer Number Set the length of the TCP CLOSE state in seconds.
Fortigate.Service.TCPTimewaitTimer Number Set the length of the TCP TIME-WAIT state in seconds.
Fortigate.Service.TCPHalfopenTimer Number Wait time to close a TCP session waiting for an unanswered open session packet.
Fortigate.Service.TCPHalfcloseTimer Number Wait time to close a TCP session waiting for an unanswered open session packet.
Fortigate.Service.Ports.SCTP String Multiple SCTP port ranges.
Fortigate.Service.Ports.UDP String Multiple UDP port ranges.
Fortigate.Service.Ports.TCP String Multiple TCP port ranges.
Fortigate.Service.FQDN String Fully Qualified Domain Name address.
Fortigate.Service.IPRange String Start and end of the IP range associated with the service.
Fortigate.Service.Helper String Helper protocol name.
Fortigate.Service.Protocol String Protocol type based on IANA numbers.
Fortigate.Service.Category String The service category.
Fortigate.Service.Proxy String Enable/disable web proxy service.
Fortigate.Service.Name String The service name.
Fortigate.Service.ICMPCode Number ICMP code.
Fortigate.Service.ICMPType Number ICMP type.
Fortigate.Service.ProtocolNumber Number IP protocol number.
Fortigate.Service.VDOM String Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
serviceName Name of the service to create. Required
comment A comment for the service. Optional
category Service category. Optional
start_ip Start of the IP range associated with the service. Optional
end_ip End of the IP range associated with the service. Optional
fqdn Fully Qualified Domain Name address. Optional
tcpRange Comma-separated list of TCP ports. Must be in the following template: {single} for example 5, {start}-{end} for example 1-50 or {start_source}-{end_source}:{start_destination}-{end_destinatinon} for example 1-3:6-9. Optional
udpRange Comma-separated list of TCP ports. Must be in the following template: {single} for example 5, {start}-{end} for example 1-50 or {start_source}-{end_source}:{start_destination}-{end_destinatinon} for example 1-3:6-9. Optional
sctpRange Comma-separated list of TCP ports. Must be in the following template: {single} for example 5, {start}-{end} for example 1-50 or {start_source}-{end_source}:{start_destination}-{end_destinatinon} for example 1-3:6-9. Optional
icmp_type Specifies the ICMP message type, defining the purpose or condition of the message. Optional
icmp_code Identifies the variant or additional information for the corresponding ICMP message type. Optional
icmp_version Determines the version of the Internet Control Message Protocol, either ICMP or ICMP6. Possible values are: ICMP, ICMP6. Optional
ip_protocol IP protocol number. Optional

Context Output

Path Type Description
Fortigate.Service.Ports.SCTP String Multiple SCTP port ranges.
Fortigate.Service.Ports.UDP String Multiple UDP port ranges.
Fortigate.Service.Ports.TCP String Multiple TCP port ranges.
Fortigate.Service.FQDN String Fully Qualified Domain Name address.
Fortigate.Service.StartIP String Start of the IP range associated with the service.
Fortigate.Service.EndIP String End of the IP range associated with the service.
Fortigate.Service.ICMPCode Number ICMP code.
Fortigate.Service.ICMPType Number ICMP type.
Fortigate.Service.ProtocolNumber Number IP protocol number.
Fortigate.Service.Name String The service name.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
name Name of the service to update. Names can be retrieved with the command fortigate-list-firewall-services. Required
comment A comment for the service. Optional
category Service category. Optional
start_ip Start of the IP range associated with the service. Optional
end_ip End of the IP range associated with the service. Optional
fqdn Fully Qualified Domain Name address. Optional
tcpRange Comma-separated list of TCP ports. Must be in the following template: {single} for example 5, {start}-{end} for example 1-50 or {start_source}-{end_source}:{start_destination}-{end_destinatinon} for example 1-3:6-9. Optional
udpRange Comma-separated list of TCP ports. Must be in the following template: {single} for example 5, {start}-{end} for example 1-50 or {start_source}-{end_source}:{start_destination}-{end_destinatinon} for example 1-3:6-9. Optional
sctpRange Comma-separated list of TCP ports. Must be in the following template: {single} for example 5, {start}-{end} for example 1-50 or {start_source}-{end_source}:{start_destination}-{end_destinatinon} for example 1-3:6-9. Optional
action Whether to add or remove destination and source ports from TCP/UDP/SCTP. Possible values are: add, remove. Optional
icmp_type Specifies the ICMP message type, defining the purpose or condition of the message. Optional
icmp_code Identifies the variant or additional information for the corresponding ICMP message type. Optional
icmp_version Determines the version of the Internet Control Message Protocol, either ICMPv4 or ICMPv6. Possible values are: icmp4, icmp6. Optional
ip_protocol IP protocol number. Optional

Context Output

Path Type Description
Fortigate.Service.Ports.SCTP String Multiple SCTP port ranges.
Fortigate.Service.Ports.UDP String Multiple UDP port ranges.
Fortigate.Service.Ports.TCP String Multiple TCP port ranges.
Fortigate.Service.FQDN String Fully Qualified Domain Name address.
Fortigate.Service.IPRange String Start and end of the IP range associated with the service.
Fortigate.Service.ICMPCode Number ICMP code.
Fortigate.Service.ICMPType Number ICMP type.
Fortigate.Service.ProtocolNumber Number IP protocol number.
Fortigate.Service.Name String The service name.

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

Argument Name Description Required
name Name of the service to delete. Names can be retrieved with the command fortigate-list-firewall-services. Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional

Context Output

Path Type Description
Fortigate.Service.Name String The name of the deleted service.
Fortigate.Service.Deleted Boolean Whether the service was deleted.

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

Argument Name Description Required
name Name of a specific service group to return. Optional
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
filter_field Specifies the field to be searched, such as name or comment, to narrow down the search criteria within the objects. Fields must be written as they are in the raw_response. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/232620/config-firewall-service-group. Optional
filter_value Indicates the value or partial value, for example Sales, that the API should look for within the specified field to find matching objects. Optional
format_fields Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the raw_response, for example: name or comment. Fields must be written as they are in the raw_response. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/232620/config-firewall-service-group. Optional

Context Output

Path Type Description
Fortigate.ServiceGroup.FabricObject String Security Fabric global object setting. Can be `enable` or `disable`. If `enable`, the object is set as a security fabric-wide global object, otherwise the object is local to this security fabric member.
Fortigate.ServiceGroup.Comment String The object`s comment.
Fortigate.ServiceGroup.Proxy String Enable/disable web proxy service.
Fortigate.ServiceGroup.Name String The service group name.
Frotigate.ServiceGroup.Member.Name String Service objects contained within the group.
Fortigate.ServiceGroup.VDOM String Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
name Name of the service group to create. Required
comment A comment for the service group. Optional
members Comma-separated list of service and service group names. Names can be retrieved with the commands fortigate-list-firewall-services and fortigate-list-firewall-service-groups. Required

Context Output

Path Type Description
Fortigate.ServiceGroup.Name String The service group name.
Fortigate.ServiceGroup.Members String Service objects contained within the group.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
groupName Name of the service group to update. Names can be retrieved with the command fortigate-list-firewall-service-groups. Required
comment A comment for the service group. Optional
serviceName Comma-separated list of service and service group names. Names can be retrieved with the commands fortigate-list-firewall-services and fortigate-list-firewall-service-groups. Optional
action Whether to add or remove members from the service group. Possible values are: add, remove. Optional

Context Output

Path Type Description
Fortigate.ServiceGroup.Name String The service group name.
Fortigate.ServiceGroup.Service.Name String Service objects contained within the group.

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

Argument Name Description Required
groupName Name of the service group to delete. Names can be retrieved with the command fortigate-list-firewall-service-groups. Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional

Context Output

Path Type Description
Fortigate.ServiceGroup.Name String The name of the deleted service group.
Fortigate.ServiceGroup.Deleted Boolean Whether the service group was deleted.

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

Argument Name Description Required
policyID ID of a specific policy to return. Optional
policyName Name of a specific policy to return. Optional
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
filter_field Specifies the field to be searched, such as name or comment, to narrow down the search criteria within the objects. Fields must be written as they are in the raw_response. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/287620/config-firewall-policy. Optional
filter_value Indicates the value or partial value, for example Sales, that the API should look for within the specified field to find matching objects. Optional
format_fields Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the raw_response, for example: name or comment. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/287620/config-firewall-policy. Optional

Context Output

Path Type Description
Fortigate.Policy.ServiceNegate String When enabled specifies what the service must not be.
Fortigate.Policy.Destination6Negate String When enabled, specifies what the destination IPv6 address must not be.
Fortigate.Policy.DestinationNegate String When enabled, specifies what the destination IPv4 address must not be.
Fortigate.Policy.Source6Negate String When enabled, specifies what the source IPv6 address must not be.
Fortigate.Policy.SourceNegate String When enabled, specifies what the source IPv4 address must not be.
Fortigate.Policy.NAT String Whether the source NAT is enabled or disabled.
Fortigate.Policy.LogStart String Whether recording logs when a session starts is enabled or disabled.
Fortigate.Policy.Log String All log sessions or security profile sessions.
Fortigate.Policy.Service String Service and service group names.
Fortigate.Policy.Source6 String Source IPv6 address name and address group names.
Fortigate.Policy.Destination6 String Destination IPv6 address name and address group names.
Fortigate.Policy.Destination String Destination IPv4 address and address group names.
Fortigate.Policy.Source String Source IPv4 address and address group names.
Fortigate.Policy.Action String Policy action (accept/deny/ipsec).
Fortigate.Policy.DestinationInterface String Outgoing (egress) interface.
Fortigate.Policy.SourceInterface String Incoming (ingress) interface.
Fortigate.Policy.UUID String Universally Unique Identifier.
Fortigate.Policy.Name String The policy name.
Fortigate.Policy.Status String Whether this policy is enabled or disabled.
Fortigate.Policy.ID Number The policy ID.
Fortigate.Policy.Description String The policy description.
Fortigate.Policy.Security String Policy attached security profile.
Fortigate.Policy.VDOM String Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.
Fortigate.Policy.Schedule String The name of the schedule.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
policyName Name of the policy to create. Required
description The policy description. Optional
sourceIntf Comma-separated list of incoming (ingress) interfaces. Required
dstIntf Comma-separated list of outgoing (egress) interfaces. Required
source Comma-separated list of source IPv4 address and address group names. Names can be retrieved with the commands fortigate-list-firewall-address-ipv4s, fortigate-list-firewall-address-ipv4-multicasts and fortigate-list-firewall-address-ipv4-groups. Optional
source6 Comma-separated list of source IPv6 address name and address group names. Names can be retrieved with the commands fortigate-list-firewall-address-ipv6s, fortigate-list-firewall-address-ipv6-multicasts and fortigate-list-firewall-address-ipv6-groups. Optional
destination Comma-separated list of destination IPv4 address and address group names. Names can be retrieved with the commands fortigate-list-firewall-address-ipv4s, fortigate-list-firewall-address-ipv4-multicasts and fortigate-list-firewall-address-ipv4-groups. Optional
destination6 Comma-separated list of destination IPv6 address name and address group names. Names can be retrieved with the commands fortigate-list-firewall-address-ipv6s, fortigate-list-firewall-address-ipv6-multicasts and fortigate-list-firewall-address-ipv6-groups. Optional
negate_source_address When enabled, the source address specifies what the source address must not be. Possible values are: enable, disable. Optional
negate_destination_address When enabled, the destination address specifies what the destination address must not be. Possible values are: enable, disable. Optional
service Comma-separated list of service and service group names. Names can be retrieved with the commands fortigate-list-firewall-services and fortigate-list-firewall-service-groups. Required
negate_service When enabled, the service specifies what the service must not be. Possible values are: enable, disable. Optional
action Whether to accept or deny sessions that match the firewall policy. Possible values are: accept, block. Required
status Enable or disable this policy. Possible values are: enable, disable. Default is enable. Optional
log Enable or disable logging. Log all sessions or security profile sessions. Possible values are: all, utm, disable. Default is enable. Optional
schedule The schedule name. This is a time frame that is applied to the policy. Default is always. Optional
nat Enable/disable source Network Address Translation. Possible values are: enable, disable. Default is enable. Optional

Context Output

Path Type Description
Fortigate.Policy.NAT String Whether the source NAT is enabled or disabled.
Fortigate.Policy.Log String All log sessions or security profile sessions.
Fortigate.Policy.Service String Service and service group names.
Fortigate.Policy.Source.Address6.name String Source IPv6 address name and address group names.
Fortigate.Policy.Destination.Address6.name String Destination IPv6 address name and address group names.
Fortigate.Policy.Destination.Address.name String Destination IPv4 address and address group names.
Fortigate.Policy.Source.Address.name String Source IPv4 address and address group names.
Fortigate.Policy.Action String Policy action (accept/deny/ipsec).
Fortigate.Policy.Destination.Interface String Outgoing (egress) interface.
Fortigate.Policy.Source.Interface String Incoming (ingress) interface.
Fortigate.Policy.Name String The policy name.
Fortigate.Policy.Status String Whether this policy is enabled or disabled.
Fortigate.Policy.Description String The policy description.

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

Argument Name Description Required
policyID ID of the policy to update. IDs can be retrieved with the command fortigate-list-firewall-policies. Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
field Field parameter to update. Possible values are: source_interface, destination_interface, description, status, source, destination, service, schedule, action, log, nat, source6, destination6, negate_source, negate_destination, negate_source6, negate_destination6, negate_service. Required
value Value of the field parameter to update. Required
keep_original_data Whether to keep the original data or not. Only relevant if the updated field is “source” or “destination”. If the supplied value is True, the current data will not be replaced. Instead, the supplied addresses will be added / removed from the existing data. Possible values are: true, false. Optional
add_or_remove Whether to add or remove the supplied addresses from the existing data. Only relevant in case the field to update is “source” or “destination”, and keep_original_data is specified to True. Possible values are: add, remove. Optional

Context Output

Path Type Description
Fortigate.Policy.ServiceNegate String When enabled, specifies what the service must not be.
Fortigate.Policy.Destination6Negate String When enabled, specifies what the destination IPv6 address must not be.
Fortigate.Policy.DestinationNegate String When enabled, specifies what the destination IPv4 address must not be.
Fortigate.Policy.Source6Negate String When enabled, specifies what the source IPv6 address must not be.
Fortigate.Policy.SourceNegate String When enabled, specifies what the source IPv4 address must not be.
Fortigate.Policy.NAT String Whether the source NAT is enabled or disabled.
Fortigate.Policy.LogStart String Whether recording logs when a session starts is enabled or disabled.
Fortigate.Policy.Log String All log sessions or security profile sessions.
Fortigate.Policy.Service String Service and service group names.
Fortigate.Policy.Source6 String Source IPv6 address name and address group names.
Fortigate.Policy.Destination6 String Destination IPv6 address name and address group names.
Fortigate.Policy.Destination String Destination IPv4 address and address group names.
Fortigate.Policy.Source String Source IPv4 address and address group names.
Fortigate.Policy.Action String Policy action (accept/deny/ipsec).
Fortigate.Policy.DestinationInterface String Outgoing (egress) interface.
Fortigate.Policy.SourceInterface String Incoming (ingress) interface.
Fortigate.Policy.UUID String Universally Unique Identifier.
Fortigate.Policy.Name String The policy name.
Fortigate.Policy.Status String Whether this policy is enabled or disabled.
Fortigate.Policy.ID Number The policy ID.
Fortigate.Policy.Description String The policy description.
Fortigate.Policy.Security String Policy attached security profile.
Fortigate.Policy.Schedule String The name of the schedule.

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

Argument Name Description Required
policyID ID of the policy to move. IDs can be retrieved with the command fortigate-list-firewall-policies. Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
position Whether to position the policy before or after its neighbor. Possible values are: before, after. Required
neighbor The ID of the neighbor policy. IDs can be retrieved with the command fortigate-list-firewall-policies. Required

Context Output

Path Type Description
Fortigate.Policy.ID Number The policy ID.
Fortigate.Policy.Moved Boolean Whether the policy was moved.

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

Argument Name Description Required
policyID ID of the policy to delete. IDs can be retrieved with the command fortigate-list-firewall-policies. Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional

Context Output

Path Type Description
Fortigate.Policy.ID Number The policy ID.
Fortigate.Policy.Deleted Boolean Whether the policy was deleted.

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

Argument Name Description Required
filter_field Specifies the field to be searched, such as name or comment, to narrow down the search criteria within the objects. Fields must be written as they are in the raw_response. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/620/config-system-vdom. Optional
filter_value Indicates the value or partial value, for example Sales, that the API should look for within the specified field to find matching objects. Optional
format_fields Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the raw_response, for example: name or comment. Reference to possible fields: https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/620/config-system-vdom. Optional

Context Output

Path Type Description
Fortigate.VDOM.VClusterID Number Virtual cluster ID.
Fortigate.VDOM.ShortName String The virtual domain short name.
Fortigate.VDOM.Name String The virtual domain name.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
filter_field Specifies the field to be searched, such as name or comment, to narrow down the search criteria within the objects. Fields must be written as they are in the raw_response. Optional
filter_value Indicates the value or partial value, for example Sales, that the API should look for within the specified field to find matching objects. Optional
format_fields Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the raw_response, for example: name or comment. Optional

Context Output

Path Type Description
Fortigate.BannedIP.IsV6 Number Whether the IP is IPv4 (0) or IPv6 (1).
Fortigate.BannedIP.Source String Source of the ban.
Fortigate.BannedIP.IP String The IPv4 address.
Fortigate.BannedIP.Created Number Date/time the IP address was added to the banned list.
Fortigate.BannedIP.Expires Number Date/time the IP address expires from the banned list.
Fortigate.BannedIP.VDOM String Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
ip_address Comma-separated list of IPs to ban. Both IPv4 and IPv6 addresses are supported. Required
expiry Time until the ban expires in seconds. 0 for indefinite ban. Default is 0. Optional

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

Argument Name Description Required
vdom Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use * to retrieve all virtual domains. VDOMs can be retrieved with the command fortigate-list-system-vdoms. Default is root. Optional
ip_address Comma-separated list of IPs to unban. Both IPv4 and IPv6 addresses are supported. IPs can be retrieved with the command fortigate-list-banned-ips. Required

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

Configuration parameters

  • server — Server URL (e.g. https://192.168.0.1) (required)
  • credentials — Account username
  • api_key — API Key
  • unsecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings

Commands (58)

  • 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.

  • fortigate-create-address Deprecated

    Deprecated. Use `fortigate-create-firewall-address-ipv4` instead. Creates a new address object.

  • fortigate-create-address-group Deprecated

    Deprecated. Use `fortigate-create-firewall-address-ipv4-group` instead. Create an address group in FortiGate firewall.

  • 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].

  • 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.

  • 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.

  • 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].

  • 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.

  • 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.

  • 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.

  • 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].

  • 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.

  • fortigate-create-policy Deprecated

    Deprecated. Use `fortigate-create-firewall-policy` instead. Create a firewall policy (rule) on FortiGate.

  • fortigate-delete-address Deprecated

    Deprecated. Use `fortigate-delete-firewall-address-ipv4` instead. Deletes an address by name.

  • fortigate-delete-address-group Deprecated

    Deprecated. Use `fortigate-delete-firewall-address-ipv4-group` instead. Delete an address group from FortiGate firewall.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • fortigate-delete-firewall-service

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

  • 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.

  • fortigate-delete-policy Deprecated

    Deprecated. Use `fortigate-delete-firewall-policy` instead. Delete a policy from FortiGate firewall.

  • fortigate-delete-service-group Deprecated

    Deprecated. Use `fortigate-delete-firewall-service-group` instead. Delete a service group from FortiGate.

  • fortigate-get-address-groups Deprecated

    Deprecated. Use `fortigate-list-firewall-address-ipv4-groups` instead. Get information about address groups from FortiGate.

  • fortigate-get-addresses Deprecated

    Deprecated. Use `fortigate-list-firewall-address-ipv4s` instead. Get all address objects from your firewall.

  • fortigate-get-banned-ips Deprecated

    Deprecated. Use `fortigate-list-banned-ips` instead. Returns a list of banned IP addresses.

  • fortigate-get-firewall-service Deprecated

    Deprecated. Use `fortigate-list-firewall-services` instead. Get information about a service from FortiGate Firewall.

  • fortigate-get-policy Deprecated

    Deprecated. Use `fortigate-list-firewall-policies` instead. Get information about a firewall policy on FortiGate.

  • fortigate-get-service-groups Deprecated

    Deprecated. Use `fortigate-list-firewall-service-groups` instead. Get information about FortiGate service groups.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • 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.

  • fortigate-list-firewall-services

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

  • 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.

  • 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.

  • fortigate-move-policy Deprecated

    Deprecated. Use `fortigate-move-firewall-policy` instead. Move a firewall policy rule to a different position.

  • 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.

  • fortigate-update-address-group Deprecated

    Deprecated. Use `fortigate-update-firewall-address-ipv4-group` instead. Update an address group on FortiGate firewall.

  • 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].

  • 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.

  • 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.

  • 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].

  • 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.

  • 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.

  • 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.

  • 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].

  • 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.

  • fortigate-update-policy Deprecated

    Deprecated. Use `fortigate-update-firewall-policy` instead. Update a firewall policy on FortiGate.

  • fortigate-update-service-group Deprecated

    Deprecated. Use `fortigate-update-firewall-service-group` instead. Update a FortiGate service group.

Source

FortiGate.py FortiGate_test.py FortiGate.yml FortiGate_description.md
Download History Raw 
category: Network Security
provider: Fortinet
commonfields:
  id: FortiGate
  version: -1
sectionorder:
- Connect
- Collect
configuration:
- display: Server URL (e.g. https://192.168.0.1)
  name: server
  required: true
  type: 0
  section: Connect
- display: Account username
  name: credentials
  required: false
  type: 9
  section: Connect
- display: API Key
  name: api_key
  required: false
  type: 9
  hiddenusername: true
  displaypassword: API Key
  section: Connect
- display: Trust any certificate (not secure)
  name: unsecure
  type: 8
  required: false
  section: Connect
- display: Use system proxy settings
  name: proxy
  type: 8
  required: false
  defaultvalue: 'false'
  section: Connect
description: '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.'
display: FortiGate
name: FortiGate
script:
  commands:
  - arguments:
    - defaultValue: root
      description: Filter by address (ip or domain).
      name: address
    - description: Filter by address name.
      name: name
    deprecated: true
    description: Deprecated. Use `fortigate-list-firewall-address-ipv4s` instead. Get all address objects from your firewall.
    name: fortigate-get-addresses
    outputs:
    - contextPath: Fortigate.Address.Name
      description: Address name.
      type: string
    - contextPath: Fortigate.Address.Subnet
      description: Address subnet.
      type: string
    - contextPath: Fortigate.Address.StartIP
      description: Address object start IP address.
      type: string
    - contextPath: Fortigate.Address.EndIP
      description: Address object end IP address.
      type: string
  - arguments:
    - description: Filter by group name.
      name: name
    deprecated: true
    description: Deprecated. Use `fortigate-list-firewall-service-groups` instead. Get information about FortiGate service groups.
    name: fortigate-get-service-groups
    outputs:
    - contextPath: Fortigate.ServiceGroup.Name
      description: Service Group name.
      type: string
    - contextPath: Fortigate.ServiceGroup.Member.Name
      description: Service Group member name.
      type: string
  - arguments:
    - description: Group name to update.
      name: groupName
      required: true
    - description: Service name to update from the group (If providing data argument value does not matter).
      name: serviceName
      required: true
    - auto: PREDEFINED
      description: Action to take on the service.
      name: action
      predefined:
      - add
      - remove
      required: true
    deprecated: true
    description: Deprecated. Use `fortigate-update-firewall-service-group` instead. Update a FortiGate service group.
    name: fortigate-update-service-group
    outputs:
    - contextPath: Fortigate.ServiceGroup.Name
      description: Service group name.
      type: string
    - contextPath: Fortigate.ServiceGroup.Service.Name
      description: Service name.
      type: string
  - arguments:
    - description: Group name of the group you would like to delete.
      name: groupName
      required: true
    deprecated: true
    description: Deprecated. Use `fortigate-delete-firewall-service-group` instead. Delete a service group from FortiGate.
    name: fortigate-delete-service-group
    outputs:
    - contextPath: Fortigate.ServiceGroup.Name
      description: Service group name.
      type: string
    - contextPath: Fortigate.ServiceGroup.Deleted
      description: Was service group deleted.
      type: boolean
  - arguments:
    - description: Service name.
      name: serviceName
    deprecated: true
    description: Deprecated. Use `fortigate-list-firewall-services` instead. Get information about a service from FortiGate Firewall.
    name: fortigate-get-firewall-service
    outputs:
    - contextPath: Fortigate.Service.Name
      description: Service name.
      type: string
    - contextPath: Fortigate.Service.Ports.TCP
      description: TCP Port range included for the service.
      type: string
    - contextPath: Fortigate.Service.Ports.UDP
      description: UDP Port range included for the service.
      type: string
  - arguments:
    - description: Policy name.
      name: policyName
    - description: Policy ID.
      name: policyID
    deprecated: true
    description: Deprecated. Use `fortigate-list-firewall-policies` instead. Get information about a firewall policy on FortiGate.
    name: fortigate-get-policy
    outputs:
    - contextPath: Fortigate.Policy.Name
      description: Policy name.
      type: string
    - contextPath: Fortigate.Policy.ID
      description: Policy ID.
      type: number
    - contextPath: Fortigate.Policy.Description
      description: Policy description.
      type: string
    - contextPath: Fortigate.Policy.Status
      description: The status of the policy (Enabled or Disabled).
      type: string
    - contextPath: Fortigate.Policy.Source
      description: Source address.
      type: string
    - contextPath: Fortigate.Policy.Destination
      description: Destination address.
      type: string
    - contextPath: Fortigate.Policy.Service
      description: Service for the policy (for example HTTP).
      type: string
    - contextPath: Fortigate.Policy.Action
      description: Policy action (Allow, Block).
      type: string
    - contextPath: Fortigate.Policy.Log
      description: Does the policy log the traffic or not.
      type: string
    - contextPath: Fortigate.Policy.Security
      description: Policy attached security profile.
      type: string
  - arguments:
    - description: Policy ID.
      name: policyID
      required: true
    - auto: PREDEFINED
      description: Field parameter to update.
      name: field
      predefined:
      - description
      - status
      - source
      - destination
      - service
      - action
      - log
      - nat
      required: true
    - description: Value of field parameter to update.
      name: value
      required: true
    - auto: PREDEFINED
      description: Whether to keep the original data or not. Only relevant if the updated field is "source" or "destination". If the supplied value is `True`, the current data will not be replaced. Instead, the supplied addresses will be added / removed from the existing data.
      name: keep_original_data
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether to add or remove the supplied addresses from the existing data. Only relevant in case the field to update is "source" or "destination", and keep_original_data is specified to `True`.
      name: add_or_remove
      predefined:
      - add
      - remove
    deprecated: true
    description: Deprecated. Use `fortigate-update-firewall-policy` instead. Update a firewall policy on FortiGate.
    execution: true
    name: fortigate-update-policy
    outputs:
    - contextPath: Fortigate.Policy.Name
      description: Policy name.
      type: string
    - contextPath: Fortigate.Policy.ID
      description: Policy ID.
      type: number
    - contextPath: Fortigate.Policy.Description
      description: Policy description.
      type: string
    - contextPath: Fortigate.Policy.Status
      description: The status of the policy (Enabled or Disabled).
      type: string
    - contextPath: Fortigate.Policy.Source
      description: Source address.
      type: string
    - contextPath: Fortigate.Policy.Destination
      description: Destination address.
      type: string
    - contextPath: Fortigate.Policy.Service
      description: Service for the policy (for example HTTP).
      type: string
    - contextPath: Fortigate.Policy.Action
      description: Policy action (Allow, Block).
      type: string
    - contextPath: Fortigate.Policy.Log
      description: Does the policy log the traffic or not.
      type: boolean
  - arguments:
    - description: Policy name.
      name: policyName
      required: true
    - description: Description for the policy.
      name: description
    - description: 'Source interface  (examples : port1, port2 or port3).'
      name: sourceIntf
      required: true
    - description: 'Destination interface (examples : port1, port2 or port3).'
      name: dstIntf
      required: true
    - description: 'Source IP address, range or domain (examples : all, update.microsoft.com).'
      name: source
      required: true
    - description: 'Destination IP address, range or domain (examples : all, update.microsoft.com).'
      name: destination
      required: true
    - description: Service for the policy (for example HTTP).
      name: service
      required: true
    - auto: PREDEFINED
      description: Action to take.
      name: action
      predefined:
      - accept
      - block
      required: true
    - auto: PREDEFINED
      defaultValue: enable
      description: policy status.
      name: status
      predefined:
      - enable
      - disable
    - auto: PREDEFINED
      defaultValue: enable
      description: Will the policy log the traffic or not.
      name: log
      predefined:
      - all
      - utm
      - disable
    - auto: PREDEFINED
      defaultValue: enable
      description: enable/disable NAT.
      name: nat
      predefined:
      - enable
      - disable
    deprecated: true
    description: Deprecated. Use `fortigate-create-firewall-policy` instead. Create a firewall policy (rule) on FortiGate.
    execution: true
    name: fortigate-create-policy
    outputs:
    - contextPath: Fortigate.Policy.Name
      description: Policy name.
      type: string
    - contextPath: Fortigate.Policy.Description
      description: Policy description.
      type: string
    - contextPath: Fortigate.Policy.Status
      description: The status of the policy (Enabled or Disabled).
      type: string
    - contextPath: Fortigate.Policy.Source.Address
      description: Source address.
      type: string
    - contextPath: Fortigate.Policy.Destination.Address
      description: Destination address.
      type: string
    - contextPath: Fortigate.Policy.Service
      description: Service for the policy (for example HTTP).
      type: string
    - contextPath: Fortigate.Policy.Action
      description: Policy action (Allow, Block).
      type: string
    - contextPath: Fortigate.Policy.Log
      description: Does the policy log the traffic or not.
      type: boolean
    - contextPath: Fortigate.Policy.Source.Intf
      description: Source interface.
      type: string
    - contextPath: Fortigate.Policy.Destination.Intf
      description: Destination interface.
      type: string
    - contextPath: Fortigate.Policy.NAT
      description: Policy NAT.
      type: string
  - arguments:
    - description: Policy ID.
      name: policyID
      required: true
    - auto: PREDEFINED
      description: Position for the policy (before or after).
      name: position
      predefined:
      - before
      - after
      required: true
    - description: The ID of the policy being used as a positional anchor.
      name: neighbor
      required: true
    deprecated: true
    description: Deprecated. Use `fortigate-move-firewall-policy` instead. Move a firewall policy rule to a different position.
    name: fortigate-move-policy
    outputs:
    - contextPath: Fortigate.Policy.ID
      description: Policy ID.
      type: number
    - contextPath: Fortigate.Policy.Moved
      description: Was policy moved successfully.
      type: boolean
  - arguments:
    - description: Policy ID.
      name: policyID
      required: true
    deprecated: true
    description: Deprecated. Use `fortigate-delete-firewall-policy` instead. Delete a policy from FortiGate firewall.
    execution: true
    name: fortigate-delete-policy
    outputs:
    - contextPath: Fortigate.Policy.ID
      description: Policy ID.
      type: number
    - contextPath: Fortigate.Policy.Deleted
      description: Was policy deleted successfully.
      type: boolean
  - arguments:
    - description: Filter by group name.
      name: groupName
    deprecated: true
    description: Deprecated. Use `fortigate-list-firewall-address-ipv4-groups` instead. Get information about address groups from FortiGate.
    name: fortigate-get-address-groups
    outputs:
    - contextPath: Fortigate.AddressGroup.Name
      description: Address Group name.
      type: string
    - contextPath: Fortigate.AddressGroup.Member.Name
      description: Address Group member name.
      type: string
    - contextPath: Fortigate.AddressGroup.UUID
      description: Address Group UUID.
      type: string
  - arguments:
    - description: Group name.
      name: groupName
      required: true
    - description: An address to add or remove from the group (If providing data argument, value does not matter).
      name: address
      required: true
    - auto: PREDEFINED
      description: Action to take on the service.
      name: action
      predefined:
      - add
      - remove
      required: true
    deprecated: true
    description: Deprecated. Use `fortigate-update-firewall-address-ipv4-group` instead. Update an address group on FortiGate firewall.
    name: fortigate-update-address-group
    outputs:
    - contextPath: Fortigate.AddressGroup.Name
      description: Address group name.
      type: string
    - contextPath: Fortigate.AddressGroup.Address.Name
      description: Address name.
      type: string
    - contextPath: Fortigate.AddressGroup.UUID
      description: Address group UUID.
      type: Unknown
  - arguments:
    - description: Group name.
      name: groupName
      required: true
    - description: Address member to add to the group.
      name: address
      required: true
    deprecated: true
    description: Deprecated. Use `fortigate-create-firewall-address-ipv4-group` instead. Create an address group in FortiGate firewall.
    name: fortigate-create-address-group
    outputs:
    - contextPath: Fortigate.AddressGroup.Name
      description: Address group name.
      type: string
    - contextPath: Fortigate.AddressGroup.Address
      description: Address group member address.
      type: string
  - arguments:
    - description: Address group name.
      name: name
      required: true
    deprecated: true
    description: Deprecated. Use `fortigate-delete-firewall-address-ipv4-group` instead. Delete an address group from FortiGate firewall.
    name: fortigate-delete-address-group
    outputs:
    - contextPath: Fortigate.AddressGroup.Name
      description: Address group name.
      type: string
    - contextPath: Fortigate.AddressGroup.Deleted
      description: Was address group deleted.
      type: boolean
  - description: Deprecated. Use `fortigate-list-banned-ips` instead. Returns a list of banned IP addresses.
    deprecated: true
    name: fortigate-get-banned-ips
    outputs:
    - contextPath: Fortigate.BannedIP.IP
      description: The IP address.
      type: string
    - contextPath: Fortigate.BannedIP.Created
      description: Date/time the IP address was added to the banned list.
      type: string
    - contextPath: Fortigate.BannedIP.Expires
      description: Date/time the IP address expires from the banned list.
      type: string
    - contextPath: Fortigate.BannedIP.Source
      description: Source of the ban.
      type: string
  - arguments:
    - description: The address name.
      name: name
      required: true
    - description: 'The IP Address, example: 1.1.1.1.'
      name: address
    - defaultValue: '255.255.255.255'
      description: 'The address mask,example: 255.255.255.0 , Default is 255.255.255.255.'
      name: mask
    - description: 'The domain name, example: example.com.'
      name: fqdn
    deprecated: true
    description: Deprecated. Use `fortigate-create-firewall-address-ipv4` instead. Creates a new address object.
    name: fortigate-create-address
    outputs:
    - contextPath: Fortigate.Address.Name
      description: The address name.
      type: String
    - contextPath: Fortigate.Address.IPAddress
      description: The IP address.
      type: String
    - contextPath: Fortigate.Address.FQDN
      description: The domain name.
      type: String
  - arguments:
    - description: The address name.
      name: name
      required: true
    deprecated: true
    description: Deprecated. Use `fortigate-delete-firewall-address-ipv4` instead. Deletes an address by name.
    name: fortigate-delete-address
    outputs:
    - contextPath: Fortigate.Address.Name
      description: The address name.
      type: String
    - contextPath: Fortigate.Address.Deleted
      description: The address deletion status.
      type: String
  - name: fortigate-list-firewall-address-ipv4s
    description: 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.
    arguments:
    - name: name
      description: Name of a specific address to return.
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: filter_field
      description: 'Specifies the field to be searched, such as `name` or `comment`, to narrow down the search criteria within the objects. Fields must be written as they are in the `raw_response`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/220620/config-firewall-address`.'
    - name: filter_value
      description: Indicates the value or partial value, for example `Sales`, that the API should look for within the specified field to find matching objects.
    - name: format_fields
      description: 'Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the `raw_response`, for example: `name` or `comment`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/220620/config-firewall-address`.'
      isArray: true
    outputs:
    - contextPath: Fortigate.Address.Name
      description: Address name.
      type: String
    - contextPath: Fortigate.Address.Subnet
      description: IP address and subnet mask of address.
      type: String
    - contextPath: Fortigate.Address.StartIP
      description: First IP address (inclusive) in the range for the address.
      type: String
    - contextPath: Fortigate.Address.EndIP
      description: Final IP address (inclusive) in the range for the address.
      type: String
    - contextPath: Fortigate.Address.FQDN
      description: Fully Qualified Domain Name address.
      type: String
    - contextPath: Fortigate.Address.MACAddresses
      description: Multiple MAC address ranges <start>[-<end>] separated by a space.
      type: String
    - contextPath: Fortigate.Address.Type
      description: 'Type of the address. Can be: `ipmask`, `iprange`, `fqdn`, `geography`, `wildcard`, `dynamic`, `interface-subnet` or `mac`.'
      type: String
    - contextPath: Fortigate.Address.FabricObject
      description: Security Fabric global object setting. Can be `enable` or `disable`. If `enable`, the object is set as a security fabric-wide global object, otherwise the object is local to this security fabric member.
      type: String
    - contextPath: Fortigate.Address.AllowRouting
      description: Enable/disable use of this address in the static route configuration.
      type: String
    - contextPath: Fortigate.Address.Tagging
      description: List of tags associated to the object.
      type: String
    - contextPath: Fortigate.Address.IPs
      description: List of IP addresses.
      type: String
    - contextPath: Fortigate.Address.SDNAddressType
      description: 'Type of addresses to collect. Can be: `private`, `public`, or `all`.'
      type: String
    - contextPath: Fortigate.Address.AssociatedInterface
      description: Network interface associated with the address.
      type: String
    - contextPath: Fortigate.Address.Comment
      description: The object`s comment.
      type: String
    - contextPath: Fortigate.Address.Dirty
      description: Whether the object is clean.
      type: String
    - contextPath: Fortigate.Address.TagType
      description: Tag type of dynamic address object.
      type: String
    - contextPath: Fortigate.Address.TagDetectionLevel
      description: Tag detection level of dynamic address object.
      type: String
    - contextPath: Fortigate.Address.ObjectType
      description: IP or MAC address.
      type: String
    - contextPath: Fortigate.Address.Interface
      description: Name of the interface whose IP address is to be used.
      type: String
    - contextPath: Fortigate.Address.FSSOGroup
      description: Fortinet Single Sign-On group name.
      type: String
    - contextPath: Fortigate.Address.SDN
      description: Software-defined networking.
      type: String
    - contextPath: Fortigate.Address.SDNTag
      description: Software-defined networking tag.
      type: String
    - contextPath: Fortigate.Address.CacheTTL
      description: Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
      type: Number
    - contextPath: Fortigate.Address.Country
      description: IP addresses associated to a specific country.
      type: String
    - contextPath: Fortigate.Address.ClearpassSPT
      description: 'System Posture Token value. Can be: `unknown`, `healthy`, `quarantine`, `checkup`, `transient` or `infected`.'
      type: String
    - contextPath: Fortigate.Address.SubType
      description: 'Sub-type of address. Can be: `sdn`, `clearpass-spt`, `fsso`, `ems-tag`, `fortivoice-tag`, `fortinac-tag`, `fortipolicy-tag` or `swc-tag`.'
      type: String
    - contextPath: Fortigate.Address.UUID
      description: Universally Unique Identifier.
      type: String
    - contextPath: Fortigate.Address.ObjectTag
      description: Tag of dynamic address object.
      type: String
    - contextPath: Fortigate.Address.VDOM
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.
      type: String
  - name: fortigate-create-firewall-address-ipv4
    description: '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].'
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: name
      description: The name of the address to create.
      required: true
    - name: address
      description: The IP address.
    - name: mask
      description: 'The subnet mask as an IP address. Default value: `255.255.255.255`.'
    - name: fqdn
      description: Fully Qualified Domain Name address.
    - name: start_ip
      description: First IP address (inclusive) in the range for the address.
    - name: end_ip
      description: Final IP address (inclusive) in the range for the address.
    - name: country
      description: 'IP addresses associated to a specific country. Input must be according to the two-letter counter codes, for example: `IL`.'
    - name: mac_addresses
      description: 'Comma-separated list of MAC addresses. Can be single or range. Range must be separated by `-`, for examlpe: `00:00:00:00:00:00` or `00:00:00:00:00:00-FF:FF:FF:FF:FF:FF`.'
      isArray: true
    - name: associated_interface
      description: Network interface associated with address.
    - name: allow_routing
      description: Enable/disable use of this address in the static route configuration.
      auto: PREDEFINED
      predefined:
      - enable
      - disable
    - name: comment
      description: A comment for the address.
    outputs:
    - contextPath: Frotigate.Address.Name
      description: The name of the updated address.
      type: String
    - contextPath: Frotigate.Address.IPAddress
      description: The IP address.
      type: String
    - contextPath: Frotigate.Address.Mask
      description: The subnet mask of the address.
      type: String
    - contextPath: Frotigate.Address.FQDN
      description: The Fully Qualified Domain Name address.
      type: String
    - contextPath: Frotigate.Address.StartIP
      description: First IP address (inclusive) in the range for the address.
      type: String
    - contextPath: Frotigate.Address.EndIP
      description: Final IP address (inclusive) in the range for the address.
      type: String
    - contextPath: Frotigate.Address.Country
      description: IP addresses associated to a specific country.
      type: String
    - contextPath: Frotigate.Address.MAC
      description: MAC addresses.
      type: String
  - name: fortigate-update-firewall-address-ipv4
    description: '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].'
    arguments:
    - name: name
      description: The name of the address to update. Names can be retrieved with the command `fortigate-list-firewall-address-ipv4s`.
      required: true
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: address
      description: The IP address.
    - name: mask
      description: The subnet mask of the address.
    - name: fqdn
      description: Fully Qualified Domain Name address.
    - name: start_ip
      description: First IP address (inclusive) in the range for the address.
    - name: end_ip
      description: Final IP address (inclusive) in the range for the address.
    - name: country
      description: 'IP addresses associated to a specific country. Input must be according to the two-letter counter codes, for example: `IL`.'
    - name: mac_addresses
      description: 'Comma-separated list of MAC addresses. Can be single or range. Range must be separated by `-`, for example: `00:00:00:00:00:00` or `00:00:00:00:00:00-FF:FF:FF:FF:FF:FF`.'
      isArray: true
    - name: associated_interface
      description: Network interface associated with address.
    - name: allow_routing
      description: Enable/disable use of this address in the static route configuration.
      auto: PREDEFINED
      predefined:
      - enable
      - disable
    - name: comment
      description: A comment for the address.
    outputs:
    - contextPath: Frotigate.Address.Name
      description: The name of the created address.
      type: String
    - contextPath: Frotigate.Address.IPAddress
      description: The IP address.
      type: String
    - contextPath: Frotigate.Address.Mask
      description: The subnet mask of the address.
      type: String
    - contextPath: Frotigate.Address.FQDN
      description: The Fully Qualified Domain Name address.
      type: String
    - contextPath: Frotigate.Address.StartIP
      description: First IP address (inclusive) in the range for the address.
      type: String
    - contextPath: Frotigate.Address.EndIP
      description: Final IP address (inclusive) in the range for the address.
      type: String
    - contextPath: Frotigate.Address.Country
      description: IP addresses associated to a specific country.
      type: String
    - contextPath: Frotigate.Address.MAC
      description: MAC addresses.
      type: String
  - name: fortigate-delete-firewall-address-ipv4
    description: 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.
    arguments:
    - name: name
      description: Name of the address to delete. Names can be retrieved with the command `fortigate-list-firewall-address-ipv4s`.
      required: true
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    outputs:
    - contextPath: Frotigate.Address.Name
      description: The name of the deleted address.
      type: String
    - contextPath: Frotigate.Address.Deleted
      description: Whether the address was deleted.
      type: Boolean
  - name: fortigate-list-firewall-address-ipv6s
    description: 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.
    arguments:
    - name: name
      description: Name of a specific address to return.
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: filter_field
      description: 'Specifies the field to be searched, such as `name` or `comment`, to narrow down the search criteria within the objects. Fields must be written as they are in the `raw_response`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/223620/config-firewall-address6`.'
    - name: filter_value
      description: Indicates the value or partial value, for example `Sales`, that the API should look for within the specified field to find matching objects.
    - name: format_fields
      description: 'Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the `raw_response`, for example: `name` or `comment`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/223620/config-firewall-address6`.'
      isArray: true
    outputs:
    - contextPath: Fortigate.Address6.FabricObject
      description: Security Fabric global object setting. Can be `enable` or `disable`. If `enable`, the object is set as a security fabric-wide global object, otherwise the object is local to this security fabric member.
      type: String
    - contextPath: Fortigate.Address6.SDNTag
      description: Software-defined networking tag.
      type: String
    - contextPath: Fortigate.Address6.Tenant
      description: Specifies the instance or environment in a multi-tenancy setup for configuring address objects.
      type: String
    - contextPath: Fortigate.Address6.HostType
      description: Can be a wildcard or a specific host address.
      type: String
    - contextPath: Fortigate.Address6.SubnetSegment.Name
      description: The subnet segment name.
      type: String
    - contextPath: Fortigate.Address6.SubnetSegment.Type
      description: The subnet segment type. Can be a wildcard or a specific address.
      type: String
    - contextPath: Fortigate.Address6.SubnetSegment.Value
      description: The subnet segment value.
      type: String
    - contextPath: Fortigate.Address6.Template
      description: IPv6 address template.
      type: String
    - contextPath: Fortigate.Address6.Comment
      description: The object`s comment.
      type: String
    - contextPath: Fortigate.Address6.Tagging
      description: List of tags associated to the object.
      type: String
    - contextPath: Fortigate.Address6.IPs
      description: List of IP addresses.
      type: String
    - contextPath: Fortigate.Address6.Country
      description: IP addresses associated to a specific country.
      type: String
    - contextPath: Fortigate.Address6.FQDN
      description: Fully Qualified Domain Name address.
      type: String
    - contextPath: Fortigate.Address6.StartIP
      description: First IP address (inclusive) in the range for the address.
      type: String
    - contextPath: Fortigate.Address6.EndIP
      description: Final IP address (inclusive) in the range for the address.
      type: String
    - contextPath: Fortigate.Address6.IPv6
      description: IPv6 address prefix.
      type: String
    - contextPath: Fortigate.Address6.SDN
      description: Software-defined networking.
      type: String
    - contextPath: Fortigate.Address6.MACAddresses
      description: Multiple MAC address ranges <start>[-<end>] separated by a space.
      type: Unknown
    - contextPath: Fortigate.Address6.Type
      description: 'Type of IPv6 address object. Can be: `ipprefix`, `iprange`, `fqdn`, `geography`, `dynamic`, `template`, `mac`.'
      type: String
    - contextPath: Fortigate.Address6.UUID
      description: Universally Unique Identifier.
      type: String
    - contextPath: Fortigate.Address6.Name
      description: Address name.
      type: String
    - contextPath: Fortigate.Address6.Host
      description: Host address.
      type: String
    - contextPath: Fortigate.Address6.CacheTTL
      description: Defines the minimal TTL of individual IP addresses in FQDN cache measured in seconds.
      type: Number
    - contextPath: Fortigate.Address6.VDOM
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.
      type: String
  - name: fortigate-create-firewall-address-ipv6
    description: '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].'
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: name
      description: Name of the address to create.
      required: true
    - name: address
      description: 'IPv6 address prefix. Can be in short form (e.g., 2001:db8::) or long form (e.g., 0000:0000:0000:0000:0000:0000:0000:0000).'
    - name: mask
      description: 'Subnet mask indicating the prefix length (format: xxx, range: 0-128).'
    - name: fqdn
      description: Fully Qualified Domain Name address.
    - name: start_ip
      description: First IP address (inclusive) in the range for the address.
    - name: end_ip
      description: Final IP address (inclusive) in the range for the address.
    - name: country
      description: 'IP addresses associated to a specific country. Input must be according to the two-letter counter codes, for example: `IL`.'
    - name: mac_addresses
      description: 'Comma-separated list of MAC addresses. Can be single or range. Range must be separated by `-`, for example: `00:00:00:00:00:00` or `00:00:00:00:00:00-FF:FF:FF:FF:FF:FF`.'
      isArray: true
    - name: sdn_connector
      description: 'Software-defined networking connector enables to interact with SDN controllers. For more information, go to: https://docs.fortinet.com/document/fortigate/7.2.5/administration-guide/753961/public-and-private-sdn-connectors.'
    - name: comment
      description: A comment for the address.
    outputs:
    - contextPath: Frotigate.Address6.Name
      description: The name of the updated address.
      type: String
    - contextPath: Frotigate.Address6.IPAddress
      description: The IP address.
      type: String
    - contextPath: Frotigate.Address6.Mask
      description: The subnet mask of the address.
      type: String
    - contextPath: Frotigate.Address6.FQDN
      description: The Fully Qualified Domain Name address.
      type: String
    - contextPath: Frotigate.Address6.StartIP
      description: First IP address (inclusive) in the range for the address.
      type: String
    - contextPath: Frotigate.Address6.EndIP
      description: Final IP address (inclusive) in the range for the address.
      type: String
    - contextPath: Frotigate.Address6.Country
      description: IP addresses associated to a specific country.
      type: String
    - contextPath: Frotigate.Address6.MAC
      description: MAC addresses.
      type: String
    - contextPath: Frotigate.Address6.SDN
      description: Software-defined networking.
      type: String
  - name: fortigate-update-firewall-address-ipv6
    description: '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].'
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: name
      description: Name of the address to update. Names can be retrieved with the command `fortigate-list-firewall-address-ipv6s`.
      required: true
      default: true
    - name: type
      description: The type of the address to update.
      auto: PREDEFINED
      predefined:
      - Subnet
      - IP Range
      - FQDN
      - Geography
      - Device (Mac Address)
      - Fabric Connector Address
    - name: address
      description: The IP address.
    - name: mask
      description: The subnet mask of the address.
    - name: fqdn
      description: Fully Qualified Domain Name address.
    - name: start_ip
      description: First IP address (inclusive) in the range for the address.
    - name: end_ip
      description: Final IP address (inclusive) in the range for the address.
    - name: country
      description: 'IP addresses associated to a specific country. Input must be according to the two-letter counter codes, for example: `IL`.'
    - name: mac_addresses
      description: 'Comma-separated list of MAC addresses. Can be single or range. Range must be separated by `-`, for example: `00:00:00:00:00:00` or `00:00:00:00:00:00-FF:FF:FF:FF:FF:FF`.'
      isArray: true
    - name: sdn_connector
      description: 'Software-defined networking connector enables to interact with SDN controllers. For more information, go to: https://docs.fortinet.com/document/fortigate/7.2.5/administration-guide/753961/public-and-private-sdn-connectors.'
    - name: comment
      description: A comment for the address.
    outputs:
    - contextPath: Frotigate.Address6.Name
      description: The name of the updated address.
      type: String
    - contextPath: Frotigate.Address6.IPAddress
      description: The IP address.
      type: String
    - contextPath: Frotigate.Address6.Mask
      description: The subnet mask of the address.
      type: String
    - contextPath: Frotigate.Address6.FQDN
      description: The Fully Qualified Domain Name address.
      type: String
    - contextPath: Frotigate.Address6.StartIP
      description: First IP address (inclusive) in the range for the address.
      type: String
    - contextPath: Frotigate.Address6.EndIP
      description: Final IP address (inclusive) in the range for the address.
      type: String
    - contextPath: Frotigate.Address6.Country
      description: IP addresses associated to a specific country.
      type: String
    - contextPath: Frotigate.Address6.MAC
      description: MAC addresses.
      type: String
    - contextPath: Frotigate.Address6.SDN
      description: Software-defined networking.
      type: String
  - name: fortigate-delete-firewall-address-ipv6
    description: 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.
    arguments:
    - name: name
      description: Name of the address to delete. Names can be retrieved with the command `fortigate-list-firewall-address-ipv6s`.
      required: true
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    outputs:
    - contextPath: Fortigate.Address6.Name
      description: The name of the address.
      type: String
    - contextPath: Fortigate.Address6.Deleted
      description: Whether the address was deleted.
      type: Boolean
  - name: fortigate-list-firewall-address-ipv4-multicasts
    description: 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.
    arguments:
    - name: name
      description: Name of a specific address to return.
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: filter_field
      description: 'Specifies the field to be searched, such as `name` or `comment`, to narrow down the search criteria within the objects. Fields must be written as they are in the `raw_response`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/221620/config-firewall-multicast-address`.'
    - name: filter_value
      description: Indicates the value or partial value, for example `Sales`, that the API should look for within the specified field to find matching objects.
    - name: format_fields
      description: 'Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the `raw_response`, for example: `name` or `comment`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/221620/config-firewall-multicast-address`.'
      isArray: true
    outputs:
    - contextPath: Fortigate.AddressMulticast.Tagging
      description: List of tags associated to the object.
      type: String
    - contextPath: Fortigate.AddressMulticast.AssociatedInterface
      description: Network interface associated with address.
      type: String
    - contextPath: Fortigate.AddressMulticast.Comment
      description: The object`s comment.
      type: String
    - contextPath: Fortigate.AddressMulticast.EndIP
      description: Final IP address (inclusive) in the range for the address.
      type: String
    - contextPath: Fortigate.AddressMulticast.StartIP
      description: First IP address (inclusive) in the range for the address.
      type: String
    - contextPath: Fortigate.AddressMulticast.Subnet
      description: Broadcast address and subnet.
      type: String
    - contextPath: Fortigate.AddressMulticast.Type
      description: 'Type of the address multicast. Can be: `multicastrange` or `broadcastmask`.'
      type: String
    - contextPath: Fortigate.AddressMulticast.Name
      description: Address multicast name.
      type: String
    - contextPath: Fortigate.AddressMulticast.VDOM
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.
      type: String
  - name: fortigate-create-firewall-address-ipv4-multicast
    description: '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.'
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: name
      description: Name of the address multicast to create.
      required: true
    - name: comment
      description: A comment for the address.
    - name: associated_interface
      description: Network interface associated with address.
    - name: type
      description: Specifies the format of the multicast address.
      required: true
      auto: PREDEFINED
      predefined:
      - Broadcast Subnet
      - Multicast IP Range
    - name: first_ip
      description: For `Broadcast Subnet`, this is the network address. For `Multicast IP Range`, (inclusive) this is the beginning of the IP range.
      required: true
    - name: final_ip
      description: 'For `Broadcast Subnet` this should be the network mask as an IP address. For `Multicast IP Range`, (inclusive) this is the end of the IP range.'
      required: true
    outputs:
    - contextPath: Frotigate.AddressMulticast.Name
      description: The name of the updated address multicast.
      type: String
    - contextPath: Frotigate.AddressMulticast.Type
      description: Specifies the format of the multicast address.
      type: String
    - contextPath: Frotigate.AddressMulticast.FirstIP
      description: First input IP address.
      type: String
    - contextPath: Frotigate.AddressMulticast.FinalIP
      description: Final input IP address.
      type: String
  - name: fortigate-update-firewall-address-ipv4-multicast
    description: '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.'
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: name
      description: Name of the address multicast to update. Names can be retrieved with the command `fortigate-list-firewall-address-ipv4-multicasts`.
      required: true
      default: true
    - name: comment
      description: A comment for the address.
    - name: associated_interface
      description: Network interface associated with address.
    - name: type
      description: Specifies the format of the multicast address.
      auto: PREDEFINED
      predefined:
      - Broadcast Subnet
      - Multicast IP Range
    - name: first_ip
      description: For 'Broadcast Subnet', this is the network address. For 'Multicast IP Range', (inclusive) this is the beginning of the IP range.
    - name: final_ip
      description: For 'Broadcast Subnet' this should be the network mask as an IP address. For `Multicast IP Range`, (inclusive) this is the end of the IP range.
    outputs:
    - contextPath: Frotigate.AddressMulticast.Name
      description: The name of the updated address multicast.
      type: String
    - contextPath: Frotigate.AddressMulticast.Type
      description: Specifies the format of the multicast address.
      type: String
    - contextPath: Frotigate.AddressMulticast.FirstIP
      description: First input IP address.
      type: String
    - contextPath: Frotigate.AddressMulticast.FinalIP
      description: Final input IP address.
      type: String
  - name: fortigate-delete-firewall-address-ipv4-multicast
    description: 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.
    arguments:
    - name: name
      description: Name of the address multicast to delete. Names can be retrieved with the command `fortigate-list-firewall-address-ipv4-multicasts`.
      required: true
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    outputs:
    - contextPath: Fortigate.AddressMulticast.Name
      description: The name of the address multicast.
      type: String
    - contextPath: Fortigate.AddressMulticast.Deleted
      description: Whether the address multicast was deleted.
      type: Boolean
  - name: fortigate-list-firewall-address-ipv6-multicasts
    description: 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.
    arguments:
    - name: name
      description: Name of a specific address multicast to return.
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: filter_field
      description: 'Specifies the field to be searched, such as `name` or `comment`, to narrow down the search criteria within the objects. Fields must be written as they are in the `raw_response`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/224620/config-firewall-multicast-address6`.'
    - name: filter_value
      description: Indicates the value or partial value, for example `Sales`, that the API should look for within the specified field to find matching objects.
    - name: format_fields
      description: 'Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the `raw_response`, for example: `name` or `comment`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/224620/config-firewall-multicast-address6`.'
      isArray: true
    outputs:
    - contextPath: Fortigate.Address6Multicast.Tagging
      description: List of tags associated to the object.
      type: String
    - contextPath: Fortigate.Address6Multicast.Comment
      description: The object`s comment.
      type: String
    - contextPath: Fortigate.Address6Multicast.IPv6
      description: Broadcast address and subnet.
      type: String
    - contextPath: Fortigate.Address6Multicast.Name
      description: Address multicast name.
      type: String
    - contextPath: Fortigate.Address6Multicast.VDOM
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.
      type: String
  - name: fortigate-create-firewall-address-ipv6-multicast
    description: 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.
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: name
      description: Name of the address multicast to create.
      required: true
    - name: comment
      description: A comment for the address.
    - name: address
      description: 'IPv6 address prefix. Can be in short form (e.g., 2001:db8::) or long form (e.g., 0000:0000:0000:0000:0000:0000:0000:0000).'
      required: true
    - name: mask
      description: 'Subnet mask indicating the prefix length (format: xxx, range: 0-128).'
      required: true
    outputs:
    - contextPath: Frotigate.Address6Multicast.Name
      description: The name of the updated address multicast.
      type: String
    - contextPath: Frotigate.Address6Multicast.IPAddress
      description: The IP address.
      type: String
    - contextPath: Frotigate.Address6Multicast.Mask
      description: The subnet mask of the address.
      type: String
  - name: fortigate-update-firewall-address-ipv6-multicast
    description: 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.
    arguments:
    - name: name
      description: Name of the address multicast to update. Names can be retrieved with the command `fortigate-list-firewall-address-ipv6-multicasts`.
      required: true
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: comment
      description: A comment for the address.
    - name: address
      description: 'IPv6 address prefix. Can be in short form (e.g., 2001:db8::) or long form (e.g., 0000:0000:0000:0000:0000:0000:0000:0000).'
    - name: mask
      description: 'Subnet mask indicating the prefix length (format: xxx, range: 0-128).'
    outputs:
    - contextPath: Frotigate.Address6Multicast.Name
      description: The name of the updated address multicast.
      type: String
    - contextPath: Frotigate.Address6Multicast.IPAddress
      description: The IP address.
      type: String
    - contextPath: Frotigate.Address6Multicast.Mask
      description: The subnet mask of the address.
      type: String
  - name: fortigate-delete-firewall-address-ipv6-multicast
    description: 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.
    arguments:
    - name: name
      description: Name of the address multicast to delete. Names can be retrieved with the command `fortigate-list-firewall-address-ipv6-multicasts`.
      required: true
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    outputs:
    - contextPath: Fortigate.Address6Multicast.Name
      description: The name of the address multicast.
      type: String
    - contextPath: Fortigate.Address6Multicast.Deleted
      description: Whether the address multicast was deleted.
      type: Boolean
  - name: fortigate-list-firewall-address-ipv4-groups
    description: Retrieve firewall IPv4 address groups. Address groups are designed for ease of use in the administration of the device.
    arguments:
    - name: groupName
      description: Name of a specific address group to return.
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: filter_field
      description: 'Specifies the field to be searched, such as `name` or `comment`, to narrow down the search criteria within the objects. Fields must be written as they are in the `raw_response`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/225620/config-firewall-addrgrp`.'
    - name: filter_value
      description: Indicates the value or partial value, for example `Sales`, that the API should look for within the specified field to find matching objects.
    - name: format_fields
      description: 'Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the `raw_response`, for example: `name` or `comment`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/225620/config-firewall-addrgrp`.'
      isArray: true
    outputs:
    - contextPath: Frotigate.AddressGroup.FabricObject
      description: Security Fabric global object setting. Can be `enable` or `disable`. If `enable`, the object is set as a security fabric-wide global object, otherwise the object is local to this security fabric member.
      type: String
    - contextPath: Frotigate.AddressGroup.AllowRouting
      description: Enable/disable use of this address in the static route configuration.
      type: String
    - contextPath: Frotigate.AddressGroup.Tagging
      description: List of tags associated to the object.
      type: String
    - contextPath: Frotigate.AddressGroup.ExcludeMember
      description: Address name exclusion member.
      type: String
    - contextPath: Frotigate.AddressGroup.Exclude
      description: Enable/disable address exclusion.
      type: String
    - contextPath: Frotigate.AddressGroup.Comment
      description: The object`s comment.
      type: String
    - contextPath: Frotigate.AddressGroup.Member.Name
      description: Address objects contained within the group.
      type: String
    - contextPath: Frotigate.AddressGroup.UUID
      description: Universally Unique Identifier.
      type: String
    - contextPath: Frotigate.AddressGroup.Category
      description: 'Address group category. `default`: Default address group category (cannot be used as ztna-ems-tag/ztna-geo-tag in policy). `ztna-ems-tag`: Members must be ztna-ems-tag group or ems-tag address. Can be used as ztna-ems-tag in policy. `ztna-geo-tag`: Members must be ztna-geo-tag group or geographic address. Can be used as ztna-geo-tag in policy.'
      type: String
    - contextPath: Frotigate.AddressGroup.Type
      description: Address group type. Default address group type (address may belong to multiple groups). Address folder group (members may not belong to any other group).
      type: String
    - contextPath: Frotigate.AddressGroup.Name
      description: Address group name.
      type: String
    - contextPath: Fortigate.AddressGroup.VDOM
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.
      type: String
  - name: fortigate-create-firewall-address-ipv4-group
    description: Create firewall IPv4 address groups. Address groups are designed for ease of use in the administration of the device.
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: groupName
      description: Name of the address group to create.
      required: true
    - name: type
      description: 'Address group type. `group`: Default address group type (address may belong to multiple groups). `folder`: Address folder group (members may not belong to any other group).'
      defaultValue: group
      auto: PREDEFINED
      predefined:
      - group
      - folder
    - name: address
      description: Comma-separated list of address names. Names can be retrieved with the commands `fortigate-list-firewall-address-ipv4s`, `fortigate-list-firewall-address-ipv4-multicasts` and `fortigate-list-firewall-address-ipv4-groups`.
    - name: excluded_addresses
      description: Comma-separated list of address names to exclude. Names can be retrieved with the commands `fortigate-list-firewall-address-ipv4s`, `fortigate-list-firewall-address-ipv4-multicasts` and `fortigate-list-firewall-address-ipv4-groups`.
    - name: allow_routing
      description: Enable/disable use of this address in the static route configuration.
      auto: PREDEFINED
      predefined:
      - enable
      - disable
    - name: comment
      description: A comment for the address group.
    outputs:
    - contextPath: Fortigate.AddressGroup.Name
      description: The address group name.
      type: String
    - contextPath: Fortigate.AddressGroup.Address
      description: The address group members.
      type: String
  - name: fortigate-update-firewall-address-ipv4-group
    description: 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.
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: groupName
      description: Name of the address group to update. Names can be retrieved with the command `fortigate-list-firewall-address-ipv4-groups`.
      required: true
    - name: address
      description: Comma-separated list of address names. Names can be retrieved with the commands `fortigate-list-firewall-address-ipv4s`, `fortigate-list-firewall-address-ipv4-multicasts` and `fortigate-list-firewall-address-ipv4-groups`.
      isArray: true
    - name: excluded_addresses
      description: Comma-separated list of address names to exclude. Names can be retrieved with the commands `fortigate-list-firewall-address-ipv4s`, `fortigate-list-firewall-address-ipv4-multicasts` and `fortigate-list-firewall-address-ipv4-groups`.
      isArray: true
    - name: allow_routing
      description: Enable/disable use of this address in the static route configuration.
      auto: PREDEFINED
      predefined:
      - enable
      - disable
    - name: comment
      description: A comment for the address group.
    - name: action
      description: Whether to add or remove members or excluded_members from address group.
      auto: PREDEFINED
      predefined:
      - add
      - remove
    outputs:
    - contextPath: Fortigate.AddressGroup.Name
      description: The address group name.
      type: String
    - contextPath: Fortigate.AddressGroup.Address.Name
      description: The address group members.
      type: String
    - contextPath: Frotigate.AddressGroup.UUID
      description: Universally Unique Identifier.
      type: String
  - name: fortigate-delete-firewall-address-ipv4-group
    description: Delete firewall IPv4 address groups. Address groups are designed for ease of use in the administration of the device.
    arguments:
    - name: name
      description: Name of the address group to delete. Names can be retrieved with the command `fortigate-list-firewall-address-ipv4-groups`.
      required: true
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    outputs:
    - contextPath: Fortigate.AddressGroup.Name
      description: The name of the address group.
      type: String
    - contextPath: Fortigate.AddressGroup.Deleted
      description: Whether the address group was deleted.
      type: Boolean
  - name: fortigate-list-firewall-address-ipv6-groups
    description: Retrieve firewall IPv6 address groups. Address groups are designed for ease of use in the administration of the device.
    arguments:
    - name: name
      description: Name of a specific address group to return.
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: filter_field
      description: 'Specifies the field to be searched, such as `name` or `comment`, to narrow down the search criteria within the objects. Fields must be written as they are in the `raw_response`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/226620/config-firewall-addrgrp6`.'
    - name: filter_value
      description: Indicates the value or partial value, for example `Sales`, that the API should look for within the specified field to find matching objects.
    - name: format_fields
      description: 'Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the `raw_response`, for example: `name` or `comment`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/226620/config-firewall-addrgrp6`.'
      isArray: true
    outputs:
    - contextPath: Frotigate.Address6Group.FabricObject
      description: Security Fabric global object setting. Can be `enable` or `disable`. If `enable`, the object is set as a security fabric-wide global object, otherwise the object is local to this security fabric member.
      type: String
    - contextPath: Frotigate.Address6Group.Tagging
      description: List of tags associated to the object.
      type: String
    - contextPath: Frotigate.Address6Group.Member.Name
      description: Address objects contained within the group.
      type: String
    - contextPath: Frotigate.Address6Group.Comment
      description: The object`s comment.
      type: String
    - contextPath: Frotigate.Address6Group.UUID
      description: Universally Unique Identifier.
      type: String
    - contextPath: Frotigate.Address6Group.Name
      description: Address group name.
      type: String
    - contextPath: Fortigate.Address6Group.VDOM
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.
      type: String
  - name: fortigate-create-firewall-address-ipv6-group
    description: Create firewall IPv6 address groups. Address groups are designed for ease of use in the administration of the device.
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: name
      description: Name of the address group to create.
      required: true
    - name: members
      description: Comma-separated list of address names. Names can be retrieved with the commands `fortigate-list-firewall-address-ipv6s`, `fortigate-list-firewall-address-ipv6-multicasts` and `fortigate-list-firewall-address-ipv6-groups`.
    - name: comment
      description: A comment for the address group.
    outputs:
    - contextPath: Fortigate.Address6Group.Name
      description: The address group name.
      type: String
    - contextPath: Fortigate.Address6Group.Address
      description: The address group members.
      type: String
  - name: fortigate-update-firewall-address-ipv6-group
    description: 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.
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: name
      description: Name of the address group to update. Names can be retrieved with the command `fortigate-list-firewall-address-ipv6-groups`.
      required: true
    - name: members
      description: Comma-separated list of address names. Names can be retrieved with the commands `fortigate-list-firewall-address-ipv6s`, `fortigate-list-firewall-address-ipv6-multicasts` and `fortigate-list-firewall-address-ipv6-groups`.
    - name: comment
      description: A comment for the address group.
    - name: action
      description: Whether to add or remove members from address group.
      auto: PREDEFINED
      predefined:
      - add
      - remove
    outputs:
    - contextPath: Fortigate.Address6Group.Name
      description: The address group name.
      type: String
    - contextPath: Fortigate.Address6Group.Address
      description: The address group members.
      type: String
  - name: fortigate-delete-firewall-address-ipv6-group
    description: Delete firewall IPv6 address groups. Address groups are designed for ease of use in the administration of the device.
    arguments:
    - name: name
      description: Name of the address group to delete. Names can be retrieved with the command `fortigate-list-firewall-address-ipv6-groups`.
      required: true
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    outputs:
    - contextPath: Fortigate.Address6Group.Name
      description: The name of the deleted address group.
      type: String
    - contextPath: Fortigate.Address6Group.Deleted
      description: Whether the address group was deleted.
      type: Boolean
  - name: fortigate-list-firewall-services
    description: Retrieve firewall services. A service is the combination of network protocols and port numbers that define traffic sources or destinations.
    arguments:
    - name: serviceName
      description: Name of a specific service to return.
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: filter_field
      description: 'Specifies the field to be searched, such as `name` or `comment`, to narrow down the search criteria within the objects. Fields must be written as they are in the `raw_response`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/231620/config-firewall-service-custom`.'
    - name: filter_value
      description: Indicates the value or partial value, for example `Sales`, that the API should look for within the specified field to find matching objects.
    - name: format_fields
      description: 'Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the `raw_response`, for example: `name` or `comment`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/231620/config-firewall-service-custom`.'
      isArray: true
    outputs:
    - contextPath: Fortigate.Service.FabricObject
      description: Security Fabric global object setting. Can be `enable` or `disable`. If `enable`, the object is set as a security fabric-wide global object, otherwise the object is local to this security fabric member.
      type: String
    - contextPath: Fortigate.Service.Application
      description: The application ID.
      type: Number
    - contextPath: Fortigate.Service.AppCategory
      description: Application category ID.
      type: Number
    - contextPath: Fortigate.Service.AppServiceType
      description: 'Application service type. Can be: `disable`, `app-id` or `app-category`.'
      type: String
    - contextPath: Fortigate.Service.Comment
      description: The object`s comment.
      type: String
    - contextPath: Fortigate.Service.CheckResetRange
      description: The configuration type of ICMP error message verification.
      type: String
    - contextPath: Fortigate.Service.SessionTTL
      description: Session time to live.
      type: String
    - contextPath: Fortigate.Service.UDPIdleTimer
      description: Number of seconds before an idle UDP connection times out.
      type: Number
    - contextPath: Fortigate.Service.TCPRSTTimer
      description: Set the length of the TCP CLOSE state in seconds.
      type: Number
    - contextPath: Fortigate.Service.TCPTimewaitTimer
      description: Set the length of the TCP TIME-WAIT state in seconds.
      type: Number
    - contextPath: Fortigate.Service.TCPHalfopenTimer
      description: Wait time to close a TCP session waiting for an unanswered open session packet.
      type: Number
    - contextPath: Fortigate.Service.TCPHalfcloseTimer
      description: Wait time to close a TCP session waiting for an unanswered open session packet.
      type: Number
    - contextPath: Fortigate.Service.Ports.SCTP
      description: Multiple SCTP port ranges.
      type: String
    - contextPath: Fortigate.Service.Ports.UDP
      description: Multiple UDP port ranges.
      type: String
    - contextPath: Fortigate.Service.Ports.TCP
      description: Multiple TCP port ranges.
      type: String
    - contextPath: Fortigate.Service.FQDN
      description: Fully Qualified Domain Name address.
      type: String
    - contextPath: Fortigate.Service.IPRange
      description: Start and end of the IP range associated with the service.
      type: String
    - contextPath: Fortigate.Service.Helper
      description: Helper protocol name.
      type: String
    - contextPath: Fortigate.Service.Protocol
      description: Protocol type based on IANA numbers.
      type: String
    - contextPath: Fortigate.Service.Category
      description: The service category.
      type: String
    - contextPath: Fortigate.Service.Proxy
      description: Enable/disable web proxy service.
      type: String
    - contextPath: Fortigate.Service.Name
      description: The service name.
      type: String
    - contextPath: Fortigate.Service.ICMPCode
      description: ICMP code.
      type: Number
    - contextPath: Fortigate.Service.ICMPType
      description: ICMP type.
      type: Number
    - contextPath: Fortigate.Service.ProtocolNumber
      description: IP protocol number.
      type: Number
    - contextPath: Fortigate.Service.VDOM
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.
      type: String
  - name: fortigate-create-firewall-service
    description: '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].'
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: serviceName
      description: Name of the service to create.
      required: true
    - name: comment
      description: A comment for the service.
      isArray: true
    - name: category
      description: Service category.
    - name: start_ip
      description: Start of the IP range associated with the service.
    - name: end_ip
      description: End of the IP range associated with the service.
    - name: fqdn
      description: Fully Qualified Domain Name address.
    - name: tcpRange
      description: 'Comma-separated list of TCP ports. Must be in the following template: {single} for example 5, {start}-{end} for example 1-50 or {start_source}-{end_source}:{start_destination}-{end_destinatinon} for example 1-3:6-9.'
      isArray: true
    - name: udpRange
      description: 'Comma-separated list of TCP ports. Must be in the following template: {single} for example 5, {start}-{end} for example 1-50 or {start_source}-{end_source}:{start_destination}-{end_destinatinon} for example 1-3:6-9.'
      isArray: true
    - name: sctpRange
      description: 'Comma-separated list of TCP ports. Must be in the following template: {single} for example 5, {start}-{end} for example 1-50 or {start_source}-{end_source}:{start_destination}-{end_destinatinon} for example 1-3:6-9.'
      isArray: true
    - name: icmp_type
      description: Specifies the ICMP message type, defining the purpose or condition of the message.
    - name: icmp_code
      description: Identifies the variant or additional information for the corresponding ICMP message type.
    - name: icmp_version
      description: Determines the version of the Internet Control Message Protocol, either ICMP or ICMP6.
      auto: PREDEFINED
      predefined:
      - ICMP
      - ICMP6
    - name: ip_protocol
      description: IP protocol number.
    outputs:
    - contextPath: Fortigate.Service.Ports.SCTP
      description: Multiple SCTP port ranges.
      type: String
    - contextPath: Fortigate.Service.Ports.UDP
      description: Multiple UDP port ranges.
      type: String
    - contextPath: Fortigate.Service.Ports.TCP
      description: Multiple TCP port ranges.
      type: String
    - contextPath: Fortigate.Service.FQDN
      description: Fully Qualified Domain Name address.
      type: String
    - contextPath: Fortigate.Service.StartIP
      description: Start of the IP range associated with the service.
      type: String
    - contextPath: Fortigate.Service.EndIP
      description: End of the IP range associated with the service.
      type: String
    - contextPath: Fortigate.Service.ICMPCode
      description: ICMP code.
      type: Number
    - contextPath: Fortigate.Service.ICMPType
      description: ICMP type.
      type: Number
    - contextPath: Fortigate.Service.ProtocolNumber
      description: IP protocol number.
      type: Number
    - contextPath: Fortigate.Service.Name
      description: The service name.
      type: String
  - name: fortigate-update-firewall-service
    description: '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].'
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: name
      description: Name of the service to update. Names can be retrieved with the command `fortigate-list-firewall-services`.
      required: true
      default: true
    - name: comment
      description: A comment for the service.
      isArray: true
    - name: category
      description: Service category.
    - name: start_ip
      description: Start of the IP range associated with the service.
    - name: end_ip
      description: End of the IP range associated with the service.
    - name: fqdn
      description: Fully Qualified Domain Name address.
    - name: tcpRange
      description: 'Comma-separated list of TCP ports. Must be in the following template: {single} for example 5, {start}-{end} for example 1-50 or {start_source}-{end_source}:{start_destination}-{end_destinatinon} for example 1-3:6-9.'
      isArray: true
    - name: udpRange
      description: 'Comma-separated list of TCP ports. Must be in the following template: {single} for example 5, {start}-{end} for example 1-50 or {start_source}-{end_source}:{start_destination}-{end_destinatinon} for example 1-3:6-9.'
      isArray: true
    - name: sctpRange
      description: 'Comma-separated list of TCP ports. Must be in the following template: {single} for example 5, {start}-{end} for example 1-50 or {start_source}-{end_source}:{start_destination}-{end_destinatinon} for example 1-3:6-9.'
      isArray: true
    - name: action
      description: Whether to add or remove destination and source ports from TCP/UDP/SCTP.
      auto: PREDEFINED
      predefined:
      - add
      - remove
    - name: icmp_type
      description: Specifies the ICMP message type, defining the purpose or condition of the message.
    - name: icmp_code
      description: Identifies the variant or additional information for the corresponding ICMP message type.
    - name: icmp_version
      description: Determines the version of the Internet Control Message Protocol, either ICMPv4 or ICMPv6.
      auto: PREDEFINED
      predefined:
      - icmp4
      - icmp6
    - name: ip_protocol
      description: IP protocol number.
    outputs:
    - contextPath: Fortigate.Service.Ports.SCTP
      description: Multiple SCTP port ranges.
      type: String
    - contextPath: Fortigate.Service.Ports.UDP
      description: Multiple UDP port ranges.
      type: String
    - contextPath: Fortigate.Service.Ports.TCP
      description: Multiple TCP port ranges.
      type: String
    - contextPath: Fortigate.Service.FQDN
      description: Fully Qualified Domain Name address.
      type: String
    - contextPath: Fortigate.Service.IPRange
      description: Start and end of the IP range associated with the service.
      type: String
    - contextPath: Fortigate.Service.ICMPCode
      description: ICMP code.
      type: Number
    - contextPath: Fortigate.Service.ICMPType
      description: ICMP type.
      type: Number
    - contextPath: Fortigate.Service.ProtocolNumber
      description: IP protocol number.
      type: Number
    - contextPath: Fortigate.Service.Name
      description: The service name.
      type: String
  - name: fortigate-delete-firewall-service
    description: Delete firewall services. A service is the combination of network protocols and port numbers that define traffic sources or destinations.
    arguments:
    - name: name
      description: Name of the service to delete. Names can be retrieved with the command `fortigate-list-firewall-services`.
      required: true
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    outputs:
    - contextPath: Fortigate.Service.Name
      description: The name of the deleted service.
      type: String
    - contextPath: Fortigate.Service.Deleted
      description: Whether the service was deleted.
      type: Boolean
  - name: fortigate-list-firewall-service-groups
    description: Retrieve firewall service groups. Service groups are collections of predefined services. Service groups can be used as the source and destination of the policy.
    arguments:
    - name: name
      description: Name of a specific service group to return.
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: filter_field
      description: 'Specifies the field to be searched, such as `name` or `comment`, to narrow down the search criteria within the objects. Fields must be written as they are in the `raw_response`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/232620/config-firewall-service-group`.'
    - name: filter_value
      description: Indicates the value or partial value, for example `Sales`, that the API should look for within the specified field to find matching objects.
    - name: format_fields
      description: 'Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the `raw_response`, for example: `name` or `comment`. Fields must be written as they are in the `raw_response`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/232620/config-firewall-service-group`.'
      isArray: true
    outputs:
    - contextPath: Fortigate.ServiceGroup.FabricObject
      description: Security Fabric global object setting. Can be `enable` or `disable`. If `enable`, the object is set as a security fabric-wide global object, otherwise the object is local to this security fabric member.
      type: String
    - contextPath: Fortigate.ServiceGroup.Comment
      description: The object`s comment.
      type: String
    - contextPath: Fortigate.ServiceGroup.Proxy
      description: Enable/disable web proxy service.
      type: String
    - contextPath: Fortigate.ServiceGroup.Name
      description: The service group name.
      type: String
    - contextPath: Frotigate.ServiceGroup.Member.Name
      description: Service objects contained within the group.
      type: String
    - contextPath: Fortigate.ServiceGroup.VDOM
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.
      type: String
  - name: fortigate-create-firewall-service-group
    description: Create firewall service groups. Service groups are collections of predefined services. Service groups can be used as the source and destination of the policy.
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: name
      description: Name of the service group to create.
      required: true
    - name: comment
      description: A comment for the service group.
    - name: members
      description: Comma-separated list of service and service group names. Names can be retrieved with the commands `fortigate-list-firewall-services` and `fortigate-list-firewall-service-groups`.
      required: true
      isArray: true
    outputs:
    - contextPath: Fortigate.ServiceGroup.Name
      description: The service group name.
      type: String
    - contextPath: Fortigate.ServiceGroup.Members
      description: Service objects contained within the group.
      type: String
  - name: fortigate-update-firewall-service-group
    description: 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.
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: groupName
      description: Name of the service group to update. Names can be retrieved with the command `fortigate-list-firewall-service-groups`.
      required: true
      default: true
    - name: comment
      description: A comment for the service group.
    - name: serviceName
      description: Comma-separated list of service and service group names. Names can be retrieved with the commands `fortigate-list-firewall-services` and `fortigate-list-firewall-service-groups`.
      isArray: true
    - name: action
      description: Whether to add or remove members from the service group.
      auto: PREDEFINED
      predefined:
      - add
      - remove
    outputs:
    - contextPath: Fortigate.ServiceGroup.Name
      description: The service group name.
      type: String
    - contextPath: Fortigate.ServiceGroup.Service.Name
      description: Service objects contained within the group.
      type: String
  - name: fortigate-delete-firewall-service-group
    description: Delete firewall service groups. Service groups are collections of predefined services. Service groups can be used as the source and destination of the policy.
    arguments:
    - name: groupName
      description: Name of the service group to delete. Names can be retrieved with the command `fortigate-list-firewall-service-groups`.
      required: true
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    outputs:
    - contextPath: Fortigate.ServiceGroup.Name
      description: The name of the deleted service group.
      type: String
    - contextPath: Fortigate.ServiceGroup.Deleted
      description: Whether the service group was deleted.
      type: Boolean
  - name: fortigate-list-firewall-policies
    description: 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.
    arguments:
    - name: policyID
      description: ID of a specific policy to return.
      default: true
    - name: policyName
      description: Name of a specific policy to return.
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: filter_field
      description: 'Specifies the field to be searched, such as `name` or `comment`, to narrow down the search criteria within the objects. Fields must be written as they are in the `raw_response`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/287620/config-firewall-policy`.'
    - name: filter_value
      description: Indicates the value or partial value, for example `Sales`, that the API should look for within the specified field to find matching objects.
    - name: format_fields
      description: 'Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the `raw_response`, for example: `name` or `comment`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/287620/config-firewall-policy`.'
      isArray: true
    outputs:
    - contextPath: Fortigate.Policy.ServiceNegate
      description: When enabled specifies what the service must not be.
      type: String
    - contextPath: Fortigate.Policy.Destination6Negate
      description: When enabled, specifies what the destination IPv6 address must not be.
      type: String
    - contextPath: Fortigate.Policy.DestinationNegate
      description: When enabled, specifies what the destination IPv4 address must not be.
      type: String
    - contextPath: Fortigate.Policy.Source6Negate
      description: When enabled, specifies what the source IPv6 address must not be.
      type: String
    - contextPath: Fortigate.Policy.SourceNegate
      description: When enabled, specifies what the source IPv4 address must not be.
      type: String
    - contextPath: Fortigate.Policy.NAT
      description: Whether the source NAT is enabled or disabled.
      type: String
    - contextPath: Fortigate.Policy.LogStart
      description: Whether recording logs when a session starts is enabled or disabled.
      type: String
    - contextPath: Fortigate.Policy.Log
      description: All log sessions or security profile sessions.
      type: String
    - contextPath: Fortigate.Policy.Service
      description: Service and service group names.
      type: String
    - contextPath: Fortigate.Policy.Source6
      description: Source IPv6 address name and address group names.
      type: String
    - contextPath: Fortigate.Policy.Destination6
      description: Destination IPv6 address name and address group names.
      type: String
    - contextPath: Fortigate.Policy.Destination
      description: Destination IPv4 address and address group names.
      type: String
    - contextPath: Fortigate.Policy.Source
      description: Source IPv4 address and address group names.
      type: String
    - contextPath: Fortigate.Policy.Action
      description: Policy action (accept/deny/ipsec).
      type: String
    - contextPath: Fortigate.Policy.DestinationInterface
      description: Outgoing (egress) interface.
      type: String
    - contextPath: Fortigate.Policy.SourceInterface
      description: Incoming (ingress) interface.
      type: String
    - contextPath: Fortigate.Policy.UUID
      description: Universally Unique Identifier.
      type: String
    - contextPath: Fortigate.Policy.Name
      description: The policy name.
      type: String
    - contextPath: Fortigate.Policy.Status
      description: Whether this policy is enabled or disabled.
      type: String
    - contextPath: Fortigate.Policy.ID
      description: The policy ID.
      type: Number
    - contextPath: Fortigate.Policy.Description
      description: The policy description.
      type: String
    - contextPath: Fortigate.Policy.Security
      description: Policy attached security profile.
      type: String
    - contextPath: Fortigate.Policy.VDOM
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.
      type: String
    - contextPath: Fortigate.Policy.Schedule
      description: The name of the schedule.
      type: String
  - name: fortigate-create-firewall-policy
    description: 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.
    execution: true
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: policyName
      description: Name of the policy to create.
      required: true
    - name: description
      description: The policy description.
    - name: sourceIntf
      description: Comma-separated list of incoming (ingress) interfaces.
      required: true
      isArray: true
    - name: dstIntf
      description: Comma-separated list of outgoing (egress) interfaces.
      required: true
      isArray: true
    - name: source
      description: Comma-separated list of source IPv4 address and address group names. Names can be retrieved with the commands `fortigate-list-firewall-address-ipv4s`, `fortigate-list-firewall-address-ipv4-multicasts` and `fortigate-list-firewall-address-ipv4-groups`.
      isArray: true
    - name: source6
      description: Comma-separated list of source IPv6 address name and address group names. Names can be retrieved with the commands `fortigate-list-firewall-address-ipv6s`, `fortigate-list-firewall-address-ipv6-multicasts` and `fortigate-list-firewall-address-ipv6-groups`.
      isArray: true
    - name: destination
      description: Comma-separated list of destination IPv4 address and address group names. Names can be retrieved with the commands `fortigate-list-firewall-address-ipv4s`, `fortigate-list-firewall-address-ipv4-multicasts` and `fortigate-list-firewall-address-ipv4-groups`.
      isArray: true
    - name: destination6
      description: Comma-separated list of destination IPv6 address name and address group names. Names can be retrieved with the commands `fortigate-list-firewall-address-ipv6s`, `fortigate-list-firewall-address-ipv6-multicasts` and `fortigate-list-firewall-address-ipv6-groups`.
      isArray: true
    - name: negate_source_address
      description: When enabled, the source address specifies what the source address must not be.
      auto: PREDEFINED
      predefined:
      - enable
      - disable
    - name: negate_destination_address
      description: When enabled, the destination address specifies what the destination address must not be.
      auto: PREDEFINED
      predefined:
      - enable
      - disable
    - name: service
      description: Comma-separated list of service and service group names. Names can be retrieved with the commands `fortigate-list-firewall-services` and `fortigate-list-firewall-service-groups`.
      required: true
      isArray: true
    - name: negate_service
      description: When enabled, the service specifies what the service must not be.
      auto: PREDEFINED
      predefined:
      - enable
      - disable
    - name: action
      description: Whether to accept or deny sessions that match the firewall policy.
      auto: PREDEFINED
      predefined:
      - accept
      - block
      required: true
    - name: status
      description: Enable or disable this policy.
      defaultValue: enable
      auto: PREDEFINED
      predefined:
      - enable
      - disable
    - name: log
      description: Enable or disable logging. Log all sessions or security profile sessions.
      defaultValue: enable
      auto: PREDEFINED
      predefined:
      - all
      - utm
      - disable
    - name: schedule
      description: The schedule name. This is a time frame that is applied to the policy.
      defaultValue: always
    - name: nat
      description: Enable/disable source Network Address Translation.
      defaultValue: enable
      auto: PREDEFINED
      predefined:
      - enable
      - disable
    outputs:
    - contextPath: Fortigate.Policy.NAT
      description: Whether the source NAT is enabled or disabled.
      type: String
    - contextPath: Fortigate.Policy.Log
      description: All log sessions or security profile sessions.
      type: String
    - contextPath: Fortigate.Policy.Service
      description: Service and service group names.
      type: String
    - contextPath: Fortigate.Policy.Source.Address6.name
      description: Source IPv6 address name and address group names.
      type: String
    - contextPath: Fortigate.Policy.Destination.Address6.name
      description: Destination IPv6 address name and address group names.
      type: String
    - contextPath: Fortigate.Policy.Destination.Address.name
      description: Destination IPv4 address and address group names.
      type: String
    - contextPath: Fortigate.Policy.Source.Address.name
      description: Source IPv4 address and address group names.
      type: String
    - contextPath: Fortigate.Policy.Action
      description: Policy action (accept/deny/ipsec).
      type: String
    - contextPath: Fortigate.Policy.Destination.Interface
      description: Outgoing (egress) interface.
      type: String
    - contextPath: Fortigate.Policy.Source.Interface
      description: Incoming (ingress) interface.
      type: String
    - contextPath: Fortigate.Policy.Name
      description: The policy name.
      type: String
    - contextPath: Fortigate.Policy.Status
      description: Whether this policy is enabled or disabled.
      type: String
    - contextPath: Fortigate.Policy.Description
      description: The policy description.
      type: String
  - name: fortigate-update-firewall-policy
    description: 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.
    execution: true
    arguments:
    - name: policyID
      description: ID of the policy to update. IDs can be retrieved with the command `fortigate-list-firewall-policies`.
      required: true
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: field
      description: Field parameter to update.
      auto: PREDEFINED
      predefined:
      - source_interface
      - destination_interface
      - description
      - status
      - source
      - destination
      - service
      - schedule
      - action
      - log
      - nat
      - source6
      - destination6
      - negate_source
      - negate_destination
      - negate_source6
      - negate_destination6
      - negate_service
      required: true
    - name: value
      description: Value of the field parameter to update.
      required: true
    - name: keep_original_data
      description: Whether to keep the original data or not. Only relevant if the updated field is "source" or "destination". If the supplied value is `True`, the current data will not be replaced. Instead, the supplied addresses will be added / removed from the existing data.
      auto: PREDEFINED
      predefined:
      - 'true'
      - 'false'
    - name: add_or_remove
      description: Whether to add or remove the supplied addresses from the existing data. Only relevant in case the field to update is "source" or "destination", and keep_original_data is specified to `True`.
      auto: PREDEFINED
      predefined:
      - add
      - remove
    outputs:
    - contextPath: Fortigate.Policy.ServiceNegate
      description: When enabled, specifies what the service must not be.
      type: String
    - contextPath: Fortigate.Policy.Destination6Negate
      description: When enabled, specifies what the destination IPv6 address must not be.
      type: String
    - contextPath: Fortigate.Policy.DestinationNegate
      description: When enabled, specifies what the destination IPv4 address must not be.
      type: String
    - contextPath: Fortigate.Policy.Source6Negate
      description: When enabled, specifies what the source IPv6 address must not be.
      type: String
    - contextPath: Fortigate.Policy.SourceNegate
      description: When enabled, specifies what the source IPv4 address must not be.
      type: String
    - contextPath: Fortigate.Policy.NAT
      description: Whether the source NAT is enabled or disabled.
      type: String
    - contextPath: Fortigate.Policy.LogStart
      description: Whether recording logs when a session starts is enabled or disabled.
      type: String
    - contextPath: Fortigate.Policy.Log
      description: All log sessions or security profile sessions.
      type: String
    - contextPath: Fortigate.Policy.Service
      description: Service and service group names.
      type: String
    - contextPath: Fortigate.Policy.Source6
      description: Source IPv6 address name and address group names.
      type: String
    - contextPath: Fortigate.Policy.Destination6
      description: Destination IPv6 address name and address group names.
      type: String
    - contextPath: Fortigate.Policy.Destination
      description: Destination IPv4 address and address group names.
      type: String
    - contextPath: Fortigate.Policy.Source
      description: Source IPv4 address and address group names.
      type: String
    - contextPath: Fortigate.Policy.Action
      description: Policy action (accept/deny/ipsec).
      type: String
    - contextPath: Fortigate.Policy.DestinationInterface
      description: Outgoing (egress) interface.
      type: String
    - contextPath: Fortigate.Policy.SourceInterface
      description: Incoming (ingress) interface.
      type: String
    - contextPath: Fortigate.Policy.UUID
      description: Universally Unique Identifier.
      type: String
    - contextPath: Fortigate.Policy.Name
      description: The policy name.
      type: String
    - contextPath: Fortigate.Policy.Status
      description: Whether this policy is enabled or disabled.
      type: String
    - contextPath: Fortigate.Policy.ID
      description: The policy ID.
      type: Number
    - contextPath: Fortigate.Policy.Description
      description: The policy description.
      type: String
    - contextPath: Fortigate.Policy.Security
      description: Policy attached security profile.
      type: String
    - contextPath: Fortigate.Policy.Schedule
      description: The name of the schedule.
      type: String
  - name: fortigate-move-firewall-policy
    description: 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.
    arguments:
    - name: policyID
      description: ID of the policy to move. IDs can be retrieved with the command `fortigate-list-firewall-policies`.
      required: true
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: position
      description: Whether to position the policy before or after its neighbor.
      auto: PREDEFINED
      predefined:
      - before
      - after
      required: true
    - name: neighbor
      description: The ID of the neighbor policy. IDs can be retrieved with the command `fortigate-list-firewall-policies`.
      required: true
    outputs:
    - contextPath: Fortigate.Policy.ID
      description: The policy ID.
      type: Number
    - contextPath: Fortigate.Policy.Moved
      description: Whether the policy was moved.
      type: Boolean
  - name: fortigate-delete-firewall-policy
    description: 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.
    execution: true
    arguments:
    - name: policyID
      description: ID of the policy to delete. IDs can be retrieved with the command `fortigate-list-firewall-policies`.
      required: true
      default: true
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    outputs:
    - contextPath: Fortigate.Policy.ID
      description: The policy ID.
      type: Number
    - contextPath: Fortigate.Policy.Deleted
      description: Whether the policy was deleted.
      type: Boolean
  - name: fortigate-list-system-vdoms
    description: 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.
    arguments:
    - name: filter_field
      description: 'Specifies the field to be searched, such as `name` or `comment`, to narrow down the search criteria within the objects. Fields must be written as they are in the `raw_response`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/620/config-system-vdom`.'
    - name: filter_value
      description: Indicates the value or partial value, for example `Sales`, that the API should look for within the specified field to find matching objects.
    - name: format_fields
      description: 'Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the `raw_response`, for example: `name` or `comment`. Reference to possible fields: `https://docs.fortinet.com/document/fortigate/7.2.5/cli-reference/620/config-system-vdom`.'
      isArray: true
    outputs:
    - contextPath: Fortigate.VDOM.VClusterID
      description: Virtual cluster ID.
      type: Number
    - contextPath: Fortigate.VDOM.ShortName
      description: The virtual domain short name.
      type: String
    - contextPath: Fortigate.VDOM.Name
      description: The virtual domain name.
      type: String
  - name: fortigate-list-banned-ips
    description: 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.
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: filter_field
      description: Specifies the field to be searched, such as `name` or `comment`, to narrow down the search criteria within the objects. Fields must be written as they are in the `raw_response`.
    - name: filter_value
      description: Indicates the value or partial value, for example `Sales`, that the API should look for within the specified field to find matching objects.
    - name: format_fields
      description: 'Comma-separated fields to format the API call to display certain information. Fields must be written as they are in the `raw_response`, for example: `name` or `comment`.'
      isArray: true
    outputs:
    - contextPath: Fortigate.BannedIP.IsV6
      description: Whether the IP is IPv4 (0) or IPv6 (1).
      type: Number
    - contextPath: Fortigate.BannedIP.Source
      description: Source of the ban.
      type: String
    - contextPath: Fortigate.BannedIP.IP
      description: The IPv4 address.
      type: String
    - contextPath: Fortigate.BannedIP.Created
      description: Date/time the IP address was added to the banned list.
      type: Number
    - contextPath: Fortigate.BannedIP.Expires
      description: Date/time the IP address expires from the banned list.
      type: Number
    - contextPath: Fortigate.BannedIP.VDOM
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units.
      type: String
  - name: fortigate-ban-ip
    description: 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.
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: ip_address
      description: Comma-separated list of IPs to ban. Both IPv4 and IPv6 addresses are supported.
      required: true
      isArray: true
    - name: expiry
      description: Time until the ban expires in seconds. `0` for indefinite ban.
      defaultValue: '0'
    compliantpolicies:
    - IP Blockage
  - name: fortigate-unban-ip
    description: 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.
    arguments:
    - name: vdom
      description: Virtual domains (VDOMs) enable you to partition and use your FortiGate unit as if it were multiple units. Use `*` to retrieve all virtual domains. VDOMs can be retrieved with the command `fortigate-list-system-vdoms`.
      defaultValue: root
    - name: ip_address
      description: Comma-separated list of IPs to unban. Both IPv4 and IPv6 addresses are supported. IPs can be retrieved with the command `fortigate-list-banned-ips`.
      required: true
      isArray: true
  dockerimage: demisto/python3:3.12.13.10116658
  runonce: false
  script: '-'
  subtype: python3
  type: python
tests:
- Fortigate Test
fromversion: 5.0.0