VMware vCloud Suite Client SDK .NET - README |
|
Directory Structure
The following table contains a brief description of the directory structure of the client SDK.
| Directory | Contents | Documentation |
|---|---|---|
| lib | Client libraries | |
| samples | Contains C# client samples that demonstrate usage of some of the APIs exposed. The samples come pre-compiled into DLL for convenience | |
| dotnet-toolkit | The C# Code Generator used for generating C# client stubs (.NET client libraries) that can interact with vCloud Suite APIs | |
| wsdl | WSDL and XML Schema files for vSphere, Single Sign-On, and lookup service APIs. Note that the SDK already contains pre compiled versions of these API descriptions under the lib directory | |
| This HTML README file |
SDK API Documentation
The apidocs directory contains the generated .NET API reference documentation for vCloud Suite features like Content Library and Tagging. The document main page also includes a hyperlink to vSphere Management SDK documentation for convenience.
SDK Libraries
All the supplied DLLs are located under the lib directory.
| Name | Description |
|---|---|
| .NET library responsible for serialization and de-serialization of objects into wire protocol | |
| .NET library to vCloud Suite APIs | |
| XML based documentation for vCloud Suite APIs (used by IDEs such as Visual Studio to provide API documentation) | |
| .NET library to Lookup Service | |
| Vim25Service.dll | .NET library to vSphere API |
| STSService.dll | .NET library to VMware Single Sign-On (SSO) |
| CommandLine.dll | Command line parser library used by the samples project |
.NET Toolkit
Generates the client stubs from the IDL files. Here is an example run of the tool:
E:\VMware-vCloudSuite-.NetSDK>client\toolkit\bin\csharp-generator.bat --library vapi_stdlib.vmidl --output toyvm-client ToyVM.java
INFO: Generating csharp files ...
INFO: Processing target language: csharp
INFO: > Found 1 csharp language 'products' templates ...
INFO: > Found 1 csharp language 'packages' templates ...
INFO: > Found 4 csharp language 'services' templates ...
INFO: > Found 1 csharp language 'structures' templates ...
INFO: > Found 1 csharp language 'enumerations' templates ...
INFO: Processing product scope templates ...
INFO: > Generating file: toyvm-client\csharp\tbd\util\StructTypeUtil.cs ...
INFO: Processing package scope templates for 'idl.model.IdlPackage(name:sample.first)' ...
INFO: > Generating file: toyvm-client\csharp\sample\first\StructDefinitions.cs ...
INFO: Processing service scope templates for 'ToyVM' ...
INFO: > Generating file: toyvm-client\csharp\sample\first\ToyVM.cs ...
INFO: > Generating file: toyvm-client\csharp\sample\first\ToyVMDefinitions.cs ...
INFO: > Generating file: toyvm-client\csharp\sample\first\ToyVMStub.cs ...
INFO: > Generating file: toyvm-client\csharp\sample\first\ToyVMTypes.cs ...
|
Copyright © 2015 VMware, Inc. All rights not expressly granted herein are reserved. |
Last updated: 26th Jan 2015 | VMware vCloud Suite SDK .NET |