2.4
Table Of Contents
- VMware® Lab Manager SOAP API Guide
- Contents
- Preface
- Introducing VMware Lab Manager SOAP API
- Getting Started with the Lab Manager SOAP API
- Lab Manager API Data Types
- Lab Manager API Method Reference
- ConfigurationCapture
- ConfigurationCheckout
- ConfigurationClone
- ConfigurationDelete
- ConfigurationDeploy
- ConfigurationPerformAction
- ConfigurationSetPublicPrivate
- ConfigurationUndeploy
- GetConfiguration
- GetConfigurationByName
- GetMachine
- GetMachineByName
- GetSingleConfigurationByName
- ListConfigurations
- ListMachines
- LiveLink
- MachinePerformAction
- Index
VMware® Lab Manager SOAP API Guide
12 VMware, Inc.
Integrating Lab Manager with Automated Testing Tools
TheLabManagerWebserviceSOAPAPIallowsyoutoleverageLabManagerdata
usingthelanguageandplatformofyourchoice.TheexamplesinthisguideusetheC#
programminglanguageandtheMicrosoft.NETframework,butotherprogramming
languagesanddevelopmentenvironmentsarealsosupported.Ifyouareusing
a
languageotherthanC#,seethedocumentationonyourdevelopmentenvironmentfor
comparableinformationaboutdevelopingWebserviceapplications.
InadditiontoextendingorcustomizingLabManagerbyusingtheSOAPAPI,youcan
alsointegrateLabManagerwithautomatedtestingsystems.Youcanseeanexampleof
thisintegration
in“AdvancedSample:IntegratingLabManagerandQualityCenter”
onpage 21.
FormoreinformationaboutLabManagersolutions,developerresources,and
communityresources,gotohttp://www.vmware.com.
Supported Operations
UsingyourpreferredWeb‐enableddevelopmentenvironment,youcanconstructWeb
serviceclientapplicationsusingstandardWebserviceprotocolstoprogrammatically:
Queryforvirtualmachineandconfigurationinformation.
Performactionsonmachinesandconfigurations.
Capture,checkout,clone,delete,anddeployconfigurations.
CreateaLiveLinkconfigurationURLyoucanemailtootherteammembers.
FordetailedinformationaboutsupportedWebserviceoperations,see“LabManager
APIMethodReference”onpage 33.
Lab Manager Data Objects
TheLabManagerWebserviceSOAPAPIinteractswiththedatainyourorganization
usingobjects,whichareprogrammaticrepresentationsoftheLabManagerdata.Object
propertiesrepresentfieldsinthosedataentities.Forexample,aLabManager
configurationisrepresentedbyaConfigurationobject,whichhasfieldsthatrepresent
the
configurationname,configurationnumericidentifier,deploymentstatus,shared
state,andmore.
Thisdocumentdescribeshowtoperformoperationssuchasquery,clone,capture,and
deployonLabManagerdatausingtheLabManagerdataobjects.Fordetailed
information,see“LabManagerAPIDataTypes”onpage 27.