How to Customize vCloud Director UI

Service providers who are offering additional services beyond vanilla vCloud Director IaaS were asking how to add links to them in the existing (Flex) vCloud Director UI.

vCloud Director 8.20 provides very simple way to extend the right column of the Home screen with additional sections and static links. It is really simple extensibility and should be used as interim solution until the new HTML 5 UI will fully replace the existing UI and which will be more extensible.

In the screenshot below you can see that the right section has been extended with vCloud Availability, Backup and Other sections.

The configuration of these links is very simple and is done from cell-management-tool on any vCloud cell.

In my example I used:

./cell-management-tool manage-config -n ui.tenant.customOrgLinks -v “
# vCloud Availability
[Monitor Replications](https://vcloud.fojta.com:8443)
# Backup
[Configure Backup](https://backup.fojta.com)
# Other
[Request Support](https://help.fojta.com)
[Impressum](https://www.fojta.com/impressum)”

Where # denotes the section header, [] the link name and () the link.

It is also possible to pass vCloud session ID as parameter in the URL by including {vcdSession} string.

The CMT manage-config command creates/modifies database entry in the config table tenant-customOrgLinks with the provided value in the quotes. Re-running it will replace the previous entry. The change is immediate, no need to run this on other cells or restart vcd services.

One last note, the right column on the home screen is not visible to all user roles. The role needs to have General > Administrator Control right.

10 thoughts on “How to Customize vCloud Director UI

  1. any documentation around this? not finding it on the vmware site :/

    Im looking for if there is parameter for org name like for the session ( {vcdSession})

    1. No there isn’t. The external application can retrieve Org name via API call: GET /api/session and providing the session token in the x-vcloud-authorization header.

  2. Hi Tom

    Is it possible to set the links up on an Org by Org basis? We were looking to add the Veeam Self Service portal but this has an individual URL per Org

  3. great article,thanks Tomas. Do we have similar option for vCD 9 HTML5 tenant portal customization? we’ve looking for options to add similar links as you’ve done in flex UI.

Leave a reply to James Cancel reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.