Configurable variables
Following is a list of variables used during deployment and referenced throughout this guide:
Parameter name |
Default value |
Description |
||
---|---|---|---|---|
Subscription |
Requires input |
Azure subscription you will deploy FortiGate Autoscale for Azure in. |
||
Requires input |
Resource group you will deploy FortiGate Autoscale for Azure in. Referred to as the Autoscale resource group. |
|||
Region |
Requires input |
Region you will deploy FortiGate Autoscale for Azure resources in. Not every resource is available in every region. |
||
Access Restriction IP Range |
Requires input |
IP address ranges (single IPv4 address or Classless Inter-Domain Routing (CIDR) range) to allow access from the internet or from your on-premise network to the CosmosDB and Function App. For security purposes, you must specify at least one entry. For multiple entries, you must separate each entry by a comma and no trailing comma is allowed.
|
||
Admin Password |
Requires input |
FortiGate administrator password on all VMs as well as the FortiAnalyzer if you enable FortiAnalyzer integration. You must follow FortiGate and Azure VM password policy and the password must be 11-26 characters in length with at least one uppercase letter, one lowercase letter, one digit, and one special character such as @ # $ % ^ & * - _ ! + =. |
||
Admin Username |
azureadmin |
FortiGate administrator username on all VMs as well as the FortiAnalyzer if you enable FortiAnalyzer integration. |
||
BYOL Instance Count |
2 |
Number of FortiGate instances the bring your own license (BYOL) VM scale set (VMSS) should have at any time. For high availability (HA) in BYOL-only and Hybrid use cases, ensure at least 2 FortiGates are in the group. For specific use cases, set to 0 for PAYG-only, and >= 2 for BYOL-only or hybrid licensing.
|
||
FortiAnalyzer Autoscale Admin Password |
Requires input |
Password for the FortiAnalyzer Autoscale Admin Username. The password must conform to the FortiAnalyzer password policy and have a minimum length of 8 and a maximum length of 128. If you need to enable KMS encryption, refer to the documentation. |
||
Requires input |
Name of the secondary administrator-level account in the FortiAnalyzer. FortiGate Autoscale uses this account to connect to the FortiAnalyzer to authorize any FortiGate device in the Auto Scaling group. To conform to the FortiAnalyzer naming policy, the user name can only contain numbers, lowercase letters, uppercase letters, and hyphens. It cannot start or end with a hyphen (-). |
|||
FortiAnalyzer Custom Private IP Address |
Requires input |
Custom private IP address to be used by the FortiAnalyzer. Must be within the Public subnet 1 CIDR range. Required if FortiAnalyzer Integration Options is set to 'yes'. If FortiAnalyzer Integration Options is set to 'no', any input will be ignored. |
||
Requires input |
Size of the FortiAnalyzer-VM. For details on selecting the size, refer to the section Selecting the instance type
|
|||
yes |
Choose 'yes' to incorporate FortiAnalyzer into FortiGate Autoscale for Azure to use extended features that include storing logs into FortiAnalyzer. |
|||
Requires input |
ID of the public IP address to associate with the FortiAnalyzer. If left empty, a new public IP address will be allocated in the resource group that contains the FortiAnalyzer. |
|||
FortiAnalyzer Version |
6.4.5 |
FortiAnalyzer version that FortiGate Autoscale for Azure supports. |
||
FortiGate PSK Secret |
Requires input |
Secret key used by FortiGate instances to securely communicate with each other. Must contain numbers and letters and may contain special characters. Maximum length is 128.
|
||
FOS Version |
7.0.1 |
FortiOS version supported by FortiGate Autoscale for Azure. |
||
Requires input |
When the ID of a Public IP Address is provided, the Public IP Address will be used as the Frontend IP address associated with the external load balancer. If left empty, a new Public IP Address will be allocated in the resource group that contains the virtual network components. |
|||
30 |
Maximum amount of time (in seconds) allowed for network latency of the FortiGate heartbeat arriving at the Autoscale handler function. Minimum is 30. |
|||
60 |
Length of time (in seconds) that the FortiGate waits between sending heartbeat requests to the Autoscale handler function. Minimum is 30. Maximum is 120. |
|||
3 |
Number of consecutively lost heartbeats. When the Heart Beat Loss Count has been reached, the VM is deemed unhealthy and failover activities will commence. |
|||
Standard_F4 |
Size of the VMs in the VMSS. The default is Standard_F4. For more options, refer to the Microsoft article Sizes for virtual machines in Azure. For details on selecting the size, refer to the section Selecting the instance type |
|||
Max BYOL Instance Count |
2 |
Maximum number of FortiGate instances in the BYOL VMSS. For specific use cases, set to 0 for PAYG-only, and >= 2 for BYOL-only or hybrid licensing. This number must be greater than or equal to the Min BYOL Instance Count.
|
||
Max PAYG Instance Count |
6 |
Maximum number of FortiGate instances in the PAYG VMSS. For specific use cases, set to 0 for BYOL-only, >= 2 for PAYG-only, and >= 0 for hybrid licensing. This number must be greater than or equal to the Min PAYG Instance Count. |
||
2 |
Minimum number of FortiGate instances in the BYOL VMSS. For specific use cases, set to 0 for PAYG-only, and >= 2 for BYOL-only or hybrid licensing.
|
|||
0 |
Minimum number of FortiGate instances in the PAYG VMSS. For specific use cases, set to 0 for BYOL-only, >= 2 for PAYG-only, and >= 0 for hybrid licensing.
|
|||
PAYG Instance Count |
0 |
Number of FortiGate instances the PAYG VMSS should have at any time. For HA in a PAYG-only use case, ensure at least two FortiGates are in the group. For specific use cases, set to 0 for BYOL-only, >= 2 for PAYG-only, and >= 0 for hybrid licensing. |
||
Requires input |
Public URL of the function source file
|
|||
Primary Election Timeout |
90 |
Maximum time (in seconds) to wait for the election of the primary instance to complete. |
||
Resource Name Prefix |
Requires input |
Prefix for all applicable resource names. Can only contain lowercase letters and numbers. Maximum length is 10. |
||
Scale In Threshold |
20 |
Percentage of CPU utilization at which scale-in should occur. |
||
Scale Out Threshold |
80 |
Percentage of CPU utilization at which scale-out should occur. |
||
Service Plan Tier |
Premium (P1V2) |
Pricing tier for the function service plan.
|
||
Requires input |
Application ID for the Registered app used as the Autoscale Function App API request service principal. This is the value that was noted when creating a service principal in Prerequisites. |
|||
Requires input |
Password (Authentication key) for the Registered app used as the Autoscale Function App API request service principal. This is the value that was noted when creating a service principal in Prerequisites. |
|||
Requires input |
Object ID for the Registered app used as the Autoscale Function App API request service principal. This is the value that was noted when creating a service principal in the section Prerequisites. |
|||
Storage Account Type |
Standard_LRS |
Storage account type. |
||
Subnet 1 Address Range |
Requires input |
Defines the Subnet 1 Address Range in CIDR notation. When creating a new VNet, the address range must be contained by the address space of the virtual network as defined in VNet Address Space. When using an existing VNet, the value must match the address range of the subnet specified in Subnet 1 Name. After deployment, the address range of a subnet which is in use can't be edited. |
||
|
Name of subnet 1. The FortiGate Autoscale VMSS is deployed in this subnet. When creating a new VNet, the input value is used as the Subnet 1 name; if left empty, a name will be generated. When using an existing VNet, a valid non-empty input will assume the association of the target subnet with FortiGate Autoscale, and the target subnet will be associated as Subnet 1. |
|||
Requires input |
Name of the Network Security Group (NSG) associated with the subnet 1. The FortiGate Autoscale VMSS is deployed in this subnet. Required when using an existing VNet. When creating a new VNet, any input will be ignored. |
|||
Subnet1 Network Security Group Rule Priority | 1000 | Starting number for the rule priority of the Network Security Group (NSG) associated with subnet 1 where the Autoscale related rules will be deployed. When using an existing VNet, assign a number that does not conflict with the priority of any existing rule in the NSG specified in the Subnet 1 Network Security Group Name. | ||
|
|
The Subnet # Address Range parameters define the address range for the subnet, in CIDR notation. The address range must be contained by the address space of the virtual network as defined in VNet Address Space.
After deployment, the address range of a subnet which is in use can't be edited. |
||
Subnet 2 Address Range |
Conditionally requires input |
|||
Subnet 3 Address Range |
Conditionally requires input |
|||
Subnet 4 Address Range |
Conditionally requires input |
|||
|
|
|
||
Subnet 2 Name |
Conditionally requires input |
(Optional) The Subnet # Name parameters specify the name of the subnet. If subnet # is created, the FortiGate will have a network interface in this subnet. When creating a new VNet that contains the subnet, the input value is used as the Subnet # name. If left empty, a name will be generated. When using an existing VNet, a valid non-empty input will assume the association of the target subnet with FortiGate Autoscale, and the target subnet will be associated as 'Subnet #'. |
||
Subnet 3 Name |
Conditionally requires input |
|||
Subnet 4 Name |
Conditionally requires input
|
|||
VMSS Availability Zones |
|
Availability zones to use "strict zone balancing", in array format. For example: [1], [1, 3], [1, 2, 3]. To use "best effort zone balancing", leave empty. If zone balancing is not applicable, set to a single zone - for example [2].
|
||
VMSS Placement Groups |
single |
VMSS placement group options. For more information, please refer to the Microsoft article Create a virtual machine scale set that uses Availability Zones. |
||
|
IP address space of the VNet in CIDR notation. E.g. 10.0.0.0/16. Required when using an existing VNet; the value should match the address space of the target VNet. |
|||
create new |
Options for Virtual Network (VNet) deployment:
|
|||
VNet Name |
Conditionally requires input |
Name of the Azure VNet to connect to FortiGate Autoscale. Required when using an existing VNet. When creating a new VNet, this parameter can be left empty and a name will be generated. |
||
Conditionally requires input |
Name of the resource group that contains the VNet and related network components.
|