Please note than OnApp 6.8 does not support any VMware Cloud Director version before 10.3.

If you wish to deploy only the VCD integration model, you only need to install the Control Panel server, configure Rabbit MQ, and import VMware Cloud Director:

  • As initial import of VMware Cloud Director into OnApp might take a considerable amount of time, you may consider increasing the Idle session timeout parameter in the VMware Cloud Director at Administration > General, to avoid the possible import failure.
  • It is recommended to have VMware Cloud Director and OnApp Control Panel in one network.
  • If you already have RabbitMQ installed on another box or you already have VCD login and password, please run the installer with additional Rabbit MQ and VCD options.

Install/Update Control Panel Server

To install/update control panel server:

  1. Update your server:

    # yum update
  2. Download OnApp YUM repository file:

    # rpm -Uvh
  3. Install OnApp Control Panel installer package:

    #> yum install onapp-cp-install
  4. Edit the /onapp/onapp-cp.conf file to set Control Panel custom values. Custom values must be set before the installer script runs.

    # vi /onapp/onapp-cp.conf

  5. Run the Control Panel installer:

    #> /onapp/onapp-cp-install/ -i SNMP_TRAP_IPS 

     Ensure that the SNMP_TRAPS_IP should be the management IP of your CP server.

    VCD and Rabbit MQ options
    The installer will automatically install/upgrade RabbitMQ server on the CP's box and configure it if no options are specified.
    Consider the options below for Rabbit MQ configuration if it is already installed on server separate from CP. 

    --rbthost RBT_HOST

    IP address/FQDN where RabbitMQ Server runs. 
    The RabbitMQ will be installed and configured on the current box if localhost/ or box's public IP address (enlisted in SNMP_TRAP_IPS)
    Default values is


    These options are usefull if VMware Cloud Director/RabbitMQ is already installed and configured.

    --VCDlogin      VCD_LOGIN

    RabbitMQ/VMware Cloud Director user. Default value is 'rbtVCD'.

    --VCDpasswd VCD_PASSWD

    RabbitMQ/VMware Cloud Director user password. The random password is generated if isn't specified.

    --VCDvhost     VCD_VHOST

    RabbitMQ/VMware Cloud Director vhost. Default value is '/'


    These options are used to configure RabbitMQ manager account. If local RabbitMQ server.

    --rbtlogin     RBT_LOGIN

    RabbitMQ manager login. The default value is 'rbtmgr'.

    --rbtpasswd RBT_PASSWD

    RabbitMQ manager password. The random password is generated if isn't specified.

  6. Install OnApp license to activate the Control Panel:

    Enter a valid license key via the Web UI (you'll be prompted to do so). Once you have entered a license it can take up to 15 minutes to activate.

  7. Restart the OnApp service:

    #> service onapp restart
  8. Once the installation of the Control Panel is complete, your default OnApp login will be admin/changeme. The password can be changed via the Control Panel's Users menu. You can now proceed to RabbitMQ and OnApp Control Panel connection.

      • Installer output is redirected to ./onapp-cp-install.log
      • All installer critical errors are in /var/log/messages

If you are using the OnApp High Availability CP and VMware Cloud Director integration:

You need to perform the following steps to be able to use OVA and ISO functionality in your cloud.

  1. Change the path to upload templates and media for using the shared directory:

        iso_path_on_cp: "/path_to_shared_directory"
        ova_path: "/path_to_shared_directory"

    You should specify the shared directory for ISO and OVA variables.

  2. Unmanage onapp-frontend-httpd-group-cluster and onapp-engine-group-cluster resources and restart services to apply the new configuraion:

    # crm resource unmanage onapp-frontend-httpd-group-cluster &&  crm resource unmanage onapp-engine-group-cluster

  3. Restart the OnApp engine and httpd services on all nodes:

    # service onapp restart && service httpd restart
  4. Ensure that the services have been restarted correctly.
  5. Manage unmanaged resources from step 2:

    # crm resource manage onapp-frontend-httpd-group-cluster &&  crm resource manage onapp-engine-group-cluster

Configure RabbitMQ and OnApp Control Panel Connection

OnApp VCD integration requires the use of RabbitMQ to keep VCD and OnApp synchronized. If you plan using the RabbitMQ server installed by OnApp by default, there is no need for additional configuration in OnApp Control Panel. Though, it is required that you edit the AMQP settings in VCD.

To specify RabbitMQ settings in VCD:

  1. Go to your OnApp Control Panel server.
  2. Open the /onapp/interface/config/on_app.yml file.
  3. Find the RabbitMQ parameters:
    • rabbitmq_login
    • rabbitmq_password
    • rabbitmq_vhost
    • rabbitmq_host - make sure it is reachable by VMware Cloud Director
  4. Edit your AMQP settings in VCD with the RabbitMQ details found at step 3:
    1. Navigate to the Administration tab of your System Organization, expand System Settings, and select Extensibility.
    2. Click Enable Notifications.
    3. Add the details from OnApp.
    4. Specify your VMware Cloud Director AMQP Exchange name that you should later use in the corresponding AMQP Exchange Name box while creating compute resources in OnApp.

If you are running your own RabbitMQ server, it is required that you add the RabbitMQ details through the OnApp Control Panel.

To specify RabbitMQ settings in OnApp Control Panel:

If you want to use a separate RabbitMQ instance for VMware Cloud Director, specify the following VMware Cloud Director RabbitMQ parameters in the /onapp/configuration/rabbit_mq/vcloud/credentials.yml file:

  • :host: - RabbitMQ server IP address
  • :port: - RabbitMQ port
  • :vhost: - the name of the "virtual host" (or vhost) that specifies the namespace for entities (exchanges and queues) referred to by the protocol. Note that this is not virtual hosting in the HTTP sense.
  • :user: - RabbitMQ login
  • :password: - RabbitMQ password

If you want to use the same Rabbit MQ instance both for VMware Cloud Director and OnApp engine:

  1. Go to your Control Panel's Settings menu, and click the Configuration icon.
  2. Click the System tab to change the following application settings:

    • Host - RabbitMQ server IP address

    • Virtual Host - the name of the "virtual host" (or vhost) that specifies the namespace for entities (exchanges and queues) referred to by the protocol. Note that this is not virtual hosting in the HTTP sense.

    • Login - RabbitMQ login
    • Password - RabbitMQ password

You have to restart OnApp daemon after changing RabbitMQ credentials.

 Remember that rabbitmq_host must be reachable by VMware Cloud Director.

Import of VMware Cloud Director Resources into OnApp

Before you start

  • Your vCD should be v10.3 or later

  • VCD public addresses should be configured properly

  • All VCD users should have a valid email, or else they won’t be imported

  • Currently, fast-provisioned virtual datacenters are not supported for vApp provisioning

  • VCD users should be assigned one of the default or custom VMware Director roles.

  • vApps that have “system” owner will be imported under "System Owner" in OnApp.
  • VSs currently cannot be connected to the network during provisioning

  • VS passwords are not imported into OnApp

  • VMware Director system admins are not imported into OnApp and all management tasks are performed via the VMware Director web interface.

  • VMware Director compute resource passwords are encrypted by default.


To import your VMware Director resources into OnApp:

  1. Log in to OnApp CP as an administrator.
  2. Set Rabbit MQ credentials for the OnApp CP and your VMware Director.

  3. Create a compute zone in which the VMware Director compute resource will reside.

    To create a compute zone:

    1. Go to your Control Panel's Settings menu and click the Compute Zones icon.
    2. Press "+" or click the Add New Compute Zone button.
    3. On the screen that follows:
      1. Label - give your compute zone a name
      2. Server type - select a type for your zone. For VMware Director compute zones select the Virtual Private Cloud type.
      3. Location group - select the location group to which this Compute zone will be assigned
      4. Failover timeout - set the time period for which the iterations will run during the failover if the compute resource does not respond

    4.  Click the Save button.

  4. Create a compute resource of a vcloud type and specify VMware Director global system admin credentials and API URL of your VMware Director. 

    When importing VCD resources you can choose whether you wish your users to be associated with one or several VMware Director instances. If you wish your users to have access to multiple VMware Director instances, you can set up several organizations from different VCD instances to be associated in OnApp with a single user group and have access to resources across multiple VCD instances.

    • single vCloud Director mode - all resources are imported from the VCD instance. Each organization is imported as a separate user group which can be associated with one VCD instance.
    • multiple vCloud director mode - only system level entities are imported (provider VDCs, external networks, etc.). Organizations are imported but are empty, i.e. do not contain resources and users. After the initial import, you can select which organization you wish to import and associate with a certain user group. Users imported in this mode can be configured to have access to multiple VCD instances.

    To create a compute resource:

    1. Go to your Control Panel Settings menu.
    2. Click the Compute Resources icon.
    3. Press + button or click the Add New Compute Resource button underneath the list of compute resources on the screen.
    4. On the screen that appears:
      • Label - enter a compute resource name.
      • Compute resource type - choose a compute resource type. Select vcloud.
      • Compute zone - select the compute zone you added on Step 3.
      • Operation mode - select whether you wish to import the zone in the single or multiple VMware Director mode. If you select the multiple VMware Director, you need to later import the resources of an organization and its users.
      • Login - specify the VMware Director system admin login
      • Password - specify the VMware Director system admin password

      • API URL - set the VMware Director API URL - e.g.

      • AMQP Exchange Name - specify your VMware Director AMQP exchange name (this can be taken in your VMware Director instance Extensibility > Settings > Exchange)

    5. Click the Save button. The compute resource will be added to the system and the import will start automatically.

    You can later switch from single VMware Director mode to the multiple VMware Director mode if required. In this case, the new organizations will no longer be synchronized from VCD to OnApp. It will be required to import each new organization.

    You cannot switch from multiple to single VMware Director mode.

  5. The import will start automatically. After the transaction is successfully completed, all your VMware Director resources will be shown in OnApp. You can view log output of transaction Import vCloud to Control Panel for more import details.

  6. Import the users and resources of the required organization. This step is only applicable if you have selected the multiple VMware Director mode for your compute resource in step 4.
    1. Go to Control Panel > Settings > Compute Resources > Label.
    2. The page that loads shows the details of your VCD compute resource. Click Tools and select Import Organization from vCloud.
    3. Move the Import slider to the right next to the organization(s) you wish to import.
    4. Select a user group to which you wish to assign the organization in the Assign to User Group field. If you do not select a user group but enable the Import slider, a new user group will be created for this organization. If you select a user group that is already associated with one or several organizations, the users from the new organization will be created in the already present organizations and the users from the already present organizations will be created in the new user group.
    5. Click Submit to import the organizations.

After adding/deleting vCloud compute resource you need to restart OnApp service on the Control Panel for the correct statistics gathering and resources synchronization. 

Please note

  • At the moment, vCloud system admins are not imported into OnApp and all management tasks are performed via the VMware Cloud Director web interface.
  • VS passwords are not imported into OnApp.
  • vCloud compute resource passwords are encrypted by default.