3.0
Table Of Contents
- SOAP API Guide
- Contents
- About This Book
- 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
Lab Manager SOAP API Guide
10 VMware, Inc.
Integrating Lab Manager with Automated Testing Tools
TheLab ManagerSOAPAPIallowsyoutointeractwithLab Managerdatausingthe
languageandplatformofyourchoice.TheexamplesinthisguideusetheC#
programminglanguageandtheMicrosoft.NETframework,butotherprogramming
languagesanddevelopmentenvironmentsarealsosupported.Ifyouareusinga
languageother
thanC#,seethedocumentationonyourdevelopmentenvironmentfor
comparableinformationaboutdevelopingWebserviceapplications.
InadditiontoextendingorcustomizingLab ManagerbyusingtheSOAPAPI,youcan
alsointegrateLab Managerwithautomatedtestingsystems.Youcanseeanexampleof
thisintegrationin“AdvancedC#Sample:Integrating
LabManagerandQuality
Center”onpage 19.
FormoreinformationaboutLab Managersolutions,developerresources,and
communityresources,gotohttp://www.vmware.com.
Supported Operations
UsingyourpreferredWeb‐enableddevelopmentenvironment,youcanconstructWeb
serviceclientapplicationsusingstandardWebserviceprotocolstoprogrammatically:
Queryforvirtualmachineandconfigurationinformation.
Performactionsonmachinesandconfigurations.
Capture,checkout,clone,delete,anddeployconfigurations.
CreateaLiveLinkconfigurationURLthatyoucanemailtootherteammembers.
FordetailedinformationaboutsupportedWebserviceoperations,see“LabManager
APIMethodReference”onpage 33.
Lab Manager Data Objects
TheLab ManagerSOAPAPIinteractswiththedatainyourorganizationusingobjects,
whichareprogrammaticrepresentationsoftheLab Managerdata.Objectproperties
representfieldsinthosedataentities.Forexample,aLab Managerconfigurationis
representedbyaConfigurationobject,whichhasfieldsthatrepresenttheconfiguration
name,configurationnumericidentifier,
deploymentstatus,sharedstate,andmore.
Thisdocumentdescribeshowtoperformoperationssuchasquery,clone,capture,and
deployonLab ManagerdatausingtheLab Managerdataobjects.See“LabManager
APIData Types”onpage 27.