VMware vCenter Chargeback Manager Connector For IT Business Management Suite

VMware vCenter Chargeback Manager Connector For IT Business Management Suite
Technical Note
vCenter Chargeback Manager Connector
For IT Business Management Suite
vCenter Chargeback Manager 2.0 and IT Business Management Suite 7.1 and 7.1.1
About the Connector
vCenter Chargeback Manager is an end‐to‐end cost reporting solution for virtual environments that leverages integration with VMware vSphere and VMware vCloud Director. If you have a VMware vCloud Director setup, you can install the vCloud Director Data Collector and configure it appropriately to integrate vCloud Director with vCenter Chargeback Manager. You can then generate cost and usage reports classified under different categories, such as Pay‐As‐You‐Go, Reservation, and Allocation Pool. vCenter Chargeback Manager interacts with the vCenter Server database and retrieves usage information, calculates the cost by using the defined chargeback formulas, and generates cost and usage reports for your virtual infrastructure.
The VMware IT Business Management Suite provides you with visibility into the costs, utilization, and service levels of end‐to‐end IT services. CIOs can plan, manage, and optimize the cost, value, and alternatives in the emerging world of dynamic IT by using the IT Business Management Suite. IT Business Management Suite has a multi‐tiered set of allocation rules and Cost Objects called Cost Model. It maps the financial relationships between expenses and other objects within the organization. The Cost Model diagram is a visual representation of the Cost Model high‐level structure. It illustrates cost flow throughout the organization.
The vCenter Chargeback Manager connector for IT Business Management Suite is a Windows‐based application that obtains the virtualization costs from vCenter Chargeback Manager and provides this cost data to IT Business Management Suite so that it can include the virtualization costs in the Cost Model. The connector scans vCenter Chargeback Manager for a specific hierarchy and creates a report schedule in vCenter Chargeback Manager to generate cost report for this hierarchy on a daily basis. The connector also fetches the generated and archived report, and provides the cost data for each virtual machine in the hierarchy to IT Business Management Suite. IT Business Management Suite populates detailed analysis and reports in its Cost Model and dashboard.
In an integrated setup, the connector and the vCenter Chargeback Manager are deployed on‐site, while the IT Business Management Suite is deployed as a SaaS application. The integration of vCenter Chargeback Manager with IT Business Management Suite provides CIOs visibility across all IT assets, and enables them to easily identify the cost reduction opportunities by comparing virtualization costs and physical costs.
How Does the Connector Work?
The connector is configured to connect to vCenter Chargeback Manager, a vCenter Server, and an SFTP Server of the IT Business Management Suite. After the connector is configured and started, the connector runs a job every hour that scans the vCenter Chargeback Manager for any hierarchy that has the custom attribute ITBM set to yes on the root of the hierarchy. If the connector finds such a hierarchy, it creates a report schedule in vCenter Chargeback Manager to generate a cost report for the hierarchy on a daily basis. The report is generated using the Default Chargeback Cost Model.
VMware, Inc.
1
vCenter Chargeback Manager Connector For IT Business Management Suite
The connector then fetches the daily report in the XML format and creates a CSV report based on the cost data included in the XML report. The CSV report contains the following information:

Virtual machine name: Name of the virtual machine.

Total cost: Total cost of the virtual machine.

Start time: The start time of the reporting period.

End time: The end time of the reporting period.

ESX/ESXi host IP: The IP address of the ESX/ESXi host on which the virtual machine is residing at the time of report generation. The ESX/ESXi host IP address for each virtual machine is obtained by the connector from the vCenter Server configured on it.
The generated CSV file is then zipped and uploaded on to the SFTP server configured on the connector. If the upload is successful, the connector backs up the XML report, the CSV report, and the ZIP of the CSV report.
NOTE The connector periodically creates a local cache of files in the root folder of the connector. Once the upload to SFTP server is successful, the files (.xml, .csv, .zip) are moved to the backup folder. The size of the folder might increase over a period of time. You should clean up the backup folder to free up disk space. Do not delete the files in the root folder, since the root folder contains files that have not been uploaded to the SFTP server.
Prerequisites
You must ensure the following for the connector to work successfully:

The vCenter Chargeback Manager has only one hierarchy with the custom attribute ITBM set to yes on the root of the hierarchy.

The hierarchy contains entities only from the vCenter Server that is configured on the connector. The hierarchy must not contain entities from other vCenter Servers.
Install the Connector
The connector can be installed and run on any Windows machine that is on a network and can connect to the vCenter Chargeback Manager, vCenter Server, and the SFTP server. To install the connector, perform the following tasks:
1
Download the CBM-ITBM-Connector-<build_number>.zip file.
2
Create a folder for the connector files.
3
Extract the contents of the downloaded ZIP file in to the created folder.
The ZIP file contains the following files and folders:
VMware, Inc.

lib: A folder containing JAR files for running the connector.

resource: This folder contain two files. The user.properties file contains the various server configuration data. The system.properties file contains information used by the connector to run the various jobs.

logs: This folder contains the various log files.

Configure-CBM-ITBM-Connector.bat: Run this file to configure the server details on the connector.

Install-CBM-ITBM-Connector-Service.bat: Run this file to install the connector as a Windows service.

Uninstall-CBM-ITBM-Connector-Service.bat: Run this file to uninstall the connector service.

Run-CBM-ITBM-Connector-Console.bat: Run this file to run the connector on a console window instead of as a Windows service.
2
vCenter Chargeback Manager Connector For IT Business Management Suite
CAUTION You must use the connector either as a Windows service (Install‐CBM‐ITBM‐Connector‐Service.bat) or as a console (Run‐CBM‐ITBM‐Connector‐Console.bat). Ensure that you do not run the service and console together.
Install the Connector as a Windows Service
To install the connector as a Windows service, perform the following tasks:
1
Configure the connector by running the Configure-CBM-ITBM-Connector.bat file.
See “Configure the Connector” on page 3 for detailed instructions about configuring the connector.
2
Set JRE_HOME if not already set.
For example, JRE_HOME=C:\Program Files\Java\jre6.
3
Run the Install-CBM-ITBM-Connector-Service.bat file to install the connector as a Windows service.
Configure the Connector
Before you run the connector, you must configure the connector so that it can connect to the vCenter Chargeback Manager, vCenter Server, and SFTP server of the IT Business Management Suite. To configure the connector, perform the following tasks:
1
Run the Configure-CBM-ITBM-Connector.bat file by double‐clicking it.
A console window is displayed.
2
Enter the details of the vCenter Chargeback Manager that you want to configure on the connector.

vCenter Chargeback Manager IP: IP address of the machine on which the vCenter Chargeback Manager is installed.

vCenter Chargeback Manager Port: The port on which the load balancer for the vCenter Chargeback Manager is listening for requests.

vCenter Chargeback Manager Username: A user name to authenticate in to the vCenter Chargeback Manager. This user must have privileges to create a report and report schedule in vCenter Chargeback Manager and read privilege on the hierarchy, vCenter Server, and the Default Cost Model.

vCenter Chargeback Manager Password: Password for the vCenter Chargeback Manager user.
You must press Enter after specifying each value for the vCenter Chargeback Manager.
3
Enter the details of the SFTP server of IT Business Management Suite that you want to configure on the connector.
NOTE The connector only supports SSH File Transfer Protocol (SFTP) server.

FTP Host Name: FQDN or IP address of the SFTP server.

FTP Username: A user name to authenticate in to the SFTP server.

FTP Password: Password for the SFTP user.
You must press Enter after specifying each value for the SFTP server.
4
Enter the details of the vCenter Server that you want to configure on the connector.

vCenter Server IP: IP address of the vCenter Server.

vCenter Server Username: A user name to authenticate in to the vCenter Server.

vCenter Server Password: Password for the vCenter Server user.
You must press Enter after specifying each value for the vCenter Server.
VMware, Inc.
3
vCenter Chargeback Manager Connector For IT Business Management Suite
Configuring the Connector Job-Related Information
You can configure the time when the different connector jobs must run. This information can be configured in the system.properties file in the resource folder. To configure the job run times, set the following properties in the system.properties file:

periodicity.scheduleReport: The time interval in minutes between two runs of the scheduleReport job. This job scans the vCenter Chargeback Manager and creates a report schedule for any hierarchy that has the custom attribute ITBM set to yes on root of the hierarchy.

periodicity.pullReport: The time interval in minutes between two runs of the pullReport job. This job fetches the daily report in the XML format from the vCenter Chargeback Manager.

periodicity.uploadCsv: The time interval in minutes between two runs of the uploadCsv job. This job uploads the ZIP file of the CSV report on to the SFTP server.

retry.scheduleReport: How many times the connector must try rerunning the scheduleReport job if it fails.

retry.pullReport: How many times the connector must try rerunning the pullReport job if it fails.

retry.uploadCsv: How many times the connector must try rerunning the uploadCsv job if it fails.

baseTime.hours: Hour of the day. Valid values are from 0 to 23.

baseTime.minutes=Minute of the hour. Valid values are from 0 to 59.

lagMinutes.scheduleReport: Minutes from the baseTime when the report schedule must fire.

lagMinutes.pullReport: Minutes from the baseTime when the report must be retrieved from vCenter Chargeback Manager.

lagMinutes.uploadCsv: Minutes from the baseTime when the CSV report must be uploaded on to the SFTP server.

report.bufferDate: No of days of report that the connector tries to fetch from the vCenter Chargeback Manager if the pullReport job fails.
CAUTION Modify the default values in the system.properties file only if it is absolutely necessary.
Configure the Hierarchy and Cost Model in vCenter Chargeback Manager
You must perform the following configuration tasks in vCenter Chargeback Manager:
1
Add the vCenter Server configured on the connector to the vCenter Chargeback Manager.
2
Create a custom attribute with the name ITBM.
3
Create a hierarchy with the entities from the vCenter Server configured on the connector.
4
Set the attribute ITBM with the value yes on the root of the hierarchy.
5
Configure the Default Chargeback Cost Model as per your requirements.
Refer to the vCenter Chargeback Manager User’s Guide for detailed instructions to perform the above tasks.
NOTE If you configure the ITBM attribute for more than one hierarchy, then the connector creates the report schedules for both hierarchy, but the report for only one of the hierarchy is fetched and uploaded on to the SFTP server.
VMware, Inc.
4
vCenter Chargeback Manager Connector For IT Business Management Suite
Configure the IT Business Management Suite Adaptor
To finalize the integration configuration, you must configure the Adaptor. The Adaptor is accessible through the IT Business Management Suite Designer, and is located under All > ITFM Content > Cost Model >Adaptors > VMware Chargeback Manager. To configure the Adaptor, perform the following tasks:
1
Change the adaptor’s File Name Template from adaptor_files CBM VM Data.xlsx to <CBM Connector
File Path><File Name>*.csv
2
Verify the imported fields are in the correct order. The adaptor assumes the file columns to be in the following order: Start Time, End Time, VM Name, Cost, Host.
3
Create a new batch that would download the Chargeback Manager files as follows:
4
a
In the IT Business Management Suite Designer, go to Tools > Job Sequencer
b
Select New Batch
c
Paste the XML file below, replacing the SFTP user name parameter with one provided to you during IT Business Management Suite installation:
<?xml version="1.0" encoding="UTF-8"?>
<batch desc="" name="Fetch Files from SFTP" resumeRun="true">
<command desc=" " isCritical="false" type="RunJava">
<arg
value="com.digifuel.serviceflow.infra.backoffice.engine.runner.SFTPScriptExecut
or"/>
<arg value="<SFTP User Name>"/>
</command>
</batch>
d
Click Save.
Configure the new batch as follows:
a
Click on ITFM Data Collection batch
b
Replace the following XML commands
<command desc="CBM VM Data" isCritical="false" type="RunAdaptor">
<arg value="455"/>
</command>
<command desc="" isCritical="false" type="WaitAdaptor">
<arg value="455"/>
</command>
with the following, using the ID of the newly created batch. (You can get the new batch ID by hovering over the new batch):
<command desc=" VMware Chargeback Manager Data Collector"isCritical="false"
type="RunBatch">
<arg value="<New Batch ID>"/>
</command>
<command desc="" isCritical="false" type="WaitBatch">
<arg value="<New Batch ID>"/>
</command>
Your adaptor is now configured and ready to retrieve Chargeback Manager Connector data.
VMware, Inc.
5
vCenter Chargeback Manager Connector For IT Business Management Suite
Starting the Connector
After you have configured the connector, you can run the connector. If you have installed the connector as a service, then you can run the connector by starting the VMware CBM-ITBM-Connector service. If you have not installed the connector as a service, you can run the connector in a console window by double‐clicking the Run-CBM-ITBM-Connector-Console.bat file. A console window is displayed. The console window displays different messages when the connector runs the various jobs. Ensure that you do not close the console window.
The ITBM Cost Model is illustrated in Figure 1
Figure 1. ITBM Cost Model
The ITBM Dashboard is illustrated in Figure 2
Figure 2. ITBM Dashboard
VMware, Inc.
6
vCenter Chargeback Manager Connector For IT Business Management Suite
Reconfiguring the Connector
To reconfigure the connector, you must run the Configure-CBM-ITBM-Connector.bat file. You need not stop the connector to reconfigure it. See “Configure the Connector” on page 3 for detailed instructions on configuring the connector.
If you reconfigure the connector with a different hierarchy but the same vCenter Chargeback Manager, then you must manually delete the report schedule in vCenter Chargeback Manager and reset the ITBM attribute set on the hierarchy. Else, some of the connector jobs will fail.
If you reconfigure the settings in the system.properties file, you must restart the connector.
If you do not modify the vCenter Chargeback Manager and vCenter Server details but change only the value of the ITBM attribute to no, the report schedule continues to generate the daily reports and the connector fetches the reports, generates the CSV files, and upload the ZIP of the CSV files on to the SFTP server.
Stopping the Connector
If you have installed the connector as a service, you must stop the service to stop the connector and the corresponding jobs. If you have not installed the connector as a service, to stop the connector, close the console window.
NOTE Stopping the connector does not delete the report schedule from the vCenter Chargeback Manager. The report scheduler keeps generating daily reports and archiving them.
Uninstall the Connector
To uninstall the connector service, run the Uninstall-CBM-ITBM-Connector-Service.bat file and then delete the folder in which the connector files exist. If you have not installed the connector as a service, to uninstall the connector, stop the connector and delete the folder in which the connector files exist.
When you uninstall the connector, the report schedule is not deleted from the vCenter Chargeback Manager. The report scheduler keeps generating daily reports and archiving them.
If you have comments about this documentation, submit your feedback to: [email protected]
VMware, Inc. 3401 Hillview Ave., Palo Alto, CA 94304 www.vmware.com
Copyright © 2011 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual property laws. VMware products are covered by
one or more patents listed at http://www.vmware.com/go/patents. 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.
Item: EN-000774-00
7
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement