fortiweb_vm

Fortiweb VM integration allows to manage WAF policies and block cookies, URLs, and host names.
This integration was integrated and tested with version 1 & 2 of fortiweb_vm

Configure Fortiweb VM in Cortex

Commands

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

fortiwebvm-protected-hostname-group-create

Create protected host name group.

Base Command

fortiwebvm-protected-hostname-group-create

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-protected-hostname-group-create name=example

Human Readable Output

Hostname group successfully created

Name
example

fortiwebvm-protected-hostname-group-update

Update protected host name group.

Base Command

fortiwebvm-protected-hostname-group-update

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-protected-hostname-group-update name=example default_action=Deny

Human Readable Output

Hostname group successfully updated

Name
example

fortiwebvm-protected-hostname-group-list

List the Protected host name group.

Base Command

fortiwebvm-protected-hostname-group-list

Input

Context Output

Command example

!fortiwebvm-protected-hostname-group-list name=example

Context Example - API Version 1

{
    "FortiwebVM": {
        "ProtectedHostnameGroup": {
            "can_delete": true,
            "default_action": "Allow",
            "id": "example",
            "protected_hostname_count": 0
        }
    }
}

Human Readable Output - API Version 1

Protected Hostnames Groups

Showing 1 rows out of 1.

Id	Default Action	Protected Hostname Count	Can Delete
example	Allow	0	true

Context Example - API Version 2

{
    "FortiwebVM": {
        "ProtectedHostnameGroup": {
            "default_action": "Allow",
            "id": "example",
            "protected_hostname_count": 0
        }
    }
}

Human Readable Output - API Version 2

Protected Hostnames Groups

Showing 1 rows out of 1.

Id	Default Action	Protected Hostname Count
example	Allow	0

fortiwebvm-protected-hostname-member-create

Create protected host name member.

Base Command

fortiwebvm-protected-hostname-member-create

Input

Context Output

Human Readable Output

Hostname member successfully created

Id
1

fortiwebvm-protected-hostname-member-update

Update a protected host name member.

Base Command

fortiwebvm-protected-hostname-member-update

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-protected-hostname-member-update group_name=example member_id=1 action=Allow

Human Readable Output

Hostname member successfully updated

Id
1

fortiwebvm-protected-hostname-member-list

List all the protected host name members.

Base Command

fortiwebvm-protected-hostname-member-list

Input

Context Output

Command example

!fortiwebvm-protected-hostname-member-list group_name=example member_id=1

Context Example - API Version 1

{
    "FortiwebVM": {
        "ProtectedHostnameMember": {
            "Members": [
                {
                    "action": "Deny",
                    "host": "1.2.3.4",
                    "id": "1"
                }
            ],
            "group_name": "example"
        }
    }
}

Human Readable Output - API Version 1

Protected Hostnames Members

Showing 1 rows out of 1.

Id	Action	Host
1	Deny	1.2.3.4

Context Example - API Version 2

{
    "FortiwebVM": {
        "ProtectedHostnameMember": {
            "Members": [
                {
                    "action": "Deny",
                    "host": "1.2.3.4",
                    "id": "1",
                    "ignore_port": "disable",
                    "include_subdomains": "disable"
                }
            ],
            "group_name": "example"
        }
    }
}

Human Readable Output - API Version 2

Protected Hostnames Members

Showing 1 rows out of 1.

Id	Action	Host	Ignore Port	Include Subdomains
1	Deny	1.2.3.4	disable	disable

fortiwebvm-protected-hostname-member-delete

Delete protected host name member.

Base Command

fortiwebvm-protected-hostname-member-delete

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-protected-hostname-member-delete group_name=example member_id=1

Human Readable Output

Hostname member successfully deleted

Id
1

fortiwebvm-protected-hostname-group-delete

Delete a protected host name.

Base Command

fortiwebvm-protected-hostname-group-delete

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-protected-hostname-group-delete name=example

Human Readable Output

Hostname group successfully deleted

Name
example

There is no context output for this command.

fortiwebvm-ip-list-group-create

Create IP List.

Base Command

fortiwebvm-ip-list-group-create

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-ip-list-group-create name=example

Human Readable Output

IP List group successfully created

Name
example

fortiwebvm-ip-list-group-update

Update an IP list.

Base Command

fortiwebvm-ip-list-group-update

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-ip-list-group-update name=example block_period=550

Human Readable Output

IP List group successfully updated

Name
example

fortiwebvm-ip-list-group-list

Supports API versions 1 & 2.

Base Command

fortiwebvm-ip-list-group-list

Input

Context Output

Command example - API Version 1

!fortiwebvm-ip-list-group-list name=example

Context Example

{
    "FortiwebVM": {
        "IpListGroup": {
            "can_delete": true,
            "id": "example",
            "ip_list_count": 0
        }
    }
}

Human Readable Output - API Version 1

IP Lists Groups

Showing 1 rows out of 1.

Id	Ip List Count
example	0

Context Example - API Version 2

{
    "FortiwebVM": {
        "IpListGroup": {
            "action": "alert_deny",
            "block_period": 550,
            "can_clone": 1,
            "can_view": 0,
            "id": "example",
            "ip_list_count": 0,
            "q_ref": 0,
            "q_type": 1,
            "severity": "Low",
            "trigger_policy": ""
        }
    }
}

Human Readable Output - API Version 2

IP Lists Groups

Showing 1 rows out of 1.

Id	Ip List Count	Action	Block Period	Severity	Trigger Policy
example	0	alert_deny	550	Low

fortiwebvm-ip-list-member-create

Create an IP list member. Supports API versions 1 & 2.

Base Command

fortiwebvm-ip-list-member-create

Input

Context Output

Command example

!fortiwebvm-ip-list-member-create group_name=example ip_address=1.2.3.4 type="Black IP"

Context Example

{
    "FortiwebVM": {
        "IpListMember": {
            "id": "1"
        }
    }
}

Human Readable Output

IP List member successfully created

Id
1

fortiwebvm-ip-list-member-update

Update IP list policy member.

Base Command

fortiwebvm-ip-list-member-update

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-ip-list-member-update group_name=example member_id=1 ip_address=1.2.3.4

Human Readable Output

IP List member successfully updated

Id
1

fortiwebvm-ip-list-member-list

List the IP list policy members.

Base Command

fortiwebvm-ip-list-member-list

Input

Context Output

Command example

!fortiwebvm-ip-list-member-list group_name=example

Context Example - API Version 1

{
    "FortiwebVM": {
        "IpListMember": {
            "Members": [
                {
                    "id": "1",
                    "ip": "1.2.3.4",
                    "severity": "Medium",
                    "trigger_policy": "",
                    "type": "Black IP"
                }
            ],
            "group_name": "example"
        }
    }
}

Human Readable Output - API Version 1

IP Lists Members

Showing 1 rows out of 1.

Id	Type	Ip	Severity	Trigger Policy
1	Black IP	1.2.3.4	Medium

Context Example - API Version 2

{
    "FortiwebVM": {
        "IpListMember": {
            "Members": [
                {
                    "id": "1",
                    "ip": "1.2.3.4",
                    "type": "Black IP"
                }
            ],
            "group_name": "example"
        }
    }
}

Human Readable Output - API Version 2

IP Lists Members

Showing 1 rows out of 1.

Id	Type	Ip
1	Black IP	1.2.3.4

fortiwebvm-ip-list-member-delete

Delete an IP list policy member.

Base Command

fortiwebvm-ip-list-member-delete

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-ip-list-member-delete group_name=example member_id=1

Human Readable Output

IP List member successfully deleted

Id
1

fortiwebvm-ip-list-group-delete

Supports API versions 1 & 2.

Base Command

fortiwebvm-ip-list-group-delete

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-ip-list-group-delete name=example

Human Readable Output

IP List group successfully deleted

Id
example

fortiwebvm-custom-predefined-whitelist-update

Update the custom predefined global whitelist.

Base Command

fortiwebvm-custom-predefined-whitelist-update

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-custom-predefined-whitelist-update id=10002 status=disable

Human Readable Output

Custom predifined whitelist member successfully updated

Id
10002

fortiwebvm-custom-predefined-whitelist-list

Get custom predefined global whitelist.

Base Command

fortiwebvm-custom-predefined-whitelist-list

Input

Context Output

Command example

!fortiwebvm-custom-predefined-whitelist-list limit=1

Context Example

{
    "FortiwebVM": {
        "CustomPredefinedGlobalWhitelist": {
            "domain": "",
            "id": 100002,
            "name": "",
            "path": "test",
            "status": true
        }
    }
}

Human Readable Output

Custom whitelist members

Showing 1 rows out of 36.

Id	Name	Path	Domain	Status
100002		test		true

fortiwebvm-custom-whitelist-url-create

Create a custom global whitelist URL object.

Base Command

fortiwebvm-custom-whitelist-url-create

Input

Context Output

Command example

!fortiwebvm-custom-whitelist-url-create request_url=/123

Context Example

{
    "FortiwebVM": {
        "CustomGlobalWhitelist": {
            "id": 1
        }
    }
}

Human Readable Output

Custom whitelist URL member succesfuly created

Id
1

fortiwebvm-custom-whitelist-parameter-create

Create a custom global whitelist parameter object.

Base Command

fortiwebvm-custom-whitelist-parameter-create

Input

Context Output

Command example

!fortiwebvm-custom-whitelist-parameter-create name=example

Context Example

{
    "FortiwebVM": {
        "CustomGlobalWhitelist": {
            "id": 2
        }
    }
}

Human Readable Output

Custom whitelist Parameter member succesfuly created

Id
2

fortiwebvm-custom-whitelist-cookie-create

Create a custom global whitelist cookie object.

Base Command

fortiwebvm-custom-whitelist-cookie-create

Input

Context Output

Command example

!fortiwebvm-custom-whitelist-cookie-create name=example domain=abc path=/abc

Context Example

{
    "FortiwebVM": {
        "CustomGlobalWhitelist": {
            "id": 2
        }
    }
}

Human Readable Output

Custom whitelist Cookie member succesfuly created

Id
2

fortiwebvm-custom-whitelist-header-field-create

Create a custom global whitelist header field object. Supports API version 2 only.

Base Command

fortiwebvm-custom-whitelist-header-field-create

Input

Context Output

fortiwebvm-custom-whitelist-url-update

Update a custom global whitelist URL object.

Base Command

fortiwebvm-custom-whitelist-url-update

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-custom-whitelist-url-update id=1 status=disable

Human Readable Output

Custom whitelist URL member succesfuly updated

Id
1

fortiwebvm-custom-whitelist-parameter-update

Update custom global whitelist parameter object.

Base Command

fortiwebvm-custom-whitelist-parameter-update

Input

Context Output

There is no context output for this command.

fortiwebvm-custom-whitelist-cookie-update

Update a custom global whitelist cookie object.

Base Command

fortiwebvm-custom-whitelist-cookie-update

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-custom-whitelist-cookie-update id=3 status=disable

Human Readable Output

Custom whitelist Cookie member succesfuly updated

Id
3

fortiwebvm-custom-whitelist-header-field-update

Update a custom global whitelist header field object. Supports API version 2 only.

Base Command

fortiwebvm-custom-whitelist-header-field-update

Input

Context Output

There is no context output for this command.

fortiwebvm-custom-whitelist-delete

Delete a custom global whitelist object from the custom global whitelist.

Base Command

fortiwebvm-custom-whitelist-delete

Input

Context Output

There is no context output for this command.

fortiwebvm-custom-whitelist-list

List the custom global whitelist objects.

Base Command

fortiwebvm-custom-whitelist-list

Input

Context Output

Command example

!fortiwebvm-custom-whitelist-list limit=1

Context Example - API Version 1

{
    "FortiwebVM": {
        "CustomGlobalWhitelist": {
            "domain": "",
            "id": 1,
            "name": "",
            "path": "",
            "request_type": "Simple String",
            "request_url": "/123",
            "status": false,
            "type": "URL"
        }
    }
}

Human Readable Output - API Version 1

Custom whitelist members

Showing 1 rows out of 3.

Id	Name	Request Url	Path	Domain	Status
1		/123			false

Context Example - API Version 2

{
    "FortiwebVM": {
        "CustomGlobalWhitelist": {
            "domain": "",
            "domain_status": "disable",
            "domain_type": "",
            "header_name_type": "",
            "header_value_type": "",
            "id": "1",
            "name": "",
            "name_type": "",
            "path": "",
            "request_type": "",
            "request_url": "/123",
            "request_url_status": "disable",
            "status": "disable",
            "type": "URL",
            "value": "",
            "value_status": "disable"
        }
    }
}

Human Readable Output - API Version 2

Custom whitelist members

Showing 1 rows out of 3.

Id	Name	Request Url	Path	Domain	Status
1		/123			disable

fortiwebvm-geo-ip-member-add

Create Geo IP member.

Base Command

fortiwebvm-geo-ip-member-add

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-geo-ip-member-add group_name=example countries=Algeria

Context Example

{
    "FortiwebVM": {
        "GeoIpMember": {
            "country": "Algeria",
            "id": "1"
        }
    }
}

Human Readable Output

Geo IP member successfully added

Id	Country
1	Algeria

fortiwebvm-geo-ip-member-delete

Delete Geo IP member .

Base Command

fortiwebvm-geo-ip-member-delete

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-geo-ip-member-delete group_name=example member_id=1

Human Readable Output

Geo IP member succesfuly deleted

Member Id
1

fortiwebvm-geo-ip-member-list

Get Geo IP member.

Base Command

fortiwebvm-geo-ip-member-list

Input

Context Output

Command example

!fortiwebvm-geo-ip-member-list group_name=example member_id=1

Context Example

{
    "FortiwebVM": {
        "GeoIpMember": {
            "countries": [
                {
                    "country": "Algeria",
                    "id": "1"
                }
            ],
            "group_name": "example"
        }
    }
}

Human Readable Output

Geo IP member

Showing 1 rows out of 1.

Id	Country
1	Algeria

fortiwebvm-geo-ip-group-create

Create Geo IP.

Base Command

fortiwebvm-geo-ip-group-create

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-geo-ip-group-create name=example

Human Readable Output

Geo IP group successfully created

Name
example

fortiwebvm-geo-ip-group-update

Update Geo IP.

Base Command

fortiwebvm-geo-ip-group-update

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-geo-ip-group-update name=example

Human Readable Output

Geo IP group successfully updated

Name
example

fortiwebvm-geo-ip-group-delete

Delete Geo IP.

Base Command

fortiwebvm-geo-ip-group-delete

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-geo-ip-group-delete name=example

Human Readable Output

Geo IP group successfully deleted

Id
example

fortiwebvm-geo-ip-group-list

Get Geo IP list.

Base Command

fortiwebvm-geo-ip-group-list

Input

Context Output

fortiwebvm-system-operation-status-get

Get operation status.

Base Command

fortiwebvm-system-operation-status-get

Input

There are no input arguments for this command.

Context Output

There is no context output for this command.

Command example

#### Context Example

```json
{
    "FortiwebVM": {
        "SystemOperation": [
            {
                "alias": "",
                "id": "port1",
                "ip_netmask": "1.2.3.4/24",
                "label": 1,
                "link": "Up",
                "name": "port1",
                "rx": 582306,
                "speed_duplex": "10000 Mbps/Full Duplex",
                "tx": 18115
            },
            {
                "alias": "",
                "id": "port2",
                "ip_netmask": "1.2.3.4/0",
                "label": 2,
                "link": "Up",
                "name": "port2",
                "rx": 571254,
                "speed_duplex": "10000 Mbps/Full Duplex",
                "tx": 141
            },
            {
                "alias": "",
                "id": "port3",
                "ip_netmask": "1.2.3.4/0",
                "label": 3,
                "link": "Up",
                "name": "port3",
                "rx": 571338,
                "speed_duplex": "10000 Mbps/Full Duplex",
                "tx": 141
            },
            {
                "alias": "",
                "id": "port4",
                "ip_netmask": "1.2.3.4/0",
                "label": 4,
                "link": "Up",
                "name": "port4",
                "rx": 571252,
                "speed_duplex": "10000 Mbps/Full Duplex",
                "tx": 141
            },
            {
                "alias": "",
                "id": "port5",
                "ip_netmask": "1.2.3.4/0",
                "label": 5,
                "link": "Up",
                "name": "port5",
                "rx": 571246,
                "speed_duplex": "10000 Mbps/Full Duplex",
                "tx": 141
            },
            {
                "alias": "",
                "id": "port6",
                "ip_netmask": "1.2.3.4/0",
                "label": 6,
                "link": "Up",
                "name": "port6",
                "rx": 571245,
                "speed_duplex": "10000 Mbps/Full Duplex",
                "tx": 141
            },
            {
                "alias": "",
                "id": "port7",
                "ip_netmask": "1.2.3.4/0",
                "label": 7,
                "link": "Up",
                "name": "port7",
                "rx": 571239,
                "speed_duplex": "10000 Mbps/Full Duplex",
                "tx": 141
            },
            {
                "alias": "",
                "id": "port8",
                "ip_netmask": "1.2.3.4/0",
                "label": 8,
                "link": "Up",
                "name": "port8",
                "rx": 571283,
                "speed_duplex": "10000 Mbps/Full Duplex",
                "tx": 141
            },
            {
                "alias": "",
                "id": "port9",
                "ip_netmask": "1.2.3.4/0",
                "label": 9,
                "link": "Up",
                "name": "port9",
                "rx": 572431,
                "speed_duplex": "10000 Mbps/Full Duplex",
                "tx": 141
            },
            {
                "alias": "",
                "id": "port10",
                "ip_netmask": "1.2.3.4/0",
                "label": 10,
                "link": "Up",
                "name": "port10",
                "rx": 572083,
                "speed_duplex": "10000 Mbps/Full Duplex",
                "tx": 141
            }
        ]
    }
}

Human Readable Output

Operation networks

Id	Name	Label	Alias	Ip Netmask	Speed Duplex	Tx	Rx	Link
port1	port1	1		1.2.3.4/24	10000 Mbps/Full Duplex	18115	582306	Up
port2	port2	2		1.2.3.4/0	10000 Mbps/Full Duplex	141	571254	Up
port3	port3	3		1.2.3.4/0	10000 Mbps/Full Duplex	141	571338	Up
port4	port4	4		1.2.3.4/0	10000 Mbps/Full Duplex	141	571252	Up
port5	port5	5		1.2.3.4/0	10000 Mbps/Full Duplex	141	571246	Up
port6	port6	6		1.2.3.4/0	10000 Mbps/Full Duplex	141	571245	Up
port7	port7	7		1.2.3.4/0	10000 Mbps/Full Duplex	141	571239	Up
port8	port8	8		1.2.3.4/0	10000 Mbps/Full Duplex	141	571283	Up
port9	port9	9		1.2.3.4/0	10000 Mbps/Full Duplex	141	572431	Up
port10	port10	10		1.2.3.4/0	10000 Mbps/Full Duplex	141	572083	Up

fortiwebvm-system-policy-status-get

Get policy status.

Base Command

fortiwebvm-system-policy-status-get

Input

There are no input arguments for this command.

Command example

#### Context Example - API Version 1

```json
{
    "FortiwebVM": {
        "SystemPolicy": {
            "connction_per_second": 0,
            "http_port": 80,
            "https_port": null,
            "id": "example",
            "mode": "Single Server/Server Pool",
            "name": "example",
            "session_count": 0,
            "status": "enable",
            "vserver": "1.2.3.4/32/"
        }
    }
}

Human Readable Output - API Version 1

Policy status

Id	Name	Status	Vserver	Http Port	Https Port	Mode	Session Count	Connction Per Second
example	example	enable	1.2.3.4/32/	80		Single Server/Server Pool	0	0

Context Example - API Version 2

{
    "FortiwebVM": {
        "SystemPolicy": {
            "app_response_time": 0,
            "client_rtt": 0,
            "connction_per_second": 0,
            "http_port": "80",
            "https_port": null,
            "id": "example",
            "mode": "Single Server/Server Pool",
            "name": "example",
            "policy": 1099,
            "protocol": "HTTP",
            "server_rtt": 0,
            "session_count": 0,
            "status": "enable",
            "vserver": ""
        }
    }
}

Human Readable Output - API Version 2

Policy status

Id	Name	Status	Vserver	Http Port	Https Port	Mode	Session Count	Connction Per Second	Policy	Client Rtt	Server Rtt	App Response Time
example	example	enable		80		Single Server/Server Pool	0	0	1099	0	0	0

fortiwebvm-system-status-get

Get system status.

Base Command

fortiwebvm-system-status-get

Input

There are no input arguments for this command.

Context Output

There is no context output for this command.

Command example

#### Context Example - API Version 1

```json
{
    "FortiwebVM": {
        "SystemStatus": {
            "administrativeDomain": "Disabled",
            "antivirusService": {
                "anti_expired": "Expired (1969-12-31)",
                "anti_expired_text": "[Renew]",
                "anti_expired_url": "test/",
                "anti_update_text": "[Update]",
                "anti_update_url": "#navigate/SignatureUpdate",
                "antivirusLastUpdateMethod": "Manual",
                "antivirusLastUpdateTime": "1969-12-31",
                "exVirusDatabaseVersion": "1.00000",
                "regularVirusDatabaseVersion": "1.00000"
            },
            "bufferSizeMax": 102400,
            "credentialStuffingDefense": {
                "databaseVersion": "0.00000",
                "expired": "Expired (1969-12-31)",
                "expired_text": "[Renew]",
                "expired_url": "test/",
                "lastUpdateTime": "1969-12-31"
            },
            "fileUploadLimitMax": 102400,
            "fipcc": "Disabled",
            "firmwareVersion": "FortiWeb-VM 6.12,build0421(GA),191218",
            "firmware_partition": 2,
            "haStatus": "Standalone",
            "hostName": "FortiWeb",
            "logDisk": "Available",
            "operationMode": "Reverse Proxy",
            "readonly": false,
            "registration": {
                "label": "[Unregistered]",
                "text": "[Register]",
                "url": "test"
            },
            "reputationService": {
                "reputationBuildNumber": "1.00020",
                "reputationLastUpdateMethod": "Manual",
                "reputationLastUpdateTime": "1969-12-31",
                "reputation_expired": "Expired (1969-12-31)",
                "reputation_expired_text": "[Renew]",
                "reputation_expired_url": "test/",
                "reputation_update_text": "[Update]",
                "reputation_update_url": "#navigate/SignatureUpdate"
            },
            "securityService": {
                "buildNumber": "0.00240",
                "expired": "Expired (1969-12-31)",
                "expired_text": "[Renew]",
                "expired_url": "test/",
                "lastUpdateMethod": "Manual",
                "lastUpdateTime": "1969-12-31",
                "update_text": "[Update]",
                "update_url": "#navigate/SignatureUpdate"
            },
            "serialNumber": "FVVM00UNLICENSED",
            "systemTime": "Sun Dec 25 01:01:32 2022\n",
            "systemUptime": "2 day(s) 20 hour(s) 7 min(s)",
            "vmLicense": "invalid"
        }
    }
}

Human Readable Output - API Version 1

System Status

High Ability Status	Host Name	Serial Number	Operation Mode	System Time	Firmware Version	Administrative Domain	System Uptime	Fips And Cc Mode	Log Disk
Standalone	FortiWeb	FVVM00UNLICENSED	Reverse Proxy	Sun Dec 25 01:01:32 2022	FortiWeb-VM 6.12,build0421(GA),191218	Disabled	2 day(s) 20 hour(s) 7 min(s)	Disabled	Available

Context Example - API Version 2

{
    "FortiwebVM": {
        "SystemStatus": {
            "administrativeDomain": "Disabled",
            "bufferSizeMax": 102400,
            "fileUploadLimitMax": 102400,
            "firmwareVersion": "test",
            "firmware_partition": 2,
            "haStatus": "Standalone",
            "hostName": "FortiWeb",
            "managerMode": "Standalone",
            "operationMode": "Reverse Proxy",
            "readonly": false,
            "registration": {
                "label": "*",
                "text": "[Login]",
                "url": "test"
            },
            "serialNumber": "FVBAWS0001be9eec",
            "systemTime": "Sun Dec 25 02:06:38 2022\n",
            "up_days": "34",
            "up_hrs": "20",
            "up_mins": "45",
            "vmLicense": "valid"
        }
    }
}

Human Readable Output - API Version 2

System Status

High Ability Status	Host Name	Serial Number	Operation Mode	System Time	Firmware Version	Administrative Domain	Manager Status	Sysyem Up Days	Sysyem Up Hrs	Sysyem Up Mins
Standalone	FortiWeb	FVBAWS0001be9eec	Reverse Proxy	Sun Dec 25 02:06:38 2022	test 7.03,build0111(GA),220912	Disabled	Standalone	34	20	45

fortiwebvm-virtual-server-list

List the virtual servers.

Base Command

fortiwebvm-virtual-server-list

Input

Context Output

Command example

!fortiwebvm-virtual-server-list limit=1

Context Example

{
    "FortiwebVM": {
        "VirtualServer": {
            "id": "virtual1"
        }
    }
}

Human Readable Output

Virtual Servers

Showing 1 rows out of 1.

Id
virtual1

fortiwebvm-geo-exception-list

List the Geo exception groups.

Base Command

fortiwebvm-geo-exception-list

Input

Context Output

Command example

!fortiwebvm-geo-exception-list limit=1

Context Example

{
    "FortiwebVM": {
        "GeoExceptionGroup": {
            "id": "exception1"
        }
    }
}

Human Readable Output

Geo exception

Showing 1 rows out of 1.

Id
exception1

fortiwebvm-trigger-policy-list

List the trigger policy rules.

Base Command

fortiwebvm-trigger-policy-list

Input

Context Output

Command example

!fortiwebvm-trigger-policy-list limit=1

Context Example

{
    "FortiwebVM": {
        "TriggerPolicy": {
            "id": "trigger1"
        }
    }
}

Human Readable Output

Content Routing Policy

Showing 1 rows out of 1.

Id
trigger1

fortiwebvm-certificate-intermediate-group-list

List the certificate intermediate groups.

Base Command

fortiwebvm-certificate-intermediate-group-list

Input

Context Output

Command example

!fortiwebvm-certificate-intermediate-group-list limit=1

Context Example

{
    "FortiwebVM": {
        "CertificateIntermediateGroup": {
            "id": "group"
        }
    }
}

Human Readable Output

Content Routing Policy

Showing 1 rows out of 3.

Id
group

fortiwebvm-server-pool-list

List the server pools.

Base Command

fortiwebvm-server-pool-list

Input

Context Output

Command example

!fortiwebvm-server-pool-list limit=1

Context Example

{
    "FortiwebVM": {
        "ServerPool": {
            "id": "Strong Dev"
        }
    }
}

Human Readable Output

Server pool

Showing 1 rows out of 2.

Id
Strong Dev

fortiwebvm-http-service-list

List the HTTP services.

Base Command

fortiwebvm-http-service-list

Input

Context Output

Command example

!fortiwebvm-http-service-list limit=1

Context Example

{
    "FortiwebVM": {
        "HttpServiceList": {
            "id": "HTTP"
        }
    }
}

Human Readable Output

HTTP services

Showing 1 rows out of 5.

Id
HTTP

fortiwebvm-inline-protection-profile-list

List the inline protection profiles.

Base Command

fortiwebvm-inline-protection-profile-list

Input

Context Output

Command example

!fortiwebvm-inline-protection-profile-list limit=1

Context Example

{
    "FortiwebVM": {
        "InlineProtectionProfile": {
            "id": "Inline High Level Security"
        }
    }
}

Human Readable Output

Inline Protection Profile

Showing 1 rows out of 10.

Id
Inline High Level Security

fortiwebvm-server-policy-create

Create a server policy.

Base Command

fortiwebvm-server-policy-create

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-server-policy-create name=example virtual_server=virtual1 http_service=HTTP deployment_mode="HTTP Content Routing"

Human Readable Output

Server Policy succesfuly created

Name
example

fortiwebvm-server-policy-update

Update the server policy.

Base Command

fortiwebvm-server-policy-update

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-server-policy-update name=example

Human Readable Output

Server Policy succesfuly updated

Name
example

fortiwebvm-server-policy-delete

Delete the server policy.

Base Command

fortiwebvm-server-policy-delete

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-server-policy-delete name=example

Human Readable Output

Server Policy succesfuly deleted

Id
example

fortiwebvm-server-policy-list

List the server policies.

Base Command

fortiwebvm-server-policy-list

Input

Context Output

Command example

!fortiwebvm-server-policy-list name=example

Context Example - API Version 1

{
    "FortiwebVM": {
        "ServerPolicy": {
            "certificate": "",
            "certificate_intermediate_group": "",
            "client_real_ip": false,
            "comments": "",
            "deployment_mode": "HTTP Content Routing",
            "half_open_thresh": 8192,
            "http2": false,
            "http_service": "HTTP",
            "https_service": "",
            "monitor_mode": false,
            "name": "example",
            "protected_hostnames": "",
            "protocol": "HTTP",
            "redirect_to_https": false,
            "server_pool": "",
            "syn_cookie": false,
            "url_case_sensitivity": false,
            "virtual_server": "virtual1",
            "web_protection_profile": ""
        }
    }
}

Human Readable Output - API Version 1

Server Policies

Showing 1 rows out of 1.

Name	Deployment Mode	Virtual Server	Protocol	Web Protection Profile	Monitor Mode
example	HTTP Content Routing	virtual1	HTTP		false

Context Example - API Version 2

{
    "FortiwebVM": {
        "ServerPolicy": {
            "allow_list": "",
            "certificate": "",
            "certificate_intermediate_group": "",
            "client_real_ip": "disable",
            "comments": "",
            "deployment_mode": "HTTP Content Routing",
            "half_open_thresh": 8192,
            "http2": "disable",
            "http_service": "HTTP",
            "https_service": "",
            "monitor_mode": "disable",
            "name": "example",
            "protected_hostnames": "",
            "protocol": "HTTP",
            "redirect_to_https": "disable",
            "replace_msg": "Predefined",
            "retry_on": "disable",
            "retry_on_cache_size": 512,
            "retry_on_connect_failure": "disable",
            "retry_on_http_layer": "disable",
            "retry_on_http_response_codes": "",
            "retry_times_on_connect_failure": 3,
            "retry_times_on_http_layer": 3,
            "scripting": "disable",
            "scripting_list": "",
            "server_pool": "",
            "syn_cookie": "disable",
            "url_case_sensitivity": "disable",
            "virtual_server": "virtual1",
            "web_protection_profile": ""
        }
    }
}

Human Readable Output - API Version 2

Server Policies

Showing 1 rows out of 1.

Name	Deployment Mode	Virtual Server	Protocol	Web Protection Profile	Monitor Mode
example	HTTP Content Routing	virtual1	HTTP		disable

fortiwebvm-content-routing-policy-list

List the HTTP content routing policies.

Base Command

fortiwebvm-content-routing-policy-list

Input

Context Output

Command example

!fortiwebvm-content-routing-policy-list limit=1

Context Example

{
    "FortiwebVM": {
        "HttpContentRoutingPolicy": {
            "id": "content1"
        }
    }
}

Human Readable Output

Content Routing Policy

Showing 1 rows out of 1.

Id
content1

fortiwebvm-http-content-routing-member-add

Create the server policy HTTP content routing member.

Base Command

fortiwebvm-http-content-routing-member-add

Input

Context Output

Command example

!fortiwebvm-http-content-routing-member-add policy_name=example http_content_routing_policy=content1

Context Example

{
    "FortiwebVM": {
        "HttpContentRoutingMember": {
            "id": "1"
        }
    }
}

Human Readable Output

HTTP content routing member succesfuly created

Id
1

fortiwebvm-http-content-routing-member-update

Update the server policy HTTP content routing member.

Base Command

fortiwebvm-http-content-routing-member-update

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-http-content-routing-member-update policy_name=example id=1

Human Readable Output

HTTP content routing member succesfuly updated

Id
1

fortiwebvm-http-content-routing-member-delete

Delete the server policy HTTP content routing member.

Base Command

fortiwebvm-http-content-routing-member-delete

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-http-content-routing-member-delete policy_name=example id=1

Human Readable Output

HTTP content routing member succesfuly deleted

Id
1

fortiwebvm-http-content-routing-member-list

List the Server policy HTTP content routing members.

Base Command

fortiwebvm-http-content-routing-member-list

Input

Context Output

fortiwebvm-persistence-policy-list

List all the persistence policies. The persistence policy applies to all members of the server pool. Supports API versions 1 & 2.

Base Command

fortiwebvm-persistence-policy-list

Input

Context Output

Command example

!fortiwebvm-persistence-policy-list limit=1

Context Example

{
    "FortiwebVM": {
        "PersistencePolicy": {
            "id": "test",
            "type": "Source IP"
        }
    }
}

Human Readable Output

Persistence policy

Showing page 1.
Current page size: 50

Id	Type
test	Source IP

fortiwebvm-server-health-check-list

List all the server health check policies. Tests for server responsiveness (called “server health checks” in the web UI) and polls web servers that are members of a server pool to determine their availability before forwarding traffic. Supports API versions 1 & 2.

Base Command

fortiwebvm-server-health-check-list

Input

Context Output

Command example

!fortiwebvm-server-health-check-list limit=1

Context Example

{
    "FortiwebVM": {
        "ServerHealthCheck": {
            "id": "HLTHCK_ICMP"
        }
    }
}

Human Readable Output

Server health check

Showing page 1.
Current page size: 50

Id
HLTHCK_ICMP

fortiwebvm-local-certificate-list

List the Server certificate that is stored locally on the FortiWeb appliance. Supports API versions 1 & 2.

Base Command

fortiwebvm-local-certificate-list

Input

Context Output

Command example

!fortiwebvm-local-certificate-list limit=1

Context Example

{
    "FortiwebVM": {
        "LocalCertificate": {
            "_id": "certificate",
            "can_config": true,
            "can_delete": true,
            "can_download": false,
            "can_view": true,
            "comments": "",
            "extension": "Name: X509v3 Subject Key Identifier<br>\nCritical: no<br>\nContent: <br>\ntest:Btest<br>\nName: X509v3 Authority Key Identifier<br>\nCritical: no<br>\nContent: <br>\nkeyid:test:Btest\n<br>\nName: X509v3 Basic Constraints<br>\nCritical: yes<br>\nContent: <br>\nCA:TRUE<br>\n",
            "id": "certificate",
            "issuer": "C = us, ST = nnew york, O = Internet Widgits Pty Ltd",
            "name": "certificate",
            "serial_number": "test",
            "status": "OK",
            "subject": "C = us, ST = nnew york, O = Internet Widgits Pty Ltd",
            "valid_from": "2023-04-23 08:47:47  GMT",
            "valid_to": "2024-04-22 08:47:47  GMT",
            "version": 3
        }
    }
}

Human Readable Output

Local certificate

Showing page 1.
Current page size: 50

Id	Valid To	Subject	Status
certificate	2024-04-22 08:47:47 GMT	C = us, ST = nnew york, O = Internet Widgits Pty Ltd	OK

fortiwebvm-network-interface-list

List the network interfaces. A network interface is a connection point that enables communication between the FortiWeb device and the network, allowing traffic to flow through for inspection and protection. Supports API versions 1 & 2.

Base Command

fortiwebvm-network-interface-list

Input

Context Output

Command example

!fortiwebvm-network-interface-list limit=1

Context Example

{
    "FortiwebVM": {
        "NetworkInterface": {
            "_id": "port1",
            "addressing6_mode": "0",
            "addressing_mode": "0",
            "can_del": false,
            "can_edit": true,
            "column_name": "port1()",
            "de": "",
            "edit_name": "port1 (00:0C:29:71:BB:4E)",
            "id": "port1",
            "ipv4_access": "HTTPS,PING,SSH,HTTP,FortiWeb Manager",
            "ipv4_administrative_access": [
                "https",
                "ping",
                "ssh",
                "http",
                "FWB-manager"
            ],
            "ipv4_netmask": "1.2.3.4/24",
            "ipv6_access": "",
            "ipv6_administrative_access": [],
            "ipv6_netmask": "::/0",
            "link_status": "up",
            "name": "port1",
            "port_id": 0,
            "ref": 0,
            "status": "up",
            "type": "Physical"
        }
    }
}

Human Readable Output

Network interface

Showing page 1.
Current page size: 50

Name	Ipv4 Netmask	Ipv4 Access	Ipv6 Netmask	Ipv6 Access	Status	Type
port1	1.2.3.4/24	HTTPS,PING,SSH,HTTP,FortiWeb Manager	::/0		up	Physical

fortiwebvm-multi-certificate-list

List the multi certificates. Multi certificates configure RSA, DSA, and ECDSA certificates and reference them in server policy in Reverse Proxy mode and pserver in True Transparent Proxy mode. Supports API version 2 only.

Base Command

fortiwebvm-multi-certificate-list

Input

Context Output

Command example

!fortiwebvm-multi-certificate-list limit=1

Context Example

{
    "FortiwebVM": {
        "MultiCertificate": {
            "id": "test"
        }
    }
}

Human Readable Output

Multi certificate

Showing page 1.
Current page size: 50

Id
test

fortiwebvm-sni-certificate-list

List the SNI certificates. Server Name Indication (SNI) configuration identifies the certificate to use by domain. Supports API version 2 only.

Base Command

fortiwebvm-sni-certificate-list

Input

Context Output

Command example

!fortiwebvm-sni-certificate-list limit=1

Context Example

{
    "FortiwebVM": {
        "SNICertificate": {
            "id": "test"
        }
    }
}

Human Readable Output

SNI certificate

Showing page 1.
Current page size: 50

Id
test

fortiwebvm-virtual-ip-list

List the system virtual IPs. The virtual IP addresses are the IP addresses that paired with the domain name of your application. When users visit your application, the destination of their requests are these IP addresses. Supports API version 2 only.

Base Command

fortiwebvm-virtual-ip-list

Input

Context Output

Command example

!fortiwebvm-virtual-ip-list limit=1

Context Example

{
    "FortiwebVM": {
        "VirtualIP": {
            "id": "test"
        }
    }
}

Human Readable Output

Virtaul IP

Showing page 1.
Current page size: 50

Id
test

fortiwebvm-letsencrypt-certificate-list

List the Letsencrypt certificates. Supports API version 2 only.

Base Command

fortiwebvm-letsencrypt-certificate-list

Input

Context Output

Command example

!fortiwebvm-letsencrypt-certificate-list limit=1

Context Example

{
    "FortiwebVM": {
        "Letsencrypt": {
            "id": "test"
        }
    }
}

Human Readable Output

Letsencrypt certificate

Showing page 1.
Current page size: 50

Id
test

fortiwebvm-url-access-rule-group-create

Create a URL access rule group. URL access rule group is a container that contains URL access rules (use fortiwebvm-url-access-rule-create/update/delete/list to manage the URL access rules). Supports API versions 1 & 2.

Base Command

fortiwebvm-url-access-rule-group-create

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-url-access-rule-group-create name=test

Human Readable Output

URL access rule group test was successfully created!

fortiwebvm-url-access-rule-group-update

Update a URL access rule group. Supports API versions 1 & 2.

Base Command

fortiwebvm-url-access-rule-group-update

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-url-access-rule-group-update name=test action="Alert & Deny"

Human Readable Output

URL access rule group test was successfully updated!

fortiwebvm-url-access-rule-group-delete

Delete a URL access rule group. Supports API versions 1 & 2.

Base Command

fortiwebvm-url-access-rule-group-delete

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-url-access-rule-group-delete name=test

Human Readable Output

URL access rule group test was successfully deleted!

fortiwebvm-url-access-rule-group-list

List URL access rule groups. Supports API versions 1 & 2.

Base Command

fortiwebvm-url-access-rule-group-list

Input

Context Output

Command example

!fortiwebvm-url-access-rule-group-list name=test

Context Example

{
    "FortiwebVM": {
        "URLAccessRuleGroup": {
            "action": "alert_deny",
            "count": 0,
            "host": "",
            "host_status": "disable",
            "id": "test",
            "severity": "Low",
            "trigger_policy": ""
        }
    }
}

Human Readable Output

URL access rule group

Showing page 1.
Current page size: 50

Id	Action	Host	Severity	Count
test	alert_deny		Low	0

fortiwebvm-url-access-rule-condition-create

Create a URL access rule condition (URL access rule condition is a member of URL access rule group). URL access rules define the HTTP requests that are allowed or denied based on their hostname and URL. Supports API versions 1 & 2.

Base Command

fortiwebvm-url-access-rule-condition-create

Input

Context Output

Command example

!fortiwebvm-url-access-rule-condition-create group_name=test url_pattern=test url_type="Regular Expression"

Context Example

{
    "FortiwebVM": {
        "URLAccessRuleGroup": {
            "Condition": {
                "id": "1"
            },
            "id": "test"
        }
    }
}

Human Readable Output

URL access rule condition 1 was successfully added to URL access rule group test

Id
1

fortiwebvm-url-access-rule-condition-update

Update a URL access rule condition (URL access rule condition is a member of URL access rule group). Supports API versions 1 & 2.

Base Command

fortiwebvm-url-access-rule-condition-update

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-url-access-rule-condition-update group_name=test condition_id=1 url_type="Regular Expression" url_pattern=test2

Human Readable Output

URL access rule condition 1 was successfully updated!

fortiwebvm-url-access-rule-condition-delete

Delete a URL access rule condition (URL access rule condition is a member of URL access rule group). Supports API versions 1 & 2.

Base Command

fortiwebvm-url-access-rule-condition-delete

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-url-access-rule-condition-delete group_name=test condition_id=1

Human Readable Output

URL access rule condition 1 was successfully deleted!

fortiwebvm-url-access-rule-condition-list

List URL access rule conditions (URL access rule condition is a member of URL access rule group). Supports API versions 1 & 2.

Base Command

fortiwebvm-url-access-rule-condition-list

Input

Context Output

Command example

!fortiwebvm-url-access-rule-condition-list group_name=test condition_id=1

Context Example

{
    "FortiwebVM": {
        "URLAccessRuleGroup": {
            "Condition": [
                {
                    "domain": "",
                    "id": "1",
                    "ip_range": "",
                    "ip_type": "IPv4",
                    "meet_this_condition_if": "Object matches the URL Pattern",
                    "only_method": "",
                    "only_method_check": "disable",
                    "only_protocol": "",
                    "only_protocol_check": "disable",
                    "source_address": "disable",
                    "source_address_type": "IP",
                    "source_domain": "",
                    "source_domain_type": "Simple String",
                    "url_pattern": "test2",
                    "url_type": "Regular Expression"
                }
            ],
            "id": "test"
        }
    }
}

Human Readable Output

URL access rule condition

Showing page 1.
Current page size: 50

Id	Url Type	Url Pattern	Meet This Condition If	Source Address Type	Ip Range	Domian Type	Domain	Source Domain Type	Source Domain
1	Regular Expression	test2	Object matches the URL Pattern	IP				Simple String

fortiwebvm-virtual-server-group-create

Create a virtual server group. In API version 1, virtual server group defines the network interface, bridge, and IP address on which traffic destined for an individual physical server or server farm will arrive. In API version 2, virtual server group is a container that contains the virtual server items (use fortiwebvm-virtual-server-item-create/update/delete/list to manage the virtual server group’s items). Supports API versions 1 & 2.

Base Command

fortiwebvm-virtual-server-group-create

Input

Context Output

There is no context output for this command.

Command example - API Version 1

!fortiwebvm-virtual-server-group-create name=test use_interface_ip=enable interface=port1

Command example - API Version 2

!fortiwebvm-virtual-server-group-create name=test

Human Readable Output

Virtual server group test was successfully created!

fortiwebvm-virtual-server-group-update

Update a virtual server group. Supports API version 1 only.

Base Command

fortiwebvm-virtual-server-group-update

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-virtual-server-group-update name=test status=disable use_interface_ip=enable

Human Readable Output

Virtual server group test was successfully updated!

fortiwebvm-virtual-server-group-delete

Delete virtual server group. Supports API versions 1 & 2.

Base Command

fortiwebvm-virtual-server-group-delete

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-virtual-server-group-delete name=test

Human Readable Output

Virtual server group test was successfully deleted!

fortiwebvm-virtual-server-group-list

List the virtual server groups. Supports API versions 1 & 2.

Base Command

fortiwebvm-virtual-server-group-list

Input

Context Output

Command example

!fortiwebvm-virtual-server-group-list limit=1

Context Example - API Version 1

{
    "FortiwebVM": {
        "VirtualServerGroup": {
            "_id": "test",
            "can_delete": true,
            "enable": true,
            "id": "test",
            "interface": "port1",
            "ipv4_address": "1.2.3.4/1.2.3.4",
            "ipv6_address": "::/0",
            "name": "test",
            "use_interface_ip": true
        }
    }
}

Context Example - API Version 2

{
    "FortiwebVM": {
        "VirtualServerGroup": {
            "can_clone": 1,
            "can_view": 0,
            "id": "test",
            "name": "test",
            "q_ref": 0,
            "q_type": 1,
            "sz_vip-list": 0
        }
    }
}

Human Readable Output

Virtual server group

Showing page 1.
Current page size: 50

Id	Items Count
test

fortiwebvm-virtual-server-item-create

Create a virtual server item (virtual server Item is a member of virtual server group in API version 2). A virtual server defines the network interface, bridge, and IP address on which traffic destined for an individual physical server or server farm will arrive in API version 2. Supports API version 2 only.

Base Command

fortiwebvm-virtual-server-item-create

Input

Context Output

Command example

!fortiwebvm-virtual-server-item-create group_name=test use_interface_ip=enable interface=port1

Context Example

{
    "FortiwebVM": {
        "VirtualServerGroup": {
            "Item": {
                "id": "1"
            },
            "id": "test"
        }
    }
}

Human Readable Output

Virtual server item 1 was successfully added to virtual server group test

Id
1

fortiwebvm-virtual-server-item-update

Update a virtual server item (virtual server Item is a member of virtual server group in API version 2). Supports API version 2 only.

Base Command

fortiwebvm-virtual-server-item-update

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-virtual-server-item-update group_name=test item_id=1 status=disable

Human Readable Output

Virtual server item 1 was successfully updated!

fortiwebvm-virtual-server-item-delete

Delete a virtual server item (virtual server Item is a member of virtual server group in API version 2). Supports API versions 2 only.

Base Command

fortiwebvm-virtual-server-item-delete

Input

Context Output

There is no context output for this command.

Command example

!fortiwebvm-virtual-server-item-delete group_name=test item_id=1

Human Readable Output

Virtual server item 1 was successfully deleted!

fortiwebvm-virtual-server-item-list

List virtual server items (virtual server item is a member of virtual server group in API version 2). Supports API version 2 only.

Base Command

fortiwebvm-virtual-server-item-list

Input

Context Output

Command example

!fortiwebvm-virtual-server-item-list group_name=test limit=1

Context Example

{
    "FortiwebVM": {
        "VirtualServerGroup": {
            "Item": [
                {
                    "id": "1",
                    "interface": "port1",
                    "status": "disable",
                    "use_interface_ip": "enable",
                    "virtual_ip": ""
                }
            ],
            "id": "test"
        }
    }
}