VMware VCLOUD SDK 1.0 - FOR NET DEVELOPERS GUIDE Manual de usuario

vCloud SDK for PHP Developer’s Guide

VMware vCloud SDK 1.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-000363-00

VMware, Inc.

3401 Hillview Ave.

Palo Alto, CA 94304

www.vmware.com

2VMware, Inc.

vCloud SDK for PHP Developer’s Guide

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

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. 3

Contents

AboutThisBook 5

1AboutthevCloudSDKforPHP 7

vCloudObjectTaxonomy 7

vCloudOrganizations 7

vCloudSDKforPHPDesign 9

CreatingaDataObject 10

CreatinganSDKObject 10

UsingaDifferentHTTPLibrary 12

UsingtheHTMLReferenceMaterial 12

2SettingUpforPHPDevelopment 13

Prerequisites 13

DownloadandInstallthevCloudSDKforPHP 14

3HellovCloud:AStructuredWorkflowExample 15

4UsingtheExamplePrograms 17

ConfiguringaRuntimeEnvironmentfortheExamples 17

RunningtheExamples 17

Index 19

vCloud SDK for PHP Developer’s Guide

4VMware, Inc.

VMware, Inc. 5

Thisbook,thevCloudSDKforPHPDeveloper’sGuide,providesinformationaboutsettingupyourdevelopment

environmenttousetheVMwarevCloud®SDKforPHP.

VMwareprovidesseveralAPIsandSDKsfordifferentapplicationsandgoals.Thisbookprovidesinformation

aboutusingthevCloudSDKforPHPfordeveloperswhoarecreatingPHPclientapplicationsforVMware

vCloudDirector.

ToviewthecurrentversionofthisbookaswellasallVMwareAPIandSDKdocumentation,goto

http://www.vmware.com/support/pubs/sdk_pubs.html.

Revision History

Thisguideisrevisedwitheachreleaseoftheproductorwhennecessary.Arevisedversioncancontainminor

ormajorchanges.Table 1summarizesthesignificantchangesineachversionofthisguide.

Intended Audience

ThisguideisintendedforsoftwaredeveloperswhoarebuildingvCloudAPIapplications,including

interactiveclientsofVMwareCloudDirector.ThisguideassumesyouarefamiliarwiththePHP

programminglanguage,RepresentationalStateTransfer(REST)andRESTfulprogrammingconventions,the

OpenVirtualizationFormatSpecification(OVFS),andVMwarevirtualmachinetechnology.Familiaritywith

othertechnologiessuchasXML,HTTP,andtheWindowsorLinuxoperatingsystemsisalsoassumed.

VMware Technical Publications Glossary

VMwareTechnicalPublicationsprovidesaglossaryoftermsthatmightbeunfamiliartoyou.Fordefinitions

oftermsastheyareusedinVMwaretechnicaldocumentationgotohttp://www.vmware.com/support/pubs.

Document Feedback

VMwarewelcomesyoursuggestionsforimprovingourdocumentation.Sendyourfeedbackto

[email protected].

Technical Support and Education Resources

Thefollowingsectionsdescribethetechnicalsupportresourcesavailabletoyou.Toaccessthecurrentversions

ofotherVMwarebooks,gotohttp://www.vmware.com/support/pubs.

About This Book

Table 1. Revision History

Revision Description

01NOV10 Version1.0.AmendmentsandminorcorrectionstoBetacontent.

31AUG10 Version1.0(Beta)

vCloud SDK for PHP Developer’s Guide

6VMware, Inc.

Online and Telephone Support

Touseonlinesupporttosubmittechnicalsupportrequests,viewyourproductandcontractinformation,and

Support Offerings

TofindouthowVMwaresupportofferingscanhelpmeetyourbusinessneeds,goto

http://www.vmware.com/support/services.

VMware Professional Services

VMwareEducationServicescoursesofferextensivehands‐onlabs,casestudyexamples,andcoursematerials

designedtobeusedason‐the‐jobreferencetools.Coursesareavailableonsite,intheclassroom,andlive

online.Foronsitepilotprograms andimplementationbestpractices,VMwareConsultingServicesprovides

offeringsto helpyouassess,plan,build,andmanageyourvirtualenvironment.Toaccessinformationabout

educationclasses,certificationprograms,andconsultingservices,gotohttp://www.vmware.com/services.

VMware, Inc. 7

TheVMwarevCloudAPIprovidessupportfordeveloperswhoarebuildinginteractiveclientsofVMware

vCloudDirectorusingaRESTfulapplicationdevelopmentstyle.vCloudAPIclientsandserverscommunicate

overHTTP,exchangingrepresentationsofvCloudobjects.TheserepresentationstaketheformofXML

elements.HTTPGETrequestsareusedtoretrievethecurrentrepresentationofanobject,HTTPPOSTand

PUTrequestsareusedtocreateormodifyanobject,andHTTPDELETErequestsaretypicallyusedtodelete

anobject.

ThevCloudSDKforPHPisaPHPlanguagebindingforthevCloudAPI.ItprovidesaPHPclasslibraryand

asetofexampleapplications.Theclassesandfunctionsinthelibraryencapsulatetheinterfaces,objects,and

operationsthatthevCloudAPIsupports,whilepreservingitsRESTfulapproachandcompatibilitywiththe

HTTPprotocolfamily.

ThisvCloudSDKforPHPDeveloper’sGuideprovidesinformationaboutsettinguptheSDKinadevelopment

environment,andinformationaboutrunningtheexampleapplicationsincludedintheSDK.

Thischapterincludesthefollowingtopics:

“vCloudObjectTaxonomy”onpage 7

“vCloudSDKforPHPDesign”onpage 9

vCloud Object Taxonomy

ThevCloudSDKforPHPdefinesasetofobjectscommontocloudcomputingenvironments.Figure 1‐1shows

theprincipalobjecttypes.

vCloud Organizations

AvCloudcontainsoneormoreorganizations.AvCloudorganizationisaunitofadministrationfora

collectionofusers,groups,andcomputingresources.Usersauthenticateattheorganizationlevel,supplying

credentialsestablishedbyanorganizationadministratorwhentheuserwascreatedorimported.

vCloud Users and Groups

Anorganizationcancontainanarbitrarynumberofusersandgroups.Userscanbecreatedbythe

organizationadministratororimportedfromadirectoryservicesuchasLDAP.Groupsmustbeimported

fromthedirectoryservice.Permissionswithinanorganizationarecontrolledthroughtheassignmentofrights

androlestousersandgroups.

vCloud Networks

Anorganizationcanbeprovisionedwithoneormorenetworks.Theseorganizationnetworkscanbe

configuredtoprovideservicessuchasDHCP,NAT,andfirewalls.

About the vCloud SDK for PHP 1

vCloud SDK for PHP Developer’s Guide

8VMware, Inc.

Figure 1-1. vCloud Object Taxonomy

vCloud Virtual Datacenters

AvCloudvirtualdatacenter(vDC)isanallocationmechanismforresourcessuchasnetworks,storage,CPU,

andmemory.InavDC,computingresourcesarefullyvirtualized,andcanbeallocatedbasedondemand,

servicelevelrequirements,oracombinationofthetwo.

TherearetwokindsofvDCs:

ProvidervDCs.ThesevDCscontainalltheresourcesavailablefromthevCloudserviceprovider.

ProvidervDCsarecreatedandmanagedbyvCloudsystemadministrators.

OrganizationvDCs.ThesevDCsprovideanenvironmentwherevirtualsystemscanbestored,deployed,

andoperated.Theyalsoprovidestorageforvirtualmedia,suchasfloppydisksandCDROMs.

AnorganizationadministratorspecifieshowresourcesfromaprovidervDCaredistributedtothevDCsinan

organization.

vCloud Catalogs

Catalogscontainreferencestovirtualsystemsandmediaimages.Acatalogcanbesharedtomakeitvisibleto

othermembersofanorganization,andcanbepublishedtomakeitvisibletootherorganizations.AvCloud

systemadministratorspecifieswhichorganizationscanpublishcatalogs,andanorganizationadministrator

controlsaccesstocatalogsbyorganizationmembers.

vCloud Tasks

Long‐runningoperationsinitiatedbymembersofanorganizationcreatetasks,whicharekeptonthe

organization’staskslist.

Catalog 2

Catalogitem

Catalog 1

Catalog 3

vDC2 Catalogitem

Catalogitem

users

Media

vApp

template

Media

vApp

TasksList

Organization

vDC1

Media

vApp

template

Media

vApp

Network

Catalogitem

groups

VMware, Inc. 9

Chapter 1 About the vCloud SDK for PHP

Virtual Systems and Media Images in a vCloud

VirtualsystemsandmediaimagesarestoredinavDCandcanbeincludedinacatalog.Mediaimagesare

storedintheirnativerepresentation(ISOorfloppy).Virtualsystemsarestoredastemplates,usinganopen

standardformat(OVF1.0).Thesetemplatescanberetrievedfromcatalogsandtransformedintovirtual

systems,calledvApps,throughaprocesscalledinstantiation,whichbindsatemplate’sabstractresource

requirementstoresourcesavailableinavDC.AvAppcontainsoneormoreindividualvirtualmachines(Vm

elements),alongwithparametersthatdefineoperationaldetailssuchas:

Howthecontainedvirtualmachinesareconnectedtoeachotherandtoexternalnetworks.

Theorderinwhichindividualvirtualmachinesarepoweredonoroff.

End‐userlicenseagreementtermsforeachvirtualmachine.

Deploymentleaseterms(typicallyinheritedfromthecontainingorganization)thatconstrainthevApp’s

consumptionofvDCresources.

Accesscontrolinformationspecifyingwhichusersandgroupscanperformoperationssuchasdeploy,

poweron,modify,andsuspendonthevAppandthevirtualmachinesitcontains.

vCloud SDK for PHP Design

ThevCloudSDKforPHPincludesthefollowingpackages:

APIpackages,listedinTable 1‐1.Thesepackagescontainclassesthatrepresentcomplextypesdefinedin

vCloudAPI,vCloudadministrativeAPIandvCloudvSphereplatformAPIextensions.Classesinthis

packagearegeneratedfromthevCloudAPIXMLschemafiles.Eachclassmapstoacomplextypedefined

inthosefiles.ObjectsoftheseclassesarereferredtoasvClouddataobjects.

SDKpackages,listedinTable 1‐2.ThesepackagescontainclassesthatimplementvCloudAPIoperations.

EachoftheclassesmapstoavCloudresourceentity.Classesmanagetheresourceentitylifecycle(create,

retrieve,update,anddelete,oftenabbreviatedasCRUD).Thispackagealsoimplementsvariousutility

functionsassociatedwithconnectingtoavCloudinstance,marshallingrequests,unmarshalling

responses,andsoon.ObjectsoftheseclassesarereferredtoasvCloudSDKobjects.

Table 1-1. VMware_VCloud_API Packages

Package Name Package Contents

VMware_VCloud_API ClassesrepresentingobjectsdefinedinthevClouduser

APIandadministrativeAPI

VMware_VCloud_API_OVF ClassesrepresentingobjectsdefinedintheOVF

specification

VMware_VCloud_API_Extension ClassesrepresentingobjectsdefinedinthevCloudAPI

vSpherePlatformExtensions

VMware_VCloud_API_Version ClassesrepresentingobjectsthatcontainvCloudAPI

versioninformation

Table 1-2. VMware_VCloud_SDK Packages

Package Name Package Contents

VMware_VCloud_SDK Classesthatimplementoperationsdefinedinthe

vClouduserAPIandadministrativeAPI

VMware_VCloud_SDK_Extension Classesthatimplementoperationsdefinedinthe

vCloudAPIvSpherePlatformExtensions

VMware_VCloud_SDK_HTTP ClassesthatsupportHTTPclientoperations.

vCloud SDK for PHP Developer’s Guide

10 VMware, Inc.

Creating a Data Object

Eachdataobjectclassincludesaconstructormethodwhoseparametersrepresentattributesoftheclassand

allofitsancestors.Attributesaremarkedasprotectedtorestricttheirvisibility.Allclassescontainsetterand

gettermethodsforXMLelementsandattributes.Thegeneralformofthesemethodnamesis

operation

_attribute‐nameforattributesand

operation

ElementNameforelements,where

operation

isone

ofsetorget.Forexample,theVMware_VCloud_API_ReferenceTypeclasssupportsset_name()and

get_name()methodsthatgetorsetthevalueofitsnameattribute,andtheVMware_VCloud_API_UserType

classsupportssetFullName()andgetFullName()methodsthatsetorgetthevalueoftheFullName

elementinaUserobject.

Tocreateadataobject,youcaneitherinvokeanemptyconstructorandthencallthesettersfortheobject(see

Example 1‐1),orinvoketheconstructorwithparameters(seeExample 1‐2).

Example 1-1. Create a Data Object From an Empty Constructor

$ref = new VMware_VCloud_API_ReferenceType();

$ref->set_href($href);

$ref->set_type($type);

$ref->set_name($name);

Example 1-2. Create a Data Object With a Parameterized Constructor

$ref = new VMware_VCloud_API_ReferenceType ($href=$href, $type=$type, $name=$name);

Creating an SDK Object

YoucancreateanSDKobjectwhenyouneedtoinvokealifecycleoperationsuchascreateormodifyona

vCloudAPIobject.MostclassconstructorsforSDKobjectsrequiretwoparameters:

AVMware_VCloud_SDK_Serviceobject,whichcontainsHTTPconnectioninformation.

AReferenceTypedataobjectwhichcontainstherequestURL.Formoreinformationaboutrequest

URLs,seethevCloudAPIProgrammingGuide.

Forexample,youcouldusecodesimilartothefragmentshowninExample 1‐3tocreatea

VMware_VCloud_SDK_Orgobjecttouseasanentrypointforclientoperations.

Example 1-3. Creating an SDK Object

// get the list of all organizations in the vCloud

$orgRefs = $service->getOrgRefs($orgName);

// create an object that represents the first organization in the list

$sdkOrg = $service->createSDKObj($orgRefs[0]);

Table 1‐3summarizesthetypesofSDKobjectsyoucancreateandprovidesinformationtohelpyouchoose

thecreationparameters(thecontainerfortheobject,andamethodtouse).Thetableomitsthe

VMware_VCloud_SDK_partofthepackagenamesintheSDKObjectandContainerObjectcolumns.

To use the information in the table to create an SDK object

1 Retrieveanarrayofobjectreferencesbyspecifyingacontainerobjectandacreationmethod.

references

Column2

Column3

2Foranyreferenceinthearray,createanSDKobjectusingtheselectedreference.

Column1

=$service->createSDKObj($

reference

)

Example 1‐3appliesthisformulatocreatinganOrgobject.

Otros manuales para VCLOUD SDK 1.0 - FOR NET DEVELOPERS GUIDE

Este manual sirve para los siguientes modelos

Tabla de contenidos

Otros manuales de Software de VMware

VMware

VMware ESX 4.0 - GETTING STARTED UPDATE 1 Manual de usuario

VMware

VMware VS4-ENT-PL-A - vSphere Enterprise Plus Manual de usuario

VMware

VMware VmWare ESX Server 2.12 Deployment Guía de referencia rápida

VMware

VMware VCLOUD SDK 1.0 - FOR NET DEVELOPERS GUIDE Manual de usuario

VMware

VMware VSHIELD APP 1.0 - Manual

VMware

VMware FUS3-ENG-M-10-CP - Fusion For Mac OS X Manual de usuario

VMware

VMware VIEW 4.5 Guía de configuración rápida

VMware

VMware VCENTER CHARGEBACK 1.5 - API Guía

VMware

VMware 4817V62 - vSphere - PC Manual de instrucciones

VMware

VMware VIRTUALIZATION AND CLOUD MANAGEMENT Guía de instalación

VMware

VMware VC-SRM4-A - vCenter Site Recovery Manager Manual de instrucciones

VMware

VMware VIEW 4.5 - GUIDE DE MISE A NIVEAU Manual de usuario

VMware

VMware ESX 4.0 - GETTING STARTED UPDATE 1 Manual de usuario

VMware

VMware VCENTER CONFIGURATION MANAGER 5.3 Manual de usuario

VMware

VMware VSHIELD APP Manual de usuario

VMware

VMware VCENTER APPLICATION DISCOVERY MANAGER 6.1.1 -... Manual de usuario

VMware

VMware ACE EN-000042-00 Manual de uso y cuidado

VMware

VMware VCLOUD SDK FOR JAVA 1.0 - DEVELOPER S GUIDE Manual de usuario

VMware

VMware VCENTER APPLICATION DISCOVERY MANAGER 6.1.1 -... Manual de usuario

VMware

VMware VSHIELD EDGE Manual de usuario

VMware

VMware VSHIELD APP 1.0 - API Instrucciones de funcionamiento

VMware

VMware VCM 5.3 Manual de usuario

VMware

VMware VCENTER APPLICATION DISCOVERY MANAGER 6.1 -... Manual de instrucciones

VMware

VMware VCENTER CHARGEBACK Manual de usuario

Manuales populares de Software de otras marcas

COMPRO

COMPRO COMPROFM Manual de usuario

Muratec

Muratec OFFICEBRIDGE ONLINE Manual de usuario

Oracle

Oracle Contact Center Anywhere 8.1 Manual de usuario

Adobe

Adobe 65007312 - Photoshop Lightroom Manual

Avaya

Avaya NULL One-X for RIM Blackberry Manual de usuario

HP ProLiant BL420c Manual de usuario

PS Audio

PS Audio PowerPlay Manual del propietario

Brady

Brady LOCKOUT PRO 3.0 Manual de servicio

Avaya

Avaya Interaction Center Manual de usuario

Texas Instruments

Texas Instruments TI-83 Plus Silver Edition Manual

Novell

Novell GROUPWISE 8 - INTERNET AGENT Manual de usuario

Oracle

Oracle Application 9i Manual de usuario

Acer

Acer RDM Manual de usuario

Canon

Canon Vixia HF21 Manual de usuario

Canon

Canon ZR950 Manual de usuario

Samsung

Samsung Auto Backup Manual de usuario

Polycom

Polycom Vortex EF2201 Instrucciones de instalación y funcionamiento

Brocade Communications Systems

Brocade Communications Systems Brocade 8/12c Manual de usuario