Fortiweb VM
#
This Integration is part of the Fortinet Fortiweb VM Pack.Supported versions
Supported Cortex XSOAR versions: 6.5.0 and later.
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 on Cortex XSOARNavigate to Settings > Integrations > Servers & Services.
Search for Fortiweb VM.
Click Add instance to create and configure a new integration instance.
Parameter Required Server URL True Username. True Password. True API Version True Use system proxy settings False Trust any certificate (not secure) False Click Test to validate the URLs, token, and connection.
#
CommandsYou can execute these commands from the Cortex XSOAR 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-createCreate protected host name group.
#
Base Commandfortiwebvm-protected-hostname-group-create
#
InputArgument Name | Description | Required |
---|---|---|
name | Protected host name group name. | Required |
default_action | Whether to accept or deny HTTP requests whose Host field does not match any of the host definitions that you add to this protected hosts group. Possible values are: Allow, Deny (no log), Deny. Default is Allow. | Optional |
#
Context OutputThere 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-updateUpdate protected host name group.
#
Base Commandfortiwebvm-protected-hostname-group-update
#
InputArgument Name | Description | Required |
---|---|---|
name | Protected host name group name. | Required |
default_action | Whether to accept or deny HTTP requests whose Host field does not match any of the host definitions that you will add to this protected hosts group. Possible values are: Allow, Deny (no log), Deny. | Optional |
#
Context OutputThere 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-listList the Protected host name group.
#
Base Commandfortiwebvm-protected-hostname-group-list
#
InputArgument Name | Description | Required |
---|---|---|
name | Protected host name group name. | Optional |
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.ProtectedHostnameGroup.id | String | Protected host name group ID. |
FortiwebVM.ProtectedHostnameGroup.default_action | Number | Protected host name group action. |
FortiwebVM.ProtectedHostnameGroup.protected_hostname_count | Number | The number of protected host name group members. |
FortiwebVM.ProtectedHostnameGroup.can_delete | Boolean | Whether the Geo IP group can be deleted. Supports API version 1 only. |
#
Command example!fortiwebvm-protected-hostname-group-list name=example
#
Context Example - API Version 1#
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#
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-createCreate protected host name member.
#
Base Commandfortiwebvm-protected-hostname-member-create
#
InputArgument Name | Description | Required |
---|---|---|
group_name | Protected host name group name. | Required |
action | Whether to accept or deny HTTP requests whose Host field does not match any of the host definitions that you add to this protected hosts group. Possible values are: Allow, Deny (no log), Deny. Default is Allow. | Optional |
host | Enter the IP address or FQDN of a virtual or real web host, as it appears in the Host field of HTTP headers, such as www.example.com. The maximum length is 256 characters. | Required |
ignore_port | Whether host names with a port number will be protected. Supports API version 2 only. Possible values are: enable, disable. Default is disable. | Optional |
include_subdomains | Whether sub-domains of the host will be protected. Supports API version 2 only. Possible values are: enable, disable. Default is disable. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.ProtectedHostnameMember.id | String | Protected host name member ID |
#
Human Readable Output#
Hostname member successfully created!
Id 1
#
fortiwebvm-protected-hostname-member-updateUpdate a protected host name member.
#
Base Commandfortiwebvm-protected-hostname-member-update
#
InputArgument Name | Description | Required |
---|---|---|
group_name | Protected host name group name. | Required |
member_id | Protected host name member ID. | Required |
action | Whether to accept or deny HTTP requests whose Host field does not match any of the host definitions that you add to this protected hosts group. Required in V1. Possible values are: Allow, Deny (no log), Deny. | Optional |
host | Enter the IP address or FQDN of a virtual or real web host, as it appears in the Host field of HTTP headers, such as www.example.com. The maximum length is 256 characters. | Optional |
ignore_port | Whether host names with a port number will be protected. Supports API version 2 only. Possible values are: enable, disable. | Optional |
include_subdomains | Whether sub-domains of the host will be protected. Supports API version 2 only. Possible values are: enable, disable. | Optional |
#
Context OutputThere 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-listList all the protected host name members.
#
Base Commandfortiwebvm-protected-hostname-member-list
#
InputArgument Name | Description | Required |
---|---|---|
group_name | Protected host name group name. | Required |
member_id | Protected host name member ID. | Optional |
page | The page number of the results to retrieve. Default is 25. | Optional |
page_size | A number of hostname members per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.ProtectedHostnameMember.group_name | String | Protected host name group name. |
FortiwebVM.ProtectedHostnameMember.Members.id | String | Protected host name member ID. |
FortiwebVM.ProtectedHostnameMember.Members.action | String | Protected hostname member action. |
FortiwebVM.ProtectedHostnameMember.Members.host | String | Protected host name member IP address. |
FortiwebVM.ProtectedHostnameMember.Members.ignore_port | String | Protected host name member ignore port. Supports API version 2 only. |
FortiwebVM.ProtectedHostnameMember.Members.include_subdomains | String | Protected host name member include sub-domains. Supports API version 2 only. |
#
Command example!fortiwebvm-protected-hostname-member-list group_name=example member_id=1
#
Context Example - API Version 1#
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#
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-deleteDelete protected host name member.
#
Base Commandfortiwebvm-protected-hostname-member-delete
#
InputArgument Name | Description | Required |
---|---|---|
group_name | Protected host name group name. | Required |
member_id | Protected host name member ID. | Required |
#
Context OutputThere 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-deleteDelete a protected host name.
#
Base Commandfortiwebvm-protected-hostname-group-delete
#
InputArgument Name | Description | Required |
---|---|---|
name | Protected host name group name. | Required |
#
Context OutputThere 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-createCreate IP List.
#
Base Commandfortiwebvm-ip-list-group-create
#
InputArgument Name | Description | Required |
---|---|---|
name | IP list group name. | Required |
action | The action FortiWeb will take when it detects a violation of the rule. Supports API version 2 only. Possible values are: Alert deny, Block period, Deny (no log). Default is Alert deny. | Optional |
block_period | Enter the number of seconds to block subsequent requests from a client after FortiWeb detects that the client has violated the rule. The valid range is 1โ3,600 seconds. Supports API version 2 only. Default is 600. | Optional |
severity | The severity level the FortiWeb appliance will use when a blacklisted IP address attempts to connect to your web servers. Supports API version 2 only. Possible values are: Low, Medium, High, Info. Default is Low. | Optional |
ignore_x_forwarded_for | Whether IP addresses will be scanned at the TCP layer instead of the HTTP layer. Supports API version 2 only. Possible values are: enable, disable. Default is disable. | Optional |
trigger_policy | The trigger, if any, that the FortiWeb appliance will use when it logs and/or sends an alert email about a blacklisted IP address's attempt to connect to your web servers. Supports API version 2 only. | Optional |
#
Context OutputThere 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-updateUpdate an IP list.
#
Base Commandfortiwebvm-ip-list-group-update
#
InputArgument Name | Description | Required |
---|---|---|
name | IP list group name. | Required |
action | The action FortiWeb will take when it detects a violation of the rule. Supports API version 2 only. Possible values are: Alert deny, Block period, Deny (no log). | Optional |
block_period | The number of seconds to block subsequent requests from a client after FortiWeb detects that the client has violated the rule. The valid range is 1โ3,600 seconds. Supports API version 2 only. | Optional |
severity | The severity level the FortiWeb appliance will use when a blacklisted IP address attempts to connect to your web servers. Supports API version 2 only. Possible values are: Low, Medium, High, Info. | Optional |
ignore_x_forwarded_for | Whether the IP addresses will be scanned at the TCP layer instead of the HTTP layer. Supports API version 2 only. Possible values are: enable, disable. | Optional |
trigger_policy | The trigger, if any, that the FortiWeb appliance will use when it logs and/or sends an alert email about a blacklisted IP address's attempt to connect to your web servers. Supports API version 2 only. | Optional |
#
Context OutputThere 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-listSupports API versions 1 & 2.
#
Base Commandfortiwebvm-ip-list-group-list
#
InputArgument Name | Description | Required |
---|---|---|
name | IP list name. | Optional |
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.IpListGroup.id | String | IP list ID. |
FortiwebVM.IpListGroup.ip_list_count | Number | The number of IP list members. |
FortiwebVM.IpListGroup.can_delete | Boolean | Whether the Geo IP group can be deleted. Supports API version 1 only. |
FortiwebVM.IpListGroup.q_ref | Number | The CMDB reference count. Supports API version 2 only. |
FortiwebVM.IpListGroup.q_type | Number | IP list group object type. Supports API version 2 only. |
FortiwebVM.IpListGroup.can_clone | Number | Whether the IP list group can be cloned. Supports API version 2 only. |
FortiwebVM.IpListGroup.block_period | Number | IP list group block period. Supports API version 2 only. |
FortiwebVM.IpListGroup.can_view | Number | Whether you can view the IP list group. Supports API version 2 only. |
FortiwebVM.IpListGroup.action | String | IP list group action. Supports API version 2 only. |
FortiwebVM.IpListGroup.trigger_policy | String | IP list group trigger policy name. Supports API version 2 only. |
FortiwebVM.IpListGroup.severity | String | IP list group severity. Supports API version 2 only. |
#
Command example - API Version 1!fortiwebvm-ip-list-group-list name=example
#
Context Example#
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#
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-createCreate an IP list member. Supports API versions 1 & 2.
#
Base Commandfortiwebvm-ip-list-member-create
#
InputArgument Name | Description | Required |
---|---|---|
group_name | IP list group name. | Required |
type | The type of the source IP address. Possible values are: Trust IP, Black IP, Allow Only Ip. | Required |
ip_address | IPv4/IPv6/IP range. | Required |
severity | The severity level the FortiWeb appliance will use when a blacklisted IP address attempts to connect to your web servers. Supports API version 1 only. Required when type= \"Black Ip\". Possible values are: High, Medium, Low, Informative. Default is Medium. | Optional |
trigger_policy | The trigger, if any, that the FortiWeb appliance will use when it logs and/or sends an alert email about a blacklisted IP address's attempt to connect to your web servers. Supports API version 1 only. Required when type= \"Black Ip\". | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.IpListMember.id | Number | IP list policy member ID. |
#
Command example!fortiwebvm-ip-list-member-create group_name=example ip_address=1.2.3.4 type="Black IP"
#
Context Example#
Human Readable Output#
IP List member successfully created!
Id 1
#
fortiwebvm-ip-list-member-updateUpdate IP list policy member.
#
Base Commandfortiwebvm-ip-list-member-update
#
InputArgument Name | Description | Required |
---|---|---|
group_name | IP list group name. | Required |
member_id | IP list policy member ID. | Required |
type | The type of the source IP address. Possible values are: Trust IP, Black IP, Allow Only Ip. | Optional |
ip_address | IPv4/IPv6/IP range. | Optional |
severity | The severity level the FortiWeb appliance will use when a blacklisted IP address attempts to connect to your web servers. Supports API version 1 only. Required when type= \"Black Ip\". Possible values are: High, Medium, Low, Informative. | Optional |
trigger_policy | The trigger, if any, that the FortiWeb appliance will use when it logs and/or sends an alert email about a blacklisted IP address's attempt to connect to your web servers. Supports API version 1 only. Required when type= \"Black Ip\". | Optional |
#
Context OutputThere 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.6
#
Human Readable Output#
IP List member successfully updated!
Id 1
#
fortiwebvm-ip-list-member-listList the IP list policy members.
#
Base Commandfortiwebvm-ip-list-member-list
#
InputArgument Name | Description | Required |
---|---|---|
group_name | IP list group name. | Required |
member_id | IP list member ID. | Optional |
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.IpListMember.group_name | String | IP list group name. |
FortiwebVM.IpListMember.Members.id | String | IP list member ID. |
FortiwebVM.IpListMember.Members.type | String | IP list member type. |
FortiwebVM.IpListMember.Members.severity | String | IP list member severity. Supports API version 1 only. |
FortiwebVM.IpListMember.Members.trigger_policy | String | IP list member trigger policy. Supports API version 1 only. |
FortiwebVM.IpListMember.Members.ip | String | IP list member IP address. |
#
Command example!fortiwebvm-ip-list-member-list group_name=example
#
Context Example - API Version 1#
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#
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-deleteDelete an IP list policy member.
#
Base Commandfortiwebvm-ip-list-member-delete
#
InputArgument Name | Description | Required |
---|---|---|
group_name | IP list group name. | Required |
member_id | IP list policy member ID. | Required |
#
Context OutputThere 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-deleteSupports API versions 1 & 2.
#
Base Commandfortiwebvm-ip-list-group-delete
#
InputArgument Name | Description | Required |
---|---|---|
name | IP list group name. | Required |
#
Context OutputThere 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-updateUpdate the custom predefined global whitelist.
#
Base Commandfortiwebvm-custom-predefined-whitelist-update
#
InputArgument Name | Description | Required |
---|---|---|
id | Predefined global whitelist ID. | Required |
status | Status. Possible values are: enable, disable. | Optional |
#
Context OutputThere 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-listGet custom predefined global whitelist.
#
Base Commandfortiwebvm-custom-predefined-whitelist-list
#
InputArgument Name | Description | Required |
---|---|---|
id | Custom predefined whitelist ID. | Optional |
type | Type of the custom predefined whitelist. Possible values are: URL, Parameter, Cookie, Header Field. | Optional |
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.CustomPredefinedGlobalWhitelist.id | Number | Predefined global whitelist member ID. |
FortiwebVM.CustomPredefinedGlobalWhitelist.name | String | Predefined global whitelist member name. |
FortiwebVM.CustomPredefinedGlobalWhitelist.path | String | Predefined global whitelist member path. |
FortiwebVM.CustomPredefinedGlobalWhitelist.domain | String | Predefined global whitelist member domain. |
FortiwebVM.CustomPredefinedGlobalWhitelist.status | Boolean | Predefined global whitelist member status. |
#
Command example!fortiwebvm-custom-predefined-whitelist-list limit=1
#
Context Example#
Human Readable Output#
Custom whitelist members:Showing 1 rows out of 36. |Id|Name|Path|Domain|Status| |---|---|---|---|---| | 100002 | | /browserconfig.xml | | true |
#
fortiwebvm-custom-whitelist-url-createCreate a custom global whitelist URL object.
#
Base Commandfortiwebvm-custom-whitelist-url-create
#
InputArgument Name | Description | Required |
---|---|---|
request_type | Indicate whether the request-file \"<url_str>\" field contains a literal URL (Simple String), or a regular expression designed to match multiple URLs (Regular Expression). Possible values are: Simple String, Regular Expression. Default is Simple String. | Optional |
request_url | Depending on your selection in the request-type {plain | regular} field, enter either: - The literal URL, such as /robots.txt, that the HTTP request must contain in order to match the rule. The URL must begin with a backslash ( / ). - A regular expression, such as ^/*.html, matching all and only the URLs to which the rule should apply. The pattern does not require a slash ( / ); however, it must at least match URLs that begin with a backslash, such as /index.html. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.CustomGlobalWhitelist.id | Number | Custom global whitelist ID |
#
Command example!fortiwebvm-custom-whitelist-url-create request_url=/123
#
Context Example#
Human Readable Output#
Custom whitelist URL member succesfuly created!
Id 1
#
fortiwebvm-custom-whitelist-parameter-createCreate a custom global whitelist parameter object.
#
Base Commandfortiwebvm-custom-whitelist-parameter-create
#
InputArgument Name | Description | Required |
---|---|---|
request_type | Indicate whether the request-file \"<url_str>\" field contains a literal URL (plain), or a regular expression designed to match multiple URLs (regular). Supports API version 2 only. Required when request_url_status= True. Possible values are: Simple String, Regular Expression. Default is Simple String. | Optional |
request_url | Depending on your selection in the request-type {plain | regular} field, enter either: - The literal URL, such as /robots.txt, that the HTTP request must contain in order to match the rule. The URL must begin with a backslash ( / ). - A regular expression, such as ^/*.html, matching all and only the URLs to which the rule should apply. The pattern does not require a slash ( / ); however, it must at least match URLs that begin with a backslash, such as /index.html. Supports API version 2 only. Required when request_url_status= True. | Optional |
name | Enter the name of the parameter as it appears in the HTTP URL or body, such as rememberme. | Required |
name_type | Indicate whether the name \"<name_str>\" field will contain a literal parameter name (Simple String), or a regular expression designed to match all parameter names (Regular Expression). Supports API version 2 only. Possible values are: Simple String, Regular Expression. Default is Simple String. | Optional |
request_url_status | Enable to apply this rule only to HTTP requests for specific URLs. Supports API version 2 only. Possible values are: enable, disable. Default is disable. | Optional |
domain_status | Enable to apply this rule only to HTTP requests for specific domains. Supports API version 2 only. Possible values are: enable, disable. Default is disable. | Optional |
domain_type | Indicate whether the domain \"<cookie_str>\" field will contain a literal domain/IP address (Simple String), or a regular expression designed to match multiple domains/IP addresses (Regular Expression). Supports API version 2 only. Required when request_url_status= True. Possible values are: Simple String, Regular Expression. Default is Simple String. | Optional |
domain | The partial or complete domain name or IP address as it appears in the cookie. Supports API version 2 only. Required when request_url_status= True. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.CustomGlobalWhitelist.id | Number | Custom global whitelist ID. |
#
Command example!fortiwebvm-custom-whitelist-parameter-create name=example
#
Context Example#
Human Readable Output#
Custom whitelist Parameter member succesfuly created!
Id 2
#
fortiwebvm-custom-whitelist-cookie-createCreate a custom global whitelist cookie object.
#
Base Commandfortiwebvm-custom-whitelist-cookie-create
#
InputArgument Name | Description | Required |
---|---|---|
name | The name of the cookie as it appears in the HTTP request, such as NID. | Required |
domain | The partial or complete domain name or IP address as it appears in the cookie. | Optional |
path | The path as it appears in the cookie. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.CustomGlobalWhitelist.id | Number | Custom global whitelist ID |
#
Command example!fortiwebvm-custom-whitelist-cookie-create name=example domain=abc path=/abc
#
Context Example#
Human Readable Output#
Custom whitelist Cookie member succesfuly created!
Id 2
#
fortiwebvm-custom-whitelist-header-field-createCreate a custom global whitelist header field object. Supports API version 2 only.
#
Base Commandfortiwebvm-custom-whitelist-header-field-create
#
InputArgument Name | Description | Required |
---|---|---|
name | Enter the name of the cookie as it appears in the HTTP header. | Required |
header_name_type | Indicate whether the type field will contain a literal name (Simple String), or a regular expression designed to match multiple names (Regular Expression). Possible values are: Simple String, Regular Expression. Default is Simple String. | Optional |
value_status | Enable to also check the value of the HTTP header. Only the HTTP headers that match both the name and the value will be allowlisted. Possible values are: enable, disable. Default is disable. | Optional |
header_value_type | Indicate whether the header name will contain a literal name (plain), or a regular expression designed to match multiple names (regular). Possible values are: Simple String, Regular Expression. Default is Simple String. | Optional |
value | The value of the HTTP header. Required when value_status is enabled. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.CustomGlobalWhitelist.id | Number | Custom global whitelist ID. |
#
fortiwebvm-custom-whitelist-url-updateUpdate a custom global whitelist URL object.
#
Base Commandfortiwebvm-custom-whitelist-url-update
#
InputArgument Name | Description | Required |
---|---|---|
id | Custom global whitelist object ID. | Required |
status | Enable to exempt this object from all scans. Possible values are: enable, disable. Default is enable. | Optional |
request_type | Indicate whether the request-file \"<url_str>\" field contains a literal URL (plain), or a regular expression designed to match multiple URLs (regular). Possible values are: Simple String, Regular Expression. | Optional |
request_url | Depending on your selection in the request-type {plain | regular} field, enter either - The literal URL, such as /robots.txt, that the HTTP request must contain in order to match the rule. The URL must begin with a backslash ( / ). - A regular expression, such as ^/*.html, matching all and only the URLs to which the rule should apply. The pattern does not require a slash ( / ); however, it must at least match URLs that begin with a backslash, such as /index.html. | Optional |
#
Context OutputThere 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-updateUpdate custom global whitelist parameter object.
#
Base Commandfortiwebvm-custom-whitelist-parameter-update
#
InputArgument Name | Description | Required |
---|---|---|
id | Custom global whitelist object ID. | Required |
status | Enable to exempt this object from all scans. Possible values are: enable, disable. Default is enable. | Optional |
request_type | Indicate whether the request-file \"<url_str>\" field contains a literal URL (plain), or a regular expression designed to match multiple URLs (regular). Supports API version 2 only. Required when request_url_status= True. Possible values are: Simple String, Regular Expression. Default is enable. | Optional |
request_url | Depending on your selection in the request-type {plain | regular} field, enter either: - The literal URL, such as /robots.txt, that the HTTP request must contain in order to match the rule. The URL must begin with a backslash ( / ). - A regular expression, such as ^/*.html, matching all and only the URLs to which the rule should apply. The pattern does not require a slash ( / ); however, it must at least match URLs that begin with a backslash, such as /index.html. Supports API version 2 only. Required when request_url_status= True. | Optional |
name | Name. | Optional |
name_type | Indicate whether the name \"<name_str>\" field will contain a literal parameter name (Simple String), or a regular expression designed to match all parameter names (Regular Expression). Supports API version 2 only. Possible values are: Simple String, Regular Expression. | Optional |
request_url_status | Enable to apply this rule only to HTTP requests for specific URLs. Supports. Possible values are: enable, disable. | Optional |
domain_status | Enable to apply this rule only to HTTP requests for specific domains. Supports. Possible values are: enable, disable. | Optional |
domain_type | Indicate whether the domain \"<cookie_str>\" field will contain a literal domain/IP address (Simple String), or a regular expression designed to match multiple domains/IP addresses (Regular Expression). Supports API version 2 only. Required when request_url_status= True. Possible values are: Simple String, Regular Expression. | Optional |
domain | Enter the partial or complete domain name or IP address as it appears in the cookie. Supports API version 2 only. Required when request_url_status= True. | Optional |
#
Context OutputThere is no context output for this command.
#
fortiwebvm-custom-whitelist-cookie-updateUpdate a custom global whitelist cookie object.
#
Base Commandfortiwebvm-custom-whitelist-cookie-update
#
InputArgument Name | Description | Required |
---|---|---|
id | Custom global whitelist object ID. | Required |
status | Enable to exempt this object from all scans. Possible values are: enable, disable. Default is enable. | Optional |
name | Enter the name of the cookie as it appears in the HTTP request, such as NID. | Optional |
domain | Enter the partial or complete domain name or IP address as it appears in the cookie. | Optional |
path | Enter the path as it appears in the cookie. | Optional |
#
Context OutputThere 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-updateUpdate a custom global whitelist header field object. Supports API version 2 only.
#
Base Commandfortiwebvm-custom-whitelist-header-field-update
#
InputArgument Name | Description | Required |
---|---|---|
id | Custom global whitelist object ID. | Required |
status | Enable to exempt this object from all scans. Possible values are: enable, disable. Default is enable. | Optional |
header_name_type | Indicate whether the type field will contain a literal name (Simple String), or a regular expression designed to match multiple names (Regular Expression). Possible values are: Simple String, Regular Expression. | Optional |
name | The name of the cookie as it appears in the HTTP header. | Optional |
header_value_type | Indicate whether the header name will contain a literal name (Simple String), or a regular expression designed to match multiple names (Regular Expression). Possible values are: Simple String, Regular Expression. | Optional |
value_status | Enable to also check the value of the HTTP header. Only the HTTP headers that match both the name and the value will be allowlisted. Possible values are: enable, disable. | Optional |
value | The value of the HTTP header. Required when value_status is enabled. | Optional |
#
Context OutputThere is no context output for this command.
#
fortiwebvm-custom-whitelist-deleteDelete a custom global whitelist object from the custom global whitelist.
#
Base Commandfortiwebvm-custom-whitelist-delete
#
InputArgument Name | Description | Required |
---|---|---|
id | Object ID number. | Required |
#
Context OutputThere is no context output for this command.
#
fortiwebvm-custom-whitelist-listList the custom global whitelist objects.
#
Base Commandfortiwebvm-custom-whitelist-list
#
InputArgument Name | Description | Required |
---|---|---|
id | Custom global whitelist object ID. | Optional |
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.CustomGlobalWhitelist.id | Number | Custom global whitelist object ID. |
FortiwebVM.CustomGlobalWhitelist.name | Number | Custom global whitelist object name. |
FortiwebVM.CustomGlobalWhitelist.type | Number | Custom global whitelist object type. |
FortiwebVM.CustomGlobalWhitelist.status | Boolean | Custom global whitelist object status. |
FortiwebVM.CustomGlobalWhitelist.request_type | Number | Custom global whitelist object request type. |
FortiwebVM.CustomGlobalWhitelist.request_url | String | Custom global whitelist object request URL. |
FortiwebVM.CustomGlobalWhitelist.header_name_type | String | Custom global whitelist object header type. Supports API version 2 only. |
FortiwebVM.CustomGlobalWhitelist.domain_type | String | Custom global whitelist object domain type. Supports API version 2 only. |
FortiwebVM.CustomGlobalWhitelist.name_type | String | Custom global whitelist object name type. Supports API version 2 only. |
FortiwebVM.CustomGlobalWhitelist.request_url_status | String | Custom global whitelist object request file status. Supports API version 2 only. |
FortiwebVM.CustomGlobalWhitelist.domain_status | String | Custom global whitelist object domain status. Supports API version 2 only. |
FortiwebVM.CustomGlobalWhitelist.domain | String | Custom global whitelist object domain. Supports API version 2 only. |
FortiwebVM.CustomGlobalWhitelist.path | String | Custom global whitelist object path. Supports API version 2 only. |
FortiwebVM.CustomGlobalWhitelist.header_value_type | String | Custom global whitelist object value type. Supports API version 2 only. |
FortiwebVM.CustomGlobalWhitelist.value | String | Custom global whitelist object value. Supports API version 2 only. |
FortiwebVM.CustomGlobalWhitelist.value_status | String | Custom global whitelist object value status. Supports API version 2 only. |
#
Command example!fortiwebvm-custom-whitelist-list limit=1
#
Context Example - API Version 1#
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#
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-addCreate Geo IP member.
#
Base Commandfortiwebvm-geo-ip-member-add
#
InputArgument Name | Description | Required |
---|---|---|
group_name | Geo IP group name. | Required |
countries | Comma-separated list of country names to add to the GEO IP list name. Possible values are: Afghanistan, Aland Islands, Albania, Algeria, American Samoa, Andorra, Angola, Anguilla, Antarctica, Antigua And Barbuda, Argentina, Armenia, Aruba, Australia, Austria, Azerbaijan, Bahamas, Bahrain, Bangladesh, Barbados, Belarus, Belgium, Belize, Benin, Bermuda, Bhutan, Bolivia, Bonaire Saint Eustatius And Saba, Bosnia And Herzegovina, Botswana, Brazil, British Indian Ocean Territory, British Virgin Islands, Brunei Darussalam, Bulgaria, Burkina Faso, Burundi, Cambodia, Cameroon, Canada, Cape Verde, Cayman Islands, Central African Republic, Chad, Chile, China, Colombia, Comoros, Congo, Cook Islands, Costa Rica, Cote D Ivoire, Croatia, Cuba, Curacao, Cyprus, Czech Republic, Democratic People S Republic Of Korea, Democratic Republic Of The Congo, Denmark, Djibouti, Dominica, Dominican Republic, Ecuador, Egypt, El Salvador, Equatorial Guinea, Eritrea, Estonia, Ethiopia, Falkland Islands Malvinas, Faroe Islands, Federated States Of Micronesia, Fiji, Finland, France, French Guiana, French Polynesia, Gabon, Gambia, Georgia, Germany, Ghana, Gibraltar, Greece, Greenland, Grenada, Guadeloupe, Guam, Guatemala, Guernsey, Guinea, Guinea-Bissau, Guyana, Haiti, Honduras, Hong Kong, Hungary, Iceland, India, Indonesia, Iran, Iraq, Ireland, Isle Of Man, Israel, Italy, Jamaica, Japan, Jersey, Jordan, Kazakhstan, Kenya, Kiribati, Kosovo, Kuwait, Kyrgyzstan, Lao People S Democratic Republic, Latvia, Lebanon, Lesotho, Liberia, Libya, Liechtenstein, Lithuania, Luxembourg, Macao, Macedonia, Madagascar, Malawi, Malaysia, Maldives, Mali, Malta, Marshall Islands, Martinique, Mauritania, Mauritius, Mayotte, Mexico, Moldova, Monaco, Mongolia, Montenegro, Montserrat, Morocco, Mozambique, Myanmar, Namibia, Nauru, Nepal, Netherlands, New Caledonia, New Zealand, Nicaragua, Niger, Nigeria, Niue, Norfolk Island, Northern Mariana Islands, Norway, Oman, Pakistan, Palau, Palestine, Panama, Papua New Guinea, Paraguay, Peru, Philippines, Poland, Portugal, Puerto Rico, Qatar, Republic Of Korea, Reunion, Romania, Russian Federation, Rwanda, Saint Bartelemey, Saint Kitts And Nevis, Saint Lucia, Saint Martin, Saint Pierre And Miquelon, Saint Vincent And The Grenadines, Samoa, San Marino, Sao Tome And Principe, Saudi Arabia, Senegal, Serbia, Seychelles, Sierra Leone, Singapore, Sint Maarten, Slovakia, Slovenia, Solomon Islands, Somalia, South Africa, South Georgia And The South Sandwich Islands, South Sudan, Spain, Sri Lanka, Sudan, Suriname, Swaziland, Sweden, Switzerland, Syria, Taiwan, Tajikistan, Tanzania, Thailand, Timor-Leste, Togo, Tokelau, Tonga, Trinidad And Tobago, Tunisia, Turkey, Turkmenistan, Turks And Caicos Islands, Tuvalu, Uganda, Ukraine, United Arab Emirates, United Kingdom, United States, Uruguay, U S Virgin Islands, Uzbekistan, Vanuatu, Vatican, Venezuela, Vietnam, Wallis And Futuna, Yemen, Zambia, Zimbabwe. Default is Low. | Required |
#
Context OutputThere is no context output for this command.
#
Command example!fortiwebvm-geo-ip-member-add group_name=example countries=Algeria
#
Context Example#
Human Readable Output#
Geo IP member successfully added!
Id Country 1 Algeria
#
fortiwebvm-geo-ip-member-deleteDelete Geo IP member .
#
Base Commandfortiwebvm-geo-ip-member-delete
#
InputArgument Name | Description | Required |
---|---|---|
group_name | Geo IP group name. | Required |
member_id | Geo IP member ID number. (The ID of the Geo IP member is the ID of the country in the Geo IP list.). | Required |
#
Context OutputThere 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-listGet Geo IP member.
#
Base Commandfortiwebvm-geo-ip-member-list
#
InputArgument Name | Description | Required |
---|---|---|
group_name | Geo IP Name. | Required |
member_id | Geo IP member ID number. (The ID of the Geo IP Member is the ID of the country in the Geo IP list.). | Optional |
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.GeoIpMember.group_name | String | Geo IP member group name. |
FortiwebVM.GeoIpMember.countries.id | String | Geo IP member ID. |
FortiwebVM.GeoIpMember.countries.country | Number | Geo IP member country name. |
#
Command example!fortiwebvm-geo-ip-member-list group_name=example member_id=1
#
Context Example#
Human Readable Output#
Geo IP member:Showing 1 rows out of 1. |Id|Country| |---|---| | 1 | Algeria |
#
fortiwebvm-geo-ip-group-createCreate Geo IP.
#
Base Commandfortiwebvm-geo-ip-group-create
#
InputArgument Name | Description | Required |
---|---|---|
name | Geo IP group name. | Required |
trigger_policy | Enter the name of the trigger to apply when this rule is violated. | Optional |
severity | The severity level to use in logs and reports generated when a violation of the rule occurs. Possible values are: High, Medium, Low, Info. Default is Low. | Optional |
exception_rule | Geo IP exception groups. | Optional |
action | Select which action FortiWeb will take when it detects a violation of the rule: alert_deny โ Block the request (or reset the connection) and generate an alert and/or log message. deny_no_log โ Block the request (or reset the connection). block-period โ Block subsequent requests from the client for a number of seconds. Also configure block-period. Supports API version 2 only. Possible values are: Alert deny, Block period, Deny (no log). Default is Block period. | Optional |
block_period | The number of seconds to block subsequent requests. The valid range is 1โ3,600 seconds. Relevant when action=Block period True. Supports API version 2 only. Default is 600. | Optional |
ignore_x_forwarded_for | Whether to enable so that IP addresses will be scanned at the TCP layer instead of the HTTP layer. Supports API version 2 only. Possible values are: enable, disable. | Optional |
#
Context OutputThere 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-updateUpdate Geo IP.
#
Base Commandfortiwebvm-geo-ip-group-update
#
InputArgument Name | Description | Required |
---|---|---|
name | Geo IP group name. | Required |
trigger_policy | Enter the name of the trigger to apply when this rule is violated. | Optional |
severity | The severity level to use in logs and reports generated when a violation of the rule occurs. Possible values are: High, Medium, Low, Info. | Optional |
exception_rule | Geo IP exception groups. | Optional |
action | The action FortiWeb will take when it detects a violation of the rule: alert_deny โ Block the request (or reset the connection) and generate an alert and/or log message.deny_no_log โ Block the request (or reset the connection). block-period โ Block subsequent requests from the client for a number of seconds. Also configure block-period. Supports API version 2 only. Possible values are: Alert deny, Block period, Deny (no log). | Optional |
block_period | The number of seconds to block subsequent requests. The valid range is 1โ3,600 seconds. Supports API version 2 only. | Optional |
ignore_x_forwarded_for | Whether to enable so that the IP addresses will be scanned at the TCP layer instead of the HTTP layer. Supports API version 2 only. Possible values are: enable, disable. | Optional |
#
Context OutputThere 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-deleteDelete Geo IP.
#
Base Commandfortiwebvm-geo-ip-group-delete
#
InputArgument Name | Description | Required |
---|---|---|
name | Geo IP group name. | Required |
#
Context OutputThere 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-listGet Geo IP list.
#
Base Commandfortiwebvm-geo-ip-group-list
#
InputArgument Name | Description | Required |
---|---|---|
name | Geo IP group name. | Optional |
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.GeoIpGroup.id | Number | Geo IP group ID. |
FortiwebVM.GeoIpGroup.count | Number | The number of Geo IP group members. |
FortiwebVM.GeoIpGroup.trigger_policy | String | Geo IP group trigger policy name. |
FortiwebVM.GeoIpGroup.severity | String | Geo IP group severity number. |
FortiwebVM.GeoIpGroup.except | String | Geo IP group exception groups. |
FortiwebVM.GeoIpGroup.can_delete | Boolean | Whether the Geo IP group can be deleted. Supports API version 1 only. |
FortiwebVM.GeoIpGroup.action | String | Geo IP group action. Supports API version 2 only. |
FortiwebVM.GeoIpGroup.block_period | Number | Geo IP group block period. Supports API version 2 only. |
FortiwebVM.GeoIpGroup.ignore_x_forwarded_for | String | Whether IP addresses will be scanned at the TCP layer instead of the HTTP layer. Supports API version 2 only. |
#
fortiwebvm-system-operation-status-getGet operation status.
#
Base Commandfortiwebvm-system-operation-status-get
#
InputThere are no input arguments for this command.
#
Context OutputThere is no context output for this command.
#
Command example!fortiwebvm-system-operation-status-get
#
Context Example#
Human Readable Output#
Operation networks:
Id Name Label Alias Ip Netmask Speed Duplex Tx Rx Link port1 port1 1 192.168.30.137/24 10000 Mbps/Full Duplex 18115 582306 Up port2 port2 2 0.0.0.0/0 10000 Mbps/Full Duplex 141 571254 Up port3 port3 3 0.0.0.0/0 10000 Mbps/Full Duplex 141 571338 Up port4 port4 4 0.0.0.0/0 10000 Mbps/Full Duplex 141 571252 Up port5 port5 5 0.0.0.0/0 10000 Mbps/Full Duplex 141 571246 Up port6 port6 6 0.0.0.0/0 10000 Mbps/Full Duplex 141 571245 Up port7 port7 7 0.0.0.0/0 10000 Mbps/Full Duplex 141 571239 Up port8 port8 8 0.0.0.0/0 10000 Mbps/Full Duplex 141 571283 Up port9 port9 9 0.0.0.0/0 10000 Mbps/Full Duplex 141 572431 Up port10 port10 10 0.0.0.0/0 10000 Mbps/Full Duplex 141 572083 Up
#
fortiwebvm-system-policy-status-getGet policy status.
#
Base Commandfortiwebvm-system-policy-status-get
#
InputThere are no input arguments for this command.
#
Command example!fortiwebvm-system-policy-status-get
#
Context Example - API Version 1#
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.0.0.0/32/ 80 Single Server/Server Pool 0 0
#
Context Example - API Version 2#
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-getGet system status.
#
Base Commandfortiwebvm-system-status-get
#
InputThere are no input arguments for this command.
#
Context OutputThere is no context output for this command.
#
Command example!fortiwebvm-system-status-get
#
Context Example - API Version 1#
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#
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 FortiWeb-AWS_OnDemand 7.03,build0111(GA),220912 Disabled Standalone 34 20 45
#
fortiwebvm-virtual-server-listList the virtual servers.
#
Base Commandfortiwebvm-virtual-server-list
#
InputArgument Name | Description | Required |
---|---|---|
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.VirtualServer.id | String | Virtual Server name. |
#
Command example!fortiwebvm-virtual-server-list limit=1
#
Context Example#
Human Readable Output#
Virtual Servers:Showing 1 rows out of 1. |Id| |---| | virtual1 |
#
fortiwebvm-geo-exception-listList the Geo exception groups.
#
Base Commandfortiwebvm-geo-exception-list
#
InputArgument Name | Description | Required |
---|---|---|
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.GeoExceptionGroup.id | String | Geo Exception Group Name. |
#
Command example!fortiwebvm-geo-exception-list limit=1
#
Context Example#
Human Readable Output#
Geo exception:Showing 1 rows out of 1. |Id| |---| | exception1 |
#
fortiwebvm-trigger-policy-listList the trigger policy rules.
#
Base Commandfortiwebvm-trigger-policy-list
#
InputArgument Name | Description | Required |
---|---|---|
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.TriggerPolicy.id | String | Trigger policy name. |
#
Command example!fortiwebvm-trigger-policy-list limit=1
#
Context Example#
Human Readable Output#
Content Routing Policy:Showing 1 rows out of 1. |Id| |---| | trigger1 |
#
fortiwebvm-certificate-intermediate-group-listList the certificate intermediate groups.
#
Base Commandfortiwebvm-certificate-intermediate-group-list
#
InputArgument Name | Description | Required |
---|---|---|
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.CertificateIntermediateGroup.id | String | Certificate intermediate group name. |
#
Command example!fortiwebvm-certificate-intermediate-group-list limit=1
#
Context Example#
Human Readable Output#
Content Routing Policy:Showing 1 rows out of 3. |Id| |---| | group |
#
fortiwebvm-server-pool-listList the server pools.
#
Base Commandfortiwebvm-server-pool-list
#
InputArgument Name | Description | Required |
---|---|---|
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.ServerPool.id | String | Server pool name. |
#
Command example!fortiwebvm-server-pool-list limit=1
#
Context Example#
Human Readable Output#
Server pool:Showing 1 rows out of 2. |Id| |---| | Strong Dev |
#
fortiwebvm-http-service-listList the HTTP services.
#
Base Commandfortiwebvm-http-service-list
#
InputArgument Name | Description | Required |
---|---|---|
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.HttpServiceList.id | String | HTTP service name. |
#
Command example!fortiwebvm-http-service-list limit=1
#
Context Example#
Human Readable Output#
HTTP services:Showing 1 rows out of 5. |Id| |---| | HTTP |
#
fortiwebvm-inline-protection-profile-listList the inline protection profiles.
#
Base Commandfortiwebvm-inline-protection-profile-list
#
InputArgument Name | Description | Required |
---|---|---|
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.InlineProtectionProfile.id | String | Inline protection profile name. |
#
Command example!fortiwebvm-inline-protection-profile-list limit=1
#
Context Example#
Human Readable Output#
Inline Protection Profile:Showing 1 rows out of 10. |Id| |---| | Inline High Level Security |
#
fortiwebvm-server-policy-createCreate a server policy.
#
Base Commandfortiwebvm-server-policy-create
#
InputArgument Name | Description | Required |
---|---|---|
name | Policy Name. | Required |
json_template_id | Allows the use of the server policy JSON template. All of the arguments listed below will be overridden. | Optional |
deployment_mode | The distribution method that FortiWeb uses when it forwards connections accepted by this policy. Possible values are: HTTP Content Routing, Single Server/Server Balance. | Optional |
virtual_server | The name of a virtual server that provides the IP address and network interface of incoming traffic that FortiWeb routes and to which the policy applies a protection profile. The maximum length is 63 characters. | Optional |
match_once | Enable to forward subsequent requests from an identified client connection to the same server pool as the initial connection from the client. Required when: deployment_mode = "HTTP Content Routing". Possible values are: enable, disable. Default is disable. | Optional |
server_pool | The name of the server pool whose members receive the connections. Required when: deployment_mode = "Single Server/Server Balance". | Optional |
protected_hostnames | The name of a protected hosts group to allow or reject connections based upon their host. | Optional |
client_real_ip | Enable to configure FortiWeb to use the source IP address of the client that originated the request when it connects to a back-end server on behalf of that client. Possible values are: enable, disable. Default is disable. | Optional |
ip_range | An IP address or address range to directly connect to the back-end server. Required when: client_real_ip = "enable". Supports API version 2 only. | Optional |
syn_cookie | Enable to detect TCP SYN flood attacks. Possible values are: enable, disable. Default is disable. | Optional |
half_open_thresh | The maximum number of TCP SYN packets, including retransmissions, that FortiWeb allows to be sent per second to a destination address. If this threshold is exceeded, the FortiWeb appliance treats the traffic as a DoS attack and ignores additional traffic from that source address. The valid range is 10โ10,000. Default is 8192. | Optional |
http_service | Custom or predefined service that defines the port number on which the virtual server receives HTTP traffic. | Optional |
https_service | Custom or predefined service that defines the port number on which the virtual server receives HTTPS traffic. | Optional |
multi_certificate | Enable to allow FortiWeb to use multiple local certificates. | Optional |
certificate_group | The multi-certificate file you created. Required when: multi_certificate is enabled. | Optional |
proxy | Certificate group name. | Optional |
redirect_to_https | Enable to automatically redirect all HTTP requests to the HTTPS service with the same URL and parameters. Possible values are: enable, disable. Default is disable. | Optional |
inline_protection_profile | Inline web protection profile name. | Optional |
monitor_mode | Enable to override deny and redirect actions defined in the server protection rules for the selected policy. This setting enables FortiWeb to log attacks without performing the deny or redirect action. Disable to allow FortiWeb to perform attack deny/redirect actions as defined by the server protection rules. Possible values are: enable, disable. Default is disable. | Optional |
url_case_sensitivity | Enable to differentiate uniform resource locators (URLs) according to upper case and lower case letters for features that act upon the URLs in the headers of HTTP requests, such as block list rules, and allow list rules. Possible values are: enable, disable. Default is disable. | Optional |
comments | A description or other comment. If the comment is more than one word or contains special characters, surround the comment with double quotes ( " ). The maximum length is 999 characters. | Optional |
certificate_type | Certificate type. Supports API version 2 only. Possible values are: Local, Multi Certificate, Letsencrypt. Default is Local. | Optional |
lets_certificate | Select the Letsencrypt certificate you created. Supports API version 2 only. Required when: certificate_type is 'Letsencrypt'. | Optional |
retry_on | Enable to configure whether to retry a failed TCP connection or HTTP request in Reverse Proxy mode. Supports API version 2 only. Possible values are: enable, disable. Default is disable. | Optional |
retry_on_cache_size | A cache size limit for the HTTP request packet. Supports API version 2 only. Required when: retry_on is enabled. Default is 512. | Optional |
retry_on_connect_failure | Enable to configure the retry times in case of any TCP connection failure. Supports API version 2 only. Required when: retry_on is enabled. Possible values are: enable, disable. Default is disable. | Optional |
retry_times_on_connect_failure | The number of retry times when FortiWeb reconnects the single server or switch to the other pserver. The valid range is 1-5. Supports API version 2 only. Required when: retry_on_connect_failure and retry_on are enabled. Possible values are: 1, 2, 3, 4, 5. Default is 3. | Optional |
retry_on_http_layer | Enable to configure the retry times and failure response code in case of any HTTP connection failure. Supports API version 2 only. Required when: retry_on is enabled. Possible values are: enable, disable. Default is disable. | Optional |
retry_times_on_http_layer | The number of retry times when FortiWeb reconnects the single server or switch to the other pserver. The valid range is 1-5. Supports API version 2 only. Required when: retry_on and retry_on_http_layer are enabled. Possible values are: 1, 2, 3, 4, 5. Default is 3. | Optional |
retry_on_http_response_codes | The failure return code when the pserver can be connected to determine enabling HTTP failure retry. Supports API version 2 only. Required when: retry_on and retry_on_http_layer are enabled. Possible values are: 404, 408, 500, 501, 502, 503, 504. | Optional |
scripting | Enable to perform actions that are not currently supported by the built-in feature set. Supports API version 2 only. Possible values are: enable, disable. | Optional |
scripting_list | Scripting list to perform actions that are not currently supported by the built-in feature set. Required when: scripting is enabled. Supports API version 2 only. | Optional |
allow_list | The Policy Based Allow list to use instead of the Global Allow List. Supports API version 2 only. | Optional |
replace_msg | The replacement message to apply to the policy. Supports API version 2 only. | Optional |
#
Context OutputThere 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-updateUpdate the server policy.
#
Base Commandfortiwebvm-server-policy-update
#
InputArgument Name | Description | Required |
---|---|---|
name | Policy name. | Required |
deployment_mode | Deployment mode. Possible values are: HTTP Content Routing, Single Server/Server Balance. | Optional |
virtual_server | The name of a virtual server that provides the IP address and network interface of incoming traffic that FortiWeb routes and to which the policy applies a protection profile. The maximum length is 63 characters. | Optional |
match_once | Enable to forward subsequent requests from an identified client connection to the same server pool as the initial connection from the client. Required when: deployment_mode = "HTTP Content Routing". Possible values are: enable, disable. Default is disable. | Optional |
server_pool | Enter the name of the server pool whose members receive the connections. Required when: deployment_mode = "Single Server/Server Balance". | Optional |
protected_hostnames | Protected hostnames group name. Enter the name of a protected hosts group to allow or reject connections based upon their host. | Optional |
client_real_ip | Enable to configure FortiWeb to use the source IP address of the client that originated the request when it connects to a back-end server on behalf of that client. | Optional |
ip_range | Specify an IP address or address range to directly connect to the back-end server. Required when: client_real_ip = "enable". Supports API version 2 only. | Optional |
syn_cookie | Enable to detect TCP SYN flood attacks. Possible values are: enable, disable. Default is disable. | Optional |
half_open_thresh | The maximum number of TCP SYN packets, including retransmissions, that FortiWeb allows to be sent per second to a destination address. If this threshold is exceeded, the FortiWeb appliance treats the traffic as a DoS attack and ignores additional traffic from that source address. The valid range is 10โ10,000. | Optional |
http_service | Custom or predefined service that defines the port number on which the virtual server receives HTTP traffic. | Optional |
https_service | HTTPS service name. Custom or predefined service that defines the port number on which the virtual server receives HTTPS traffic. | Optional |
http2 | Enable HTTP/2. Required when: HTTPSService is not null. Possible values are: enable, disable. Default is disable. | Optional |
multi_certificate | Enable to allow FortiWeb to use multiple local certificates. | Optional |
certificate_group | Required when: multi-certificate is enabled. Select the multi-certificate file you created. | Optional |
certificate | Certificate group name. Required when: multi-certificate is disabled. | Optional |
intergroup | Certificate intermediate group. Required when: HTTPSService is not null. | Optional |
proxy | Enable this option when proxy servers or load balancers are installed before FortiWeb. Possible values are: enable, disable. Default is disable. | Optional |
redirect_to_https | Enable to automatically redirect all HTTP requests to the HTTPS service with the same URL and parameters. | Optional |
inline_protection_profile | Inline web protection profile name. | Optional |
monitor_mode | Enable to override deny and redirect actions defined in the server protection rules for the selected policy. This setting enables FortiWeb to log attacks without performing the deny or redirect action. Disable to allow FortiWeb to perform attack deny/redirect actions as defined by the server protection rules. Possible values are: enable, disable. Default is disable. | Optional |
url_case_sensitivity | Enable to differentiate uniform resource locators (URLs) according to upper case and lower case letters for features that act upon the URLs in the headers of HTTP requests, such as block list rules, and allow list rules. | Optional |
comments | A description or other comment. If the comment is more than one word or contains special characters, surround the comment with double quotes ( " ). The maximum length is 999 characters. | Optional |
certificate_type | Certificate type. Supports API version 2 only. Possible values are: Local, Multi Certificate, Letsencrypt. Default is Local. | Optional |
lets_certificate | Select the Letsencrypt certificate you created. Supports API version 2 only. Required when: certificate-type is enabled. | Optional |
retry_on | Enable to configure whether to retry a failed TCP connection or HTTP request in Reverse Proxy mode. Supports API version 2 only. Possible values are: enable, disable. | Optional |
retry_on_cache_size | The cache size limit for the HTTP request packet. Supports API version 2 only. Required when: retry_on is enabled. | Optional |
retry_on_connect_failure | Enable to configure the retry times in case of any TCP connection failure. Supports API version 2 only. Required when: retry_on is enabled. Possible values are: enable, disable. | Optional |
retry_times_on_connect_failure | The number of retry times when FortiWeb reconnects the single server or switch to the other pserver. The valid range is 1-5. Supports API version 2 only. Required when: retry_on_connect_failure and retry_on are enabled. Possible values are: 1, 2, 3, 4, 5. | Optional |
retry_on_http_layer | Enable to configure the retry times and failure response code in case of any HTTP connection failure. Supports API version 2 only. Required when: retry_on is enabled. Possible values are: enable, disable. | Optional |
retry_times_on_http_layer | The number of retry times when FortiWeb reconnects the single server or switch to the other pserver. The valid range is 1-5. Supports API version 2 only. Required when: retry_on and retry_on_http_layer are enabled. Possible values are: 1, 2, 3, 4, 5. | Optional |
retry_on_http_response_codes | The failure return code when the pserver can be connected to determine enabling HTTP failure retry. Supports API version 2 only. Required when: retry_on and retry_on_http_layer are enabled. Possible values are: 404, 408, 500, 501, 502, 503, 504. | Optional |
scripting | Enable to perform actions that are not currently supported by the built-in feature set. Supports API version 2 only. | Optional |
scripting_list | Scripting list to perform actions that are not currently supported by the built-in feature set. Required when: scripting is enabled. Supports API version 2 only. | Optional |
allow_list | The Policy Based Allow list to use instead of the Global Allow List. Supports API version 2 only. | Optional |
replacemsg | The replacement message to apply to the policy. Supports API version 2 only. | Optional |
json_template_id | Allows the use of the server policy JSON template. All of the arguments listed below will be overridden. For an example, see the integration. | Optional |
#
Context OutputThere 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-deleteDelete the server policy.
#
Base Commandfortiwebvm-server-policy-delete
#
InputArgument Name | Description | Required |
---|---|---|
name | Policy name. | Required |
#
Context OutputThere 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-listList the server policies.
#
Base Commandfortiwebvm-server-policy-list
#
InputArgument Name | Description | Required |
---|---|---|
name | Server policy name. | Optional |
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.ServerPolicy.name | String | Server policy name. |
FortiwebVM.ServerPolicy.deployment_mode | String | Server policy deployment mode. |
FortiwebVM.ServerPolicy.protocol | String | Server policy protocol. |
FortiwebVM.ServerPolicy.web_protection_profile | String | Server policy inherit web protection profile flag. |
FortiwebVM.ServerPolicy.monitor_mode | String | This setting enables FortiWeb to log attacks without performing the deny or redirect action. Disable to allow FortiWeb to perform attack deny/redirect actions as defined by the server protection rules. |
FortiwebVM.ServerPolicy.http_service | String | Custom or predefined service that defines the port number on which the virtual server receives HTTPS traffic. |
FortiwebVM.ServerPolicy.https_service | String | Custom or predefined service that defines the port number on which the virtual server receives HTTPS traffic. |
FortiwebVM.ServerPolicy.certificate | String | Server policy certificate. |
FortiwebVM.ServerPolicy.certificate_intermediate_group | String | Server policy certificate intermediate group. |
FortiwebVM.ServerPolicy.server_pool | String | Server policy server pool name. |
FortiwebVM.ServerPolicy.protected_hostnames | String | Server policy protected hostname name. |
FortiwebVM.ServerPolicy.client_real_ip | String | Enable to configure FortiWeb to use the source IP address of the client that originated the request when it connects to a back-end server on behalf of that client. |
FortiwebVM.ServerPolicy.syn_cookie | String | Whether to detect TCP SYN flood attacks. |
FortiwebVM.ServerPolicy.redirect_to_https | String | Whether to automatically redirect all HTTP requests to the HTTPS service with the same URL and parameters. |
FortiwebVM.ServerPolicy.http2 | String | Whether to enable HTTP/2. Required when: HTTPSService is not null. |
FortiwebVM.ServerPolicy.url_case_sensitivity | String | Whether to differentiate uniform resource locators (URLs) according to upper case and lower case letters for features that act upon the URLs in the headers of HTTP requests, such as block list rules, and allow list rules. |
FortiwebVM.ServerPolicy.comments | String | A description or other comment. If the comment is more than one word or contains special characters, surround the comment with double quotes ( " ). The maximum length is 999 characters. |
FortiwebVM.ServerPolicy.retry_on | String | Whether to configure whether to retry a failed TCP connection or HTTP request in Reverse Proxy mode. Supports API version 2 only. |
FortiwebVM.ServerPolicy.retry_on_cache_size | String | A cache size limit for the HTTP request packet. Supports API version 2 only. Required when: retry_on is enabled. |
FortiwebVM.ServerPolicy.retry_times_on_connect_failure | String | The number of retry times in case of any TCP connection failure. Supports API version 2 only. Required when: retry_on is enabled. |
FortiwebVM.ServerPolicy.retry_on_http_layer | String | The number of retry times and failure response code in case of any HTTP connection failure. Supports API version 2 only. Required when: retry_on is enabled. |
FortiwebVM.ServerPolicy.retry_times_on_http_layer | String | The number of retry times when FortiWeb reconnects the single server or switch to the other pserver. The valid range is 1-5. Supports API version 2 only. Required when: retry_on and retry_on_http_layer are enabled. |
FortiwebVM.ServerPolicy.retry_on_http_response_codes | String | The failure return code when the pserver can be connected to determine enabling HTTP failure retry. Supports API version 2 only. Required when: retry_on and retry_on_http_layer are enabled. |
FortiwebVM.ServerPolicy.scripting | String | Whether to perform actions that are not currently supported by the built-in feature set. Supports API version 2 only. |
FortiwebVM.ServerPolicy.scripting_list | String | Server policy scripting list. Required when: scripting is enabled. Supports API version 2 only. |
FortiwebVM.ServerPolicy.allow_list | String | Server policy allow list. Supports API version 2 only. |
FortiwebVM.ServerPolicy.replace_msg | String | Server policy replacement message. Supports API version 2 only. API version 2 only. |
#
Command example!fortiwebvm-server-policy-list name=example
#
Context Example - API Version 1#
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#
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-listList the HTTP content routing policies.
#
Base Commandfortiwebvm-content-routing-policy-list
#
InputArgument Name | Description | Required |
---|---|---|
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.HttpContentRoutingPolicy.id | String | Policy name. |
#
Command example!fortiwebvm-content-routing-policy-list limit=1
#
Context Example#
Human Readable Output#
Content Routing Policy:Showing 1 rows out of 1. |Id| |---| | content1 |
#
fortiwebvm-http-content-routing-member-addCreate the server policy HTTP content routing member.
#
Base Commandfortiwebvm-http-content-routing-member-add
#
InputArgument Name | Description | Required |
---|---|---|
policy_name | Policy name. | Required |
is_default | Whether FortiWeb applies the protection profile to any traffic that does not match conditions specified in the HTTP content routing policies. Possible values are: yes, no. Default is no. | Optional |
http_content_routing_policy | HTTP content routing policy name. | Required |
inherit_web_protection_profile | Whether to enable the inherit web protection profile. Possible values are: enable, disable. Default is disable. | Optional |
profile | Web protection profile. This is required when inherit web protection profile is disabled. | Optional |
status | HTTP content routing member status. Supports API version 2 only. Possible values are: enable, disable. Default is enable. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.HttpContentRoutingMember.id | Number | HTTP content routing member ID. |
#
Command example!fortiwebvm-http-content-routing-member-add policy_name=example http_content_routing_policy=content1
#
Context Example#
Human Readable Output#
HTTP content routing member succesfuly created!
Id 1
#
fortiwebvm-http-content-routing-member-updateUpdate the server policy HTTP content routing member.
#
Base Commandfortiwebvm-http-content-routing-member-update
#
InputArgument Name | Description | Required |
---|---|---|
policy_name | Policy name. | Required |
http_content_routing_policy | HTTP content routing policy name. | Optional |
id | Server policy HTTP content routing member ID. | Required |
is_default | Whether FortiWeb applies the protection profile to any traffic that does not match conditions specified in the HTTP content routing policies. Possible values are: yes, no. | Optional |
inherit_web_protection_profile | Whether to enable inherit web protection profile. Possible values are: enable, disable. | Optional |
profile | Web protection profile. This is required when inherit web protection profile is disabled. Supports API version 1 only. | Optional |
status | HTTP content routing member status. Supports API version 2 only. Possible values are: enable, disable. | Optional |
#
Context OutputThere 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-deleteDelete the server policy HTTP content routing member.
#
Base Commandfortiwebvm-http-content-routing-member-delete
#
InputArgument Name | Description | Required |
---|---|---|
policy_name | Policy name. | Required |
id | Server policy HTTP content routing member ID. | Required |
#
Context OutputThere 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-listList the Server policy HTTP content routing members.
#
Base Commandfortiwebvm-http-content-routing-member-list
#
InputArgument Name | Description | Required |
---|---|---|
policy_name | Policy name. | Required |
id | Server policy HTTP content routing member ID. | Optional |
page | The page number of the results to retrieve. | Optional |
page_size | The maximum number of records to retrieve per page. | Optional |
limit | The maximum number of records to retrieve. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
FortiwebVM.HttpContentRoutingMember.policy_name | String | HTTP content routing policy name. |
FortiwebVM.HttpContentRoutingMember.Members.id | String | HTTP content routing ID. |
FortiwebVM.HttpContentRoutingMember.Members.default | String | Whether the HTTP content routing is the default. |
FortiwebVM.HttpContentRoutingMember.Members.http_content_routing_policy | String | HTTP content routing policy name. |
FortiwebVM.HttpContentRoutingMember.Members.inherit_web_protection_profile | Boolean | HTTP content routing inherit web protection profile flag. |
FortiwebVM.HttpContentRoutingMember.Members.profile | String | HTTP content routing profile. |
FortiwebVM.HttpContentRoutingMember.Members.status | String | HTTP content routing status. Supports API version 2 only. |