Version 2.3 User Guide

Transcription

1 V Mware vcloud Usage Meter Version 2.3 User Guide 2012 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 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 VMware, Inc. All rights reserved. Page 2 of 20

2 Contents Installing VMware vcloud Usage Meter... 5 Software Requirements... 5 Hardware Requirements... 5 Configuration Maximums... 5 Deploy VMware vcloud Usage Meter Through vcenter Server... 5 Deploy vcloud Usage Meter Through vsphere Host... 7 Change Password and Time Zone Details... 8 Upgrading vcloud Usage Meter... 9 Managing VMware vcloud Usage Meter... 9 Service Provider... 9 vcenter Servers... 9 Site Recovery Servers Outgoing Server Collector Alerts License Management License Sets License Categories Automatic Reporting Customer Management Add Customer Delete Customers Import/Export Customers Customer Rules Create Rules through User Interface Generating Reports About Reports Detailed Billing Report Detailed Usage Report Customer Summary Report VMware, Inc. All rights reserved. Page 3 of 20

3 License Summary Report Product Report Customer Product Report Generate a Report Support VMware, Inc. All rights reserved. Page 4 of 20

4 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 8 and later releases Mozilla Firefox 7 and later releases Google Chrome 12 and later releases When working with large datasets of virtual machines and vcenter Server inventory objects, i.e. greater than 10,000 virtual machines and 2500 vcenter Server inventory objects respectively, it is recommended to have at least 750MB of RAM available on the client to page result efficiently. 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 o o o 2.0GHz or faster Inter or AMD x86 processor 2.5GB or more RAM 40GB or more disk storage 10/100 Ethernet adapter (Gigabit recommended) Configuration Maximums Each vcloud Usage Meter appliance has been configured to support metering of 10 vcenter Servers 10,000 virtual machines Customers 2500 vcenter Inventory objects Deploy VMware vcloud Usage Meter Through vcenter Server

5 You can deploy VMware vcloud Usage Meter as a virtual appliance through VMware vcenter Server. Prerequisites o Download the OVA installation file from and save it to your local machine. o Ensure that you have vsphere Client installed 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 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 VMware vcenter Server 4.0 Update 2 VMware vcenter Server 4.0 Update 3 VMware vcenter Server 4.1 VMware vcenter Server 4.1 Update 1 Page 6 of 20

6 vcenter Server Versions VMware vcenter Server 5.0 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 and save it to your local machine. o Ensure that you have vsphere Client installed 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 Table 2: Supported vsphere Hosts Supported vsphere Versions VMware ESX 4.0 VMware ESX 4.0 Update 1 Page 7 of 20

7 Supported vsphere Versions VMware ESX 4.0 Update 2 VMware ESX 4.0 Update 3 VMware ESX 4.1 VMware ESX 4.1 Update 1 VMware ESXi 4.0 VMware ESXi 4.0 Update 1 VMware ESXi 4.0 Update 2 VMware ESXi 4.0 Update 3 VMware ESXi 4.1 VMware ESXi 4.1 Update 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 o Successfully deploy vcloud Usage Meter. Power on the virtual machine 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 with no arguments for directions. /opt/vmware/cloudusagemetering/scripts/webpass.sh Execute the arguments for the role, service provider <s> or aggregator <a>, you wish to run as. Example: /opt/vmware/cloudusagemetering/scripts/webpass.sh set s Page 8 of 20

8 7. A password prompt will be displayed. Enter the password and hit return. 8. Type Exit to return to the virtual machine console and reset your time zone. 9. On the virtual machine console, navigate to Set Timezone and press Enter. By default, NTP has not been configured for virtual appliance. 10. Select your time zone and press Enter. 11. To reflect the changed time zone you must restart the tomcat service. 12. 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 At the time of publication, upgrade from vcloud Usage Meter releases version 2.2 and newer is not supported. It is recommended to install version 2.3 before next month s billing cycle to ensure all the records are available. 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. Review the required and optional steps as part of the configuration process for the service provider roll. Functionality listed in this section 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 and customer usage. Failure to enter details will result in failed vcenter collections in addition to incomplete monthly reports. 1. Click Manage Tab 2. Enter Company 3. Enter Contact Name 4. Enter Phone Number 5. Enter 6. Click Save when completed to commit changes. Dialog message will appear in upper left of browser window confirming service provider changes have been saved. vcenter Servers 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. The vcloud Usage Meter does not support metering vsphere hosts directly 1. Click Manage tab 2. Click Add Page 9 of 20

9 3. Enter IP Address 4. Enter User Name. Read-Only administrator privileges required. 5. Enter Password. 7. Click Save when completed to commit changes. Dialog message will appear in upper left of browser window confirming changes In order to test the vcenter Server address and credentials when saving, enable the Test Before Saving check box. If there is an error connecting to the vcenter Server, an error message will be displayed and the vcenter Server will not be added to the list for collections. The default value for the Test Before Saving check box is set to enabled. Site Recovery Servers Configure Site Recovery Manager Servers and their relationships to vcenter Servers. Only one Site Recovery Manager Server, located at the protected or recovery site, needs to be configured for metering. 1. Click Add tab 2. Enter Host Name or IP for SRM Server 3. Enter User of vcenter Server 4. Enter Password of vcenter Server 5. Select vcenter Server to pair to SRM Server 6. Click Save when completed to commit changes In order to test the SRM Server address and credentials when saving, enable the Test Before Saving check box. If there is an error connecting to the SRM Server, an error message will be displayed and the vcenter Server will not be added to the list for collections. The default value for the Test Before Saving check box is set to enabled. Outgoing Server Configure the outgoing server to receive automatic monthly billing reports and alerts of failed and successful collections. 7. Click Manage tab 8. Enter Host 9. Enter User (if required) 10. Enter Password (if required) 11. Click Save when completed to commit changes. 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. Page 10 of 20

10 Click Test to verify that the collection process is working correctly. alerts must be set in advance to receive results. Alerts To monitor the metering of vcenter Servers, there is the option to receive alerts after successful or failed collections. 1. Enter From Enter To . If more than one address is to be entered, separate out address with a comma (example: jdoe@vmware.com, ddoe@vmware.com). 3. Select whether successful or failed collection s will be received. 4. Select Send a test alert after saving to verify that the outgoing server is working correctly and that the alerts will be sent. 5. Click Save when completed to commit changes. License Management License Sets License Sets provides a mechanism to associate virtual machine vram usage with one or more vsphere license keys which can be used to group vram usage based on Aggregator, location, customer, or other organization structure required by the aggregator. Available licenses to use with License Sets are displayed as name or type of vsphere license, license code, vcenter Servers where license key is deployed, and number of hosts associated with each vsphere license. for creating License Set 1. Click Licenses tab 2. Enter License Set name and click New. 3. Select newly created License Set 4. Select licenses to associate with License Set. Licenses can span more than one licenses set. to delete License Set 1. Click Licenses tab 2. Select License Set 3. Click Delete 4. Confirm deletion of License Set. License Set is deleted. to edit License Set 1. Click Licenses tab 2. Select License Set 3. Edit by changing the licenses associated with the License Set. Page 11 of 20

11 License Categories vsphere license keys deployed by service providers may have different billing characteristics and the vcloud Usage Meter provides the ability to indicate which vsphere license keys are billable by defining the licensing category. Fields defined in the license categories include the name or type of vsphere license, license code, vcenter Servers where license key is deployed, and default license categories defined below. VSPP License key obtained through VSPP and all virtual machines running on hosts with these keys are considered to be billable. Perpetual License keys obtained outside of the VSPP program and virtual machines running on hosts with these keys are not considered billable. Demo License keys that are not billable that can be used for environments such as demo systems and View deployments. vsphere licenses keys will be updated after a successful vcenter query. Once the keys are available, the Category can be modified to represent the correct license category. By default, the Category is set to VSPP. If license key is no longer present in a vcenter Server, the license is removed from the licenses to manage in the License Categories. Changes made to the license categories are saved after modification. Automatic Reporting You can set up Usage Meter to automatically generate reports and them to an Aggregator, or elsewhere. Service providers who report to multiple aggregators can set up an automatic report for each one, using a different license set for each (see Licenses). To select an automatic report, use the Name select control. The form on the right presents the report details. To create or change a report, enter details in the form and push Save. Use the Delete button to delete the selected report. to create Automatic Report 1. Click Automatic Reporting tab 2. Enter Name of Automatic Report 3. Select Reporting Day on which to generate reports 4. Select the Reports to Include 5. Select the License Set to associate with reports 6. Enter sender and recipient 7. Click Save to edit Automatic Report Page 12 of 20

12 1. Click Automatic Reporting tab 2. Select Name of Automatic Report 3. Update Reporting Day, Reports to Include, License Set, or 4. Click Save to create Delete Report 1. Click Automatic Reporting tab 2. Select Automatic Report from Dropdown 3. Click Delete Customer Management The vcloud Usage meter provides the ability to add, edit, delete, export, and import customers that are using service provider resources. Customers details stored in a vcloud Usage Meter appliance are not shared among other vcloud Usage Meter appliances and must be exported and imported into in order to share changes. Add Customer Add a customer through the vcloud Usage Meter user interface. for importing customers 1. Click Customers tab 2. Click Add and a new dialog window appears 3. Enter unique customer Name 4. Select Country 5. Enter Postal Code 6. Click Save Delete Customers Customers can be deleted from the vcloud Usage Meter by accessing the Customer tab and working with the existing customers. When deleting a customer from the vcloud Usage Meter, all Rules associated with the customers are also removed from the system. 1. Select one or more customers to be deleted. 2. Click the Delete Multiple button. Button will display how many customers are being deleted. 3. vcloud Usage Meter will display confirmation dialog to confirm customer deletion. Click Yes to remove customers and Cancel will exit out of delete transaction. Page 13 of 20

13 Import/Export Customers Customer and rules can be imported into the vcloud Usage Meter via a tab separated file. This file can be manually generated or be an exported customers and customers rules list from another vcloud Usage Meter appliance. The Usage Meter allows for import of Customers only, Customers and Rules, or Rules only and duplicates are not permitted. for importing customers 7. Click Customers tab 8. Browse to file to be uploaded and click Import 9. If import completes without error, a new page is displayed with the message Importing completed with no errors. Click Customer tab to return to the Customer management interface. Customers that are considered to be restricted are not allowed to be imported via the tab separated file and must be entered manually. If import of customers fails, an error message indicating the line number, text associated with the line producing the error, and the error message are displayed. for exporting customers 1. Click Customers tab 2. Click Export All button 3. A new dialog window is presented in order to save the customers and customer s rules as a tab separated text file. Customer Rules Customer rules enable the Service Provider to associate vcenter Server objects with a customer s cloud infrastructure to enable monthly customer usage reporting as defined in the VSPP Program Guide and VSPP Product Guide. The vcloud Usage Meter provides the Service Provider with granular control of vcenter Server inventory where they are able link objects in the vcenter Server inventory from as high as the vcenter Server down to the individual unique ID for a virtual machine or IP address. Refer to the Reports section and Customer Summary Report to review customer s monthly usage after creating rules. Create Rules through User Interface There are several options for assigning the customer rules to the customer which include creating the relationship through the user interface or by importing a tab separated file with customer and customer rules defined. When working with the user interface, use the following procedure to link a rule to a customer. 1. Click Rules tab Page 14 of 20

14 2. Enter Customer name. Customer name has autocomplete functionality enabled to assist with finding customer. After each letter entered there is a slight delay as the customer list is populated based on values entered. Complete name manually or select the customer from the filtered list provided to assign customer to work with. 3. Create Rules to be associated with customer using vsphere Inventory Tree (Option 1) The vsphere Inventory filter is linked to those vcenter Servers that the vcloud Usage Meter is collecting usage data for. By default, all objects in the vcenter Server inventory are collected for each vcenter Server. Objects displayed in the vsphere Inventory filter can then be reduced by entering text related to the customer s vcenter Server objects followed by clicking Filter. The vcenter Servers, and objects contained within them, can then be expanded or collapsed by manually or clicking the Expand All or Collapse All buttons to display those objects that match the entered text. Select the vsphere Inventory Object associated with the customer. By using the vsphere Inventory Tree, a Unique ID or mapping between the vcenter Server ID and moref is created to link the customer to the associated vsphere Inventory object and the details of that mapping are displayed under the Create Rules section. If the mapping is correct, click Create and the Current Rules is updated with the new rule to be associated with the customer. Click Show customer virtual machines to view all virtual machines associated with all customer rules created. During customer rules creation, if there is a conflict with another customer rule an error message is displayed to the end user with customer and virtual machines affected and the rule is not created. Click Reset Filter to reset search criteria. 4. Create Rules to be associated with customer using Create Rules (Option 2) a. Select Object Type. Refer to the Supported methods for mapping customers to rules below for more details on methods permitted. b. Select Value Type. Exact String, Substring, Regular Expression, and CIDR Notation apply to all vcenter Servers registered with vcloud Usage Meter appliance. c. Enter Value to be associated with the customer d. Click Create and the Current Rules are updated with the new rule to be associated with the customer. Click Show customer virtual machines to view all virtual machines associated with all customer rules created. During customer rules creation, if there is a conflict with another customer rule an error message is displayed to the end user with customer and virtual machines affected and the rule is not created. Table 3: Supported methods for mapping customers to rules Unique ID Exact String Substring Regular Expression CIDR Notation VM X VM vcenter Name X X X Page 15 of 20

15 Unique ID Exact String Substring Regular Expression CIDR Notation VM DNS Name X X X IP V4 address X Folder X X X X Resource Pool X X X X vapp X X X X Host Cluster Data Center vcenter Server X X X X Delete Customers Rules Customer s rules can be deleted from the vcloud Usage Meter by accessing the Rules tab and working with the existing customers and rules. When deleting customer s rules from the vcloud Usage Meter, only the relationship between the vsphere Inventory object and the customer is removed. All usage data associated with the virtual machines is still maintained. 1. Select Rules tab 2. Enter Customer. Rules associated with customer are displayed. 3. Select the checkbox associated with the rules to be deleted 4. Click Delete Selected 5. Confirm deletion and rules are removed from customer 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 Page 16 of 20

16 About Reports There are 6 different reports that can be generated from the vcloud Usage Meter. Previous report executed will remain cached in browser until another report is generated or logout from vcloud Usage Meter Appliances 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 (optional). 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 4: Detailed Billing Report Details Report Column Time Service Provider Host DNS Name Host Memory Size (KB) VM RAM (MB) Billing RAM (MB) VM CPUs VM Instance UUID Description Day of the reporting month, hour, minute, and milliseconds Name of the service provider associated with the report Host identifier which can be IP address or FQDN depending on how the host was configured with vcenter Host memory size displayed in KB Configured virtual RAM for the virtual machine Billing virtual RAM for the virtual machine calculated from the amount of reserved RAM assigned to the virtual machine Number of CPUs assigned to the virtual machine 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. Table 5: Detailed Usage Report Details Report Column Time Customer Description Day of the reporting month, hour, minute, and milliseconds Customer associated with record Page 17 of 20

17 Report Column Host DNS Name Host RAM (GM) vsphere Licenses VM VC Name VM Hostname VM RAM (MB) Billing RAM (MB) VM CPUs VM Instance UUID Description Host identifier which can be IP address or FQDN depending on how the host was configured with vcenter Host memory size displayed in GB vsphere license type associated with vsphere host Virtual machine name as listed in vcenter Server Virtual machine DNS name Configured virtual RAM for the virtual machine Billing virtual RAM for the virtual machine calculated from the amount of reserved RAM assigned to the virtual machine Number of CPUs assigned to the virtual machine Unique identifier for virtual machine to assist with identification and audit Customer Summary Report This report provides information such as customer, vsphere license type, category, if license is billable, Billed vram in GB, and Capped Billed vram in GB. Un-capped and capped memory totals are based on the sum of all hourly collections for each license type. This report is sent to the aggregator on to report on customer vram usage at the service provider. Table 6: Customer Summary Report Details Report Column Customer License Type Category Billable Billed vram (GB-Hour) Capped Billed vram (GB-Hour) Description Customer associated with usage License type being metered. vsphere license category If the vsphere license is billable and sent to aggregator Non-Capped Memory (GB-Hour) Capped Memory (GB-Hour) Used in billing calculation Page 18 of 20

18 License Summary Report This report provides information such as vsphere license type, category, if license is billable, Billed vram in GB, and Capped Billed vram in GB. Un-capped and capped memory totals are based on the sum of all hourly collections for each license type. This report replaces the Aggregate Billing report for vcloud Usage Meter releases previous to version 2.3 and is sent to the aggregator for use in monthly reporting. Table 7: License Summary Report Details Report Column Billable Category License Type Billed vram (GB-Hour) Capped Billed vram (GB-Hour) Description If the vsphere license is billable and sent to aggregator vsphere license category License type being metered. Non-Capped Memory (GB-Hour) Capped Memory (GB-Hour) Used in billing calculation Product Report This report provides information such the product being monitored, the metric being metered on, and the associated monthly usage. This report will be included in monthly reporting if Site Recovery Manage is used to protect customer s virtual machines. Table 8: Product Report Details Report Column Product Metric Type Value Description Product metered Metric being used to meter product Monthly usage for product Customer Product Report This report provides lists the customers and virtual machines protected by Site Recovery Manager. Customers will be displayed in the report if the vcenter Server Folder and vcenter Resource Pool associated with a protection group are also mapped to the customer as part of the customers rules definitions. Virtual machines will be displayed in this report if they are protected for one or more days during the month. Page 19 of 20

19 Table 9: Customer Product Report Details Report Column Customer Product Object Description Customer associated with virtual machine Product metered Metric being used to meter product Generate a Report A report can be generated manually at any time and can be exported as a tab separated file or zip when a large number of records are returned. Support 1. Click Report tab. 2. Select Report Type 3. Select specific Customers, Countries, or Postal Codes or select All to return all records 4. Select License Set or leave blank to return all records 5. Select Month and Year 6. Per VM Memory Cap is defaulted to 24 GB, but can be modified by the end user 7. Click Browse to generate report or Export to save report to file Support logs for vcloud Usage Meter are available through the console at /var/log/usgmtr/* or available through the user interface at using the following procedure. 1. Select Support tab 2. Click Get Appliance Log File 3. Save log file to specified directory Only the current log file is use exported. All log files can be accessed and exported through console. vcloud Usage Meter, User Guide and FAQ available at: Technical Support VMware GSS handles support for Service Providers and Aggregators with vsphere or vcloud entitlements Customers with no entitlements go to vcloudusagemeter@vmware.com Page 20 of 20

20 VSPP Program and Pricing Updated guide coming online in March Review release notes for a list of know issues Page 21 of 20