4.0
Table Of Contents
- Lab Manager SOAP API Reference
- Contents
- About This Book
- Introducing VMware vCenter 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
- GetCurrentOrganizationName
- GetCurrentWorkspaceName
- GetMachine
- GetMachineByName
- GetSingleConfigurationByName
- ListConfigurations
- ListMachines
- LiveLink
- MachinePerformAction
- SetCurrentOrganizationByName
- SetCurrentWorkspaceByName
- Index
Lab Manager SOAP API Reference
10 VMware, Inc.
Capture,checkout,clone,delete,anddeployconfigurations.
CreateaLiveLinkconfigurationURLthatyoucanemailtootherteammembers.
FordetailedinformationaboutsupportedWebserviceoperations,see“Lab ManagerAPIMethodReference”
onpage 23.
Lab Manager Data Objects
TheLab ManagerSOAPAPIusesobjectstointeractwiththedatainyourorganization.Objectsare
programmaticrepresentationsoftheLab Managerdata.Objectpropertiesrepresentfieldsinthosedata
entities.Forexample,aLab ManagerconfigurationisrepresentedbyaConfigurationobject,whichhasfields
thatrepresenttheconfigurationname,configurationnumeric
identifier,deploymentstatus,sharedstate,and
more.
ThisdocumentdescribeshowtousetheLabManagerdataobjectstoperformoperationssuchasquery,clone,
capture,anddeployonLab Managerdata.See“Lab ManagerAPIDataTypes”onpage 19.
Standards Compliance and Compatible Development Platforms
TheLab ManagerSOAPAPIcomplieswithSOAP1.1,WSDL1.1,andotherstandardsidentifiedintheWS‐I
BasicProfileVersion1.1.TheLab ManagerSOAPAPIworkswithcurrentSOAPdevelopmentenvironments
thatadheretotheBasicProfileVersion1.1standards.TheexamplesinthisdocumentusetheMicrosoftVisual
Studio
.NET2005developmentenvironmentandtheC#programminglanguage.
Ifyouare usingVisualStudiofor.NETdevelopment,VMwarerecommendsthatyouuseVisualStudio2005
orlater.
SOAP API Security
ClientapplicationsthataccesstheLab Managerdatainyourorganizationaresubjecttothesamesecurity
protectionsthatareusedintheLab ManagerWebconsole.Lab ManagerusesSSLexposesallSOAPAPI
methods.
WhenyouusetheWebserviceURLtoaccesstheSOAPAPIwiththeWebserviceURL,you
mightseeanSSL
certificatewarning.AcceptthecertificatetousetheAPIorreplacethecertificatewithavalidsignedcertificate.
User Authentication
ClientapplicationsmustprovidevalidusercredentialswitheachLab ManagerWebservicemethodcall.
The requiredcredentialsareaLab Manageruseraccount,password,organization,andworkspacename.
You mustprovidethenameoftheorganizationand/orworkspacethatcontainstheobjectsonwhichyouwant
toperformoperations.TheLab Managerserverauthenticatesthese
credentials.
N
OTEImplementationdifferencesincertaindevelopmentplatformsmightpreventaccesstosomeorallof
thefeaturesintheLab ManagerSOAPAPI.
NOTEYoucanusenon‐administratorcredentials.