User manual VMWARE VCLOUD SDK 1.0 FOR NET DEVELOPERS GUIDE

[. . . ] Version 1. 0 (Beta) 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 C# programming language, the . NET framework, Representational State Transfer (REST) and RESTful programming conventions, the Open Virtualization Format (OVF) Specification, 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. [. . . ] Static methods get resources by passing object references, and act as constructors for SDK wrapper objects. NOTE The vCloud SDK for . NET does not provide object lifecycle management. Every wrapper object represents the resource at the time of the GET operation. If a client makes multiple GET requests for the same resource, the client receives multiple representations of the resource wrapped in the helper object. It is the client's responsibility to make new requests to get the latest values. To avoid memory leaks, the client must dispose of objects that are not in use. VMware, Inc. 9 vCloud SDK for . NET Developer's Guide 10 VMware, Inc. 2 Setting Up for . NET Development 2 This chapter describes how to prepare for using the vCloud SDK for . NET, how to download the SDK, and how to install and use it. In the Resources area of the vCloud SDK for . NET Community page, click the Download button. When the download completes, uncompress the download package into any convenient folder on your computer. The package includes the following folders: Docs: vCloud SDK for . NET reference documentation in HTML format. Samples: Example code demonstrating common use cases associated with programmatically managing virtual infrastructure. 7 8 Import the package into Visual Studio. See the README file in the download for information about additional DLL files that you must obtain. 12 VMware, Inc. 3 Hello vCloud: A Structured Workflow Example 3 This chapter presents an example of using the vCloud SDK for . NET to implement a structured workflow through the lifecycle of a vApp. This chapter contains the following topics. "Running the HellovCloud Example" on page 13 "Logging In and Getting an Organization List" on page 14 "Getting References to the vDC and Catalog" on page 14 "Upload an OVF Package to Create a vApp Template" on page 14 "Add the vApp Template to a Catalog" on page 16 "Instantiate the vApp Template" on page 16 "Operate the vApp" on page 17 Running the HellovCloud Example The HellovCloud example, included in the Samples folder, demonstrates the following operations supported by the vCloud SDK for . NET: Logging in to the vCloud Uploading an OVF package to create a vApp template Adding the vApp template to a catalog Instantiating the vApp template to create a vApp Operating the vApp The file HellovCloud. txt in the Samples folder includes example program input and output. For information about building the examples, see "Building the Examples" on page 19. To run the HellovCloud example, use a command of the following form: . Net HellovCloud vCloudApiVersionsURL versionId user@vcloud-organization password orgName vdcName ovfFileLocation vmdkFileLocation vmdkFileName catalogName The following options are required: vCloudApiVersionsURL is the base API URL of the vCloud. username is the name of a vCloud Director user, in the form user@vcloudorganization, who has rights to upload OVF, create vApp templates, create vApps, and operate vApps. VMware, Inc. 13 vCloud SDK for . NET Developer's Guide password is the user's password. orgName is the name of the organization to which the user is authenticating. vdcName is the name of a vDC in that organization where the user can upload the OVF and deploy the vApp. ovfFileLocation is the full pathname to the OVF descriptor on the local disk. vmdkFileLocation is the full pathname to the vmdk file referenced in the OVF descriptor. catalogName is the name of the catalog in which the vApp template will be catalogued. For example: . Net HellovCloud https://vcloud. example. com/api/versions 1. 0 user@exampleOrg Pa55w0rd exampleOrg exampleVdc C:\descriptor. ovf C:\disk. vmdk disk. vmdk exampleCatalog Logging In and Getting an Organization List Most vCloud API requests must be authenticated by a login request that supplies user credentials in the form required by Basic HTTP authentication (MIME Base64 encoding of a string having the form user@vcloudorganization:password). The vCloudClient class implements a login method that takes the following parameters: userName: supplied in the form user@vcloudorganization password: the user's password The HellovCloud example uses this method to authenticate to the cloud. [. . . ] Delete the vApp using the vapp. Delete() method. VMware, Inc. 17 vCloud SDK for . NET Developer's Guide 18 VMware, Inc. 4 Using the Examples 4 The vCloud SDK for . NET includes example programs that demonstrate how to use the SDK to develop client applications. This chapter contains the following topics: "Building the Examples" on page 19 "Running the Examples" on page 19 Building the Examples To build the examples in Visual Studio 1 2 Doubleclick the file samples. sln. Click Build > Build Solution. Running the Examples Examples listed in Table 41 can be run by any user with rights to create and modify catalog items and vApps. User API Examples Example Name CatalogInventory CatalogItemCRUD DiskCRUD ListAllvApps ThreadSample VdcInventoryCRUD Description Lists name and href for all items in all catalogs in the organization. [. . . ]