VMware vCenter Chargeback Manager 2.5 User guide

VMware
Brand
VMware
Model
vCenter Chargeback Manager 2.5
Type
User guide
API Programming Guide
vCenter Chargeback Manager 2.5.0
This document supports the version of each product listed and
supports all subsequent versions until the document is replaced
by a new edition. To check for more recent editions of this
document, see http://www.vmware.com/support/pubs.
EN-000968-00
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:
docfeedback@vmware.com
Copyright © 2009-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.
VMware, Inc.
3401 Hillview Ave.
Palo Alto, CA 94304
www.vmware.com
2 VMware, Inc.
API Programming Guide
VMware, Inc. 3
Contents
AboutThisBook 5
1 vCenterChargebackManagerAPIs 7
WhatIsvCenterChargebackManager? 7
RESTArchitecture 7
Requests 8
Responses 8
CommonElementsintheRequestandResponseXMLs 9
vCenterChargebackManagerAPISyntax 9
APIVersioning 10
2 UnderstandingtheWorkflow 13
RequirementsforCodeExamples 13
JARFiles 13
CommonUtilClass 14
FakeSSLCertificateSocketFactoryClass 15
LogIntovCenterChargebackManager 16
AddvCenterServerInformation 17
AddaCustomChargebackHierarchy 18
AddavCenterServerEntitytotheChargebackHierarchy 19
AddaFixedCost 21
ModifyaFixedCostValue 22
GenerateaReport 23
3 UsingvCenterChargebackManagerwithaBillingSystem 25
RequirementsforCodeExamples 25
JARFiles 25
CommonUtilClass 26
FakeSSLCertificateSocketFactoryClass 27
AddPricingModels 28
AddaBillingPolicy 29
RetrieveListofHierarchies 30
GetDetailsofaHierarchy 31
AddReportScheduleforHierarchy 32
GetReportSchedulebyHierarchyName 33
RescheduleaReport 35
DeleteReportSchedule 36
GetListofArchivedReportsforaHierarchy 37
GetaReportasXML 38
Index 39
API Programming Guide
4 VMware, Inc.
VMware, Inc. 5
TheAPIProgrammingGuideprovidesinformationonhowtousevCenterChargebackManagerAPIs.
Intended Audience
ThisbookisintendedforanyonewhodevelopapplicationstoworkwithvCenterChargebackManager.
VMware Technical Publications Glossary
VMwareTechnicalPublicationsprovidesaglossaryoftermsthatmightbeunfamiliartoyou.Fordefinitions
oftermsastheyareusedinVMwaretechnicaldocumentationgotohttp://www.vmware.com/support/pubs.
Document Feedback
VMwarewelcomesyoursuggestionsforimprovingourdocumentation.Ifyouhavecomments,sendyour
feedbacktodocfeedback@vmware.com.
vCenter Chargeback Manager Documentation
ThevCenterChargebackManagerdocumentationincludesthefollowingguides:
InstallationandUpgradeGuide
User’sGuide
APIProgrammingGuide
APIReference
SDKforJavaDeveloper’sGuide
ToaccessthecompletevCenterChargebackManagerdocumentation,goto
http://www.vmware.com/support/pubs/vcbm_pubs.html.
Technical Support and Education Resources
Thefollowingsectionsdescribethetechnicalsupportresourcesavailabletoyou.Toaccessthecurrentversion
ofthisbookandotherbooks,gotohttp://www.vmware.com/support/pubs.
Online and Telephone Support
Touseonlinesupporttosubmittechnicalsupportrequests,viewyourproductandcontractinformation,and
registeryourproducts,gotohttp://www.vmware.com/support.
Customerswithappropriatesupportcontractsshouldusetelephonesupportforthefastestresponseon
priority1issues.Gotohttp://www.vmware.com/support/phone_support.
About This Book
API Programming Guide
6 VMware, Inc.
Support Offerings
TofindouthowVMwaresupportofferingscanhelpmeetyourbusinessneeds,goto
http://www.vmware.com/support/services.
VMware Professional Services
VMwareEducationServicescoursesofferextensivehands‐onlabs,casestudyexamples,andcoursematerials
designedtobeusedason‐the‐jobreferencetools.Coursesareavailableonsite,intheclassroom,andlive
online.Foronsitepilotprograms andimplementationbestpractices,VMwareConsultingServicesprovides
offeringsto helpyouassess,plan,
build,andmanageyourvirtualenvironment.Toaccessinformationabout
educationclasses,certificationprograms,andconsultingservices,gotohttp://www.vmware.com/services.
VMware, Inc. 7
1
Thischapterincludesthefollowingtopics:
“WhatIsvCenterChargebackManager?”onpage 7
“RESTArchitecture”onpage 7
“vCenterChargebackManagerAPISyntax”onpage 9
“A P I Versioning”onpage 10
What Is vCenter Chargeback Manager?
vCenterChargebackManagerisacostreportingsolutionforenvironmentsvirtualizedusingvSphere.This
Web‐basedapplicationinteractswiththevCenterServer,vCloudDirector,andvShieldManagertoretrieve
resourceusageinformationandotherconfigurationdetails,calculatesthecostbyusingthechargeback
formulasdefinedintheapplication,andgeneratesreports.
vCenterChargebackManagerrunsonanApacheTomcatserverinstance.TheuserinteractswiththevCenter
ChargebackManagerthroughaloadbalancer(ApachehttpdServer).vCenterChargebackManagerconnects
toadatabasethatstoresapplication‐relatedinformation,suchasthedefinedhierarchies,pricingmodel,users,
roles,andsoon.The
applicationalsointeractswiththevCenterServerandvCenterServerDatabasethrough
adatacollector.ThedatacollectorusesVIMAPIstocommunicatewiththevCenterServerandJDBCto
communicatewiththevCenterServerDatabase.
vCenterChargebackManagercanbeintegratedwithavCloudDirectorsetupusingthevCloudDirector
data
collector.ThisdatacollectorinteractswiththevCloudDirectorDatabaseandfetchestheOrgdatarequiredfor
importingthehierarchiesandtherelevantdataintovCenterChargebackManager.Youcanalsoinstallthe
vShieldManagerdatacollectorwhichhelpsyoufetchtheexternalnetworkrelatedinformationforeachOrg
inthevCloudDirectorsetupandreplicatethesameinthevCenterChargebackManagerdatabase.
vCenterChargebackManagerAPIsprovideaninterfaceforapplicationdeveloperstoprogrammaticallyuse
thefunctionalityofvCenterChargebackManager.
FormoreinformationaboutthevCenterChargebackManageranditscapabilities,seethevCenterChargeback
ManagerUser’s
Guide.
REST Architecture
vCenterChargebackManagerAPIsimplementtheRepresentationalStateTransfer(REST)architecture.
REST‐basedAPIshelpyousendHTTPrequestsforresourcesoverthenetworkandreceiveresponses.
vCenter Chargeback Manager APIs
1
API Programming Guide
8 VMware, Inc.
Figure 1-1. REST Architecture in vCenter Chargeback Manager
Requests
AnHTTPrequestsentbyavCenterChargebackManagerAPIcanbeofthefollowingtype:PUT,POST,GET,
orDELETE.Table 1‐1showshoweachoftheserequesttypesmapstoastandardCRUDoperation.
AlongwiththeHTTPrequests,youcanpassrequestparametersbyusingXMLs.Anexample
requestXMLfor
theLoginAPIisprovidedhere.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Request xmlns="http://www.vmware.com/vcenter/chargeback/2.0">
<Users>
<User>
<Name>admin</Name>
<Password>P@ssw0rd</Password>
<Type>local</Type>
</User>
</Users>
</Request>
Responses
WhenanAPItaskissuccessful,thevalueofthestatusparameterintheresponseXMLissettosuccessas
showninthefollowingexample.
<?xml version="1.0" encoding="UTF-8"?>
<Response status="success" isValidLicense="true"
xmlns="http://www.vmware.com/vcenter/chargeback/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Hierarchies>
<Hierarchy id="1">
...
vCenter
Chargeback
Manager
Database
JDBC
vCenter Chargeback Manager Reports
vCenter Chargeback Manager Configuration
HTTPS
REST APIs/HTTP
vCenter Chargeback Manager
vSphere APIs/JDBC
Multi-vCenter Server Deployment
vCenter Chargeback Manager Plug-in
vSphere Client
vCenter Chargeback Manager
Application/Web UI
vCenter
Server 1
vCenter
Server 2
Table 1-1. Request Type Mapping
Request Type CRUD Operation
POST CREATE
GET READ
PUT UPDATE/CREATE
DELETE DELETE
VMware, Inc. 9
Chapter 1 vCenter Chargeback Manager APIs
</Hierarchy>
</Hierarchies>
</Response>
IfanAPItaskisunsuccessful,thestatusparameterissettofailureandtheErrorelementcapturesallthe
details.
<?xml version="1.0" encoding="UTF-8"?>
<Response status="failure" isValidLicense="true"
xmlns="http://www.vmware.com/vcenter/chargeback/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Error majorErrorCode="500" minorErrorCode="2014"
message="Hierarchy with id '1' does not exist." />
</Response>
Table 1‐2explainsthecomponentsoftheErrorelement.
Common Elements in the Request and Response XMLs
Table 1‐3presentsthecommonXMLelementsusedbytherequestandresponseXMLs.
ForanexamplerequestXML,see“Requests.”ForanexampleresponseXML,see“Responses.”
vCenter Chargeback Manager API Syntax
EachvCenterChargebackManagerAPIhasthefollowingsyntax:
<HTTP_request_method> <Base_Url>/<API_signature>
Forexample,GET https://123.123.123.123/vCenter-CB/api/hierarchies
Table 1‐4describesthecomponentsofvCenterChargebackManagerAPIsyntax.
Table 1-2. Components of Error Element
Element Description
majorErrorCode Theclassoftheerror.ItrepresentstheHTTPStatuscodes.
minorErrorCode TheAPIerrorcode.Forexample,itcanindicatethathierarchycreationfailed.
vendorSpecificErrorCode
(Optional)
Avendororimplementation‐specificerrorcodethatpointstospecificmodulesorparts
ofthecode,andcanmakeproblemdiagnosticseasier.For
example,itcanindicateifa
codesnippetisavCenterChargebackManagererrorcodeoradatabaseerrorcode.
message Aone‐line,human‐readablemessagethatdescribestheerrorthatoccurred.
ErrorStackTrace ThiselementispresentwhentheloglevelinvCenterChargebackManagerissetto
debug.
Table 1-3. Common Elements
Element Description
Request AnAPIrequeststartswiththiselement.
Response AnAPIresponsestartswiththiselement.
status DenoteswhetherAPIissuccessfullyexecuted.
IsValidLicense Indicatesthestatusofthelicense.Valuecanbetrueorfalse.
Table 1-4. API Syntax Components
Syntax Component Description
HTTP_request_method PUT,POST,GET,orDELETE
Base_Url TheURLofthevCenterChargebackManager.ThebaseURLforvCenterChargeback
ManagerAPIsis:
https://<vCenter Chargeback Manager IP>/vCenter-CB/api
Forexample,https://123.123.123.123/vCenter-CB/api
API Programming Guide
10 VMware, Inc.
IfyouwanttouseanearlierversionofthevCenterChargebackManagerAPI,youmustperformthefollowing
tasks:
IntheAPIURL,specifyversion=<version_number>.
Forexample,<HTTP_request_method> <Base_Url>/<API_signature>?version=1.5.0
IntherequestXML,updatetherequestelementwiththefollowingtag:
<Request xmlns="http://www.vmware.com/vcenter/chargeback/1.5.0">
API Versioning
EveryvCenterChargebackManagerAPIrequestandresponseincludestargetnamespacetodenotetheAPI
version.For example,thefollowingrequestXMLsendstheversionwithwhichitisworking.
<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="http://www.vmware.com/vcenter/chargeback/2.0">
<Hierarchies>
<Hierarchy>
<Name>Test_Hierarchy</Name>
<Description>Test Hierarchy</Description>
</Hierarchy>
</Hierarchies>
</Request>
TherequeststatesthatvCenterChargebackManagerAPIversion2.0isbeingcalled.Iftherequestisfor
vCenterChargebackManagerversion1.5,thecallfails.IftherequestisforvCenterChargebackManager2.0,
thecallsucceedsandgetsaresponsesimilartothefollowing:
<?xml version="1.0" encoding="UTF-8"?>
<Response xmlns="http://www.vmware.com/vcenter/chargeback/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" status="success"
isValidLicense="true">
<Hierarchies>
<Hierarchy id="1174">
<Name>Test_Hierarchy</Name>
<Description>Test Hierarchy</Description>
<CreatedOn>1275033342320</CreatedOn>
<InSync>true</InSync>
<LastUpdatedTime>1275033342350</LastUpdatedTime>
<LastUpdatedUser>local\superuser</LastUpdatedUser>
<Entities>
<Entity id="1175">
<Name>Test_Hierarchy</Name>
<Description>Root</Description>
<Type>100</Type>
<Shares>
<Share>
<Percentage>100</Percentage>
<Parent id="-1" />
<StartTime>0</StartTime>
</Share>
API_signature TheURLpathforavCenterChargebackManagerAPI.Forexample,/hierarchies
retrievesthehierarchiesaddedtothevCenterChargebackManagerrunningon
123.123.123.123.
version (Optional)APIversion.IfyouwanttousevCenterChargebackManager1.5API,then
specifytheversionas1.5.0.
Ifyoudonotspecifytheversion,thecurrentAPIversion,
whichis2.5,isconsidered.Forexample,
GET https://12.123.12.123/vCenter-CB/api/hierarchies?version=2.5
NOTEEnsurethatyouspecifytheversioninboththeAPIURLandtherequestXML.
Table 1-4. API Syntax Components
Syntax Component Description
VMware, Inc. 11
Chapter 1 vCenter Chargeback Manager APIs
</Shares>
</Entity>
</Entities>
</Hierarchy>
</Hierarchies>
</Response>
IfyouspecifytheAPIversion,besuretospecifyitwithboththerequestXML(whereverapplicable)andthe
URL.IfitisspecifiedonlyintherequestXMLortheURLandnotboth,thentheAPIresultsinanerror.Ifthe
APIversionisabsentinboth
theURLandtherequestXML(whereverapplicable),thentheAPIreturnsthe
outputcorrespondingtothelatestversion.
API Programming Guide
12 VMware, Inc.
VMware, Inc. 13
2
ThischapterexplainshowtoperformsomeofthebasicvCenterChargebackManagertasksusingtheAPIs.
Youcancreateahierarchyandaddentities,addfixedcostandgenerateareportonresourceutilization.
Thechapterincludesthefollowingtopics:
“RequirementsforCodeExamples”onpage 13
“LogIntovCenterChargebackManager”onpage 16
“A d d vCenterServerInformation”onpage 17
“A d d aCustomChargebackHierarchy”onpage 18
“A d d avCenterServerEntitytotheChargebackHierarchy”onpage 19
“A d d aFixedCost”onpage 21
“ModifyaFixedCostValue”onpage 22
“GenerateaReport”onpage 23
Requirements for Code Examples
ThischapterprovidescodeexamplestoexplainhowyoucancalltheAPIs.Torunthesecodeexamples,you
requirethefollowingJARandhelperclassfiles.
JAR Files
ThecodeexamplesneedthefollowingJARfiles.
commons-httpclient-3.1.jar
commons-logging-1.1.1.jar
jdom.jar
YoumustplacetheseJARfilesintheclasspath.
Understanding the Workflow
2
API Programming Guide
14 VMware, Inc.
CommonUtil Class
ThecodeexamplesusethefollowingCommonUtilclass.
public final class CommonUtil {
/**
* This method writes out a formatted XML document to the Writer out.
*
* @param doc
* @param out
* @throws IOException
*/
public static void printXML(Document doc, Writer out) throws IOException {
XMLOutputter o = new XMLOutputter();
Format newFormat = o.getFormat();
newFormat.setIndent(" ");
o.setFormat(newFormat);
o.output(doc, out);
}
/**
* This method returns the XML document as a string object
*
* @param doc JDOM document representation of the XML
* @return String representation of the XML document
* @throws IOException
*/
public static String xmlAsString(Document doc) throws IOException {
Writer w = new StringWriter();
printXML(doc, w);
return w.toString();
}
/**
* This method reads the XML from a file and returns its representation as a
* JDOM document
*
* @param filePath path to the XML file
* @return JDOM document representation of the XML
* @throws IOException
* @throws JDOMException
*/
public static Document getXMLDocument(String filePath) throws IOException, JDOMException {
FileInputStream fis = null;
try {
fis = new FileInputStream(filePath);
return getXMLDocument(fis);
} finally {
if (fis != null) {
fis.close();
}
}
}
/**
* This method reads an XML document from the input Stream and returns its
* JDOM document representation
*
* @param is input stream that has the XML content
* @return jDOM document representation for the XML
* @throws IOException
* @throws JDOMException
*/
private static Document getXMLDocument(InputStream is) throws IOException, JDOMException {
Document xml = null;
SAXBuilder builder = new SAXBuilder();
xml = builder.build(is);
return xml;
}
}
VMware, Inc. 15
Chapter 2 Understanding the Workflow
FakeSSLCertificateSocketFactory Class
ThecodeexamplesusethefollowingclasstoaccessresourcesovertheHTTPSprotocol.
/**
* Helper class to accept self-signed certificate.
*/
public class FakeSSLCertificateSocketFactory implements SecureProtocolSocketFactory {
private SSLContext sslContext;
public FakeSSLCertificateSocketFactory() throws NoSuchAlgorithmException,
KeyManagementException {
sslContext = SSLContext.getInstance("SSL");
sslContext.init(null, new TrustManager[] {new X509TrustManager() {
@Override
public void checkClientTrusted(X509Certificate[] ax509certificate, String s) throws
CertificateException {
// Allow.
}
@Override
public void checkServerTrusted(X509Certificate[] ax509certificate, String s) throws
CertificateException {
// Allow.
}
@Override
public X509Certificate[] getAcceptedIssuers() {
return new X509Certificate[0];
}
}}, null);
}
@Override
public Socket createSocket(String s, int i) throws IOException, UnknownHostException {
return sslContext.getSocketFactory().createSocket(s, i);
}
@Override
public Socket createSocket(String s, int i, InetAddress inetaddress, int j) throws
IOException, UnknownHostException {
return sslContext.getSocketFactory().createSocket(s, i, inetaddress, j);
}
@Override
public Socket createSocket(String s, int i, InetAddress inetaddress, int j,
HttpConnectionParams httpconnectionparams) throws IOException,
UnknownHostException, ConnectTimeoutException {
return sslContext.getSocketFactory().createSocket(s, i, inetaddress, j);
}
@Override
public Socket createSocket(Socket socket, String s, int i, boolean flag) throws IOException,
UnknownHostException {
return sslContext.getSocketFactory().createSocket(socket, s, i, flag);
}
}
API Programming Guide
16 VMware, Inc.
Log In to vCenter Chargeback Manager
TostartusingvCenterChargebackManagerAPIs,youmustlogintovCenterChargebackManager.
To log in to vCenter Chargeback Manager
1 CalltheLoginAPIbyusingthefollowingsyntax.
<HTTP_request_method> <Base_URL>/login
Forexample,youcandefineacallasfollows:
POST https://123.123.123.123/vCenter-CB/api/login?version=2.5
2 (Optional)UsetheURLparameterversiontospecifytheAPIversionthatyouwanttocall.
3IntherequestXMLforthisAPI,youcanspecifythefollowinglogindetails.
Usertype
Username
Password
LDAPserverIDorLDAPservername
ThefollowingisanexamplerequestXMLfile.
<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="http://www.vmware.com/vcenter/chargeback/2.0">
<Users>
<User>
<Type>userType</Type>
<Name>administrator</Name>
<Password>vmware</Password>
<!-- For LDap User you can either provide LdapServer id or ldap server name
-->
<LdapServer id=”1”/>
</User>
</Users>
<!-- For Ldap Users -->
<LdapServers>
<LdapServer>
<LdapServerName>vmw</LdapServerName>
</LdapServer>
</LdapServers>
</Request>
Iftheloginsucceeds,theAPIreturnsaresponseXMLthatindicateswhethertheuserisauthenticated.
ThefollowingisanexampleprogramthatcallstheAPI.
/**
* This method is for Login to vCenter-ChargeBack
*
* @param requestFilePath
* @param baseURL
* @param version
* @throws IOException
* @throws JDOMException
* @throws NoSuchAlgorithmException
* @throws KeyManagementException
* @throws HttpException
*/
public static void sampleLoginMethod(String requestFilePath, String baseURL, String
version) throws IOException, JDOMException,
NoSuchAlgorithmException, KeyManagementException, HttpException {
PostMethod post = null;
NameValuePair[] parameters = {new NameValuePair("version", version)};
Document requestDocument = CommonUtil.getXMLDocument(requestFilePath);
String bodyString = CommonUtil.xmlAsString(requestDocument);
HttpClient client = new HttpClient();
VMware, Inc. 17
Chapter 2 Understanding the Workflow
Protocol.registerProtocol("https", new Protocol("https", (ProtocolSocketFactory) new
FakeSSLCertificateSocketFactory(), 443));
String uri = "https://" + baseURL + "/vCenter-CB/api/login?version=2.5";
System.out.println(uri);
try {
post = new PostMethod(uri);
post.setQueryString(parameters);
post.setRequestBody(bodyString);
client.executeMethod(post);
System.out.println(post.getResponseBodyAsString());
} finally {
if (post != null) {
post.releaseConnection();
}
}
}
Add vCenter Server Information
YoucanaddthevCenterServerinstancesinyourvirtualizedenvironmenttovCenterChargebackManager.
Thishelpsdeterminethecomputingresourceutilizationforthevirtualmachinesandcalculatethetotalcosts.
To add vCenter Server information
1 CalltheAPIbyusingthefollowingsyntax.
<HTTP_request_method> <Base_URL>/vCenterServer
Forexample,youcandefineacallasfollows:
POST https://123.123.123.123/vCenter-CB/api/vCenterServer?vesrion=2.5
2IntherequestXML,specifythefollowinginformation:
vCenterServerURL
vCenterServerName
vCenterServerDescription
vCenterServerUsername
vCenterServerPassword
PluginRegistered
StatsSync
DatasourceURL
DataSourceName
DataSourceUserName
DataSourcePassword
DataSourceType
DataSourceAuthType
ThefollowingisanexamplerequestXML.
<?xml version="1.0" encoding="UTF-8"?>
<Request xmlns="http://www.vmware.com/vcenter/chargeback/2.0">
<VCenterServers>
<VCenterServer>
<Url>101.102.107.21:443</Url>
<Name>vc1</Name>
<Description>vc1</Description>
<UserName>administrator</UserName>
<Password>xxxx</Password>
<PluginRegistered>true</PluginRegistered>
<StatsSync>true</StatsSync>
<DataSourceUrl>
10.112.107.21\sqlexp_vim
API Programming Guide
18 VMware, Inc.
</DataSourceUrl>
<DataSourceName>vim_vcdb</DataSourceName>
<DataSourceUserName>sa</DataSourceUserName>
<DataSourcePassword>xxxx</DataSourcePassword>
<DataSourceType id="1" />
<DataSourceAuthType id="1" />
<ForceUpdate>false</ForceUpdate>
</VCenterServer>
</VCenterServers>
</Request>
IfthevCenterServerissuccessfullyadded,theAPIreturnsanXMLresponsethatprovidesthevCenter
ServerID.
ThefollowingisanexampleprogramthatcallstheAPI.
/**
* This method is to add the vCenter-Server in vCenter-Chargeback application
*
* @param requestFilePath
* @param baseURL
* @throws IOException
* @throws JDOMException
* @throws NoSuchAlgorithmException
* @throws KeyManagementException
* @throws HttpException
*/
public static void sampleAddVCenterServerMethod(String requestFilePath, String baseURL)
throws IOException, JDOMException, NoSuchAlgorithmException,
KeyManagementException, HttpException {
PostMethod post = null;
Document requestDocument = CommonUtil.getXMLDocument(requestFilePath);
String bodyString = CommonUtil.xmlAsString(requestDocument);
HttpClient client = new HttpClient();
Protocol.registerProtocol("https", new Protocol("https", (ProtocolSocketFactory) new
FakeSSLCertificateSocketFactory(), 443));
String uri = "https://" + baseURL + "/vCenter-CB/api/vCenterServer?version=2.5";
System.out.println(uri);
System.out.println(bodyString);
try {
post = new PostMethod(uri);
post.setRequestBody(bodyString);
client.executeMethod(post);
System.out.println(post.getResponseBodyAsString());
} finally {
if (post != null) {
post.releaseConnection();
}
}
}
Add a Custom Chargeback Hierarchy
UsetheAddaChargebackHierarchyAPItocreateahierarchywiththegivennameanddescription.
To add a custom Chargeback hierarchy
1 CalltheAPIbyusingthefollowingsyntax.
<HTTP_request_method> <Base_URL>/hierarchy
Forexample,youcandefineacalllikethis:
POST https://123.123.123.123/vCenter-CB/api/hierarchy
2IntherequestXML,specifyanameandadescriptionforthehierarchy.
VMware, Inc. 19
Chapter 2 Understanding the Workflow
ThefollowingisanexamplerequestXML.
<?xml version="1.0" encoding="UTF-8"?>
<Request>
<Hierarchies>
<Hierarchy>
<Name>Test_Hierarchy</Name>
<Description>Test Hierarchy</Description>
</Hierarchy>
</Hierarchies>
</Request>
Ifsuccessful,theAPIreturnsdetailsofthenewhierarchy.
ThefollowingisanexampleprogramthatcallstheAPI.
/**
* This method is to add a vCenter-ChargeBack hierarchy in
* vCenter-ChargeBack
*
* @param requestFilePath
* @param baseURL
* @throws IOException
* @throws JDOMException
* @throws NoSuchAlgorithmException
* @throws KeyManagementException
* @throws HttpException
*/
public static void sampleAddHierarchyMethod(String requestFilePath, String baseURL)
throws IOException, JDOMException, NoSuchAlgorithmException,
KeyManagementException, HttpException {
PostMethod post = null;
Document requestDocument = CommonUtil.getXMLDocument(requestFilePath);
String bodyString = CommonUtil.xmlAsString(requestDocument);
Protocol.registerProtocol("https", new Protocol("https", (ProtocolSocketFactory) new
FakeSSLCertificateSocketFactory(), 443));
HttpClient client = new HttpClient();
String uri = "https://" + baseURL + "/vCenter-CB/api/hierarchy";
System.out.println(uri);
System.out.println(bodyString);
try {
post = new PostMethod(uri);
post.setRequestBody(bodyString);
client.executeMethod(post);
System.out.println(post.getResponseBodyAsString());
} finally {
if (post != null) {
post.releaseConnection();
}
}
}
Add a vCenter Server Entity to the Chargeback Hierarchy
ThistaskhelpsyouaddavCenterServerentityunderaspecifiedparententityinaChargebackhierarchy.
To add a vCenter Server entity to the Chargeback hierarchy
1 CalltheAPIbyusingthefollowingsyntax.
<HTTP_request_method> <Base_URL>/hierarchy/{hierarchyId}/entity/{parentEntityId}
Forexample,youcandefineacalllikethis:
POST https://123.123.123.123/vCenter-CB/api/hierarchy/11/entity/101
2IntherequestXML,specifythehierarchyID,entityname,anddescriptionforthehierarchy.
API Programming Guide
20 VMware, Inc.
ThefollowingisanexamplerequestXML.
<?xml version="1.0" encoding="UTF-8"?>
<Request>
<VCenterServers>
<VCenterServer id="502">
<VCenterServerView id = "2"/>
<Entities>
<Entity id="1062"/>
</Entities>
</VCenterServer>
</VCenterServers>
</Request>
Ifsuccessful,theAPIreturnsanXMLfilethatindicatesthestatus.
TheIDofthevCenterServerandthevCenterServerentitiescanbeobtainedbyfetchingthelistofthe
vCenterServersandthevCenterServerentitiesavailableinvCenterChargebackManagerbyusingthe
followingAPIs:
GET <Base_URL>/vCenterServers
GET <Base_URL>/vcHierarchy/{vCenterServerId}
ThefollowingisanexampleprogramthatcallstheAddEntityAPI.
/**
* This method is for adding a new vCenter-Server entity under
* vCenter-Chargeback Hierarchy entity
*
* @param requestFilePath
* @param baseURL
* @param hierachyId
* @param CBEntityId
* @throws IOException
* @throws JDOMException
* @throws NoSuchAlgorithmException
* @throws KeyManagementException
* @throws HttpException
*/
public static void sampleAddNewVCenterServerEntity(String requestFilePath, String
baseURL, int hierachyId, int CBEntityId, long startTime)
throws IOException, JDOMException, NoSuchAlgorithmException,
KeyManagementException, HttpException {
PostMethod post = null;
Document requestDocument = CommonUtil.getXMLDocument(requestFilePath);
NameValuePair[] parameters = {new NameValuePair("startTime",
String.valueOf(startTime))};
String bodyString = CommonUtil.xmlAsString(requestDocument);
Protocol.registerProtocol("https", new Protocol("https", (ProtocolSocketFactory) new
FakeSSLCertificateSocketFactory(), 443));
String uri = "https://" + baseURL + "/vCenter-CB/api/hierarchy/" + hierachyId +
"/entity/" + CBEntityId;
HttpClient client = new HttpClient();
System.out.println(uri);
System.out.println(bodyString);
try {
post = new PostMethod(uri);
post.setQueryString(parameters);
post.setRequestBody(bodyString);
client.executeMethod(post);
System.out.println(post.getResponseBodyAsString());
} finally {
if (post != null) {
post.releaseConnection();
}
}
}
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
  • Page 1 1
  • Page 2 2
  • Page 3 3
  • Page 4 4
  • Page 5 5
  • Page 6 6
  • Page 7 7
  • Page 8 8
  • Page 9 9
  • Page 10 10
  • Page 11 11
  • Page 12 12
  • Page 13 13
  • Page 14 14
  • Page 15 15
  • Page 16 16
  • Page 17 17
  • Page 18 18
  • Page 19 19
  • Page 20 20
  • Page 21 21
  • Page 22 22
  • Page 23 23
  • Page 24 24
  • Page 25 25
  • Page 26 26
  • Page 27 27
  • Page 28 28
  • Page 29 29
  • Page 30 30
  • Page 31 31
  • Page 32 32
  • Page 33 33
  • Page 34 34
  • Page 35 35
  • Page 36 36
  • Page 37 37
  • Page 38 38
  • Page 39 39
  • Page 40 40

VMware vCenter Chargeback Manager 2.5 User guide

VMware
Brand
VMware
Model
vCenter Chargeback Manager 2.5
Type
User guide
Download PDF
report

Ask a question and I''ll find the answer in the document

Finding information in a document is now easier with AI

Related papers

Other documents