VCloud Usage Meter User's Guide 3.3

vCloud Usage Meter User's GuidevCloud Usage Meter 3.3

This document supports the version of each product listed andsupports all subsequent versions until the document isreplaced by a new edition. To check for more recent editionsof this document, see http://www.vmware.com/support/pubs.

EN-000529-00

http://www.vmware.com/support/pubs

vCloud Usage Meter User's Guide

2 VMware, Inc.

You can find the most up-to-date technical documentation on the VMware Web site at:

http://www.vmware.com/support/

The VMware Web site also provides the latest product updates.

If you have comments about this documentation, submit your feedback to:

[email protected]

Copyright © 2014 VMware, Inc. All rights reserved. Copyright and trademark information.

VMware, Inc.3401 Hillview Ave.Palo Alto, CA 94304www.vmware.com

http://www.vmware.com/support/

mailto:[email protected]

http://pubs.vmware.com/copyright-trademark.html

Contents

About This Book 5

1 Introduction 7

VMware Products Metered 8

2 Manage 11

Provider tab 11Email tab 12Products tab 12Collections tab 18API tab 18LDAP tab 18

3 Licenses 21

Create License Set 21Edit License Set 22Delete License Set 22

4 Automatic Reporting 23

Create Automatic Report Set 23Edit Automatic Report Set 24Delete Automatic Report Set 24

5 Monitor 25

6 Customers 27

About Restricted Customers 27Add a Customer 27Change Customer Details 28Delete a Customer 28Import Customers and Rules 28Export Customers and Rules 30

7 Rules 31

Add a Rule 31Change Rule Details 32Delete a Rule 32About Object and Value Types 33

8 Reports 35

Manage Billing Categories 35

VMware, Inc. 3

About Product Consumption Reports 36Generate a Product Consumption Report 38

9 Support 41

Review Diagnostic Information 41Delete Older Data from the Database 42View vCloud Usage Meter Logs 42Change Logging Level 43Change Log History Capacity 43Generate a Support Bundle Log File Collection 44Delete a Support Bundle Log File Collection 44

10 Advanced Management 45

About User Activity and Process Notifications 45Add ESXi Host Instances 45Back Up the Database 46Change TCP Port for vCenter Server Collections 47Increase Collection Speed with Parallel Collections 47Generate SSL Certificate for vCloud Usage Meter 48Java Management Extensions for vCloud Usage Meter 49

11 Installation 51

System Requirements 51TCP Port Configuration 52Install with vSphere Client 53Configure IP Pool 53Change Time Zone 54Configure Web Application Password 54Upgrades 55

Index 59


4 VMware, Inc.

About This Book

The VMware vCloud Usage Meter User's Guide provides information to install, configure, and use the vCloud®

Usage Meter.

Intended AudienceThe VMware vCloud Usage Meter User's Guide is intended for service provider administrators with accessprivileges to manage the VMware vCloud Usage Meter. These individuals must be familiar with data centeroperations.

VMware, Inc. 5


6 VMware, Inc.

Introduction 1vCloud Usage Meter collects raw product consumption data on Service Provider products that are part ofVMware Service Provider Program bundles.

Service providers can generate reports to use the reported data for their VMware Service Provider Programaggregator, as well as diagnostic purposes.

For information about the VMware Service Provider Program, see http://www.vmware.com/partners/partners.html.

Figure 1‑1. Service Provider Workflow

Install

Monitor data polling (Optional) run or exportproduct consumption

data report

VMware vFabricPostgres DB

Automatically sendproduct consumption

data in email ifdesired

VMware.comdownload site

Service provideruser

Provided with vCloud UsageMeter virtual machine

Serviceprovider

user

Serviceprovider

user

VMware vSphere

Client

Service Provider User InterfaceSet up

- service provider details- email alerts- vCenter information- other product information

Download vCloudUsage Meter OVA file

Access vCloud Usage Meter After InstallationAfter installation and configuration, there are several methods to access settings or data.

VMware, Inc. 7

http://www.vmware.com/partners/partners.html

Table 1‑1. Access Methods

Access Method Description

Virtual machine console Access configuration settings.

Web application Use menus, tabs, and pages to manage settings, metering, andreports.

Java Management Extensions (JMX) service Access internal data such as database size, customer count, customerrules count.

REST API vCloud Usage Meter REST API can be used by external clients(portals, scripts, and other programs). See the vCloud Usage MeterAPI Guide.

About Data CollectionsConsumption data is collected from vCenter Server instances and other products from:

n VMware vSphere® host includes DNS name, RAM (physical memory), and license type.

n Virtual machine includes the VMware vCenter® name, hostname, allocated and billing vRAM (virtualmemory), CPU, instance universal unique identifier (UUID), and location in the vSphere inventory.

n Products include billing vRAM, storage, and other metrics specific to the product.

Collected data is stored in the VMware® vFabric™ Postgres database of the virtual appliance.

About Customer and Rule ManagementvCloud Usage Meter customers of the service providor can be manged (Add, Edit, Delete, Export, andImport functions). Rules can associate vCenter Server objects with a customer’s cloud infrastructure.Monthly customer product consumption reporting aids in planning, billing, general account management,dispute resolution.

Customer-specific rules provide granular control of vCenter Server inventory. Objects can be linked fromthe vCenter Server down to individual unique IDs of virtual machines or IP addresses.

About ReportsVarious reports help monitor and track specific resource consumption. Reports can be generated on demandand managed with several output options:

n Browse

n Export (tab separated)

n Zip

n Submit to VSPP Business Portal

n Email

Other reports can be automatically generated and emailed to specific recipients. Service providers withmultiple aggregators can set up automatic reports to each aggregator, specific to their requirements.

VMware Products MeteredvCloud Usage Meter supports metering of VMware products that are part of vCloud Service ProviderBundles.

NOTE vCloud Usage Meter Not all products or product versions available through the VMware ServiceProvider Program are monitored.


8 VMware, Inc.

VMware vCenter Server Versions Supportedn VMware vCenter Server 4.0

n VMware vCenter Server 4.0 Update 1 through 4

n VMware vCenter Server 4.1





n VMware vCenter Server 5.1 Update 1


VMware ESXi Versions SupportedYou can add an ESXi host directly, whether or not it is managed by a vCenter Server instance. Support isexperimental in this release.

VMware vCenter Operations Manager Versions Supportedn VMware vCenter Operations Manager 5.0

n VMware vCenter Operations Manager 5.0.1


n VMware vCenter Operations Manager 5.6

n VMware vCenter Operations Manager 5.7



Other VMware Products and Versions Supportedn VMware Horizon Workspace - Data 1.0, 1.5

n VMware vCenter Site Recovery Manager 5.0.1, 5.1, 5.5

n VMware vCloud Director 1.5 , 5.1, 5.5

n VMware vCloud Integration Manager 1.0

Chapter 1 Introduction

VMware, Inc. 9


10 VMware, Inc.

Manage 2Configure vCloud Usage Meter to set up how information about product consumption is received. Thisincludes email alerts, access to vCloud Usage Meter, and collection times that do not conflict with serveroperations.

vCloud Usage Meter configuration includes service provider information. This information is used to reportconsumption data.

You can configure several settings.

n Send metering alerts to email addresses that you provide.

n Set up LDAP authentication to manage who can use the application.

n Configure and test collection timing, to avoid conflicts with other server operations.

This chapter includes the following topics:

n “Provider tab,” on page 11

n “Email tab,” on page 12

n “Products tab,” on page 12

n “Collections tab,” on page 18

n “API tab,” on page 18

n “LDAP tab,” on page 18

Provider tabConfigure Service Providor information. These details appear in reports.

Procedure

1 On the Provider tab, enter Service Provider Information details:

Option Description

Company Name of your company.

Contact Name Name of the person who is the single point of contact. Type the name inLast Name, First Name format.

Phone Phone number of the contact. Type the number in +country code phonenumber format.

Email Email address of the contact.

Partner ID The ID of the Partner

Contract Number The contract number with the VMware

VMware, Inc. 11

Option Description

Site ID (optional) Enter the SP-defined ID for the Usage Meter location. ServiceProviders can create sites to report multiple locations with multiple usagemeters. This can be used to report back to an individual site for each usagemeter.

VSPP Business Portal Username Username for the VSPP Business Portal.

VSPP Business Portal Password Password for the VSPP Business Portal.

2 Click Save.

Email tabSettings of the Email communications configuration. Alerts can be automatically sent for automatic monthlybilling reports. Alerts can also be sent for failed or successful collections.

Procedure

1 Click the Manage link.

2 On the Email tab, in the Outgoing Email Server section, enter the details:

Option Action

Host Enter the host name.

Port Enter the port number or accept the default of 25.

3 (Optional) If needed, select Connection Security from the drop-down.

4 If authentication is required, enter User and Password, then click Save.

5 In the Email Alerts, enter details:

Option Action

From Email Type the name to appear in the From line of the email alert.

To Email Type the email address to receive email alerts. Use commas to separatemultiple email addresses.

Alerts Select Successful collection and/or Failed collection, as needed. Selectedcheck boxes will send email alerts.

Testing Select check box to send a test email after this configuration is saved.

6 Click Save.

Products tabOn this tab, add selected products to be metered.

Prerequisites

Verify that you have read-only administrator privileges.

Procedure

1 Click the Manage link.

2 Click the Products tab.

3 Perform necessary configuration details.


12 VMware, Inc.

The selected vCloud products are added for metering and monitoring. If an error occurs, a message appearsand the server is not added.

Add vCenter ServerTo begin metering, you provide a host name and credentials for at least one vCenter Server instance. Youcan add one or more instances.

Prerequisites


If your vCenter Server is protected by vCenter Site Recovery Manager, credenitials are needed for both theprotected and recovery site vCenter Server instances. For more information onvCenter Site Recovery Manager, see the document Site Recovery Manager Installation and Configuration, UsingArray-Based Replication with SRM http://pubs.vmware.com/srm-55/topic/com.vmware.srm.install_config.doc/GUID-01D20E5F-4B98-442B-

Procedure

1 On the Products tab, vCenter Server area, click Add to enter details.

2 Host Name or IP

Use a comma to separate multiple servers. Each must use the same User Name and Password.

3 Administrator User Name

4 Password

5 Meter checkbox

Do not select if this is a recovery site vCenter Server instance.

6 Monitor checkbox

Select only for special cases, as directed by technical support.

7 Site Recovery Manager Peer vCenter Server drop-down

if this is a protected site instance, select and link it to the corresponding recovery site instance on thedrop-down list. To appear on the drop-down, the recovery site instance must be added.vCenter Site Recovery Manager servers do not need to be added to vCloud Usage Meter becausevCloud Usage Meter automatically detects them through their associated vCenter Server instance.

8 Click Save.

If server certificates cannot be authenticated, a dialog displays. When a vCenter Site Recovery Managercertificate fingerprint is not in the vCenter Server extension, vCloud Usage Meter presents it forapproval. First the vCenter Server certificate must be presented and accepted, which allows connectingto the vCenter Server instance, which allows discovery of vCenter Site Recovery Manager. So in thisstep you press Save, Accept and Save for the vCenter Server instance, and then Accept and Save forvCenter Site Recovery Manager

The vCenter Server instance is added to the list of vCenter Server instances. vCloud Usage Meter performscollections against all added vCenter Server instances and vCenter Site Recovery Manager instances in boththe protected and recovery sites.

Metered and Unmetered vCenter Server Instance Examples

Chapter 2 Manage

VMware, Inc. 13

http://pubs.vmware.com/srm-55/topic/com.vmware.srm.install_config.doc/GUID-01D20E5F-4B98-442B-

Figure 2‑1. vCenter Servers Set Up For vCenter Site Recovery Manager Management

n The row for server 10.24.183.124 shows a vCenter Server instance for which vCloud Usage Meter doesnot perform collections. In this case this is the recovery site server for server 10.24.183.244.

n The row for server 10.24.183.244 shows a vCenter Server instance for which vCloud Usage Meterperforms collections. In this case this is the protected site server. Its recovery site server 10.24.183.124 islisted in the Site Recovery Manager Peer column.

n The row for server 10.255.79.100 shows a vCenter Server instance for which vCloud Usage Meterperforms collections. In this case this server is not protected by vCenter Site Recovery Manager. A checkin the Monitor column designates special cases for which vCloud Usage Meter performs collectionsdepending upon power status.

n The row for server 10.24.183.124 shows a vCenter Server instance for which vCloud Usage Meter doesnot perform collections. In this case this is the recovery site server for server 10.24.183.244.

n The row for server 10.24.183.244 shows a vCenter Server instance for which vCloud Usage Meterperforms collections. In this case this is the protected site server. Its recovery site server 10.24.183.124 islisted in the Site Recovery Manager Peer column.

n The row for server 10.255.79.100 shows a vCenter Server instance for which vCloud Usage Meterperforms collections. In this case this server is not protected by vCenter Site Recovery Manager.

n A check in the Monitor column designates special cases for which vCloud Usage Meter performscollections depending upon power status.

Add vCenter Operations ManagerUse Rebuild when vCenter Operations Manager server has been updated from verison 5.0+ to 5.6+.

Prerequisites


vCenter Operations Manager server was updated from version 5.0+ to 5.6+.

Procedure

u On the Products tab, vCenter Operations Manager area, click Rebuild.

vCenter servers are refreshed.

Add vCloud Automation CenterThis adds a vCloud Automation Center for metering.

Prerequisites



14 VMware, Inc.

Procedure

1 On the Products tab, Center Automation Center area, click Add to enter details.

2 Host Name or IP



4 Password

5 Click Save.

The vCloud Automation center server is added to the list of instances. If an error occurs, a message appearsand the server is not added.

Add vCenter DirectorThis adds vCenter Director to the vCloud Usage Meter application.

Prerequisites


Procedure

1 On the Products tab, vCenter Director area, click Add to enter details.

2 Host Name or IP


3 Port

Change as needed, otherwise accept default value.


5 Password

The vCloud Integration Manager server is added to the list of instances. If an error occurs, a messageappears and the server is not added.

Add vCloud Integration ManagerTo add the product vCloud Integration Manager to be metered, you provide thevCloud Integration Manager server's host name and credentials.

Prerequisites


Procedure

1 On the Products tab, vCenter Integration Manager area, click Add to enter details.

2 Host Name or IP



4 Password

5 Click Save.

Chapter 2 Manage

VMware, Inc. 15

The vCloud Integration Manager server is added to the list of vCloud Integration Manager instances. If anerror occurs, a message appears and the server is not added.

Add Horizon DataTo add the product Horizon Workspace - Data to be metered, provide the server's host name andcredentials.

Prerequisites

Super User privileges.

SSH port is enabled where Harizon Data will be added.

Copy of the host key fingerprint. See “Authenticate with Sample Host Key Fingerprints,” on page 17.

Procedure

1 On the Products tab, Horizon Data area, click Add to enter details.

2 Unique ID or Name

3 Host Name or IP


4 User Name

5 Password

6 Type the user name in the User Name text box.

7 Click Get host key and compare the host key fingerprint shown to the copy.

8 Click Save.

The Horizon Data server is added to the list of instances. If an error occurs, a message appears and theserver is not added.

Edit Product DetailsYou can change the user and password details for products.

Prerequisites


Procedure

1 Click the Manage link, and then the Products tab.

2 In the product area, select the server and click Edit.

3 Modify product details, as needd.

4 Click Save.


16 VMware, Inc.

Delete or Reactivate Product ServersSometimes product servers are no longer in use, so you can delete them. If no data was collected prior to thedeletion, vCloud Usage Meter deletes all record of the server. If data was collected, vCloud Usage Meterdesignates the server as inactive and data that was collected before removal remains in the database. Aninactive server can be activated to re-include it in collections.

Procedure

1 On the Products tab - to delete a server, in the appropriate product area, select the server, click Delete.

It is moved to the inactive listing for that product. If any data was collected prior to the deletion,vCloud Usage Meter designates the server as inactive and data that was collected before removalremains in the database. If a server was added to but no collections were made, nothing is saved in thedatabase and the server cannot be activated.

2 To reactivate a server, in the appropriate product area, select the Show Inactive checkbox. Select theinactive server and click Activate.

It is moved to the active list.

Authenticate with Sample Host Key FingerprintsNetwork attackers can pose as real servers, attempting to trick vCloud Usage Meter on port 22 with a man-in-the-middle attack. To protect against this, vCloud Usage Meter provides a procedure for you toauthenticate comparing the server host key fingerprint of servers as part of adding these products tovCloud Usage Meter. This procedure applies to Horizon Workspace - Data andvCenter Site Recovery Manager.

You obtain a copy of the server host key fingerprint from the prospective server. When you add theseproducts in vCloud Usage Meter the fingerprint is displayed, allowing you to compare fingerprints.

Prerequisites

Verify that you have vSphere Client installed.

Verify that you have Super User privileges to the servers.

Procedure

1 Log in to the console of the product server.

2 Enter ssh root@server IP to display the server host key fingerprint.

The host key fingerprint is represented both as a character string and a graphical representation.

3 Take a picture or copy the host key fingerprint.

Example: Sample Host Key FingerprintRSA key fingerprint is 85:92:b5:ff:ed:f6:45:b4:d2:46:11:a9:50:16:63:e9.

+--[ RSA 2048]----+

| . .*ooo|

| o o .o....|

| o o . o ...|

| . o Eo..|

| S . . +.|

| . .o. |

Chapter 2 Manage

VMware, Inc. 17

| . . .|

| .. .|

| ....|

+-----------------+

What to do next

Add the product on the Manage page, Products tab.

Collections tabvCloud Usage Meter collects consumption data from vCenter Server instances and other products. Defaultis one the hour collection. If this competes with other scripts, the start time can be adjusted.

Procedure

1 On the Collections tab, on the Start at minute drop-down, select when the data collection begins.

2 (Optional) Click Test to run a test data collection.

The test collection results are not saved and do not affect collection details.

What to do next

Monitor your collections. See Chapter 5, “Monitor,” on page 25.

API tabThis procedure adds/revokes Access Tokens.

Prerequisites

Super-user access.

Procedure

1 On the API tab, adjust tokens as needed.

2 To view Admin Token, click Add Admin Token

Click Revoke to remove the displayed Admin Token.

3 To view Admin Token, click Add User Token.

Click Revoke to remove the displayed User Token.

Admin and User Tokens are added or revoked according to the user action.

LDAP tabvCloud Usage Meter can authenticate users against an LDAP service.

Prerequisites

n Verify that the LDAP server is supported by vCloud Usage Meter. See “System Requirements,” onpage 51.

n Verify a base distinguished name of the LDAP hierarchy to allow log in to vCloud Usage Meter. Use aspecific Base DN that only contains your intended user group.

n Verify a user name and password for a user account within the LDAP hierarchy user group to allow ogin to vCloud Usage Meter.


18 VMware, Inc.

n Verify a valid SSL certificate if using SSL security. See “Generate SSL Certificate for vCloud UsageMeter,” on page 48.

Procedure

1 On the LDAP tab, enter details.

2 Host

Option Description

Hostname (Most commonly used.) Requires vCloud Usage Meter appliance to haveDNS configured. (DNS configuration is verified in appliance console.)

Domain Name Or - this is recommended because it supports failover. Requires thevCloud Usage Meter appliance to have DNS configured. (DNSconfiguration is verified in appliance console.)

IP Address Or - least preferred, but does not require DNS configuration.

3 Port

389 is the default port for LDAP.

4 (Optional) Use SSL check box.

5 Username DN

(60 characters) This is the user account that will connect to LDAP for the purposes of locating theaccount of someone logging in to vCloud Usage Meter.

6 Password

Password of the user account that connects to LDAP to locate the account of log in ovCloud Usage Meter.

7 LDAP Schema

a User Base DN

(60 characters) Base distinguished name of LDAP hierarchy group that allows log in tovCloud Usage Meter. Use a specific user base DN that contains only your intended user group.

b Object Class - for example, User.

c User Name Attribute - for example, sAMAccountName.

8 Click Save.

What to do next

To test your LDAP login.

1 To verify and confirm the certificate fingerprint, log out of vCloud Usage Meter.

2 Log in with the user name and password of a user in the intended user group.

3 If successful, LDAP login is verified.

Chapter 2 Manage

VMware, Inc. 19


20 VMware, Inc.

Licenses 3The VMware Service Provider Program provides licenses to use service provider bundles. With billinggroups, vCloud Usage Meter you can designate some licenses as nonbillable and can group licenses in sets.

Super User admin credentials are required to manage licenses. Users can:

n Create License Sets

n Edit License Sets

n Remove License Sets

vCloud Usage Meter Reports include licenses that are identified and updated through queries to thevCenter Server instances in your inventory. If a license key is no longer present, the license is removed fromthe licenses that can be managed.

vSphere license keys that service providers deploy might have different billing characteristics, so you canindicate which license keys are billable by defining the billing category. You can assign one of the followingcategories.

VSPP License key obtained through the VMware Service Provider Program. Allvirtual machines running on hosts with these keys are considered to bebillable.

Demo License key that is not billable, such as for a system used for demonstration.

Perpetual license key Obtained outside of the VMware Service Provider Program. Virtualmachines running on hosts with perpetual license keys are not billable.

With license sets, you can group one or more vSphere license keys and associate virtual machine vRAMconsumption with those groups.


n “Create License Set,” on page 21

n “Edit License Set,” on page 22

n “Delete License Set,” on page 22

Create License SetWith license sets, you can group licenses in sets that are meaningful for reporting.

Procedure

1 Click the Licenses link.

2 Click the License Sets tab.

VMware, Inc. 21

3 Type the name for the new license set.

4 Click New.

5 Select License check boxes to include in the set.

A license can belong to multiple sets.

6 Click Save.

Edit License SetYou can change which licenses are included in a license set.

Procedure



3 Click the name of the License Set to edit.

The included licenses display.

4 Select or deselect licenses, as needed.

5 Click Save.

Delete License SetIndividual licenses or entire license sets can be removed if the set is no longer meaningful or needed.

Procedure



3 To delete an entire License Set, select the name. To delete a single (or several) licenses within a LIcenseSet, click the License Set name and select the license(s) to be deleted.

4 Click Delete.

The License Set or individual license(s) is removed.


22 VMware, Inc.

Automatic Reporting 4You can configure vCloud Usage Meter to create automatically generated sets of reports and email them toan aggregator, or elsewhere. If you report to multiple aggregators, you can configure a report set for eachone.

A single name can contain one or more reports.

n Create Automatic Report Set

n Edit Automatic Report Set

n Delete Automatic Report Set


n “Create Automatic Report Set,” on page 23

n “Edit Automatic Report Set,” on page 24

n “Delete Automatic Report Set,” on page 24

Create Automatic Report SetThis procedure describes how to create Aatomatically Generated Reports. Reports are created individuallyand together form an Automatic Report Set.

Prerequisites

Create license sets. See “Create License Set,” on page 21.

Super User credentials.

Procedure

1 Click Automatic Reporting link.

This opens the Automatic Reporting page.

2 For a new report, in the right-hand details panel, enter Name.

3 Reporting Day drop-down menu. Select day of the month to send.

4 Reports to Include list. Select report types to include in the set.

5 License Set list. Select license sets in the reporting set.

VMware, Inc. 23

6 Configure the email settings.

Option Action

From Email Enter email address to appear in the From line.

To Email Enter email address to receive the Automatic Report Set. Separate multipleemail addresses with a semicolon ( ; ).

7 Click Save.

The name of the new reporting set appears in the left-hand panel list.

Edit Automatic Report SetYou can modify details and contents of an Automatic Report set.

Procedure


This opens the Automatic Reporting page.

2 In the left-hand pane, Name drop-down, select the reporting set to edit.

The last time sent for the selection in at the bottom of the right-hand pane.

3 In the right-hand pane, change these details, as needed.

Option Description

Name Type the name of the reporting set. If existing name is changed, it is savedas a new set.

Reporting Day Select the day of the month to send.

Reports to Include Select reports to include in the set.

License Set Select license set(s) to include in the report set.

From Email Type the name to appear in the From line of the reporting set.

To Email Enter email address to receive the Automatic Report Set. Separate multipleemail addresses with a semicolon ( ; ).

4 Click Save.

What to do next

Old reporting sets can be deleted. See “Delete Automatic Report Set,” on page 24.

Delete Automatic Report SetYou can remove reporting sets that are no longer needed.

Procedure


2 In the left-side pane, Name drop-down, select the reporting set to remove.

3 Click Delete.

There is no confirmation of the deletion.

The reporting set is removed and is no longer included in the list.


24 VMware, Inc.

Monitor 5You can view times of successful or failed collections for vCenter Server instances and other productsassociated with vCloud Usage Meter, to monitor the incidence of failed collections.

Procedure

1 Click Monitor in the top right menu bar.

2 Select the year and month to view.

3 Click Submit.

4 To view collection times, point to the OK or Fail count in any column.

What to do next

To minimize failed collections you can change collection times or memory settings.

n If your collection start time is competing with other scripts that are working with your vCenter Serverinstances, you can change the start time. See “Collections tab,” on page 18.

n Verify your memory settings. See Configure Memory Size.

VMware, Inc. 25


26 VMware, Inc.

Customers 6Product consumption is metered on the entire vCenter Server inventory. Customers and rules providedetailed control to organize consumption reporting. Customers and rules work together.

Customers can be added individually or imported to vCloud Usage Meter. The import and export processensures the same customer list is used on multiple vCloud Usage Meter virtual appliance installations. Thisis useful when customer consumption is shared among multiple vCenter Server instances or products.

On the Customers page, a Rule can be added to an individual customer. To do this, select the customer, andclick Rules button. This opens the Rules UI.

.


n “About Restricted Customers,” on page 27

n “Add a Customer,” on page 27

n “Change Customer Details,” on page 28

n “Delete a Customer,” on page 28

n “Import Customers and Rules,” on page 28

n “Export Customers and Rules,” on page 30

About Restricted CustomersIf a customer's name or location is considered confidential or sensitive, it can be be designated as restricted.The customer is given a code name or location, or both.

Work with your VMware Service Provider Program administrator to use code details for metering andreporting instead of the customer's actual details. Confidential details of restricted customers are maintainedat VMware Service Provider Program operations.

A customer restricted status must be done manually through the Customers dialog.

For more information about how to restrict status, see “Add a Customer,” on page 27.

Add a CustomerProduct consumption is recorded by customer. This procedure adds one or multiple customers tovCloud Usage Meter.

Procedure

1 Click Customers link.

VMware, Inc. 27

2 For an individual customer, click Add.

3 Name

(60 characters) Name of customer

4 Restricted check box.

(optional) Select if customer's details are to be coded as confidential.

5 Country

Select from drop-down list.

6 Postal Code

(associated with selected Country)

7 Click Save.

What to do next

Add more customes as needed.

For more information, see “Import Customers and Rules,” on page 28.

Change Customer DetailsYou can change the name, country, and postal code details for customers.

Procedure


2 Locate the customer to be updated, and select the check box.

3 Click Edit.

4 Make changes and modifications as needed.

5 Click Save.

Delete a CustomerYou can remove one or more customers from the metering scope of vCloud Usage Meter.

Procedure


2 Locate the customer(s) to be removed and select the check box.

3 Click Delete Selected and confirm the removal.

The selected customer(s) is removed from the list of customers. Data that was collected before removalremains in the database.

Import Customers and RulesThe tab-separated file can contain customers with associated customer rules. The file can be manuallygenerated or based on an exported list from vCloud Usage Meter.

Tab-separated files can contain data for either customers or rules, or both. Restricted customers can not beimported via a tab separated file and must be entered manually. For more information, see “Add aCustomer,” on page 27.


28 VMware, Inc.

Prerequisites

n Prepared a tab-separated file. See “Export Customers and Rules,” on page 30. If transferring customerand rule data from one vCloud Usage Meter virtual appliance to another, obtain a tab-separated file byexport.

n Verify no duplicate custome names in the tab-separated file.

n Verify that countries are listed in alpha-2 code format. See http://www.iso.org/iso/country_codes/iso_3166_code_lists/country_names_and_code_elements.htm.

Procedure


2 In the Import section, click Browse to locate the tab-separated file.

3 Click Import.

n If the import is successful, a page appears with a confirmation message.

n If the import fails, an error message appears that indicates the type of error and the line numberproducing the error.

Example: Tab-Separated File Format for Importing Customers and RulesThis example shows the format for tab-separated rows and columns for several sample customers and rules.

Table 6‑1. Tab-Separated File Format for Importing Customers and Rules

Row Column A Column B Column C Column D Column E

1 # vCloud UsageMeter CustomerExport

2 # Version: 1

3 # Customers

4 # Name Country Postal Code

5 NewCo AF 44

6 YourCo US 94555

7 TheCo

8 ThisCo US 95555

9 # Rules

10 # Example rule:Exact stringfolder match forabc for customerCloudCo

11 # CloudCo Folder Exact String abc

12 # Customer vCenter Object Type Value Type Value

13 NewCo 10.255.79.10 VM Unique ID vm-100

14 NewCo 10.255.79.10 Host Unique ID host-77

15 NewCo VM DNS name Exact string ad

16 NewCo 10.255.79.10 vApp Unique ID resgroup-v99

17 NewCo 10.255.79.10 VM Unique ID vm-103

Chapter 6 Customers

VMware, Inc. 29

http://www.iso.org/iso/country_codes/iso_3166_code_lists/country_names_and_code_elements.htm

Table 6‑1. Tab-Separated File Format for Importing Customers and Rules (Continued)

Row Column A Column B Column C Column D Column E

18 NewCo 10.255.79.10 vApp Unique ID resgroup-v91

19 TheCo 192.168.128.1 Data Center Unique ID datacenter-2

Export Customers and RulesThe exported tab-separated file can contain customers and associated customer rules.

Procedure


2 Click Export All.

A tab-separated file is exported.

What to do next

n Use the file as an example for other imports.

n Use the file to import data to another vCloud Usage Meter virtual appliance. See “Import Customersand Rules,” on page 28.


30 VMware, Inc.

Rules 7Customers that require confidentiality can be still be represented and metered in vCloud Usage Meter. Ifconfidentiality is needed, you designate that customer as restricted, and work with your VMware ServiceProvider Program coordinator to set up a code, so confidential names and locations are never visible.

User with Super User privileges can:

n Add a Rule

n Change Rule Details

n Delete a Rule


n “Add a Rule,” on page 31

n “Change Rule Details,” on page 32

n “Delete a Rule,” on page 32

n “About Object and Value Types,” on page 33

Add a RuleRules can be added to collect product consumption data about your customers for the VMware ServiceProvider Program.

Prerequisites

Review vSphere inventory for object types that correspond to your customers. See “About Object and ValueTypes,” on page 33.

Review status of virtual machines. Virtual machines that have been deleted from a vCenter Server inventorybut that remain in the vCloud Usage Meter database are shown as dimmed out. A rule assignment remainsvalid for reporting and billing purposes, whether the virtual machine is active or not.

Procedure

1 Click Rules link.

2 Customer drop-down list

Select from the drop-down list. Can also start by typing.

3 You can select in three different ways;Select from the vSphere Inventory or To select Object Type drop-down

Select from the list.

VMware, Inc. 31

4 You can select Rule details in three different ways:

n In the Object Type drop-down list, select an item. Remaining fields (Value Type, vCenter andValue) are populated as selections are made.

n Select directly from the vSphere Inventory list.

n Use Filter to reduce the list size, and then select an item.

5 Click Create.

The rule is added to the Rules List sub-tab.

During customer rules creation, if a conflict occurs with another customer rule, an error message displayswith details. The rule is not created.

What to do next

On the Mapped Virtual Machines tab, view a list of virtual machines that have rules associated with them.

On the Unmapped Virtual Machines tab, view a list of virtual machines that have no rules associated withthem.

Change Rule DetailsYou can change rules that collect product consumption data for customers if the rule needs to point to adifferent location in your vCenter Server inventory. To change a rule, delete it and then construct areplacement rule.

Prerequisites

Before deleting, note any details to be reinstated.

Procedure

1 .Click Rule link

2 Click the Rules List tab to view the existing rules.

3 Select the Rule to be modified.

4 Review the Rule details, and note items to be duplicated.

5 To delete the old rule, follow “Delete a Rule,” on page 32.

6 To create a new rule, follow “Add a Rule,” on page 31

Make sure to include details to be used in the new rule.

What to do next

Confirm that the replacement Rule details are accurate.

Delete a RuleYou can remove rules based on relationships between a vSphere inventory object and a customer. When arule is deleted, only the relationship between the vSphere inventory object and the customer is removed. Allproduct consumption data is maintained.

Procedure

1 Click Rules in the top right menu bar of the Web application.

2 Click the Rules List tab to view the existing rules.


32 VMware, Inc.

3 (Optional) Select a customer by typing part of the customer name and then locating it in the list thatappears.

vCloud Usage Meter populates a list of customer names that match the characters you typed.

4 (Optional) Show Rules for All Customers check box shows all rules for all customers.

5 Select check box for the rule to be deleted.

6 Click Delete Selected Rules.

The selected rules are removed from the rules list.

About Object and Value TypesWhen rules are added, the customer is linked to specific objects in the vCenter Server inventory. Each objecthas a value type that uniquely identifies it for metering by vCloud Usage Meter. The value type varies,depending upon the object.

Object Type DefinitionsObject types aid you in metering and reporting specific customer activity.

Table 7‑1. Object Type Definitions

Object Type inInventory Definition

VM Virtual machine. A software-based computer that, like a physical computer, runs an operatingsystem and applications. Virtual machines that have been deleted from a vCenter Serverinventory but that remain in the vCloud Usage Meter database are shown as dimmed out.

VM vCenter ServerName

A vCenter Server name in your inventory. Differs from the object type vCenter Server in thatrules based on this object are based on string, substring, or regular expression.

VM DNS Name A DNS name of a virtual machine in your inventory.

IPv4 address An IP network address in your inventory.

Folder Grouped objects of the same type. For example, folders help set permissions across objects, toset alarms across objects, and to organize objects in a meaningful way.

Resource Pool Divisions of computing resources used to manage allocations between virtual machines inyour inventory.

vApp A format that packages and manages applications containing multiple virtual machines.

Host Physical computer on which virtualization or other software is installed.

Cluster Server group in the virtual environment.

Datacenter A required structure in vCenter Server under which hosts and their associated virtualmachines are added.

vCenter Server A vCenter Server as identified by a unique ID. Differs from the object type VM vCenter ServerName in that rules based on this object are specific to the unique ID only.

Supported Object and Value Type CombinationsEach combination of supported objects requires specific value types, and some also need identification ofthe vCenter Server. Exact string, substring, regular expression, and CIDR notation apply to allvCenter Server instances registered with vCloud Usage Meter.

Chapter 7 Rules

VMware, Inc. 33

Table 7‑2. Supported Object and Value Types

Object Type Value Types vCenter Server Needed

VM, host, cluster,datacenter, orvCenter Server

Unique ID Yes

VMvCenterServerName orVM DNS Name

Exact string No

Substring No

Regular expression No

IP V4 address IP V4 CIDR notation No

Folder, resourcepool, or vApp

Unique ID Yes

Exact string No

Substring No

Regular expression No


34 VMware, Inc.

Reports 8These product consumption reports monitor and track resource consumption by customer or by vSphereinventory object. Any and all reports can be manually generated at any time. Report results can be exportedas a tab-separated file or ZIP file (when large numbers of records are returned).

License Sets and Billing CategoriesUse license sets to group license keys for convenience in reporting to aggregators. Because license keys canhave different billing characteristics, you can indicate which license keys are billable by designating a billingcategory.

Report TypesvCloud Usage Meter provides a choice of reports. See “About Product Consumption Reports,” on page 36.

Report Generation Methodsn Browse a report in the user interface or save it to a file. See “Generate a Product Consumption Report,”

on page 38.

n Create automatic reporting sets. See “Create Automatic Report Set,” on page 23.


n “Manage Billing Categories,” on page 35

n “About Product Consumption Reports,” on page 36

n “Generate a Product Consumption Report,” on page 38

Manage Billing CategoriesYou can indicate which license keys are billable by defining the billing category.

Procedure

1 Click Licenses link.

2 Click the Billing Categories tab.

VMware, Inc. 35

3 In the Billing Category drop-down menu, select a category.

Option Description

VSPP License key obtained through the VMware Service Provider Program. Allvirtual machines running on hosts with these keys are considered to bebillable.

Demo License keys that are not billable that can be used for environments such asdemonstration systems.

Perpetual License keys obtained outside of the VMware Service Provider Program.Virtual machines running on hosts with these keys are not consideredbillable.

About Product Consumption ReportsYou can use vCloud Usage Meter to generate different types of reports that monitor and track resourceconsumption by customer or by vSphere inventory object.

Monthly UsageThe monthly usage report provides information such as the product being monitored, the unit type beingmetered, and the associated consumption, including usage information by VSPP bundles.

Table 8‑1. Monthly Usage Report Details

Report Column Description

Product Product or VSPP bundle metered

Unit of Measure Unit being measured

Units to be Reported Quantity for the listed unit

BundleThe bundle report provides further information than the monthly usage report, related to bundleconsumption.

Table 8‑2. Bundle Report Details


vCloud Service Provider Bundle Type of bundle, such as Standard, Premier, or PremierPlus.

Capped Billed vRAM (GB-Hours) Capped billing memory (GB-Hours), used in billingcalculations

Hours Number of hours in the month

Average Result of capped memory divided by number of hours

Customer SummaryThe customer summary report summarizes customer activity.

Table 8‑3. Customer Summary Report Details


Customer Customer associated with product consumption

Country Customer’s country


36 VMware, Inc.

Table 8‑3. Customer Summary Report Details (Continued)


Postal Customer’s postal code

License Type License type being metered

Category vSphere license category

Billable Whether the vSphere license is billable

Billed vRAM (GB-Hours) Non-capped memory (GB-Hour)

Capped Billed vRAM (GB-Hours) Capped memory (GB-Hour). Used in billing calculations

Detailed BillingThe detailed billing report is a generic report that provides billing information for all types of vSpherelicenses. This report is also used for sending product consumption details to the aggregator assigned to theservice provider. Virtual machine use reported is based on which vSphere license keys are selected asVMware Service Provider Program keys.

Table 8‑4. Detailed Billing Report Details


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

Host DNS Name Host identifier, which can be IP address or FQDN,depending on how the host was configured withvCenter Server

Host RAM (GB) Host memory size in GB

vSphere License vSphere license type associated with vSphere host

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

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

VM CPUs Number of CPUs assigned to the virtual machine

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

Detailed UsageThe detailed usage report provides all product consumption-related information.

Table 8‑5. Detailed Usage Report Details


Time Day , hour, minute, and milliseconds of the reportingmonth

Customer Customer associated with record

Host DNS Name Host identifier, which can be IP address or FQDN,depending on how the host was configured withvCenter Server

Host RAM (GB) Host memory size in GB

vSphere License vSphere license type associated with vSphere host

VM VC Name Virtual machine name as listed in vCenter Server

Chapter 8 Reports

VMware, Inc. 37

Table 8‑5. Detailed Usage Report Details (Continued)


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 fromthe amount of reserved RAM assigned to the virtualmachine

VM CPUs Number of CPUs assigned to the virtual machine

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

License SummaryThe license summary report summarizes license type activity.

Table 8‑6. Customer Summary Report Details


Billable Whether the vSphere license is billable

Category vSphere license category

License Type License type being metered

Billed vRAM (GB-Hours) Non-capped memory (GB-Hour)

Capped Billed vRAM (GB-Hours) Capped memory (GB-Hour). Used in billing calculations

Customer ProductThe customer product report is included in monthly reporting if vCenter Site Recovery Manager is used toprotect the customer's virtual machines. Customers appear in the report if the vCenter Server folder andresource pool associated with a protection group are also mapped to the customer as part of the customer'srule definitions.

NOTE The reporting by vCloud Usage Meter on vCenter Site Recovery Manager should be used forreporting of normal operations only. Manual corrections may be needed when recovery plans have beenrun.

Table 8‑7. Customer Product Report Details


Customer Customer associated with the virtual machine

Product Product metered

Object Object type being used in metering a product

Generate a Product Consumption ReportYou can generate a report to monitor product consumption.

Some reports cover only one month, for others you can specify a range of months.

CAUTION If a report request is made with an API that is more than one month for a report that does notallow a range of months, the request will fail with an error message.


38 VMware, Inc.

Procedure

1 Click Reports link.

2 In the Report Type drop-down menu, select a report.

3 Select the report criteria.

You can select a customer, country, or postal code by typing part of the item and then locating it in thelist that appears. vCloud Usage Meter populates a list that matches the characters you typed.

4 (Optional) Select License Sets to report by license set.

Select a license set by typing part of the name and locating it in the list that appears.vCloud Usage Meter populates a list that matches the characters you typed.

5 Select the report's beginning and ending month and year.

6 In Per VM Memory Cap text box, enter a value.

7 Select how to view the report:

n Browse - view report in web browser. There is a 6000 limit on the total rows.

n To change total rows, log into virtual machine consle.

n Pause Tomcat service, enter service tomcat stop

n Goto: /usr/local/tcserver/vfabric-tc-server-standard/um/webapps/um/WEB-INF/classes/props/default.props

n Change browserReportLimit=<number of rows>

n To start Tomcat service, enter service tomcat start

n Export (tab separated) - save report to a file.

n Zip - select checkbox to save as a zip file.

n Submit to VSPP Business Portal - send report to portal

n Email - select checkbox to email report to designated addresses.

vCloud Usage Meter generates the report. vCloud Usage Meter retains the report in your browser's cacheuntil another report is generated or you log out from the virtual appliance.

Chapter 8 Reports

VMware, Inc. 39


40 VMware, Inc.

Support 9The Support link provides details on vCloud Usage Meter activities.

Sections include:

n Runtime Information

n Background Activity

n vCenter Server Extensions

n Database

n Logging Level

n Support Bundle


n “Review Diagnostic Information,” on page 41

n “Delete Older Data from the Database,” on page 42

n “View vCloud Usage Meter Logs,” on page 42

n “Change Logging Level,” on page 43

n “Change Log History Capacity,” on page 43

n “Generate a Support Bundle Log File Collection,” on page 44

n “Delete a Support Bundle Log File Collection,” on page 44

Review Diagnostic InformationYou can review system, runtime, and database information.

Prerequisites

Verify that you have user privileges.

Procedure

1 Click Support link.

VMware, Inc. 41

2 Review diagnostic activity information.

Option Description

Runtime Information Information such as heap used and Java arguments.

Background Activity Activity and status of collections.

vCenter Server Extensions Extensions of vCenter Server. A list of extensions is useful, for example, tosee if the Chargeback 2.5 extension is being discovered byvCloud Usage Meter.

3 Generate and review diagnostic database information.

Option Description

Display vCenter Servers and Hosts Displays table of details and Licenses.

Display vCenter Servers, Hosts andVirtual Machines

Displays additional VCHS deails., including instance UUID.

What to do next

n If desired, back up the database. See “Back Up the Database,” on page 46.

n If desired, delete old data. See “Delete Older Data from the Database,” on page 42.

Delete Older Data from the DatabaseYou can delete data older than a specified number of days.

Prerequisites


If you want to delete data still within the required VMware Service Provider Program retention period, youmust first back up the vCloud Usage Meter appliance.

Procedure


2 In Database section, click Delete Old Data.

3 On the Delete Old Data dialog, enter Age (days).

Data older than this number of days will be deleted. Deletion cannot be undone.

4 Enter CONFIRM.

5 Click Delete.

All data older than the specified number of days is deleted.

View vCloud Usage Meter LogsYou can view logs to monitor activities in the vCloud Usage Meter virtual appliance or to troubleshootproblems.

Prerequisites

n Verify that vSphere Client is installed.

n Verify that you have access to the location of the vCloud Usage Meter console.

n Verify that you have a password to log in to the vCloud Usage Meter console as root.


42 VMware, Inc.

Procedure

1 Log in to the virtual machine console.

2 Type /var/log/usgmtr/*.

Log information appears.

What to do next

n Review log level. See Chapter 9, “Support,” on page 41.

n Review log rolling capacity. See “Change Log History Capacity,” on page 43.

Change Logging LevelYou can change the logging level of vCloud Usage Meter to collect more details.

Prerequisites


Procedure


2 In the Logging Level area, select a level.

Option Description

Trace Do not select - not currently used.

Debug Additional log detail than Info. Log capacity fills faster.

Info All Warn, Error, and Fatal warnings.

Warn Warnings only. (Not recommended.)

Error Error warnings only. (Not recommended.)

Fatal Fatal warnings only. (Not recommended.)

What to do next

After review of logging activity, consider setting the level for minimum effect on log rolling capacity. See “Change Log History Capacity,” on page 43.

Change Log History CapacityYou can increase or decreate the amount of log history recorded by vCloud Usage Meter.

vCloud Usage Meter allots 100MB for log activity, before the older log history is deleted. Do not reduce thislog rolling capacity. IWhen the log level is increased, also increase the log rolling capacity. See “ChangeLogging Level,” on page 43.

Prerequisites




Procedure

1 Log in to the virtual machine console.

Chapter 9 Support

VMware, Inc. 43

2 Enter /usr/local/tcserver/vfabric-tc-server-standard/um/webapps/um/WEB-INF/classes/log4j.properties

3 Change the capacity.

Option Description

log4j.appender.roll.MaxFileSize=10MB

Enter a new maximum file size.

log4j.appender.roll.MaxBackupIndex=10

Enter a new maximum backup index.

What to do next

Review log history. Adjust the log rolling capacity to conserve resources.

Generate a Support Bundle Log File CollectionYou can generate support bundle collections of log files to help diagnose problems, as directed by technicalsupport.

Prerequisites


Procedure


2 In the Support Bundle area, click Generate.

3 Coordinate with technical support to diagnose problems.

Delete a Support Bundle Log File CollectionSupport bundles use disk space. Delete when no longer needed.

Prerequisites

Verify that you have user privileges and that the support bundles are no longer needed.

Procedure


2 In the Support Bundle area, click Delete support bundles to delete existing support bundle collectionsof log files.


44 VMware, Inc.

Advanced Management 10You can change default settings and perform other advanced management of vCloud Usage Meter. Theprocedures are available either in the vCloud Usage Meter Web application or through the console.


n “About User Activity and Process Notifications,” on page 45

n “Add ESXi Host Instances,” on page 45

n “Back Up the Database,” on page 46

n “Change TCP Port for vCenter Server Collections,” on page 47

n “Increase Collection Speed with Parallel Collections,” on page 47

n “Generate SSL Certificate for vCloud Usage Meter,” on page 48

n “Java Management Extensions for vCloud Usage Meter,” on page 49

About User Activity and Process NotificationsvCloud Usage Meter displays notices about user activities and background processes at the top of each Webapplication page. An example of a user activity notification is a confirmation that the service provider namewas changed in the contact details. A process notification can inform about system actions, i.e., generating aproduct consumption report.

Notifications persist from session to session unless cleared, or the vCloud Usage Meter virtual machine isrestarted.

You can also view notifications as part of a log. See “View vCloud Usage Meter Logs,” on page 42.

Add ESXi Host InstancesTo begin metering, you can add an ESXi host directly, whether or not it is managed by a vCenter Serverinstance. This is experimental in this release.

Add an ESXi host by following the same steps to add a vCenter Server instance.

Prerequisites

NOTE vAPP options and properties are functions of vCenter. When a virtual machine is deployed invCenter and if it has vAPP configuration, vCenter will not allow the VM to start until all properties are set.With ESXi, this is not the case, because ESXi is only a server and part of vCenter inventory.


VMware, Inc. 45

Verify vCloud Usage Meter virtual appliance details.




Procedure

1 Follow the procedure to add vCenter Server instances.

See “Add vCenter Server,” on page 13.

2 Log into the virtual machine consle.

3 Type service tomcat stop to pause the Tomcat service.

4 Change the enableNativeHosts value from n to y.

/usr/local/tcserver/vfabric-tc-server-standard/um/webapps/um/WEB-

INF/classes/props/default.props

enableNativeHosts=y

5 Enter service tomcat start to start the Tomcat service.

The ESXi host instance is added to the list of vCenter Server instances. If an error occurs, a message appearsand the host instance is not added.

Back Up the DatabaseYou can back up all product consumption data that vCloud Usage Meter collects. The data is maintained inthe virtual appliance database. Backups can be created in several formats. The resulting file can be used totroubleshoot or as a backup before upgrades.

Prerequisites




IMPORTANT All collected product consumption data is maintained in the virtual appliance database. Tomaintain history, do not delete thevCloud Usage Meter virtual appliance.

Procedure

1 Log into the vCloud Usage Meter virtual appliance.

2 Enter the command appropriate to the vCloud Usage Meter version.

n 3.2 and later - Enter cd /tmp then sudo -u usgmtr /opt/vmware/vpostgres/current/bin/pg_dumpusgmtr | gzip >umdump.sql.gz

n 3.1 - Enter cd /tmp, then sudo -u postgres /opt/vmware/vpostgres/9.2/bin/pg_dumpusage_meter_db | gzip >umdump.sql.gz

n Earlier than 3.1 - Enter cd /tmp, then sudo -u postgres pg_dump usage_meter_db | gzip>umdump.sql.gz

3 Backup file can be copied to other locations.

The database is saved to a file.


46 VMware, Inc.

Change TCP Port for vCenter Server CollectionsIf vCenter Server instances are configured for a port other than the default of 443, the vCloud Usage Meterconfiguration must match the new port.

Changing this port parameter should not be necessary for most users.

Prerequisites

Verify yourvCloud Usage Meter details.




Verify yourvCenter Server port value.

Procedure

1 Log into the virtual appliance console.

2 To pause the Tomcat service, enter service tomcat stop

3 Change the port value from 443 to the preferred value.



vCenterServerPort=<port>

4 To start the Tomcat service, enter service tomcat start

The port is changed for vCenter Server collections.

Increase Collection Speed with Parallel CollectionsIf there are multiple vCenter Server instances and collections need to proceed faster, turn on parallelcollections.

Prerequisites




Procedure

1 Log into the virtual machine console.

2 To pause Tomcat service, enter service tomcat stop

3 [identify the file name, then show the line] Change the 1 to a 5 in the collection parameter value.



maxConcurrentCollections=1

4 To start Tomcat service, enter service tomcat start

Parallel collections are enabled for up to five vCenter Server instances.

Chapter 10 Advanced Management

VMware, Inc. 47

What to do next

Monitor your collection speed. See Chapter 5, “Monitor,” on page 25.

Generate SSL Certificate for vCloud Usage MeterYou can generate the SSL certificate for the vCloud Usage Meter virtual appliance if it expires. This complieswith security polices and continuance of communication security over the Internet.

Prerequisites




Procedure


2 To pause Tomcat Service, enter service tomcat stop

3 Prepare to create the keystore file.

Option Description

Place keytool command on yourpath.

Enter export PATH=$PATH:/usr/java/latest/bin

Verify keytool command is on yourpath.

Enter which keytool. The system confirms the path. A typical responseis /usr/java/latest/bin/keytool.

Change directories. Enter cd /home/usgmtr/.

4 (Optional) Make a backup copy of the existing keystore file.

cp .keystore .keystore.bak

To restore the existing file, enter cp .keystore.bak .keystore.

5 Enter keytool -genkey -alias tomcat -keyalg RSA -keysize 2048 -keystore .keystore and followthe prompts to create a new keystore file.

Follow the prompts. The first is for domain first and last name (your domain name and extension). Ifordering a wildcard certificate, begin phrase with *, for example: *.example.com. Make a note of thekeystore password.

6 Enter keytool -certreq -alias tomcat -keyalg RSA -file example.com.csr -keystore .keystore,where example.com is domain name and extension, and enter the keystore password when prompted.

This action creates a certificate signing request file with the extension csr.

7 Send the certificate signing request file to a certificate authority (CA).

The certificate authority issues an SSL certificate file.

8 Enterkeytool -import -trustcacerts -alias tomcat -file certificate-from-ca.pem -keystore .keystore

to import the certificate file.

The system confirms the import.

9 Type Y to trust the certificate.

10 To start Tomcat Service, enter service tomcat start

The new SSL certificate is now in use.


48 VMware, Inc.

What to do next

To confirm that the SSL certificate is valid, open the URL for the vCloud Usage Meter Web application in abrowser.

Java Management Extensions for vCloud Usage MeterJava Management Extensions can be used to access internal data details of vCloud Usage Meter.

You can:

n Enable Java Management Extensions

n Connect with Client to JMX Service

n Disable Java Management Extensions

Enable Java Management ExtensionsEnable Java Management Extensions (JMX) service to gain access to internal data such as database size,customer count, customer rules count, and other information. You can use any JMX client to access thevCloud Usage Meter JMX service.

Prerequisites

Verify that you have a Java Management Extensions (JMX) client installed. JConsole is an example of a JMXclient.

Verify that you have a password to log in to the vCloud Usage Meterconsole as root.

Procedure


2 Enter cd /usr/local/tcserver/vfabric-tc-server-standard/um/conf/.

3 For the provided admin user, replace <password> with your desired password.

4 Enter /opt/vmware/cloudusagemetering/scripts/jmxcontrol.sh enable.

5 (Optional) To check JMX status, enter /opt/vmware/cloudusagemetering/scripts/jmxcontrol.sh status

Connect with the Java Management Extensions Client to Use the JMX ServiceConnect with your JMX client to use the JMX service. With JMX service you gain access to internal data suchas database size, customer count, customer rules count, and other information.

Prerequisites

Verify that you have enabled Java Management Extensions for vCloud Usage Meter. See “Enable JavaManagement Extensions,” on page 49.

Procedure

1 Type the IP address of the vCloud Usage Meter server.

2 Type port number 9003.

3 Type the user name monitorRole.

4 Type your JMX read-only user password.

Chapter 10 Advanced Management

VMware, Inc. 49

Disable Java Management ExtensionsDisable Java Management Extensions (JMX) service to remove access to internal data such as database size,customer count, customer rules count, and other information.

Prerequisites

Verify that you have a password to log in to the vCloud Usage Meterconsole as root.

Procedure


2 Enter /opt/vmware/cloudusagemetering/scripts/jmxcontrol.sh disable


50 VMware, Inc.

Installation 11vCloud Usage Meter is a virtual appliance installed with vSphere Client. Installation includes enteringconnection and configuration details.

Data collection speed is affected by the size of your data set and vCenter Server inventories. Write downdetails on system requirements and metering capacities.

For large data sets and vCenter Server inventories, you should consider the installation of more than onevCloud Usage Meter virtual appliances. Reported data can be consolidated from multiple virtual appliancesin monthly reports to individual VMware Service Provider Program aggregators.

For upgrades from previous versions, use the correct procedure.


n “System Requirements,” on page 51

n “TCP Port Configuration,” on page 52

n “Install with vSphere Client,” on page 53

n “Configure IP Pool,” on page 53

n “Change Time Zone,” on page 54

n “Configure Web Application Password,” on page 54

n “Upgrades,” on page 55

System RequirementsBefore installation, verify that your system meets the minimum requirements. Usage Meter is deployed on avCenter Server. Deployment on an ESXi host is possible with a vCenter Server license.

Web BrowsersThe vCloud Usage Meter Web application is compatible with:

n Microsoft Internet Explorer 8 and later releases

n Mozilla Firefox 7 and later releases

n Google Chrome 12 and later releases

Metered CapacitiesThe following metering of capacities is supported:

n 10 vCenter Server instances

VMware, Inc. 51

n 25,000 virtual machines

n 1,000 customers

n vCloud Service Provider bundle editions: Standard, Premier and Premier Plus

NOTE For higher capacities, parallel collections should be enabled. See “Increase Collection Speed withParallel Collections,” on page 47.

Hardware RequirementsThis is the minimum recommended hardware:

n Intel or AMD x86 processor - 2.0GHz or faster.

n RAM - 1,536MB or more.

n Disk storage - 40GB or more.

n 10/100 Ethernet adapter - 1,000Mbps is recommended.

Software RequirementsvCenter Server

vSphere Client

SSH client

LDAP RequirementsThese LDAP servers are supported:

n Microsoft Active Directory Server

n Microsoft Active Directory Server with SSL

n OpenLDAP

n OpenLDAP with SSL

TCP Port ConfigurationvCloud Usage Meter uses predetermined TCP ports. If network components are managed from outside afirewall, configure the firewall to allow access on the appropriate ports.

Table 11‑1. TCP Port Configurations

Port Source Target Purpose

22 vCloud Usage Meter Horizon Workspace - Data Executes reportingcommands

443 vCloud Usage Meter vCenter Server For vSphere API. Most userscan accept default. If changeis required, see “ChangeTCP Port for vCenter ServerCollections,” on page 47.

8443 Client browser vCloud Usage Meter For the Web application

9003 Jconsole or custom JMXclient

vCloud Usage Meter For Java ManagementExtensions (JMX)

9007 vCloud Usage Meter SRM Server Invoking SRM APIs onserver


52 VMware, Inc.

Install with vSphere ClientInstall vCloud Usage Meter with vSphere Client.

Prerequisites

n Download and save the vCloud Usage Meter OVA installation file from http://www.vmware.com/download/download.do?downloadGroup=UMSV32.

n Verify vSphere Client is installed with read-only administrator privileges.

Procedure

1 Open vSphere Client.

2 On the File drop-down menu in t, click Deploy OVF template.

3 On the Deploy OVF Template dialog, specify the location of the saved OVA file.

4 Review and verify the OVF template details.

5 Accept the end-user license agreement.

6 Specify a name and inventory location.

7 Select the resource pool.

8 Select the data store.

9 Select the disk format of the virtual disks.

10 Select a network for the installed template.

11 Select the allocation policy to allocate IP addresses.

12 Type a password for the root account.

CAUTION KEEP A RECORD OF THE ROOT PASSWORD!! Password cannot be recovered. If thepassword is lost, ALL appliance admin control is lost.

13 On the Ready to Complete dialog, confirm the information and click Finish.

The installer starts the deployment process.

What to do next

If the IP allocation policy was set to Fixed, configure an IP pool for vCloud Usage Meter. See “Configure IPPool,” on page 53.

Set the vCloud Usage Meter appliance vRAM as needed. Most service providers can use the 2048MBdefault. Monitor memory usage on the Support page and adjust as needed.

Configure IP PoolWhen vCloud Usage Meter is installed with a fixed IP policy, create an associated IP pool.

Because the OVF template uses network properties, vCloud Usage Meter might not work correctly unlessassigned networks have an associated IP pool. If not, the vCloud Usage Meter virtual machine does notpower on and users get a message that there is no associated network protocol profile.

Prerequisites

n Verify vSphere Client is installed and you have read-only administrator privileges.

Chapter 11 Installation

VMware, Inc. 53

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

n Verify vCloud Usage Meter is installed and you can navigate to the data center. See “Install withvSphere Client,” on page 53.

n LIst the IP pool configuration details.

Procedure

1 In the vSphere Client, Inventory tree, click the data center that contains the vCloud Usage Meter virtualmachine.

2 On the IP Pools tab, click Add. On the dialong, enter IP pool details.

n Name

n Subnet and Gateway (do not select Enable IP Pool).

3 On the DNS tab, enter:

n DNS domain

n Seach Path

n IPv4 DNS Server details

4 On the Associations tab:

n Select networks to associate with the IP pool

5 Click OK.

The IP pool has been created.

What to do next

Power on the virtual machine and configure virtual machine details.

Change Time ZoneThe vCloud Usage Meter virtual machine's clock is not synchronized at OVF deployment, which can causetime reporting inconsistencies in your collections. Change the time zone in the vCloud Usage Meter virtualmachine console.

Prerequisites

Verify that the vCloud Usage Meter virtual machine is powered on.

Procedure

1 In vSphere Client, open the virtual console and select Set Timezone.

2 Press Enter.

3 Change your time zone.

4 Type service tomcat restart to restart the Tomcat service.

5 Type exit to return to the virtual machine console.

Configure Web Application PasswordConfigure your Web application password and note the URL so you can provide credentials to your users.

Prerequisites

Verify that the vCloud Usage Meter virtual machine is powered on.


54 VMware, Inc.

Procedure

1 In vSphere Client, open the virtual console and select Login.

2 Press Enter.

3 Type root and the password that was configured at installation and press Enter.

4 To create your Web application password, at the prompt, type webpass and press Enter.

5 Type a Web application password.

NOTE Keep a record of the Web application password.

6 Type exit to return to the virtual machine console.

What to do next

n Note the URL for accessing the vCloud Usage Meter Web application that appears in the console.

n Provide user credentials to your users.

UpgradesThere are three ways to migrate vCloud Usage Meter from an older version to the latest version (3.3). ForApply a One path 3.2 to version 3.3.provides a newer, more secure virtual appliance, based on SUSE LinuxEnterprise Server 11 Service Pack 2. You do not upgrade an earlier appliance. Instead, you can migrate datato vCloud Usage Meter 3.2 from older versions 2.3.2 through 3.1

n Version 3.3 beta to 3.3 GA

n Version 3.2 to 3.3 GA

n Versions 2.3.2 through 3.1 to 3.3 GA

Upgrade Versions 2.3.2 - 3.1 to 3.3 GAThis is the process to bring the vCloud Usage Meter content from versions 2.3.2 through 3.1 into the 3.3 GAenvironment. This procedure migrates data from the previous version into 3.3 GA. The 3.3 GA is based onSUSE Linux Enterprise Server 11 Service Pack 2.

Prerequisites

n Back up or snapshot the vCloud Usage Meter virtual appliance that you are migrating from, in case anunexpected error occurs during the migrate process.

n Verify that you are migrating from vCloud Usage Meter 2.3.2 or later. This procedure does not work forversions earlier than 2.3.2.

n Verify that you have the TCP hostname or IP address of the older vCloud Usage Meter virtualappliance, and its root and Web application passwords.

n Verify vCloud Usage Meter 3.3 has been properly installed and you have the root password.


VMware, Inc. 55

Procedure

1 Prepare the older vCloud Usage Meter appliance:

a In vSphere Client, open the older vCloud Usage Meter appliance virtual console and log in as theroot user.

b If the root password is still set to the default password vmware for the older vCloud Usage Meterappliance, change it from the default.

Option Description

Enter passwd Type the command to change the password and press Enter.

Enter new password Type a new password and make a record of it.

c On the older vCloud Usage Meter virtual appliance, enter service sshd start to turn on sshd.

2 Migrate the data to the 3.3 GA virtual appliance.

a In vSphere Client, open the 3.3 GA appliance virtual console and log in as the root user.

b Type importum hostname version, where hostname is the TCP hostname or IP address of the oldervCloud Usage Meter virtual appliance, and the version is 232, 300, 302, or 310.

The command uses ssh and scp to export the database from the old system, and copies it and akeystore file to 3.3 GA. There are two prompts for the root password of the older system, once byssh and once by scp. Ignor log file messages: ERROR: must be owner of extension plpgsql orWARNING: no privileges could be revoked for "public" .

3 On older vCloud Usage Meter virtual appliance console, enter service sshd stop to turn off sshd.

4 Log in to the 3.3 GA Web application to review and accept the security information for all products.

Option Description

Log in to 3.3 GA appliance Log in with the Web application password of the oldervCloud Usage Meter virtual appliance. The migration sets the password ofthe 3.2 virtual machine to the password of the older system.

Go to the Products tab Click the Manage page, then the Products tab.

Open and re-save server credentials Click Edit, then Save. for each product server Note that there is no need toretype credentials. This action displays the server's security information.

Verify security information Review the server's security information and click Accept.

The data of the older vCloud Usage Meter virtual appliance is migrated to the 3.3 GA virtual appliance. Runthis in parallel with the old system while you verify that it is working correctly. The migration steps morethan once.

What to do next

Manage collection speed, if needed. Any changes made to web.xml on the old system are not preserved. See “Increase Collection Speed with Parallel Collections,” on page 47.

If desired, change the Web application password of the 3.3 GA virtual appliance. See “Configure WebApplication Password,” on page 54.

Upgrade from version 3.2 to 3.3 GAThis process upgrades from vCloud Usage Meter virtual appliance version 3.2 to 3.3 GA.

Prerequisites

Back up or snapshot the vCloud Usage Meter virtual appliance that you are migrating from, in case anunexpected error occurs during the migrate process.


56 VMware, Inc.

Verify that you have the TCP hostname or IP address of the older vCloud Usage Meter virtual appliance,and its root and Web application passwords

Verify vCloud Usage Meter 3.3 has been properly installed and you have the root password

Procedure

1 Transfer the patch file, usage-meter-330-update.zip to /root in the appliance

2 Unzip usage-meter-330-update.zip

3 Enter cd usage-meter-330-update

4 Enter ./update-um

Appliance is upgraded to 3.3 GA.

What to do next

Monitor results to ensure continuous data collection.

Upgrade from version 3.3 Beta to 3.3 GAThis process upgrades from vCloud Usage Meter virtual appliance version 3.3 Beta to 3.3 GA.

Prerequisites

Back up or snapshot the vCloud Usage Meter virtual appliance that you are migrating from, in case anunexpected error occurs during the migrate process.

Verify that you have the TCP hostname or IP address of the older vCloud Usage Meter virtual appliance,and its root and Web application passwords

Verify vCloud Usage Meter 3.3 has been properly installed and you have the root password

Procedure

1 Transfer the patch file, usage-meter-330-update.zip to /root in the appliance.

2 Unzip usage-meter-330-update.zip

3 Enter cd usage-meter-330-update

4 Enter ./update-um

Appliance is upgraded to 3.3 GA.

What to do next

Monitor results to ensure continuous data collection.


VMware, Inc. 57


58 VMware, Inc.

Index

AActive Directory 18advanced management overview 45API 18authenticate servers 17automatic reporting sets

creating 23editing 24removing 24

Bbilling categories, managing 35browsers, supported 51

Ccapacities, metered 51Chargeback 2.5 extension 41collections

configure testing 18configure timing 18failed 12successful 12troubleshooting speed 47viewing success or failure 25

customersadd for metering 27edit metering details 28exporting 30importing 28overview 27remove from metering 28requiring confidentiality 27

Ddata, migrate or import 55database

backing up 46delete older data 42

Eemail alerts, configuring 12ESXi host, add for metering 45

Ffirewall port configuration 52

HHorizon Workspace - Data, add to vCloud Usage

Meter 16

Iinstallation

configure time zone 54firewall ports configuration 52overview 51virtual appliance 51

IP pool, configure 53

JJava Management Extensions service 49, 50

LLDAP authentication,configuring 18licenses

creating sets 21editing sets 22managing billing category 35removing sets 22

log file, collection 44logs

changing history capacity 43changing level 43generating support bundles 41overview 41rolling 43viewing 42

Nnotifications 45

Oobject types

understanding 33using in rules 28, 31

outgoing email server, configuring 12

Ppoll start time, configuring 18products

activate 17edit metering details 16inactivate 17

VMware, Inc. 59

remove from metering 17versions metered 8

Rreports

generating 38overview 35, 36

restricted status, customers 27, 28RSA key fingerprint 17rules

add for metering customers 27, 31, 33edit details 32exporting 30importing 28removing 32

Sserver host key fingerprint 17service provider contact details, configuring 11settings, overview 11SSL certificate, generating 48support bundles 41, 44system requirements

hardware 51software 51

Ttab separated file 28, 30TCP ports, configuring 52TCP Port, configuring for a different vCenter

Server port 47time zone, configuring 54troubleshooting

accessing Java Management Extensions 49connecting with the JMX client 49generating diagnostic information 41

Vvalue types

understanding 33using in rules 28, 31

vCenter Server, changing the default port 47vCenter Servers, add for metering 13vCenter Site Recovery Manager, add for

metering 13vCloud Director, add to vCloud Usage Meter 12vCloud Integration Manager, add to vCloud

Usage Meter 15vCloud Usage Meter

book audience 5introduction to 7service provider workflow 7

vCloud Usage Meter API 7, 52virtual machine mapping 31

VMware Service Provider Program 7, 27, 31,35, 36, 51

vSphere inventory 31

WWeb application password, configure 54


60 VMware, Inc.

Documents

VCloud Usage Meter User's Guide 3.3