Configure virtual Connector

Virtual Magic WAN Connector (Virtual Connector) is a virtual appliance alternative to the hardware based Magic WAN Connector appliance. These two versions of Connector are identical otherwise.

Before you begin

You can install up to two Magic WAN Connectors for redundancy at each of your sites. If one of your Connectors fail, traffic will fail over to the other Connector ensuring that you never lose connectivity to that site.

In this type of high availability (HA) configuration, you will choose a reliable LAN interface as the HA link which will be used to monitor the health of the peer connector. HA links can be dedicated links or can be shared with other LAN traffic.

You must decide the type of configuration you want for your site from the beginning: no redundancy or with redundancy. You cannot add redundancy after finishing configuring your dashboard settings. If, at a later stage, you decide to enable redundancy, you will need to delete your site configuration in the Cloudflare dashboard, and start again.

Do you need a high availability configuration?

• If you need a high availability configuration for your premises, refer to About high availability configurations for more information and learn how to configure your Connector in this mode.

• If you do not need a high availability configuration for you premises, proceed to Set up Cloudflare dashboard.

Warning

You cannot enable high availability for an existing site. To add high availability to an existing site in the Cloudflare dashboard, you need to delete the site and start again. Plan accordingly to create a high availability configuration from the start if needed.

Prerequisites

Before you can install Virtual Connector, you need an Enterprise account with Magic WAN enabled. Additionally, you need to have a VMware host with sufficient compute, memory, and storage to run the virtual machine with Virtual Connector. This includes:

• Intel x86 CPU architecture
• ESXi hypervisor 7.0U1 or higher
• 4 virtual CPUs per virtual connector (We recommend deployment with a 1:1 virtual CPU to physical core allocation to avoid CPU over contention which will cause packet loss.)
• 8 GB of RAM per virtual connector
• 8 GB of disk per virtual connector
• One vSwitch port group or VLAN with access to the Internet (for example, through a WAN)
• One or more vSwitch port group or VLAN that will be the internal LAN

Refer to VMware's documentation ↗ for more information on how to install ESXi and configure a virtual machine.

Obtain the Virtual Connector image

Contact your account team at Cloudflare to obtain the Virtual Connector OVA package ↗ and license keys. The OVA image includes the files required to install and configure the virtual machine (VM) for Virtual Connector with the appropriate settings.

This image can be deployed multiple times to create several instances of a Virtual Connector, in different locations or on the same ESXi host.

You will consume one license key for each instance created. For example, if you want to deploy 10 Virtual Connectors you should request 10 license keys, and your account team will create 10 Connector instances in your Cloudflare dashboard.

Deploy the Virtual Connector on VMware

The following instructions assume you already have VMware ESXi hypervisor installed with sufficient resources. Refer to Prerequisites for more information.

1. When setting up your VMware ESXi, you need to create port groups for Virtual Connector. Go to Networking > Port groups, and prepare your vSwitch port groups and/or VLANs for your desired network topology. For example, a simple deployment typically has:
   • A WAN port group where the Virtual Connector will get an IP address (static or DHCP) that has access to the Internet.
   • A LAN port group, where the Virtual Connector will act as default router, and possibly DHCP server.
   • A null, or unused, port group for allocating unused virtual interfaces in the Virtual Connector. You can, for example, create a null port group with the name of Null port group, and a VLAN ID of 999.

VLAN tagging

Virtual Connector supports creating subinterfaces through the use of 802.1Q VLAN tagging ↗.

Use VLAN ID 0 when:

• Connected to a Port Group or Distributed Port Group that is associated with a specific VLAN.
• Connected to a Port Group or Distributed Port Group that is configured as a trunk that requires untagged packets.

You can also configure subinterfaces on the Virtual Connector by associating the network interface with a Port Group or Distributed Port Group trunk and specifying a VLAN ID in addition to the port associated with the network interface (VLAN ID 1–4094).

Refer to VMWare's documentation ↗ for more information.

2. Extract the files in the OVA image provided by your Cloudflare account team. For example:

   tar -xvf mconn-2024-1-3.ova

   Take note of the folder where you are extracting the files to, as you will need to refer to that folder when creating the VM.

3. Go to Virtual Machines > Create/Register VM wizard to start deploying the Virtual Connector.

4. Select Deploy a virtual machine from an OVF or OVA file > Next.

5. Choose a descriptive name for your virtual machine.

6. Upload the files you have extracted from the OVA image. These include mconn.ovf, mconn.nvram, and mconn.vmdk.

7. Select where you want to save the files extracted from the OVA image > Next.

8. In Networking mappings, select assignments for your desired topology according to the port groups you set up previously:

   1. For example, map eno1 port to VM Network to create your WAN, and eno2 to LAN0 to act as your LAN port.
   2. Allocate any unused ports to the null port group.
   3. Take note of your configuration. You will need this information to configure your network in the Cloudflare dashboard.

9. In Disk provisioning, select Thin.

10. Before completing the deployment wizard, disable Power on automatically. This is important so that you can configure the license key prior to boot.

11. Configure the virtual machine with the license key your account team provided you:

    1. Select the Virtual Connector's VM > Settings.
    2. Go to VM Options > Advanced > Edit Configuration.
    3. Select Add parameter to add your license key. Scroll down to the last entry (this is where VMware adds the new parameter), and add the following two new entries:
       • Key: guestinfo.cloudflare.identity
       • Value: <YOUR_LICENCE_KEY>

Note

You cannot use the same license key twice, or reuse a key once the virtual machine has been registered with Cloudflare. You need a new key from your account team for every new Virtual Connector.

12. Select Save to finish configuring your Virtual Connector.
13. Continue set up in your Cloudflare dashboard.

Set up Cloudflare dashboard

1. Create a site

Sites represent the local network where you have installed your Magic WAN Connector — for example, a branch office location.

You need to create a site and set up all the settings associated with it before you can connect your Magic WAN Connector to the Internet.

To add a site:

Dashboard

1. Log in to the Cloudflare dashboard ↗ and select your account.
2. Go to Magic WAN > Sites.
3. Select Create to create a new site and start the configuration wizard.
4. Add a name and description for your new site.
5. (Optional) In Site location, you can add the geographical coordinates for your site. If you add geographical coordinates, your site will show up in the Site Analytics overview map.
6. Under Connector, select Add Connector. This will show you a list of Magic WAN Connector devices associated with your account. For a Virtual Connector to show up you need to have already obtained your OVA package and licence keys.
7. If you have more than one Connector, choose the one that corresponds to the site you are creating. Connectors are identified by a serial number, also known as a service tag. Use this information to choose the right Connector. Select Add Connector when you are ready to proceed.
8. The Connector will be added to your site with an Interrupt window defined. The interrupt window is the time period when the Magic WAN Connector software can update, which may result in interruption to existing connections. You can change this later. Refer to Interrupt window for more details on how to define when the Connector can update its systems.
9. Select Next to proceed to creating your WAN and LAN networks.

API

Note

You will need your account ID and API Key to use the API.

Create a POST request using the API to create a site.

Example:

curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/sites \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "name": "<SITE_NAME>"
  "description": "<SITE_DESCRIPTION>",
}'

{
  "result": {
    "site": {
      "id": "<SITE_ID>",
      "name": "<SITE_NAME>",
      "description": "<SITE_DESCRIPTION>",
      "connector_id": null,
      "secondary_connector_id": null,
      "ha_mode": false
    }
  },
  "success": true,
  "errors": [],
  "messages": []
}

Take note of the site id parameter, as you will need it to create WANs and LANs.

2. Create a WAN

Dashboard

1. In WAN configuration, select Create. You can create one or more wide area networks (WANs) ↗. Configuring multiple WANs will create multiple IPsec tunnels (one IPsec tunnel per WAN port). This allows the Connector to failover between circuits according to their health.
2. In Interface name, enter a descriptive name for your WAN.
3. Interface number needs to correspond to the virtual network interface on the Virtual Connector instance you have set up in VMware. Following our example from the previous steps, you need to choose port 1 since that is what corresponds to the eno1 port we set up in VMware.
4. In VLAN ID, enter a number between 0 and 4094 to specify a VLAN ID.
5. In Priority, choose the priority for your WAN. Lower numbers have higher priority. Refer to Traffic steering to learn more about how Cloudflare calculates priorities.
6. Addressing: If this is the first time you are setting up your Magic WAN Connector, select DHCP. After you activate your Connector, you can then choose to continue fetching the WAN IP address from a DHCP server, or change it to a static IP. If you choose a static IP, you also need to specify the static IP and gateway addresses.

7. Select Save when you are finished.

API

Note

You will need your account ID and API Key to use the API.

Create a POST request using the API to create a WAN.

The static_addressing object is optional. Omit it if you are using DHCP. If you are using static addressing, add the secondary_address parameter when your site is in high availability (HA) mode.

Example:

curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/sites/{site_id}/wans \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "name": "<YOUR_WAN_NAME>",
  "physport": 1,
  "priority": 0,
  "vlan_tag": 0
}'

3. Create a LAN

Dashboard

1. In LAN configuration, select Create.

2. Enter a descriptive name for your LAN in Interface name.

3. Interface number needs to correspond to the virtual LAN interface on the Virtual Connector instance you have set up in VMware. Following our example from the previous steps, you need to choose port 2 since that is what corresponds to the eno2 port we set up in VMware.

4. In VLAN ID, specify a VLAN ID to create virtual LANs.

5. In Static addressing > Static address give your Connector's LAN interface its IP address. You can also enable the following options if they suit your use case:

   • This is a DHCP server: If your Connector is a DHCP server.
   • This is a DHCP relay: If your Connector is a DHCP relay.

6. (Optional) In Directly attached subnet > Static NAT prefix, enter a CIDR prefix to enable NAT (network address translation). The prefix you enter here should be the same size as the prefix entered in Static addressing. For example, both networks have a subnet mask of /24: 192.168.100.0/24 and 10.10.100.0/24.

7. (Optional) If your LAN contains additional subnets behind a layer 3 router, select Add routed subnet under Routed subnets to add them:

   • Prefix: The CIDR prefix for the subnet behind the L3 router.

   • Next hop: The address of the L3 router to which the Connector should forward packets for this subnet.

   • Static NAT prefix: Optional setting. If you want to enable NAT for a routed subnet, supply an "external" prefix for the overlay-facing side of the NAT to use. It must be the same size as Prefix.

     Refer to Routed subnets for more information.

8. Select Save.

9. Select Save and exit to finish your configuration. Tunnels and static routes will be automatically created and associated with your site once the Magic WAN Connector boots up (refer to the next step).

API

Note

You will need your account ID and API Key to use the API.

Create a POST request using the API to create a LAN.

Example:

curl https://api.cloudflare.com/client/v4/accounts/{account_id}/magic/sites/{site_id}/lans \
--header "X-Auth-Email: <EMAIL>" \
--header "X-Auth-Key: <API_KEY>" \
--header "Content-Type: application/json" \
--data '{
  "name": "<YOUR_LAN_NAME>",
  "physport": 2,
  "static_addressing": {
    "address": "172.16.14.0/24"
  },
  "vlan_tag": 0
}'

Network segmentation

After setting up your LANs, you can configure your Connector to enable communication between them without traffic leaving your premises. Refer to Network segmentation for more information.

DHCP options

Magic WAN Connector supports different types of DHCP configurations. Connector can:

• Connect to a DHCP server or use a static IP address instead of connecting to a DHCP server.
• Act as a DHCP server.
• Use DHCP relay to connect to a DHCP server outside the location your Magic WAN Connector is in.
• Reserve IP addresses for specific devices on your network.

Refer to DHCP options to learn more.

Activate Connector

Virtual Magic WAN Connector is deactivated after you install it, and will only establish a connection to the Cloudflare network when it is activated. Cloudflare recommends leaving it deactivated until you finish setting it up in the dashboard.

When the Connector is first activated, one of the ports must be connected to the Internet through a device that supports DHCP. This is required so that the Connector can reach the Cloudflare global network and download the required configurations that you set up in the site configuration step.

Warning

Remember to connect Magic WAN Connector through a route that supports DHCP for its first connection to the Internet. Otherwise, the Connector will not work.

When you are ready to connect your Magic WAN Connector to the Cloudflare network:

1. Log in to the Cloudflare dashboard ↗ and select your account.
2. Go to Magic WAN > Configuration > Connectors.
3. Find the Connector you want to activate, select the three dots next to it > Edit. Make sure you verify the serial number to choose the right connector you want to activate.
4. In the new window, the Status dropdown will show as Deactivated. Select it to change the status to Activated.
5. The Interrupt window is the time period when the Magic WAN Connector software can update, which may result in interruption to existing connections. Choose a time period to minimize disruption to your sites. Refer to Interrupt window for more details on how to define when the Connector can update its systems.
6. Select Update.

WAN with a static IP address

After activating your Virtual Connector, you can use it in a network configuration with the WAN interface set to a static IP address — that is, an Internet configuration that is not automatically set by DHCP.

To use your Virtual Connector on a network configuration with a static IP:

1. Wait 60 seconds after activating your Connector.
2. Modify your Port Groups as needed to change the source from which the WAN port obtains its IP address.
3. Adjust the WAN settings in the Cloudflare dashboard to reflect the new static IP address configuration.
4. Reboot your virtual machine.

Boot your Virtual Connector

1. Go to Virtual Machines in VMware, and boot up Virtual Connector's VM.
2. The Virtual Connector will make a request to Cloudflare. This is the step where Virtual Connector registers your provided license key and downloads the site configuration for its connected site.
3. The Virtual Connector will set up the LAN and WAN connections according to the configuration downloaded from the site you created on the Cloudflare dashboard. The Virtual Connector will also establish IPsec tunnels.
4. If successful, the tunnel health checks will show as healthy.
5. If you do not see a healthy heartbeat the Cloudflare dashboard, reboot the Virtual Connector's VM in VMware.

---

About high availability configurations

When you set up a site in high availability, the WANs and LANs in your Connectors have the same configuration but are replicated on two nodes. In case of failure of a Connector, the other Connector becomes the active node, taking over configuration of the LAN gateway IP and allowing traffic to continue without disruption.

Because Connectors in high availability configurations share a single site, you need to set up:

• Static address: The IP for the primary node in your site.
• Secondary static address: The IP for the secondary node in your site.
• Virtual static address: The IP that the LAN south of the Connector will forward traffic to, which is the LAN's gateway IP.

Make sure all IPs are part of the same subnet.

Note

• Failure conditions include Connector down or software restart, LAN or WAN link down, tunnel health down.
• High availability (HA) is run in non-preempt mode, which means either the primary or the secondary node can come up as active through an election process which includes node health parameters.
• In the case of a failover where a Connector is acting as a DHCP server, DHCP leases will be synchronized.

​​Create a high availability configuration

You cannot enable high availability for an existing site. To add high availability to an existing site in the Cloudflare dashboard, you need to delete the site and start again.

To set up a high availability configuration:

1. Follow the steps in Create a site up until step 4.
2. After naming your site, select Enable high availability.
3. Under Connector, select Add Connector.
4. From the list, choose your first Connector > Add Connector.
5. Back on the previous screen, select Add secondary Connector.
6. From the list, choose your second Connector > Add Connector.
7. Select Next to Create a WAN. If you are configuring a static IP, configure the IP for the primary node as the static address, and the IP for the secondary node as the secondary static address.
8. To create a LAN, follow the steps mentioned above in Create a LAN up until step 4.
9. In Static address, enter the IP for the primary node in your site. For example, 192.168.10.1/24.
10. In Secondary static address, enter the IP for the secondary node in your site. For example, 192.168.10.2/24.
11. In Virtual static address, enter the IP that the LAN south of the Connector will forward traffic to. For example, 192.168.10.3/24.
12. Select Save.
13. From the High availability probing link drop-down menu, select the port that should be used to monitor the node's health. Cloudflare recommends you choose a reliable interface as the HA probing link. The primary and secondary node's probing link should be connected over a switch, and cannot be a direct connection.
14. Follow the instructions in Activate connector to finish setting up your Connectors.

---

IP sec tunnels and static routes

Magic WAN Connector automatically creates IPsec tunnels and static routes for you. You cannot configure these manually.

To check the IPsec tunnels and static routes created by your Magic WAN Connector:

1. Log in to the Cloudflare dashboard ↗ and select your account.
2. Go to Magic WAN > Sites.
3. Select the name of the site for which you want to check the Connector's IPsec tunnels and static routes, and select Edit.
4. Select Tunnels to check IPsec tunnels, and Routes for the static routes.

---

Next steps

• Network options
• Maintenance
• Reference information
• Troubleshooting

Was this helpful?

What did you like?

Accurate

Easy to understand

Solved my problem

Helped me decide to use the product

Other

What went wrong?

Hard to understand

Incorrect information

Missing the information

Other

Thank you for helping improve Cloudflare's documentation!