Product Documentation

Installing CloudBridge Virtual Appliances on VMware ESX

May 24, 2013

Before installing Citrix Branch Repeater virtual appliances on VMware ESX, make sure that VMware ESX server is installed on a machine with adequate system resources. To install virtual appliances on VMware ESX version 4.1 or VMware ESXi version 4.0, or later, you use the VMware vSphere client. The client must be installed on a remote machine that can connect to VMware ESX through the network. After the installation, you can use the vSphere client to manage virtual appliances on either VMware ESX or VMware ESXi.

Before you begin installing a virtual appliance, do the following:
  • Install VMware ESX version 4.1 or ESXi 4, or later, on hardware that meets the minimum requirements.
  • Install the VMware vSphere client on a management workstation that meets the minimum system requirements.
  • Download the CloudBridge VPX setup files.
  • Obtain CloudBridge VPX license files.

Also, before installing a CloudBridge VPX virtual appliance, label all the interfaces that you plan to assign to VPX virtual appliances, in a unique format. In large deployments, labeling these interfaces in a unique format helps in quickly identifying them among other interfaces used by other virtual machines, such as Windows and Linux virtual machines. Such labeling is especially important when different types of virtual machines share the same interfaces.

CloudBridge VPX requires non-default networking options. Among other things, you will create two new virtual switches (vswitch0 and vswitch1) for the accelerated bridge, which must be assigned to two different virtual switches.
To label the physical network ports of the VMware ESX server
  1. Log on to the VMware ESX server by using the vSphere client.
  2. In the vSphere client, select the Configuration tab, and then click Networking.
  3. At the top-right corner of the screen that appears, click Add Networking.
  4. In the Add Network Wizard, for Connection Type, select Virtual Machine, and then click Next.
  5. Scroll through the list of vSwitch physical adapters, and choose the physical port to map to interface 1/1 on the virtual appliance.
  6. Enter NS_NIC_1_1 as the name of the vSwitch to associate with interface 1/1 of the virtual appliances.
  7. Click Next to finish the vSwitch creation. Repeat the procedure, beginning with step 2, to add at least one more interface to be used by your virtual appliances. Label the interfaces sequentially, in the correct format (for example, NS_NIC_1_2).
To install CloudBridge virtual appliances on VMware ESX 4.1/ESXi 4
Note: This procedure assumes a basic familiarity with VMware vSphere. Details of the vSphere client’s operation might change with new releases of the vSphere software. The VMware documentation should be considered definitive. This procedure shows the desired results and one example of achieving them.
  1. Install VMware ESX 4.1 1 (or later) on the selected server and the vSphere client on a system from which you can manage the server. You can download the software from http://downloads.VMware.com.
  2. Configure the setting for the first virtual switch (vSwitch0)
    • Log on to the VMware ESX server by using the vSphere client.
    • On the vSphere client, select the Configuration tab, and then click Networking.
    • On virtual switch vswitch0, click Properties.
      Figure 1. Configuring vSwitch0, continued


    • On the Properties page, select the VM Network and click Edit.
      Figure 2. Configuring vSwitch0, continued


    • On the Security tab, enable Promiscuous Mode. Click OK.
      Figure 3. Configuring vSwitch0: setting promiscuous mode


    • In the Properties dialog box, verify the changes, and then click Close.
      Figure 4. Configuring vSwitch0, continued


  3. Create the second virtual switch, label it, and configure settings for the new virtual switch (vswitch1).
    • Log on to the VMware ESX server by using the vSphere client.
    • In the vSphere client, on the Configuration tab, click Networking.
    • At the top-right corner, of the screen that appears, click Add Networking.
    • In the Add Network Wizard, for Connection Type, select Virtual Machine, and then click Next.
    • Select the Create a virtual switch check box .
    • Scroll through the list of vSwitch physical adapters, and choose the physical port that will map to interface 1/1 on the virtual appliance.
      Important: Do not select Use vSwitch0, or you will cause routing loops.
    • Click Next.
      Figure 5. Creating vSwitch1, continued


      Figure 6. Creating vSwitch1, continued


    • Verify that all new and modified virtual switches are configured appropriately.
    • Label the new virtual switch as apA-1 by clicking on the connection settings and typing apA-1 in Network Label text box.
    • Click Next, and click Finish.
      Figure 7. Naming vSwitch1


    • Enable promiscuous mode on vSwitch1, following the same steps as for vSwitch0 in Step 2.
      Figure 8. Enabling promiscuous mode on vSwitch1


  4. Create the third virtual switch, vSwitch2, following the procedure in step 3, but attaching it to the port on the WAN side of your network and naming it apA-2. Enable the promiscuous mode on vSwitch2, as you did on the other ports.
  5. Change the name of the virtual machine, if desired, and then click Next. Install the virtual machine.
    • Start the VMware vSphere client on your workstation.
    • In the IP address / Name text box, type the IP address of the VMware ESX server that you want to connect to.
    • In the User Name and Password text boxes, type the administrator credentials, and then click Login.
    • On the File menu, click Deploy OVF Template.
    • In the Deploy OVF Template dialog box, in Deploy from file, browse to the location at which you saved the CloudBridge VPX setup files, select the .ovf file, and click Next.
    • Change the name of the virtual machine, if desired, and then click Next.
    • Map the networks shown in the CPX OVF template to the networks that you configured on ESX host : LAN-apA1 to apA-1, and WAN-apA2 to apA-2.
      Note:

      Always assign the two CloudBridge bridge ports (accelerated pair ports) to different virtual and physical Ethernet segments.

      If you assign both CloudBridge bridge (accelerated pair) ports to the same virtual or physical Ethernet port or switch, you will cause network loops. These network loops can make managing CloudBridge impossible and can bring down the entire Ethernet segment. For example, you will cause network loops if you assign both CloudBridge ports to vmnic0. The same thing happens if you assign the CloudBridge ports to different physical Ethernet interfaces, but plug both Ethernet interfaces into the same physical switch.

      Figure 9. Mapping network interfaces to CloudBridge VPX


    • Click Next to start installing VPX on VMware ESX. When installation is complete, a pop-up window informs you of the successful installation.
  6. You are now ready to start the CloudBridge VPX instance. In the navigation pane, right-click the instance that you have just installed, and select Power On. Click the Console tab to emulate a console port.
  7. Optionally, add a Primary Ethernet port.
    • In the navigation pane, right-click the CloudBridge VPX instance that you have just installed, and select the Edit Settings option. On the Virtual Machine Properties page click Add.
    • In Add Hardware window, select Ethernet Adapter as the device type to add, and then click Next.
      Figure 10. Installing the Primary interface


    • Select VMXNET 3 as the adapter type, and select VM Network as the network label.
    • Click Finish, and then click OK.
    • If desired, change the memory and hard disk parameters assigned to the CloudBridge VPX virtual machine to match one of the supported, nondefault configurations listed in REF RTF39313235393a204669677572 \h \* MERGEFORMAT <Section xref> .
      Figure 11. Adjusting memory and disk allocation


  8. If you are running Branch Repeater VPX release 6.0, deploy the virtual appliance as follows:
    • At the logon prompt (in the console window), log on with default credentials: admin as the user name and password as the password.
    • Use the set adapter apa command to set the accelerated bridge (apA) IP parameters. For example: set adapter apa -ip 172.16.0.213 -gateway 172.16.0.1 -netmask 255.255.255.0
    • If you want a Primary port, use the set adapter primary command to set its IP parameters This IP address must be different from the one assigned to apA. . For example: set adapter primary -ip 172.16.1.222 -gateway 172.16.1.1 -netmask 255.255.255.0
      Note: In systems with a Primary port, do not specify -gateway on both the Primary and apA ports. Choose one or the other.
    • Restart the virtual machine to put the parameters into effect. Type: restart.
  9. If you are running CloudBridge VPX release 6.1 or later, the CloudBridge VPX virtual machine automatically runs the Deployment Wizard when started for the first time. Follow the instructions and prompts that appear on the screen.
  10. Continue configuration from the web UI, using the URL of either apA or the Primary port. For example (your address may vary): https://172.16.0.213
  11. On the Quick Installation page, perform a quick installation, as you would for a physical CloudBridge appliance.
  12. Enable bridging by clicking the Enable Bridging link.
  13. Check the network assignments in XenCenter to make sure that the two network devices are connected to different Networks, and then click OK.
    Important: Connecting two accelerated bridge ports to the same virtual or physical Ethernet segment creates network loops, which can bring down your entire network. In such a case, shut down the CloudBridge VPX virtual machine and fix the network assignments before proceeding.
  14. Complete the configuration as you would with any CloudBridge installation.

Configuring Advanced VMware Features

You can configure advanced VMware features to enhance CloudBridge capabilities. Most of the procedures for configuring advanced features use the vSphere Client, and details of its operation can vary with new releases of the vSphere software. The VMware documentation should be considered definitive. The procedures here show the desired results and one example of achieving them.
VLAN Support
CloudBridge VPX accelerates VLAN traffic automatically, without special configuration, and is thus compatible with VLAN trunking. To use VLAN trunking in a VPX deployment, the VMware server must have VLAN trunking enabled on the two apA bridge ports (apA.1 and apA.2), whose VLAN IDs must be set to "All(4095)."
To Enable VLAN Trunking
  1. Log on to the VMware ESX server by using the vSphere client.
  2. On the vSphere client, select the Configuration tab, and then click Networking.
  3. On bridge port apA-1, click Properties.
  4. On the Properties page, select the VM Network and click Edit .
    Figure 12. Enabling VLAN trunking, continued


  5. On the General tab, select VLAN ID ALL (4095). Click Ok.



Larger Disks
To support the 500 GB CloudBridge VPX configurations, the datastore must be configured to support a maximum file size of 512 GB or more. This requires that the datastore have a block size of 2 MB or greater.
To Configure the datastore in VMware ESXi 4.1
  1. Log on to the VMware ESX server by using the vSphere client.
  2. Delete any existing virtual machines on the server.
  3. Delete the existing datastore and create a new datastore with a block size of 2 MB or greater:
    • In the vSphere client, select the Configuration tab, and then click Storage.
    • In the datastores view, right click the datastore and select Delete.
      Figure 13. Deleting the default datastore


    • Click Add Storage…link.
      Figure 14. Adding a new datastore


    • In the Add Storage window, select the 512 GB, Block size: 2MB as the Maximum File size. Click Next.
      Figure 15. Setting the datastore block size


  4. Create a 500 GB virtual disk.
    • In the Virtual Machine Properties, on the Hardware tab, click Hard disk 1.
    • Set the Provisioned Size value to 500 GB. Click OK.
      Figure 16. Creating a 500 GB virtual disk


To Configure the Datastore in VMware ESX 4.1
  1. Boot the ESX 4.1 installation DVD.
  2. Select the ESX installation as Install ESX in graphical mode.
  3. After the ESX Installer welcome screen appears, switch to the shell prompt by pressing the Ctrl+Alt+F2 keys on your keyboard.
  4. Type:

    ps | grep Xorg

  5. Kill the Xorg process. For example, if the PID of Xorg is 582, type:

    kill 582

  6. After you kill the Xorg process, the message Press <return> to reboot appears. Do not reboot, instead, press Ctrl+Alt+F3 to go to another console and continue working without rebooting.
  7. Type:

    cd /usr/lib/vmware/weasel

  8. Edit fsset.py (these instructions assume familiarity with vi). Type:

    vi fsset.py

  9. Search for class vmfs3FileSystem(FileSystemType):
  10. Edit the blockSizeMB parameter to 2 (default value is 1)
  11. Save the file and exit vi.
  12. Go to the root directory and run weasel. Type:

    cd /

    /bin/weasel

  13. Proceed with the normal installation process.
  14. Create a 500 GB virtual disk.
    • In the Virtual Machine Properties, on the Hardware tab, click Hard disk 1.
    • Set the Provisioned Size value as 500 GB, and then click OK.
VMware Guest Customization
VMware guest customization is supported for some CloudBridge parameters, but not all.
The parameters for which VMware guest customization is supported are:
  • Hostname
  • Primary adapter network settings
  • Primary DNS configuration
VMware guest customization is not supported for the following parameters:
  • Accelerated bridge (apA) networks settings
  • Domain name, Area, Location, Secondary DNS, Tertiary DNS, and DNS search path
  • Parameters specific to CloudBridge, such as bandwidth limits.
To configure VMware Guest Customization
  1. Start with a CloudBridge VPX virtual machine that has been configured to include the Primary port as well as apA.
  2. Verify that the Ethernet port configuration matches that shown in the following figure.
    Figure 17. Verify Ethernet port assignments


  3. Convert the VPX virtual machine into a template.
    • In the vSphere Client, right-click Branch Repeater VPX and expand the Template option.
    • Select Convert to Template.
      Figure 18. Convert to template


  4. Deploy a new virtual machine from the template.
    • In the vSphere Client, right-click the Branch Repeater VPX instance and select Deploy Virtual Machine from this Template.
      Figure 19. Deploying the new virtual machine


    • On the Deploy Template screens, name the new VPX virtual machine, select Thick Format for virtual disks, and select Customize using the Customization Wizard .
    • In the Customization Wizard, enter a host name and a dummy domain name for the new VPX virtual machine.
      Figure 20. Customization wizard


    • The value on the Time Zone screen is ignored by CloudBridge. Accept the default and go on to the next screen.
    • On the Network screen, select Custom Settings if you need to change the Primary port IP address from the one in the template. You then assign this address (plus a subnet mask and default gateway) to NIC3. Do not change NIC1 or NIC2.
    • On the DNS and Domain Settings screen, enter the DNS address used by CloudBridge VPX in the Primary DNS field. Leave the Secondary DNS and Tertiary DNS paths blank. Add a dummy domain such as test.com as the DNS Search Path.
      Figure 21. Setting the DNS server


    • Click Next, and then click Finish to exit the Guest Customization Wizard.
    • In the Deploy Template Wizard, clear the Power on the virtual machine after creation check box.
    • Double check network assignments before powering up the virtual machine.
      Note: Attaching both apA ports to the same virtual or real switch causes network loops.
  5. Start the virtual machine and continue CloudBridge configuration.