VMware Cloud Director VS Service Add-ons

Service Add-ons functionality allows you to offer to your customers additional services on top of your current IaaS Virtual Server offering.

Before managing service add-ons, ensure that:

1. VMware Cloud Director is added to OnApp UI.
2. RabbitMQ settings are set in config/rabbit_mq/vcloud/credentials.yml.
3. Login and password are set for vCenter (Control Panel should have access to vCenter directly) in Admin > Settings > Compute Resources > Compute resource’s label > Actions > Resources Options > vCenter Passwords.
4. Guest customization is enabled on a VMware Cloud Director VS and Admin Password is set.

When you have the service add-on functionality enabled in your license and everything is properly configured, you can assign service add-on to your VMware Cloud Director VS.

You can monitor the total cost for all service add-ons inside the company. For this, go to your Control Panel’s > Admin > Groups > your User group’s label > Groups link.

View Service Add-ons Assigned to Virtual Server

1. Go to your Control Panel > Cloud > Virtual Servers menu.
2. On the following page, click the label of the server you’re interested in.
3. Click the Overview tab and choose Service Add-ons.
4. On the page that appears, you can see the details of all the service add-ons assigned to the VS, if there are any:
   • Label - the service add-on name
   • Type - Virtual Server or System
   • Description - the service add-on description
   • Price - the service add-on price, set for this service add-on in the Manage Service Add-on Store
   • Status - the status of the service add-on that can be as follows:
     • Pending - a status meaning you are not billed for the service add-on yet, and you can remove service add-on targets without any recipes execution
     • Running - a status showing that the current recipes start running and the service add-on is pending activation
     • Active - a status that confirms that the service add-on has been successfully activated and the system starts billing you for the service add-on
     • Failed - a status that appears if one of the recipes failed
     • Removal Running - a status that appears when deleting the service add-on and means that the system stops billing you for the service add-on
     • Removal Failed - a status showing that the system failed to run an On Remove event and delete the service add-on

You can unassign the service add-on from this virtual server by clicking .

Also, if any service add-on is already assigned to the VS, you can view it at the VS’s details page.

Assign Service Add-on to the VS

1. Go to your Control Panel > Cloud > Virtual Servers menu.
2. On the following page, click the label of the server you’re interested in.
3. Click the Overview tab and choose Service Add-ons.
4. On the page that appears, click upper right. You will get the list of service add-on groups (availability is configured in the buckets). The transaction to execute the On Add event(s) will be scheduled for running.
5. Choose the necessary service add-on and click Assign.

Alternatively, if any service add-on is already assigned to the VS, you can assign another one at the VS’s details page.

Unassign Service Add-on from the VS

1. Go to your Control Panel > Cloud > Virtual Servers menu.
2. On the following page, click the label of the server you’re interested in.
3. Click the Overview tab and choose Service Add-ons .
4. On the page that appears, click next to the service add-on you want to unassign. Confirm the deletion. The transaction to execute the On Remove event(s) will be scheduled

Alternatively, you can unassign the service add-on at the VS’s details page.

Delete Service Add-on

You can delete a virtual server service add-on or system service add-on assigned to a virtual server, regardless of the service add-on status, if you are an owner of the virtual server or granted the vCloud Organization Administrator role.

1. Go to your Control Panel > Cloud > Virtual Servers menu.
2. On the following page, click the label of the required virtual server.
3. Click the Overview tab and select Service Add-ons.
4. On the page that appears, click next to the service add-on you want to delete.
5. In the dialog, click OK to confirm the deletion.

Alternatively, you can delete a service add-on at the VS’s details page.

Generate Statistics for System Service Add-ons

You may generate the statistics for the system service add-ons usage for a specified period. To generate the statistics:

1. Go to your Control Panel > Admin > Users menu.
2. Click the Full Name of the cloud admin to get to the User Profile.
3. In the Billing Details section, click the System Service Add-ons Report button.
4. Select the time period from the drop-down menu and click the Apply button to generate the report.
5. On the page that appears you will see the report with the following details:
   • From - the beginning of the specified time period for the statistics generation
   • Till - the end of the specified time period for the statistics generation
   • Virtual server - the VS the system service add-on in question is assigned to
   • Cores (peak usage) - the number of CPU cores used
   • Memory (peak usage) - RAM usage, GB
   • Disk size (peak usage) - disk usage, GB

You can save your billing statistics to a file in a CSV format. To download a CSV file with billing statistics for a selected period of time, click the Save as CSV button. The download will start automatically after you click the button.

The CSV file includes the following information:

• from - the beginning of the specified time period for the statistics generation
• till - the end of the specified time period for the statistics generation
• user_id - the ID of the user
• virtual_machine_id - the ID of the VS the system service add-on in question is assigned to
• service_addon_id - the ID of the system service add-on
• cpus - the number of CPU cores used
• memory - RAM usage, GB
• disk_size - disk usage, GB

The generated reports will be stored at the System Service Add-ons Report page. However, if you have statistics archiving enabled for your cloud, the reports will be stored according to the period, specified for the archiving.