WilliamLam.com

  • About
    • About
    • Privacy
  • VMware Cloud Foundation
  • VKS
  • Homelab
    • Resources
    • Nested Virtualization
  • VMware Nostalgia
  • Apple
You are here: Home / VCSA / How to customize the new vSphere 6.0 Web Client login UI?

How to customize the new vSphere 6.0 Web Client login UI?

02.17.2015 by William Lam // 35 Comments

A common feature request that I hear from customers from time to time is the ability to customize the login screen for the vSphere Web Client. Going beyond just aesthetics such as adding an organizations logo or colors, it is often a mandatory requirement for some organizations to display a security or warning banner to the users prior to logging in. In prior releases of vSphere, the login page of the vSphere Web Client (which is actually from vCenter Single Sign-On service) was written in Flash which meant that it was impossible to change without recompiling the source code.

Screen Shot 2015-01-19 at 6.15.52 PM
In vSphere 6.0 (yes, vSphere 6.0 is required), the vCenter Single Sign-On login page is now written using regular HTML and CSS. This means you can actually now customize the login page with your own logos, colors or text that you wish to display to your end users. Not only can you customize the login for vCenter Server but you can also do the same for vRealize Automation Center as long as you are using the latest version of the Platform Services Controller which now provides other services in addition to vCenter Single Sign-On.

UPDATE (07/14/16): For vSphere 6.0 Update 2 environments, please follow the instructions here as there have been some minor changes. This article is only applicable for vSphere 6.0 and vSphere 6.0 Update 1 environments.

Disclaimer: This is not officially supported by VMware, if you decide to enable this, please use at your own risk and ensure you backup all original files in case you need revert back to the original configurations.

There are two specific files that you will want to take a look at, the first is unpentry.jsp which controls the look and feel of the actual login page and the second is login.css which controls the stylesheet for the login page. If you wish to include your own images including gifs (which I did not expect would work), there is a img directory that you can reference. Below are the paths to these configuration files for both a Windows vCenter Server and the VCSA 6.0.

Windows vCenter Server 6.0 / 6.0u1

  • C:\ProgramData\VMware\vCenterServer\runtime\VMwareSTSService\webapps\websso\WEB-INF\views\unpentry.jsp
  • C:\ProgramData\VMware\vCenterServer\runtime\VMwareSTSService\webapps\websso\resources\css\login.css
  • C:\ProgramData\VMware\vCenterServer\runtime\VMwareSTSService\webapps\websso\resources\img

VCSA 6.0 / 6.0u1

  • /usr/lib/vmware-sso/vmware-sts/webapps/websso/WEB-INF/views/unpentry.jsp
  • /usr/lib/vmware-sso/vmware-sts/webapps/websso/resources/css/login.css
  • /usr/lib/vmware-sso/vmware-sts/webapps/websso/resources/img

Note: It is highly recommended that you backup all original files before making edits so you can easily revert to the original configuration. If you are only updating the image to figure out layout and placement, you may notice changes are not reflected when you refresh the vSphere Web Client. The reason for this is that the image is only refreshed when the configuration files (.jsp) is updated. You can easily do this by simply opening it up and then saving it without making changes. I found this was the quickest way to force a reload of an updated image that has been uploaded.

I figure it might be cool to create a couple of vSphere Web Client "themes" for some of my buddies like Rawlinson Rivera, Duncan Epping, Alan Renouf, Mike Foley and Cormac Hogan. I hope Rawlinson likes his theme as I know how big of a fan he is 😉 I have also created a Github repo customize-vsphere-web-client-6.0 where you can find all the themes below. Feel free to create your own and contribute them back to the community.

Rawlinson Rivera Theme -
customize-vsphere-web-client6-ui-1
Duncan Epping Theme -
customize-vsphere-web-client6-ui-2
Alan Renouf Theme -
customize-vsphere-web-client6-ui-3
Mike Foley Theme -
customize-vsphere-web-client6-ui-4
Cormac Hogan Theme -
Screen Shot 2015-02-23 at 8.54.01 PM
Here is an additional bonus theme as I could not leave out my good buddy CaptainVSAN!

customize-vsphere-web-client6-ui-5
I am looking forwarding to see what others come up with in terms of their own vSphere Web Client themes and be sure to share them back by either posting back here or better yet, contributing to the Github repository.

Image Sources:

  • http://www.twitterevolutions.com/bgs/justin-bieber-2.jpg
  • http://s1174.photobucket.com/user/D-A-C-20/media/Holland%20EUIV/Holland.png.html
  • http://www.chrisschofield.me/wp-content/uploads/2011/08/PowerCLIman.jpg
  • http://stream1.gifsoup.com/view6/2662404/you-didnt-say-the-magic-word-o.gif

More from my site

  • vSphere Client Login UI customizations do not persist in VCSA 6.5 Update 1
  • Automating Cross vCenter vMotion (xVC-vMotion) between the same & different SSO Domain
  • Automating the configuration of new logon banner for the vSphere Web Client in 6.0 Update 2
  • Erasing existing disk partitions now available in the vSphere Web Client (vSphere 6.0 Update 1)
  • Which Platform Services Controller (PSC) is my vCenter Server pointing to?

Categories // VCSA, vSphere 6.0, vSphere Web Client Tags // unpentry.jsp, vSphere 6.0, vSphere 6.0 Update 1, vsphere web client

Comments

  1. *protectedJoe Kozlowicz says

    02/17/2015 at 8:51 pm

    Finally, the Flash customization was a huge pain.

    Reply
  2. *protectedThe Hammer says

    02/17/2015 at 9:34 pm

    It is all fun changing the default theme BUT is this supported by VMware?

    Reply
    • *protectedMatt Cowger (@mcowger) says

      02/18/2015 at 1:37 am

      Of course not 🙂

      Reply
    • William Lam says

      02/18/2015 at 4:09 am

      No, unfortunately this is not officially supported. I know the PM is open to feedback, so if this is something you would like to see officially supported, please let your account team know.

      Reply
  3. *protectedJimP says

    02/19/2015 at 9:01 am

    Is there yet anyway to have either a URL that defaults to Use Windows Session Credentials (and preferably still not having to click Login), or vice versa set the default URL to that and have an alternate URL for Admins and special case scenarios to enter credentials?

    Reply
    • *protectedjohnt1893 says

      04/24/2015 at 1:49 pm

      This would be great. I'm surprised they didn't add it.

      Reply
    • *protectedP. Cruiser says

      12/23/2015 at 12:08 pm

      +1 for the ability to make "Use Windows Session Credentials" the default. This is just another reason people cling to the Win32 client.

      Reply
  4. *protectedBraxton Lay (@BraxtonLay) says

    03/19/2015 at 1:22 pm

    Thanks for sharing this information. We have successfully changed the background and made more customization's to the CSS. If VMware officially supported this, that would be even better.

    Reply
  5. *protectedRishab Mehta says

    05/05/2015 at 7:02 am

    Hi thanks for the great post.
    You have mentioned, the same can be done for vRA...
    I was wondering if you could post one example for the same in github?
    I use a VMware Identity appliance for SSO linked to vRA. So I understand i have to edit the files in the IA Appliance directory.

    Thanks.

    Reply
    • William Lam says

      05/05/2015 at 1:05 pm

      Take a look at this article which has a link to the vRA solution http://www.virtuallyghetto.com/2015/03/how-to-customize-the-login-ui-for-vrealize-operations-manager-log-insight-automation.html

      Reply
  6. *protectedChandler Bing says

    05/21/2015 at 9:02 pm

    Can't seem to change the wallpaper. downloaded the ghostbuster theme files from github i see the ecto1 sign but background is still blue with no jpg showing.

    Reply
  7. *protectedChandler Bing says

    05/21/2015 at 9:29 pm

    Ok, works in IE11 but not on firefox 38

    Reply
  8. *protectedVirtualJMills says

    06/29/2015 at 6:48 pm

    "You can easily do this by simply opening it up and then saving it without making changes."

    `touch ...`

    🙂

    Reply
  9. *protectedMatthew Damp says

    07/03/2015 at 8:47 am

    If you want to modify the root vCenter page (i.e. https://SeverName instead of https://ServerName/vsphere-client) you can modify the files in the C:\ProgramData\VMware\vCenterServer\cfg\vmware-vpx\docRoot directory. They are also relatively basic HTML, CSS, and JavaScript files.

    Reply
  10. *protectedscooterphoenix says

    09/02/2015 at 8:20 pm

    1 Good Reason to upgrade to 6.0!!!

    Reply
  11. *protectedjgreen says

    10/14/2015 at 10:28 pm

    Do you know how to get back the default login page for the web client, mine is showing vRealize Automation for the web client

    Reply
  12. *protectedivan says

    10/19/2015 at 8:21 am

    how about 5.5

    Reply
  13. *protectedWrangler says

    12/03/2015 at 7:25 am

    Does anyone know how to modify the background of the webpage after logging in to vSphere Web Client? I tried modifying the file /usr/lib/applmgmt/appliance-ui/resources/img/appBgPattern.png in the VCSA and even rebooted the PSC and VCSA but it still did not take effect.

    Reply
    • William Lam says

      12/03/2015 at 1:48 pm

      You won't be able to do that since once logged in, you're in the Flash application & no longer regular HTML

      Reply
  14. *protectedLewis Heidrick says

    01/18/2016 at 1:24 am

    How would I move the VMware vCenter Single Sign On branding to the bottom or top of the page?

    Reply
  15. *protectedDim says

    04/20/2016 at 7:09 am

    In VCSA 6.0 U2 I can't find unpentry.jsp

    Reply
    • William Lam says

      04/20/2016 at 8:16 am

      It's in the same location as before 🙂

      /usr/lib/vmware-sso/vmware-sts/webapps/websso/WEB-INF/views/unpentry.jsp

      If you have an External PSC, then you'll need to search in the PSC system versus the VC's VCSA

      Reply
  16. *protectedDim says

    04/21/2016 at 1:12 am

    Thanks a lot.

    Reply
  17. *protectedJames Johnston says

    06/05/2016 at 7:36 am

    Thanks for the post, any tips for changing the favicon? Have tried replacing the existing file but no joy.

    Reply
  18. *protectedphimic says

    06/05/2016 at 11:52 pm

    Hello William, does this customizing still works in U2? I changed the files on my PSC but only get a white screen with login and password fields (no background, no CSS).

    Reply
    • *protectedMarcelSt says

      07/11/2016 at 12:46 pm

      same problem here, can't get it to work 🙁

      Reply
      • William Lam says

        07/14/2016 at 11:43 am

        Folks -

        For those trying to customize the vSphere Web Client running vSphere 6.0 Update 2, please have a look at this post here http://www.virtuallyghetto.com/2016/07/quick-tip-minor-changes-on-how-to-customize-vsphere-6-0-update-2-web-client-login-ui.html for those running vSphere 6.0 or vSphere 6.0 Update 1, this article is still applicable

        Reply
  19. *protectedkgonzalez says

    06/06/2016 at 3:27 pm

    Hey William,

    Do you know if there is something similar for VMware Horizon View 6.0+ logon portal?

    Reply
    • William Lam says

      06/07/2016 at 12:43 pm

      I don't sorry.

      Reply
  20. *protectedvirtualvic69 says

    12/02/2016 at 9:55 am

    OMG!... These are fantastic dude!

    Reply
  21. *protectedRodeo says

    08/04/2017 at 8:26 pm

    I have 6.5 running on Windows Server 2016 and I dont even have the ProgramData folder nor the other folders. So I doubt that this works for vCenter 6.5

    Reply
  22. *protectedluciano says

    09/30/2017 at 7:53 am

    Hi ,
    In Vsphere 6U3 after following this guide (for vsphere 6U2 ) the logo change didn't work
    Any ideas if this supposed to work with 6U3?
    Thanks

    Reply
  23. *protectedSalvador says

    06/28/2018 at 3:47 pm

    when restarting the VCSA, it returns to original state 🙁

    Reply
    • *protectedNicole Quan says

      03/12/2019 at 3:39 pm

      Same. My custom image file got removed and background-image setting got removed from login.css file when restarting vcsa. I never got it working. 🙁

      Reply
  24. *protectedMax Mustermann says

    07/01/2019 at 4:08 am

    Is there a way to customize the UI login page at VCSA 6.7U2. The default is terrible.

    Reply

Thanks for the comment!Cancel reply

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

Search

Thank Author

Author

William is Distinguished Platform Engineering Architect in the VMware Cloud Foundation (VCF) Division at Broadcom. His primary focus is helping customers and partners build, run and operate a modern Private Cloud using the VMware Cloud Foundation (VCF) platform.

Connect

  • Bluesky
  • Email
  • GitHub
  • LinkedIn
  • Mastodon
  • Reddit
  • RSS
  • Twitter
  • Vimeo

Recent

  • Programmatically accessing the Broadcom Compatibility Guide (BCG) 05/06/2025
  • Quick Tip - Validating Broadcom Download Token  05/01/2025
  • Supported chipsets for the USB Network Native Driver for ESXi Fling 04/23/2025
  • vCenter Identity Federation with Authelia 04/16/2025
  • vCenter Server Identity Federation with Kanidm 04/10/2025

Advertisment

Privacy & Cookies: This site uses cookies. By continuing to use this website, you agree to their use.
To find out more, including how to control cookies, see here: Cookie Policy

Copyright WilliamLam.com © 2025

 

Loading Comments...