Install vRealize Orchestrator Plug-in for vSphere Client

Version 9

    Intended Audience

    This information is intended for users who want to install and configure the vRealize Orchestrator plug-in for vSphere Client (HTML5-based GUI). This installation guide assumes that the user is experienced with:

    • VMware vSphere and VMware vSphere Client
    • vRealize Orchestrator and the vCenter Server plug-in for vRealize Orchestrator.

     

    For information about VMware vSphere, see https://docs.vmware.com/en/VMware-vSphere/index.html.

    For information about vRealize Orchestrator, see https://docs.vmware.com/en/vRealize-Orchestrator/.

     

    vRealize Orchestrator Plug-In Prerequisites

    To install and use the vRealize Orchestrator plug-in for vSphere Client, your system must meet the following prerequisites.

     

    VMware vCenter Server

    Verify that you have a running instance of VMware vCenter Server Appliance, version 6.7, 6.7 U1 or 6.7 U2, either with an embedded or with an external Platform Services Controller.

     

    Verify that you can log in to the vSphere Client at https://<vcenter_server FQDN or IP address>/ui

    If the server is part of an Enhanced Linked Mode group, verify that you can browse the inventories of the other vCenter servers in the group.

     

    Verify that access to the Bash shell of the appliance is enabled. For instructions about setting up Bash shell access see Enable Bash Shell Access From the Appliance Shell at https://docs.vmware.com/en/VMware-vSphere/index.html.

     

    VMware vRealize Orchestrator

    Verify that you have a running instance of vRealize Orchestrator, version 7.6, in a standalone deployment. For information about setting up vRealize Orchestrator, see Installing and Configuring VMware vRealize Orchestrator at https://docs.vmware.com/en/vRealize-Orchestrator/.

     

    Verify that the server is configured with vSphere Authentication and that it is registered with a vCenter Single Sign-On server. You must register vRealize Orchestrator with vSphere authentication to the same Platform Services Controller that your vCenter Server authenticates with. For more information, see Configure a Standalone Orchestrator Server with vSphere Authentication at https://docs.vmware.com/en/vRealize-Orchestrator/.

     

    You must configure the vCenter Server plug-in and define the connection parameters between the Orchestrator and the vCenter Server instances you want to orchestrate. For more information, see Configuring the vCenter Server Plug-In at https://docs.vmware.com/en/vRealize-Orchestrator/.

     

    Install vRealize Orchestrator Plug-in

    Prerequisites

    • FTP client available on your local operating system.
    • vcoin-html-plugin.zip file downloaded on your local file system.

     

    Register the Orchestrator server as a vCenter Server extension

    First you must register the vRealize Orchestrator server as an extension of vCenter Server.

     

    The current version of the plug-in relies on the same vCenter Server extension that is required by the legacy vRealize Orchestrator plug-in for vSphere Web Client (Flex-based GUI).

     

    For instructions how to register your Orchestrator instance as a vCenter Server extension, see Configure vRealize Orchestrator Plugin for vSphere Web Client at https://docs.vmware.com/en/vRealize-Orchestrator/.

     

    Deploy the vRealize Orchestrator plug-in to the vSphere Client

    • Upload the vRealize Orchestrator plug-in to the vCenter Server Appliance.

              Using an FTP client, copy the vcoin-html-plugin.zip file from your local file system to the /usr/lib/vmware-vsphere-ui/plugin-packages/ directory of the vCenter Server Appliance. For example:

                   scp vcoin-html-plugin.zip root@<vcenter_server FQDN or IP address>:/usr/lib/vmware-vsphere-ui/plugin-packages/vcoin-html-plugin.zip

    • Log in as root through an SSH or console session on the vCenter Server Appliance.

                   ssh root@<vcenter_server FQDN or IP address>

    • Go to the vSphere Client installation directory.

                   cd /usr/lib/vmware-vsphere-ui/plugin-packages

    • Unarchive the vcoin-html-plugin.zip file.

                   unzip vcoin-html-plugin.zip -d vro-plugin

    • Change the owner of the vro-plugin directory to vsphere-ui.

                   chown -R vsphere-ui vro-plugin

    • Remove the vcoin-html-plugin.zip file.

                   rm vcoin-html-plugin.zip

     

    Restart the vSphere Client

    While you are logged in to the vCenter Server Appliance, restart the vSphere Client service.

                   service-control --restart vsphere-ui

     

    Verify the Plug-In Installation

    • Open a Web browser and enter the URL for the vSphere Web Client: https://<vcenter_server FQDN or IP address>/ui.

    • Log in with a user who is a member of the administrators group configured in the vRealize Orchestrator authentication provider.
    • Verify that the vRealize Orchestrator shortcuts are present in Shortcuts page and in vSphere Client Menu.

    0_vSphereShortcuts-new.png