Fortinet white logo
Fortinet docs logo DOCUMENT LIBRARY
Fortinet white logo
Fortinet docs logo DOCUMENT LIBRARY
Products Best Practices Hardware Guides Products A-Z
Summary
By Solution
By 4D Pillars
By Cloud
Secure Networking
Unified SASE
Security Operations
Secure SD-WAN
Secure Access Service Edge (SASE)
ZTNA
LAN Edge
Identity and Access Management
Next Generation Firewall
Public Cloud
Private Cloud
FortiCloud
Secure Networking
  • Hybrid Mesh Firewall
  • NOC Management
  • LAN
  • WAN
    • More >>
    Unified SASE
  • Single Vendor SASE
  • Cloud Network Security
  • Secure Endpoint Connectivity
  • Web Application / API Protection
    • More >>
    Security Operations
  • Security Operations Automation
  • Identity
  • Early Detection & Prevention
    • More >>
    Secure Networking
  • Hybrid Mesh Firewall
  • NOC Management
  • LAN
  • WAN
  • Communication & Surveillance
    • Unified SASE
  • Single Vendor SASE
  • Secure Endpoint Connectivity
  • Cloud Network Security
  • Cloud-Native Security
  • Web Application / API Protection
    • Security Operations
  • Security Operations Automation
  • Endpoint
  • Data Protection
  • Identity
  • Email
  • Early Detection & Prevention
  • Expert Services
  • Edge Firewall
  • Orchestration & management
  • SD Branch
  • Application Delivery
  • Single Vendor SASE
  • Secure Endpoint Connectivity
  • Secure Private Access
  • Thin Edge
  • Identity
  • Application Gateway
  • Enterprise Asset Management
  • Endpoint Agent
  • Agentless Security Posture
  • Identity
  • Wireless
  • Switching
  • Identity
  • Privilege Acccess Management
  • Next Generation Firewall
  • Orchestration & management
  • Expert Services
  • All
  • All
  • Account Management
  • SAAS Management
  • SAAS Application Security
  • Managed Services
  • Platform as a service (PAAS)
  • Other SAAS Services
    • 4D Resources
    Solution Hubs
  • 4D Pillars
  • Cloud
  • Popular Solutions

    • Handbook

    Home FortiADC 7.4.2 Handbook
    7.4.2
    7.4.5
    7.4.4
    7.4.3
    7.4.2
    7.4.1
    7.4.0
    7.2.7
    7.2.6
    7.2.5
    7.2.4
    7.2.3
    7.2.2
    7.2.1
    7.2.0
    7.1.4
    7.1.3
    7.1.2
    7.1.1
    7.1.0
    7.0.5
    7.0.4
    7.0.3
    7.0.2
    7.0.1
    7.0.0
    6.2.6
    6.2.5
    6.2.4
    6.2.3
    6.2.2
    6.2.1
    6.2.0
    6.1.6
    6.1.5
    6.1.4
    6.1.3
    6.1.2
    6.1.1
    6.1.0
    6.0.1
    6.0.0
    5.4.3
    5.4.2
    5.4.1
    5.4.0
    5.3.6
    5.3.5
    5.3.4
    5.3.3
    5.3.2
    5.3.1
    5.3.0
    5.2.7

    Predefined scripts

    Predefined scripts

    Predefined scripts provides the syntax, usage, and examples of the predefined commands that are useful for writing scripts.

    Predefined scripts
    Predefined script Usage
    COMPARE_IP_ADDR_2_ADDR_GROUP_DEMO

    Compares an IP address to an address group to determine if the IP address is included in the specified IP group. For example ,192.168.1.2 is included in 192.168.1.0/24.

    Note: Do NOT use this script "as is". Instead, copy it and customize the IP address and the IP address group.
    CONTENT_ROUTING_by_URI Routes to a pool member based on URI string matches. You should not use this script as is. Instead, copy it and customize the URI string matches and pool member names.

    CUSTOMIZE_AUTH_KEY

    Demonstrate how to customize the crypto key for authentication cookie.
    HTTP_DATA_FETCH_SET_DEMO

    Collects data in HTTP request body or HTTP response body. In HTTP_REQUEST or HTTP_RESPONSE, you could collect specified size data with “size” in collect().In HTTP_DATA_REQUEST or HTTP_DATA_RESPONSE. You could print the data use “content”, calculate data length with “size”, and rewrite the data with “set”.

    Note: Do NOT use this script "as is". Instead, copy it and manipulate the collected data.
    REDIRECTION_by_USER_AGENT Redirects requests based on User Agent (for example, a redirect to the mobile version of a site). You should not use this script as is. Instead, copy it and customize the User Agent and URL values.

    TWO_STEP_VERIFICATION_2_SAME

    Demonstrate how to perform 2-Step Verification for the second authentication group using the same token group.
    OPTIONAL_CLIENT_AUTHENTICATION

    Performs optional client authentication.

    Note: Before using this script, you must have the following four parameters configured in the client-ssl-profile:

    • client-certificate-verify—Set to the verify you'd like to use to verify the client certificate.
    • client-certificate-verify-option—Set to optional
    • ssl-session-cache-flag—Disable.
    • use-tls-tickets—Disable.

    PERSIST_COMMANDS

    Lists the persist event and commands

    TWO_STEP_VERIFICATION_2_NEW

    Demonstrate how to perform 2-Step Verification using FortiToken for the second authentication group.

    AUTH_COOKIE_BAKE

    Allows you to retrieve the baked cookie and edit the cookie content.
    HTTP_2_HTTPS_REDIRECTION_FULL_URL

    Redirects requests to the specified HTTPS URL.

    Note: This script can be used directly, without making any change.
    REDIRECTION_by_STATUS_CODE

    Redirects requests based on the status code of server HTTP response (for example, a redirect to the mobile version of a site). Do NOT use this script "as is". Instead, copy it and customize the condition in the server HTTP response status code and the URL values.

    TWO_STEP_VERIFICATION_2_NEW

    Demonstrate how to perform 2-Step Verification using FortiToken for the second authentication group.

    TWO_STEP_VERIFICATION_2_SAME

    Demonstrate how to perform 2-Step Verification for the second authentication group using the same token group.

    TWO_STEP_VERIFICATION_CHANGE_KEY

    Demonstrate how to change the AES key and its size for stored token group.

    URL_UTILITY_COMMANDS

    Demonstrate how to use those url tools to encode/decode/parser/compare.
    USE_REQUEST_HEADERS_in_OTHER_EVENTS

    Stores a request header value in an event and uses it in other events. For example, you can store a URL in a request event, and use it in a response event.

    Note: Do NOT use this script "as is". Instead, copy it and customize the content you want to store, use collect() in HTTP_REQUEST to trigger HTTP_DATA_REQUEST,or use collect() in HTTP_ RESPONSE to trigger HTTP_DATA_ RESPONSE.
    UTILITY_FUNCTIONS_DEMO

    Demonstrates how to use the basic string operations and random number/alphabet, time, MD5, SHA1, SHA2, BASE64, BASE32, table to string conversion, network to host conversion utility function
    Commands

    AUTH_EVENTS_n_COMMANDS

    Lists the auth event and commands
    COOKIE_COMMANDS Lists the two cookie commands and shows how to use them.
    IP_COMMANDS Lists the IP commands and shows how to use them.
    MANAGEMENT_COMMANDS Lists the management commands and shows how to use them.

    PERSIST_COMMANDS

    Lists the persist event and commands

    RAM_CACHING_COMMANDS

    Lists the RAM caching event and commands
    SSL_EVENTS_n_COMMANDS Lists the SSL events and commands.
    TCP_EVENTS_n_COMMANDS Lists the TCP events and commands.
    Predefined script Usage

    AES_DIGEST_SIGN_2F_COMMANDS

    Demonstrate how to use AES to encryption/decryption data and some tools to generate the digest.

    AUTH_COOKIE_BAKE

    Allows you to retrieve the baked cookie and edit the cookie content.

    AUTH_EVENTS_n_COMMANDS

    Used to get the information from authentication process.
    CLASS_SEARCH_n_MATCH Demonstrates how to use the class_match and class_search utility function.
    COMPARE_IP_ADDR_2_ADDR_GROUP_DEMO

    Compares an IP address to an address group to determine if the IP address is included in the specified IP group. For example ,192.168.1.2 is included in 192.168.1.0/24.

    Note: Do NOT use this script "as is". Instead, copy it and customize the IP address and the IP address group.
    CONTENT_ROUTING_by_URI Routes to a pool member based on URI string matches. You should not use this script as is. Instead, copy it and customize the URI string matches and pool member names.
    CONTENT_ROUTING_by_X_FORWARDED_FOR Routes to a pool member based on IP address in the X-Forwarded-For header. You should not use this script as is. Instead, copy it and customize the X-Fowarded-For header values and pool member names.

    COOKIE_COMMANDS

    Demonstrate the cookie command to get the whole cookie in a table and how to remove/insert/set the cookie attribute.

    COOKIE_COMMANDS_USAGE

    Demonstrate the sub-function to handle the cookie attribute "SameSite" and others.

    COOKIE_CRYPTO_COMMANDS

    Used to perform cookie encryption/decryption on behalf of the real server.

    CUSTOMIZE_AUTH_KEY

    Demonstrate how to customize the crypto key for authentication cookie.
    GENERAL_REDIRECT_DEMO

    Redirects requests to a URL with user-defined code and cookie.

    Note: Do NOT use this script "as is". Instead, copy and customize the code, URL, and cookie.
    Previous
    Next

    Predefined scripts

    Predefined scripts

    Predefined scripts provides the syntax, usage, and examples of the predefined commands that are useful for writing scripts.

    Predefined scripts
    Predefined script Usage
    COMPARE_IP_ADDR_2_ADDR_GROUP_DEMO

    Compares an IP address to an address group to determine if the IP address is included in the specified IP group. For example ,192.168.1.2 is included in 192.168.1.0/24.

    Note: Do NOT use this script "as is". Instead, copy it and customize the IP address and the IP address group.
    CONTENT_ROUTING_by_URI Routes to a pool member based on URI string matches. You should not use this script as is. Instead, copy it and customize the URI string matches and pool member names.

    CUSTOMIZE_AUTH_KEY

    Demonstrate how to customize the crypto key for authentication cookie.
    HTTP_DATA_FETCH_SET_DEMO

    Collects data in HTTP request body or HTTP response body. In HTTP_REQUEST or HTTP_RESPONSE, you could collect specified size data with “size” in collect().In HTTP_DATA_REQUEST or HTTP_DATA_RESPONSE. You could print the data use “content”, calculate data length with “size”, and rewrite the data with “set”.

    Note: Do NOT use this script "as is". Instead, copy it and manipulate the collected data.
    REDIRECTION_by_USER_AGENT Redirects requests based on User Agent (for example, a redirect to the mobile version of a site). You should not use this script as is. Instead, copy it and customize the User Agent and URL values.

    TWO_STEP_VERIFICATION_2_SAME

    Demonstrate how to perform 2-Step Verification for the second authentication group using the same token group.
    OPTIONAL_CLIENT_AUTHENTICATION

    Performs optional client authentication.

    Note: Before using this script, you must have the following four parameters configured in the client-ssl-profile:

    • client-certificate-verify—Set to the verify you'd like to use to verify the client certificate.
    • client-certificate-verify-option—Set to optional
    • ssl-session-cache-flag—Disable.
    • use-tls-tickets—Disable.

    PERSIST_COMMANDS

    Lists the persist event and commands

    TWO_STEP_VERIFICATION_2_NEW

    Demonstrate how to perform 2-Step Verification using FortiToken for the second authentication group.

    AUTH_COOKIE_BAKE

    Allows you to retrieve the baked cookie and edit the cookie content.
    HTTP_2_HTTPS_REDIRECTION_FULL_URL

    Redirects requests to the specified HTTPS URL.

    Note: This script can be used directly, without making any change.
    REDIRECTION_by_STATUS_CODE

    Redirects requests based on the status code of server HTTP response (for example, a redirect to the mobile version of a site). Do NOT use this script "as is". Instead, copy it and customize the condition in the server HTTP response status code and the URL values.

    TWO_STEP_VERIFICATION_2_NEW

    Demonstrate how to perform 2-Step Verification using FortiToken for the second authentication group.

    TWO_STEP_VERIFICATION_2_SAME

    Demonstrate how to perform 2-Step Verification for the second authentication group using the same token group.

    TWO_STEP_VERIFICATION_CHANGE_KEY

    Demonstrate how to change the AES key and its size for stored token group.

    URL_UTILITY_COMMANDS

    Demonstrate how to use those url tools to encode/decode/parser/compare.
    USE_REQUEST_HEADERS_in_OTHER_EVENTS

    Stores a request header value in an event and uses it in other events. For example, you can store a URL in a request event, and use it in a response event.

    Note: Do NOT use this script "as is". Instead, copy it and customize the content you want to store, use collect() in HTTP_REQUEST to trigger HTTP_DATA_REQUEST,or use collect() in HTTP_ RESPONSE to trigger HTTP_DATA_ RESPONSE.
    UTILITY_FUNCTIONS_DEMO

    Demonstrates how to use the basic string operations and random number/alphabet, time, MD5, SHA1, SHA2, BASE64, BASE32, table to string conversion, network to host conversion utility function
    Commands

    AUTH_EVENTS_n_COMMANDS

    Lists the auth event and commands
    COOKIE_COMMANDS Lists the two cookie commands and shows how to use them.
    IP_COMMANDS Lists the IP commands and shows how to use them.
    MANAGEMENT_COMMANDS Lists the management commands and shows how to use them.

    PERSIST_COMMANDS

    Lists the persist event and commands

    RAM_CACHING_COMMANDS

    Lists the RAM caching event and commands
    SSL_EVENTS_n_COMMANDS Lists the SSL events and commands.
    TCP_EVENTS_n_COMMANDS Lists the TCP events and commands.
    Predefined script Usage

    AES_DIGEST_SIGN_2F_COMMANDS

    Demonstrate how to use AES to encryption/decryption data and some tools to generate the digest.

    AUTH_COOKIE_BAKE

    Allows you to retrieve the baked cookie and edit the cookie content.

    AUTH_EVENTS_n_COMMANDS

    Used to get the information from authentication process.
    CLASS_SEARCH_n_MATCH Demonstrates how to use the class_match and class_search utility function.
    COMPARE_IP_ADDR_2_ADDR_GROUP_DEMO

    Compares an IP address to an address group to determine if the IP address is included in the specified IP group. For example ,192.168.1.2 is included in 192.168.1.0/24.

    Note: Do NOT use this script "as is". Instead, copy it and customize the IP address and the IP address group.
    CONTENT_ROUTING_by_URI Routes to a pool member based on URI string matches. You should not use this script as is. Instead, copy it and customize the URI string matches and pool member names.
    CONTENT_ROUTING_by_X_FORWARDED_FOR Routes to a pool member based on IP address in the X-Forwarded-For header. You should not use this script as is. Instead, copy it and customize the X-Fowarded-For header values and pool member names.

    COOKIE_COMMANDS

    Demonstrate the cookie command to get the whole cookie in a table and how to remove/insert/set the cookie attribute.

    COOKIE_COMMANDS_USAGE

    Demonstrate the sub-function to handle the cookie attribute "SameSite" and others.

    COOKIE_CRYPTO_COMMANDS

    Used to perform cookie encryption/decryption on behalf of the real server.

    CUSTOMIZE_AUTH_KEY

    Demonstrate how to customize the crypto key for authentication cookie.
    GENERAL_REDIRECT_DEMO

    Redirects requests to a URL with user-defined code and cookie.

    Note: Do NOT use this script "as is". Instead, copy and customize the code, URL, and cookie.
    Previous
    Next