F5 BIG-IQ Cloud version 4.0.0 API integration with VMware vCloud Networking and Security
search cancel

F5 BIG-IQ Cloud version 4.0.0 API integration with VMware vCloud Networking and Security


Article ID: 339343


Updated On:


VMware NSX Networking


This article provides information about the F5 BIG-IQ Cloud API integration with VMware vCloud Networking and Security (vCNS).
Disclaimer: The F5 product referenced in this article is product that is developed and supported by F5. Use of this product is governed by the end user license agreement of F5. You must obtain from F5 the application, support, and licensing for using this product. For more information, see http://support.f5.com/kb/en-us/products/big-iq-cloud.html.


VMware vCloud Networking and Security 5.1.x


BIG-IQ Cloud Supported software

BIG-IQ is a product from F5 designed to enable central management and configuration of multiple BIG-IP network devices. BIG-IP network devices provide application delivery networking services to applications, such as load balancing. BIG-IQ Cloud includes a rest-based API that allows integration with the vCNS Manager. This allows vCNS Manager administrators to apply BIG-IP services to virtual machines from within the vCNS Manager console. Because vCNS is integrated with vCloud Director (vCD), it is also possible for application owners to self-service BIG-IP services for their virtual machines from within vCD (through vCNS and BIG-IQ).

Product documentation

For BIG-IQ Cloud documentation, see the BIG-IQ Cloud product page in the F5 Website.

Versions and Minimum Requirements

F5 Products

  • BIG-IQ Cloud version 4.0.0

    For more information, see Getting Started with BIG-IQ Virtual Edition.

  • BIG-IQ™ Virtual Edition (VE) is compatible with VMware ESX 4.0 and 4.1, and VMware ESXi 4.0, 4.1 Update 1, 5.0, and 5.1 hosts.

    For production licenses, F5 Networks suggests using the maximum configuration limits for the BIG-IQ VE system. Reservations can be less for lab editions. For each virtual machine, the VMware virtual machine guest environment permits a maximum of 10 virtual network adapters (either 10 VMXNET3 with 1 management and 9 dataplane or 1 Flexible management and 9 VMXNET3 dataplane).

  • BIG-IQ VE virtual machine deployment is restricted to these maximum configuration limits:

    • CPU reservation can be up to 100 percent of the defined virtual machine hardware. For example, if the hypervisor has a 3 GHz core speed, the reservation of a virtual machine with 2 CPUs can only be 6 GHz or less.
    • To achieve licensing performance limits, all allocated RAM must be reserved.
    • For production environments, virtual disks should be deployed Thick (allocated up front). Thin deployments are acceptable for lab environments.

VMware Products

  • VMware vCNS Manager version 5.1.1 and 5.1.2 (formerly known as vShield Manager)
  • ESXi 4.0, ESXi 4.1 Update 1, ESXi 5x hosts

    Note: Hypervisors other than these ESXi versions are not supported with this BIG-IQ version. Any installation attempts on unsupported platforms might not be successful.

  • The VMware virtual machine guest environment for the BIG-IQ Virtual Edition (VE), at minimum, must include:
    • 2 x virtual CPUs
    • 4 GB RAM
    • 1 x VMXNET3 virtual network adapter or Flexible virtual network adapter (for management)
    • 1 x virtual VMXNET3 virtual network adapter (three are configured in the default deployment for dataplane network access)
    • 1 x 100 GB SCSI disk, by default
    • 1 x 50 GB SCSI optional secondary disk, which might be required as a datastore for specific BIG-IP modules. For information about datastore requirements, see the BIG-IP module's documentation.

Note: If these minimum virtual configuration limits are not satisfied, you may experience unexpected results.

Note: There is no limitation on the maximum amount of RAM supported on the hypervisor guest.

Downloading the F5 Software

BIG-IQ can be downloaded from the F5 Download Center. You must create an account in the F5 Website to download the software.

Tips for downloading the software

  • Ensure to read the Release Notes as some files are designed for specific devices and do not work on others.

    Note: You can find the Release Notes in Ask F5, under each product menu.

  • Read the End User License Agreement thoroughly before accepting.
  • This site supports http, https, and ftp downloads. Choose the protocol that you prefer.
  • If you have questions or issues while trying to download, see the FAQ section.
  • Certain downloads require a service contract for activation.

Installing BIG-IQ

To deploy a BIG-IQ VE virtual machine:
  1. Download the OVA file to your local system.
  2. Run the Deploy OVF Template wizard from within the vSphere Client.
  3. Follow the steps in Deploying BIG-IP Virtual Edition to create an instance of the BIG-IQ system that runs as a virtual machine on the host system.

Support information

Links to documentation

Support Process

Free self-service tools provide 24x7 access to the knowledge base and technical support.
To get support:

F5 and VMware are members of TSANet, making it easier for you to transfer information about your support request from one organization to the other, so that both support organizations can cooperate in resolving any issues.

Additional support information

Accessing BIG-IQ log files
The BIG-IQ logs are located at:
  • /var/log/restjavad.*.log
  • /var/log/msgbusd*log
  • The log files are plain text files. Reading the logs is a fairly straight forward and simple.
  • Most issues have a clear indicative error message. For example, this message shows that the user typed the wrong tenant name:

    [WARNING][644332][30 May 2013 17:19:26 UTC][RestRequestReceiver][warning] Error processing request for URI:http://localhost:8100/mgmt/cm/cloud/connectors/vmware/baef2e6a-c69b-4c6a-81d2-11c95899d170/vshieldmanager/vmware/
    {"code":400,"message":"The tenant 'AcmeCom' does not exist or cannot be contacted:

Restarting Main Services

  • BIG-IQ includes two services: restjavad and msgbusd. The restjavad service depends on msgbusd.

    You can restart these services using this command:

    bigstart restart restjavad msgbusd

  • BIG-IQ can be restarted in the standard Linux way using this command:

    /sbin/shutdown –r now

Considerations when integrating F5 BIG-IQ Cloud with VMware vCNS

  • There must be two-way connectivity between the BIG-IQ and VCNS on the BIG-IQ’s internal interface (not the management interface).
  • The provider must create a tenant in the BIG-IQ, and the vCNS user must type the tenant name correctly (including capitalization) for it to deploy correctly.
  • The provider must give the tenant access to the correct vCNS connector (in the BIG-IQ) for it to deploy correctly.

Known issues

For a list of known issues, see the BIG-IQ Cloud 4.0.0 Release Notes.