vcloud usage meter v2 2 user guide

© 2011 VMware, Inc. All rights reserved.

Page 2 of 15

V Mware vCloud Usage Mete r

Version 2.2 User

Guide

© 2011 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual

property laws. This product is covered by one or more patents listed at

http://www.vmware.com/download/patents.html.

VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions. All

other marks and names mentioned herein may be trademarks of their respective companies.

http://www.vmware.com/download/patents.html

© 2011 VMware, Inc. All rights reserved.

Page 3 of 15

Contents

Installing VMware vCloud Usage Meter ................................................................................................................. 4 Software Requirements ............................................................................................................... 4

Hardware Requirements ............................................................................................................. 4

Deploy VMware vCloud Usage Meter Through vCenter Server .................................................. 4

Deploy vCloud Usage Meter Through vSphere Host ................................................................... 5

Change Password and Time Zone Details .................................................................................... 7

Upgrading vCloud Usage Meter .................................................................................................. 7

Managing VMware vCloud Usage Meter ................................................................................................................ 9 Service Provider ........................................................................................................................... 9

vCenter Servers ........................................................................................................................... 9

Outgoing Email Server ............................................................................................................... 10

Collector .................................................................................................................................... 11

Automatic Report Generation and Email to Aggregator ........................................................... 11

Email Alerts ................................................................................................................................ 11

Generating Reports .............................................................................................................................................. 12 About Reports ........................................................................................................................... 12

Generate a Report ..................................................................................................................... 14

Managing Licenses ............................................................................................................................................... 15 Support ................................................................................................................................................................ 15

Installing VMware vCloud Usage Meter

Before you install VMware vCloud Usage Meter, ensure that the minimum hardware and software requirements are met and the relevant pre-installation tasks are performed.

Software Requirements

You must have VMware vSphere to deploy VMware vCloud Usage Meter, and have a web browser to access the vCloud Usage Meter user web interface.

vSphere Requirements

VMware vCloud Usage Meter can be deployed on the following:

VMware vSphere 4.0 and later releases

Web Browsers

VMware vCloud Usage Meter is an application that is tested and supported on the following Web browsers:

Microsoft Internet Explorer 7.0 and later releases

Mozilla Firefox 3.6 and later releases

Google Chrome 1.0 and later releases

Hardware Requirements

The systems on which VMware vCloud Usage Meter is installed must meet the minimum hardware requirements to install and run the application.

VMware vCloud Usage Meter virtual appliance requires the following hardware specifications:

o 2.0GHz or faster Inter or AMD x86 processor

o 2.5GB or more RAM

o 15GB or more disk storage

o 10/100 Ethernet adapter (Gigabit recommended)

Deploy VMware vCloud Usage Meter Through vCenter Server

You can deploy VMware vCloud Usage Meter as a virtual appliance through VMware vCenter Server.

Prerequisites

o Download the OVA installation file from

http://www.vmware.com/download/download.do?downloadGroup=UMSV2 and save it to your

local machine.

o Ensure that you have vSphere Client installed

Procedure

1. From the File menu in the vSphere client, select Deploy OVF Template

The installation wizard is displayed.

http://www.vmware.com/download/download.do?downloadGroup=UMSV2

of 15

2. In the Deploy OVF Template screen, specify the location of the saved OVA file and click Next.

3. Verify OVF Template Details and click Next.

4. Accept VMware End User License Agreement and click Next.

5. Specify a Name and Inventory Location for the vCloud Usage Meter virtual appliances and click Next.

6. Select the resource pool within which you want to deploy the template and click Next.

7. Select the Datastore in which you want to store the virtual machine files and click Next.

8. Select the Disk Format in which you want to store the virtual disks and click Next.

9. Select a network for the deployed template and click Next.

10. Select the IP Address Allocation policy to allocate IP addresses and click Next.

11. Review the information in the Ready to Complete screen and click Finish.

The installer starts deploying the template.

What to do next

Power on the virtual machine and configure virtual machine details.

Table 1: Supported vCenter Server Versions

vCenter Server Versions

VMware vCenter Server 4.0

VMware vCenter Server 4.0 Update 1






Deploy vCloud Usage Meter Through vSphere Host

You can deploy vCloud Usage Meter as a virtual appliance

Prerequisites

o Download the OVA installation file from

http://www.vmware.com/download/download.do?downloadGroup=UMSV2 and save it to your

local machine.


of 15

o Ensure that you have vSphere Client installed

Procedure

1. From the File menu in the vSphere client, select Deploy OVF Template

The installation wizard is displayed.

2. In the Deploy OVF Template screen, specify the location of the saved OVA file and click Next.

3. Verify OVF Template Details and click Next.

4. Accept VMware End User License Agreement and click Next.

5. Specify a Name for the vCloud Usage Meter virtual appliances and click Next.

6. Select the resource pool within which you want to deploy the template and click Next.

7. Select the Datastore in which you want to store the virtual machine files and click Next.

8. Select the Disk Format in which you want to store the virtual disks and click Next.

9. Review the information in the Ready to Complete screen and click Finish.

The installer starts deploying the template.

What to do next

Power on the virtual machine and configure virtual machine details. Network details were not configured at OVF deployment and must be configured after VMware vCloud Usage Meter console appears. Select Configure Network and follow instructions on configuring new network settings. On completion of setting up network, interfaces will reset followed by a return to the VMware vCloud Usage Meter console. The webapp URL will be updated with new address in the format http://<IP-Address>:8443/um.

Table 2: Supported vSphere Hosts

Supported vSphere Versions

VMware ESX 4.0

VMware ESX 4.0 Update 1



VMware ESX 4.1


VMware ESXi 4.0

VMware ESXi 4.0 Update 1


of 15

Supported vSphere Versions


VMware ESXi 4.1


VMware ESXi 5.0

Change Password and Time Zone Details

After you have deployed the vCloud Usage Meter virtual appliance, you must power on the virtual machines.

Prerequisites

o Successfully deploy vCloud Usage Meter.

o Power on the virtual machine

Procedure

1. One the virtual machine console, navigate to Login and press Enter

2. The command line interface prompts you to enter your credentials.

3. Enter your username root and password vmware and press Enter.

4. To change your password, at the #prompt, type passwd and press Enter.

5. Enter a new password and reenter to the same password to confirm.

The password is changed.

6. The webapp password must be initialized before it can be used. Run the command

/opt/vmware/cloudusagemetering/scripts/webpass.sh

with no arguments for directions. Precede the command with a space, so the command, along with

password, won't be saved in the shell history. The command may take some time to run. Execute the

arguments for the role, service provider <s> or aggregator <a>, you wish to run as.

7. Type Exit to return to the virtual machine console and reset your time zone. 8. On the virtual machine console, navigate to Set Timezone and press Enter. 9. Select your time zone and press Enter. 10. To reflect the changed time zone you must restart the tomcat service. 11. Navigate to the Login and press Enter. Enter credentials and at the prompt, Type service tomcat

restart and press Enter to restart the Tomcat service.

Upgrading vCloud Usage Meter

You can upgrade your existing vCloud Usage Meter setup to vCloud Usage Meter 2.2 from vCloud Usage

Meter versions 2.0, 2.1, and 2.1.1.

of 15

When you upgrade vCloud Usage Meter, you can retain your earlier data and gain access to the newer

features included with the latest version.

Upgrade from vCloud Usage Meter version 2.0

Prerequisites

Ensure that the earlier version and the latest version of the vCloud Usage Meter are deployed as separate virtual machines.

Procedure

Deploy vCloud Usage Meter version 2.2 using vSphere Client.

From the vCloud Usage Meter version 2.0, run the On-Demand Extraction Report for the months to migrate. Extract reports to a file for upload into vCloud Usage Meter 2.2.

Login to vCloud Usage Meter version 2.2 webapp using the service provider credentials.

Navigate to the Migrate tab.

Click Browse and select file to upload.

Click Upload File.

Repeat for additional files to migrate.

Upgrade from vCloud Usage Meter version 2.1

This section covers the upgrade of vCloud Usage Meter version 2.1 and vCloud Usage Meter version 2.1.1.

Prerequisites

Download the zip files usage-meter-210-211.zip and usage-meter-211-220.zip from http://www.vmware.com/download/download.do?downloadGroup=UMSV2

DNS servers and lookup domain must be configured for SSH to be enabled on appliance.

Procedure

1. Login to the vCloud Usage Meter version 2.1 shell using the root password. 2. Transfer the upgrade patch files to /root in the 2.1.0 system 3. unzip /root/usage-meter-210-211.zip -d / 4. Answer the prompt to replace all files. 5. bash /opt/vmware/cloudusagemetering/scripts/migrate/<upgrade version>.sh 6. unzip /root/usage-meter-211-220.zip -d / 7. Answer the prompt to replace all files. 8. bash /opt/vmware/cloudusagemetering/scripts/migrate/<upgrade version>.sh 9. Restart VMware vCloud Usage Meter appliance.

Upgrade from vCloud Usage Meter version 2.1.1

This section covers the upgrade of VMware vCloud Usage Meter version 2.1.1.

Prerequisites

Download the zip file usage-meter-211-220.zip from http://www.vmware.com/download/download.do?downloadGroup=UMSV2



of 15

DNS servers and lookup domain must be configured for SSH to be enabled on appliance.

Procedure

1. Login to the vCloud Usage Meter version 2.1.1 shell using the root password. 2. Transfer the upgrade patch files to /root in the 2.1.1 system 3. unzip /root/usage-meter-211-220.zip -d / 4. Answer the prompt to replace all files. 5. bash /opt/vmware/cloudusagemetering/scripts/migrate/<upgrade version>.sh 6. Restart VMware vCloud Usage Meter appliance.

Managing VMware vCloud Usage Meter

The VMware vCloud Usage Meter must be configured after installation to properly meter vCenter Servers and report virtual machine usage. The following steps review required and optional steps as part of the configuration process for the service provider roll. Functionality listed in this chapter is not required by the aggregator.

Service Provider

All service provider details are required in order for the vCloud Usage Meter virtual appliance to collect and report on virtual machine usage.

Procedure

1. Enter Company

2. Enter Contact Name

3. Enter Phone Number

4. Enter Email

5. Click Save when completed to commit changes.

Figure 1: Server Provider Data Entry

vCenter Servers

of 15

At least one vCenter Server must be added to collect virtual machine usage data. Please refer to the Software Requirements section for more details on the supported vCenter Server versions and number of vCenter Servers supported per vCloud Usage Meter virtual appliance.

Procedure

1. Click Add

2. Enter IP Address

3. Enter User Name. Read-Only administrator privileges required.

4. Enter Password.


Outgoing Email Server

Configure the outgoing email server to receive automatic monthly billing reports and alerts of failed and successful collections.

Procedure

1. Enter Host

2. Enter User (if required)

3. Enter Password (if required)


of 15

Collector

Set the start time for the VMware vCloud Usage Meter to poll vCenter Servers. Default is 5 minutes after the hour and can be adjusted for every minute of the hour to not compete with other scripts working against the vCenter Servers.

Click Test to verify that the collection process is working correctly. Email alerts mush be set in advance to receive results.

Automatic Report Generation and Email to Aggregator

Detailed Billing Report can be sent to the service provider at the day requested by the aggregator. To achieve this follow the procedure below. Outgoing email server must be set up in advance for the aggregator email to be sent correctly.

Procedure

1. Select Reporting Day

2. Enter From Email.

3. Enter To Email. If more than one email address is to be entered, separate out email address with a comma (example: [email protected], [email protected]).


Email Alerts

To monitor the metering of vCenter Servers, there is the option to receive email alerts after successful or failed collections.

Procedure

1. Enter From Email.

2. Enter To Email. If more than one email address is to be entered, separate out email address with a comma (example: [email protected], [email protected]).

3. Select whether successful or failed collection emails will be received.

mailto:[email protected]




of 15

4. Select Send a test email alert after saving to verify that the outgoing email server is working correctly and that the alerts will be sent.


Generating Reports

The vCloud Usage Meter allows the end user to generate various reports to monitor and track resource usage for your vCenter Server and virtual machines.

This chapter includes the following topics:

About Reports

Generate a Report

Export a Report

About Reports

There are three different reports that can be generated from the vCloud Usage Meter by both the Service Provider and Aggregator.

Detailed Billing Report

This is a generic report that provides billing information for all types of vSphere licenses and is also used for sending usage details to the aggregator assigned to the service provider. Virtual machine usage reported is based on which vSphere license keys are selected as VSPP keys. Please refer to Managing Licenses for more details.

Table 3: Detailed Billing Report Details

Report Column Description

Time Day of the reporting month, hour, minute, and milliseconds

Service Provider Name of the service provider associated with the report

of 15


Host DNS Name Host identifier which can be IP address or FQDN depending on how the host was configured with vCenter

Host Memory Size (KB) Host memory size displayed in KB

VM RAM (MB) Configured virtual RAM for the virtual machine

Billing RAM (MB) Billing virtual RAM for the virtual machine calculated from the amount of reserved RAM assigned to the virtual machine

VM CPUs Number of CPUs assigned to the virtual machine

VM Instance UUID Unique identifier for virtual machine to assist with identification and audit

Detailed Usage Report

The Usage Data Report provides all usage-related information including virtual machine name as listed in vCenter Server and virtual machine DNS name. Detailed Usage Report is not provided to Aggregator since it could contain customer specific details in the virtual machine name.


Time Day of the reporting month, hour, minute, and milliseconds

Host DNS Name Host identifier which can be IP address or FQDN depending on how the host was configured with vCenter

Host RAM (GM) Host memory size displayed in GB

vSphere Licenses vSphere license type associated with vSphere host

VM VC Name Virtual machine name as listed in vCenter Server

VM Hostname Virtual machine DNS name

VM RAM (MB) Configured virtual RAM for the virtual machine

Billing RAM (MB) Billing virtual RAM for the virtual machine calculated from the amount of reserved RAM assigned to the virtual machine

VM CPUs Number of CPUs assigned to the virtual machine

VM Instance UUID Unique identifier for virtual machine to assist with identification and audit

of 15

Aggregate Billing Report

This report provides information such as license type, vCenter Server type, total un-capped memory and total capped memory. Un-capped and capped memory totals are based on the sum of all hourly collections. Points are based on your vSphere license type and the VSPP agreement. For more information on VSPP, see the Service Provider Program Guide.


License Type License type being metered.

Total Allocated vRAM (GB-Hour)

Non-Capped Memory (GB-Hour)

Total Billed vRAM (GB-Hour) Capped Memory (GB-Hour) – Used in billing calculation

Generate a Report

A report can be generated manually at any time. Reports generated under Service Provider and Aggregator mode are the same.

Procedure

1. Click Report tab.

2. Provide the following report criteria

Option Description

Report Type Type of report to be executed

Service Provider Name of the service provider associated with the report

Per-VM Memory Cap (MB) Virtual Machine memory cap as referenced in the VSPP Program. Value entered here is the limit in MB for which a virtual machine can be billed for. Multiple the GB memory cap X 1024 for the memory cap in MB.

Zip When exporting, vCloud Cloud Usage Meter provides the option for compressing large dataset to make transport easier.

3. Click Browse to generate report or Export to save report to file.

of 15

Managing Licenses

Service Providers under VSPP may have perpetual VMware license keys that were acquired outside of

VSPP. As a result, vCloud Usage Meter provides a mechanism for excluding those perpetual VMware

license keys in usage reports sent to aggregators.

Procedure to view VMware product keys linked to vCenter Servers.

Login to vCloud Usage Meter appliance as a Service Provider

Navigate to the Licenses tab

VMware license keys are displayed by license code, product name, number of hosts attached to license key, and if they are included in the usage meter billing reports to an aggregator.

If the VMware license key is a perpetual license key owned by the service provider, deselect the license key. Changes are saved immediately.

Figure 2: License Management Tab

VMware license keys will only be displayed after the first poll by the vCloud Usage Meter against the

vCenter Server. If new keys are added to a vCenter Server monitored by the vCloud Usage Meter, they

will be displayed after the next successful poll. If new VMware licenses key are perpetual, it is the

responsibility of the service provider to identify the license keys as such before the billing report is sent

to the aggregator.

Only VMware vSphere 4.0 license keys and newer can be managed with the vCloud Usage Meter.

Licenses maintained with VMware Virtual Infrastructure 3.5 hosts are not eligible for license

management and as a result all VI3.5 keys are included in billing reports to aggregators.

Support

In version 2.2 of the vCloud Usage Meter, there is the option for using the web appliance for reviewing

or saving the support log files to local disk. This feature pulls the latest support log with a limit of 10MB

and is available under both Service Provider and Aggregator roles.

Example:

Select Support Tab

Click Get Appliance Log File button

of 15

Open file to review or save file to disk. Click OK when finished.

vcloud usage meter v2 2 user guide

Documents

vmware vcloud usage

trademark of vmware

outgoing email server

email alerts

registered trademark

vcenter servers

software requirements

hardware requirements