How to install the vCloud Usage Meter for VMware Extended Support
The VMware Extended Support service provides ongoing Level 1 and Level 2 support for VMware estates where vSphere licences are operating on currently unsupported versions such as v5.5 and v6.0. This provides organisations with additional time to plan upgrades to supported levels of VMware or migrations onto new platforms or services, such as UKCloud's range of public and private clouds operating at OFFICIAL and above.
As VMware Extended Support is consumption-based, you must send reports to UKCloud each month to detail your usage of VMware products. To generate these monthly reports, you need to install the vCloud Usage Meter (Usage Meter).
This article provides all the information you need to install the Usage Meter in your UKCloud environment. For more information about the Usage Meter, see the VMware documentation here.
To install and perform initial configuration of the Usage Meter, you need the following:
Usage Meter OVA and hot patch 5, available here
A Static IP address, DNS server IP address and DNS domain name
A vCenter network that has access to vCenter, the ESXi Host Management interface and other products to be metered
A Network Protocol Profile created in vCenter (see steps below), attached to the network where the Usage Meter will reside
Access to an SMTP server (if the VM won't have access to an SMTP server, let us know as soon as possible by raising a support ticket in My Calls and we'll provide the necessary information to work around this issue)
Two passwords created and recorded for the Usage Meter's
SCP or WinSCP access to the Usage Meter IP to transfer the patch file
Creating a Network Protocol Profile
If you don't already have a Network Protocol Profile attached to the network where the Usage Meter will reside, you must create one before you start the installation.
To create the Network Profile within vCenter:
Log on to the vCenter where you want to host the Usage Meter.
Navigate to the data center object in the vSphere hierarchy where you want to host the Usage Meter, then select the Configure tab.
Select Network Protocol Profiles, then click Add.
In the Add Network Protocol Profile dialog box, enter the following information:
Name and Network page: Enter a Name for the profile and, in the Assign Networks section, select the network on which the Usage Meter will be deployed.
Configure IPv4 page: Enter the network Subnet, Gateway IP and DNS server addresses.
Set other network configurations page: Enter the DNS domain and use the DNS domain for the DNS search path.
Ready to complete page: Review the information you entered.
When you're done, click Finish.
Installing the Usage Meter
To use VMware Extended Support, you must install the Usage Meter to collect usage information and generate the reports that you need to send to UKCloud.
The following steps use the Flex vCenter client, however they should be the same for the HTML5 client.
Deploying and setting up the Usage Meter appliance
To deploy and set up the Usage Meter:
Download the Usage Meter OVA file from the link provided in the Prerequisites section.
In vCenter, navigate to the folder where you want to deploy the Usage Meter.
From the Actions menu, select Deploy OVF Template.
In the Deploy OVF Template dialog box, select Local file and browse for the Usage Meter OVA file, then click Next.
Enter a Name for the VM and ensure the correct folder is selected (if not, select it now), then click Next.
Select a cluster or ESXi server to host the VM, then click Next.
Review the OVA file details, then click Next.
Review the licence agreement and click Accept, then click Next.
Select the desired data store on which to deploy the VM and, from the Select virtual disk format list, select Thin Provision, then click Next.
Select the network you want the Usage Meter to reside on and, from the IP Allocation list, select Static - Manual.
On the Customize template page, set the passwords to use for the Usage Meter
Depending on the vCenter client used, expand the Networking Properties section and enter the following information (where possible), then click Next.
Network 1 IP Address: Enter the IP address to assign to the Usage Meter
Gateway: Gateway IP for the network where the Usage Meter is located
Domain name: AD Domain name where the ESXi and vCenter host is located
DNS search path: Use the AD Domain name
DNS servers: Use the DNS server IPs for the domain
Netmask: Subnet mask of the network where the Usage Meter is located
Review the configuration of the import, then click Finish.
When the appliance has been deployed, power it on.
Setting the time zone
For the data collection process to work correctly, it's important that the Usage Meter is in the same time zone as vCenter.
Open the Usage Meter VM console.
Select the Set Timezone option.
7for Europe, then enter
49for United Kingdom.
If the time shown for Selected time is now is correct, enter
Setting the web application password
You access the Usage Meter via a web application. Before you can access the application, you need to set a password.
In the Usage Meter VM console, select the Login option.
Log in with the
usgmtrusername and the password that you configured at installation.
At the prompt, enter
Enter a password for the Usage Meter web application.
Make a note of the password as you'll need it later to log in to the web application.
exitto log out.
Applying the latest patch to the Usage Meter appliance
VMware has released several rollup patch packs for Usage Meter 3.6.1. You need to apply the latest patch: Hot patch 5.
Download the hot patch zip file from the link provided in the Prerequisites section.
In vCenter, take a snapshot of the Usage Meter appliance.
Open the Usage Meter VM console and log on as
/etc/ssh/sshd.conffile using vi and, in the
# Authenticationsection, change the
yes, then save the file.
Start the SSH service using the following command:
service sshd start.
Using SCP or WinSCP, open a connection to the Usage Meter using the
rootaccount and transfer the hot patch zip file to the
/home/usgmtrfolder. Close SCP/WinSCP when complete.
Switch back to the Usage Meter VM console and stop the SSH service using the following command:
service sshd stop
/etc/ssh/sshd.conffile using vi and, in the
# Authenticationsection, change the
PermitRootLoginoption back to
no, then save the file.
Change directory to
/home/usgmtrand unzip the hot patch file using the following command:
cat vCloudUsageMeter-18.104.22.168-16604978-hot_patch_5.rpm.sha1to display its sha1 hash value.
sha1sum vCloudUsageMeter-22.214.171.124-16604978-hot_patch_5.rpmand compare the output to that of the
catoutput to confirm that they match. If they don't, repeat from step 6.
Install the patch using the following command:
rpm --install vCloudUsageMeter-126.96.36.199-16604978-hot_patch_5.rpm
When the patch has installed, check the services are up and running using
service tomcat statusand, if everything has worked, the service should be active. If not, regress the snapshot taken earlier and perform the steps again.
If the patch was applied successfully, delete the snapshot taken in step 2.
Configuring the Usage Meter
After installing the Usage Meter and applying the latest patch, you need to perform a couple of configuration tasks to complete the setup of the appliance.
Performing initial configuration
First, you need to configure a provider and and email server:
In your web browser, connect to the URL that is displayed in the Usage Meter VM console, and log in to the web application using the account
adminand the password you created earlier.
On first login, you'll be presented with a dialog box asking to give your permission to submit data to VMware. Click Accept.
On the Provider tab, configure the provider as follows:
Company: Enter your company name
Contact Name: Enter the name of your company contact
Phone: Enter a phone number for your company contact
Email: Enter the email address to use as the sender address on any system generated emails
Partner ID: Enter the details given to you during the onboarding of your service (if you're installing the Usage Meter for the inital scoping of your environment, enter 12345)
Contract Number: Enter the details given to you during the onboarding of your service (if you're installing the Usage Meter for the inital scoping of your environment, enter 12345)
Site ID: Enter the details given to you during the onboarding of your service (if you're installing the Usage Meter for the inital scoping of your environment, enter 99)
On the Email tab, configure the email server as follows:
If the Usage Meter VM doesn't have access to an SMTP server, let us know as soon as possible by raising a support ticket in My Calls and we'll provide the necessary information to work around this issue.
Host: The IP address of your SMTP relay
Port: Port details of the SMTP relay
Connection Security: Set the type of the SMTP connection
User: Enter the username if authentication is required
Password: Enter the password if authentication is required
Click Send email to send a test email.
When you've completed all the fields and sent a test email, you'll be able to click Save on the Email tab.
Completing Usage Meter configuration
After finishing the initial Usage Meter configuration successfully, you can select the other tabs on the Manage page to complete the configuration, clicking Save on each tab when you're done.
On the Proxy tab, in the IP or hostname field, enter a dummy IP to prevent the Usage Meter from sending data directly to VMware.
On the Collections tab, from the Start at minute list, select the minute of each hour when you want the Usage Meter to attempt to collect usage information from each product.
If you've connected the Usage Meter to your SMTP server, on the Email Alerts tab, complete the following fields to inform UKCloud of any failed collections:
From Email: Enter a sender email address, for example,
To Email: Enter
email@example.com(if you also want to to receive failed collection alerts, use a comma between addresses and enter your internal email address)
Alerts: Ensure both Successful collection and Failed collection are selected
Testing: Select Send a test email alert after saving
This article described how to install and configure the vCloud Usage Meter. Next, you need to give the Usage Meter access to the products that you need it to report on and send monthly usage reports to UKCloud.
If you find a problem with this article, click Improve this Doc to make the change yourself or raise an issue in GitHub. If you have an idea for how we could improve any of our services, send an email to firstname.lastname@example.org.