Class

VMware_VCloud_SDK_Vdc

class VMware_VCloud_SDK_Vdc extends VMware_VCloud_SDK_Abstract

Methods

string getEntityId()

Get vCloud ID of the vCloud resource entity from its data object.

 from VMware_VCloud_SDK_Abstract
VMware_VCloud_API_ReferenceType getVdcRef()

Get a reference to a VMware vCloud vDC entity.
VMware_VCloud_API_VdcType getVdc()

Get a VMware vCloud vDC entity.
string getId()

Constructs vCloud ID of this vDC from its UUID.
VMware_VCloud_API_LinkType|null getOrgRef()

Get the link to the container of the vDC.
VMware_VCloud_API_OrgType|null getOrg()

Get the container entity of the vDC.
array getAvailableNetworkRefs(string $name = null)

Get references to VMware vCloud available organization networks.
array getEdgeGatewayRefs(string $name = null)

Get references to all edgegateways for this Org vDC with the given name.
array getAvailableNetworks(string $name = null)

Get VMware vCloud available organization networks/organization vdc networks.
VMware_VCloud_API_OrgVdcNetworkType addOrgVdcNetwork(VMware_VCloud_API_OrgVdcNetworkType $vdcNetwork)

Create an isolated/routed Org vDC network which can be created by an org administrator.
array getVAppRefs(string $name = null)

Get references to all vApps or vApps with a given name in the vDC.
array getVApps(string $name = null)

Get all vApps or vApps with a given name in the vDC.
array getVAppTemplateRefs(string $name = null)

Get references to all VMware vCloud vApp templates or vApp templates with a given name in the vDC.
array getVAppTemplates(string $name = null)

Get all VMware vCloud vApp templates in this vDC or vApp templates with a given name.
string uploadOVFAsVAppTemplate(string $name, string $ovfDescriptorPath, string $description = null, boolean $manifestRequired = null, VMware_VCloud_API_ReferenceType $vdcStorageProfileRef, VMware_VCloud_API_ReferenceType $catalogRef)

Upload vApp template from an OVF pacakage.
checkCatalogForDuplicates(VMware_VCloud_API_ReferenceType $catalogRef, string $resourceName)

Check if the resource name is already existing in the catalog.
addResourceToCatalog($resourceRef, $catalog)

Add the resource to catalog.
null uploadOVFDescriptor(string $url, string $filename)

Upload OVF descriptor.
array getUploadFiles(VMware_VCloud_API_VAppTemplateType $vAppTemplate)

Get file information for uploading vApp template.
VMware_VCloud_API_VAppTemplateType sendUploadVAppTemplateRequest(string $name, string $format, string $description = null, boolean $manifestRequired = false, VMware_VCloud_API_ReferenceType $vdcStorageProfileRef = null)

Send a upload vApp template request.
array getMediaRefs(string $name = null)

Get references to all VMware vCloud media or media with the given name in the vDC.
array getMedias(string $name = null)

Get all VMware vCloud media or media with the given name in the vDC.
VMware_VCloud_API_MediaType uploadIsoMedia(string $isoName, VMware_VCloud_API_MediaType $mediaType, function $onProgress = false)

Upload an ISO format media.
VMware_VCloud_API_MediaType uploadFloppyMedia(string $floppyName, VMware_VCloud_API_MediaType $mediaType)

Upload a floppy format media.
VMware_VCloud_API_VAppTemplateType captureVApp(VMware_VCloud_API_CaptureVAppParamsType $params)

Capture a vApp to create a vApp template.
VMware_VCloud_API_MediaType cloneMoveMedia(VMware_VCloud_API_CloneMediaParamsType $params)

Clone or move a media image.
VMware_VCloud_API_VAppType cloneMoveVApp(VMware_VCloud_API_CloneVAppParamsType $params)

Clone or move a vApp.
VMware_VCloud_API_VAppTemplateType cloneMoveVAppTemplate(VMware_VCloud_API_CloneVAppTemplateParamsType $params)

Clone or move a vApp template.
VMware_VCloud_API_VAppType composeVApp(VMware_VCloud_API_ComposeVAppParamsType $params)

Compose a vApp.
VMware_VCloud_API_VAppType instantiateVAppTemplate(VMware_VCloud_API_InstantiateVAppTemplateParamsType $params)

Instantiate a vApp template by providing a VMwareVCloudAPI_InstantiateVAppTemplateParamsType data object.
VMware_VCloud_API_VAppType instantiateVAppTemplateDefault(string $name, VMware_VCloud_API_ReferenceType $sourceRef, boolean $deploy = false, boolean $powerOn = false, string $description = null)

Instantiate a vApp template with default settings.
VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null getMetadata(string $key = null, string $domain = null)

Get metadata associated with the vDC or metadata associated with the vDC for the specified key in the specified domain.
VMware_VCloud_API_DiskType createDisk(VMware_VCloud_API_DiskCreateParamsType $params)

Create a disk.
array getDiskRefs(string $name = null)

Get references to all disks or a disk with a given name in the vDC.
array getDisks(string $name = null)

Get all disks or disk with a given name in the vDC.
array|null getVdcStorageProfileRefs(string $name = null)

Get vDC storage profile references.
array|null getVdcStorageProfiles(string $name = null)

Get vDC storage profiles.
VMware_VCloud_API_VAppType uploadOVFAsVApp(VMware_VCloud_API_InstantiateOvfParamsType $params, string $ovfDescriptorPath)

Creating vApp by uploading an ovf package.
VMware_VCloud_API_VAppType instantiateOvf(VMware_VCloud_API_InstantiateOvfParamsType $params)

Instantiate a vApp or VM from an OVF.

Details

in VMware_VCloud_SDK_Abstract at line 85
public string getEntityId()

Get vCloud ID of the vCloud resource entity from its data object.

Return Value

string

at line 10
public VMware_VCloud_API_ReferenceType getVdcRef()

Get a reference to a VMware vCloud vDC entity.

Return Value

VMware_VCloud_API_ReferenceType

at line 21
public VMware_VCloud_API_VdcType getVdc()

Get a VMware vCloud vDC entity.

Return Value

VMware_VCloud_API_VdcType

at line 32
public string getId()

Constructs vCloud ID of this vDC from its UUID.

Return Value

string

at line 43
public VMware_VCloud_API_LinkType|null getOrgRef()

Get the link to the container of the vDC.

Return Value

VMware_VCloud_API_LinkType|null

at line 54
public VMware_VCloud_API_OrgType|null getOrg()

Get the container entity of the vDC.

Return Value

VMware_VCloud_API_OrgType|null

at line 67
public array getAvailableNetworkRefs(string $name = null)

Get references to VMware vCloud available organization networks.

Parameters

string $name Name of the available networks. If null, returns all

Return Value

array VMwareVCloudAPI_ReferenceType object array

at line 81
public array getEdgeGatewayRefs(string $name = null)

Get references to all edgegateways for this Org vDC with the given name.

Parameters

string $name Name of the edgegateway to get. If null, returns all

Return Value

array VMwareVCloudAPI_ReferenceType object array

at line 104
public array getAvailableNetworks(string $name = null)

Get VMware vCloud available organization networks/organization vdc networks.

Parameters

string $name Name of the available networks. If null, returns all

Return Value

array VMwareVCloudAPI_OrgNetworkType object array for 1.5

at line 119
public VMware_VCloud_API_OrgVdcNetworkType addOrgVdcNetwork(VMware_VCloud_API_OrgVdcNetworkType $vdcNetwork)

Create an isolated/routed Org vDC network which can be created by an org administrator.

Parameters

VMware_VCloud_API_OrgVdcNetworkType $vdcNetwork

Return Value

VMware_VCloud_API_OrgVdcNetworkType

at line 146
public array getVAppRefs(string $name = null)

Get references to all vApps or vApps with a given name in the vDC.

Parameters

string $name Name of the vApp. If null, returns all

Return Value

array VMwareVCloudAPI_ResourceReferenceType object array

at line 159
public array getVApps(string $name = null)

Get all vApps or vApps with a given name in the vDC.

Parameters

string $name Name of the vApp. If null, returns all

Return Value

array VMwareVCloudAPI_VAppType object array

at line 173
public array getVAppTemplateRefs(string $name = null)

Get references to all VMware vCloud vApp templates or vApp templates with a given name in the vDC.

Parameters

string $name Name of the vApp template. If null, returns all

Return Value

array VMwareVCloudAPI_ReferenceType object array

at line 189
public array getVAppTemplates(string $name = null)

Get all VMware vCloud vApp templates in this vDC or vApp templates with a given name.

Parameters

string $name Name of the vApp template. If null, returns all

Return Value

array VMwareVCloudAPI_VAppTemplateType object array

at line 210
public string uploadOVFAsVAppTemplate(string $name, string $ovfDescriptorPath, string $description = null, boolean $manifestRequired = null, VMware_VCloud_API_ReferenceType $vdcStorageProfileRef, VMware_VCloud_API_ReferenceType $catalogRef)

Upload vApp template from an OVF pacakage.

Parameters

string $name Name of the vApp template to be created
string $ovfDescriptorPath Path to the OVF descriptor
string $description Description of the vApp template to be created
boolean $manifestRequired A flag indicates the manifest file is required or not
VMware_VCloud_API_ReferenceType $vdcStorageProfileRef
VMware_VCloud_API_ReferenceType $catalogRef

Return Value

string A URL of the newly created vApp template.

Exceptions

VMware_VCloud_SDK_Exception

at line 270
public checkCatalogForDuplicates(VMware_VCloud_API_ReferenceType $catalogRef, string $resourceName)

Check if the resource name is already existing in the catalog.

Parameters

VMware_VCloud_API_ReferenceType $catalogRef
string $resourceName Name of the vApp template to be created.

at line 291
public addResourceToCatalog($resourceRef, $catalog)

Add the resource to catalog.

Parameters

$resourceRef
$catalog

at line 308
public null uploadOVFDescriptor(string $url, string $filename)

Upload OVF descriptor.

Parameters

string $url HTTP request URL
string $filename Path to the OVF descriptor

Return Value

null

at line 321
public array getUploadFiles(VMware_VCloud_API_VAppTemplateType $vAppTemplate)

Get file information for uploading vApp template.

Parameters

VMware_VCloud_API_VAppTemplateType $vAppTemplate

Return Value

array VMwareVCloudAPI_FileType object array

Exceptions

VMware_VCloud_SDK_Exception

at line 357
public VMware_VCloud_API_VAppTemplateType sendUploadVAppTemplateRequest(string $name, string $format, string $description = null, boolean $manifestRequired = false, VMware_VCloud_API_ReferenceType $vdcStorageProfileRef = null)

Send a upload vApp template request.

Parameters

string $name Name of the vApp template
string $format Format of the package to be uploaded
string $description Description of the vApp template to be created
boolean $manifestRequired A flag indicates the manifest file is required or not
VMware_VCloud_API_ReferenceType $vdcStorageProfileRef A reference to the storage profile being used

Return Value

VMware_VCloud_API_VAppTemplateType

at line 380
public array getMediaRefs(string $name = null)

Get references to all VMware vCloud media or media with the given name in the vDC.

Parameters

string $name Name of the media. If null, returns all

Return Value

array VMwareVCloudAPI_ResourceReferenceType object array

at line 393
public array getMedias(string $name = null)

Get all VMware vCloud media or media with the given name in the vDC.

Parameters

string $name Name of the media. If null, returns all

Return Value

array VMwareVCloudAPI_MediaType object array

at line 474
public VMware_VCloud_API_MediaType uploadIsoMedia(string $isoName, VMware_VCloud_API_MediaType $mediaType, function $onProgress = false)

Upload an ISO format media.

Parameters

string $isoName Media full path file name
VMware_VCloud_API_MediaType $mediaType
function $onProgress @yconan

Return Value

VMware_VCloud_API_MediaType

at line 488
public VMware_VCloud_API_MediaType uploadFloppyMedia(string $floppyName, VMware_VCloud_API_MediaType $mediaType)

Upload a floppy format media.

Parameters

string $floppyName Full path of a floppy file
VMware_VCloud_API_MediaType $mediaType

Return Value

VMware_VCloud_API_MediaType

at line 500
public VMware_VCloud_API_VAppTemplateType captureVApp(VMware_VCloud_API_CaptureVAppParamsType $params)

Capture a vApp to create a vApp template.

Parameters

VMware_VCloud_API_CaptureVAppParamsType $params

Return Value

VMware_VCloud_API_VAppTemplateType

at line 514
public VMware_VCloud_API_MediaType cloneMoveMedia(VMware_VCloud_API_CloneMediaParamsType $params)

Clone or move a media image.

Parameters

VMware_VCloud_API_CloneMediaParamsType $params

Return Value

VMware_VCloud_API_MediaType

at line 528
public VMware_VCloud_API_VAppType cloneMoveVApp(VMware_VCloud_API_CloneVAppParamsType $params)

Clone or move a vApp.

Parameters

VMware_VCloud_API_CloneVAppParamsType $params

Return Value

VMware_VCloud_API_VAppType

at line 542
public VMware_VCloud_API_VAppTemplateType cloneMoveVAppTemplate(VMware_VCloud_API_CloneVAppTemplateParamsType $params)

Clone or move a vApp template.

Parameters

VMware_VCloud_API_CloneVAppTemplateParamsType $params

Return Value

VMware_VCloud_API_VAppTemplateType

at line 557
public VMware_VCloud_API_VAppType composeVApp(VMware_VCloud_API_ComposeVAppParamsType $params)

Compose a vApp.

Parameters

VMware_VCloud_API_ComposeVAppParamsType $params

Return Value

VMware_VCloud_API_VAppType

at line 572
public VMware_VCloud_API_VAppType instantiateVAppTemplate(VMware_VCloud_API_InstantiateVAppTemplateParamsType $params)

Instantiate a vApp template by providing a VMwareVCloudAPI_InstantiateVAppTemplateParamsType data object.

Parameters

VMware_VCloud_API_InstantiateVAppTemplateParamsType $params

Return Value

VMware_VCloud_API_VAppType

at line 594
public VMware_VCloud_API_VAppType instantiateVAppTemplateDefault(string $name, VMware_VCloud_API_ReferenceType $sourceRef, boolean $deploy = false, boolean $powerOn = false, string $description = null)

Instantiate a vApp template with default settings.

Parameters

string $name Name of the vApp to be created
VMware_VCloud_API_ReferenceType $sourceRef Reference to the source vApp template
boolean $deploy A flag indicates deploy or not after instantiation
boolean $powerOn A flag indicates power on or not after instantiation
string $description Description of the vApp to be created

Return Value

VMware_VCloud_API_VAppType

at line 618
public VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null getMetadata(string $key = null, string $domain = null)

Get metadata associated with the vDC or metadata associated with the vDC for the specified key in the specified domain.

Parameters

string $key
string $domain

Return Value

VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null

at line 630
public VMware_VCloud_API_DiskType createDisk(VMware_VCloud_API_DiskCreateParamsType $params)

Create a disk.

Parameters

VMware_VCloud_API_DiskCreateParamsType $params

Return Value

VMware_VCloud_API_DiskType

at line 644
public array getDiskRefs(string $name = null)

Get references to all disks or a disk with a given name in the vDC.

Parameters

string $name Name of the disk. If null, returns all

Return Value

array VMwareVCloudAPI_ResourceReferenceType object array

at line 657
public array getDisks(string $name = null)

Get all disks or disk with a given name in the vDC.

Parameters

string $name Name of the disk. If null, returns all

Return Value

array VMwareVCloudAPI_DiskType object array

at line 670
public array|null getVdcStorageProfileRefs(string $name = null)

Get vDC storage profile references.

Parameters

string $name Name of the vDC storage profile. If null, returns all

Return Value

array|null VMwareVCloudAPI_ReferenceType object array or null

at line 684
public array|null getVdcStorageProfiles(string $name = null)

Get vDC storage profiles.

Parameters

string $name Name of the vDC storage profile. If null, returns all

Return Value

array|null VMwareVCloudAPI_VdcStorageProfileType object array or null

at line 699
public VMware_VCloud_API_VAppType uploadOVFAsVApp(VMware_VCloud_API_InstantiateOvfParamsType $params, string $ovfDescriptorPath)

Creating vApp by uploading an ovf package.

Parameters

VMware_VCloud_API_InstantiateOvfParamsType $params
string $ovfDescriptorPath Path to the OVF descriptor

Return Value

VMware_VCloud_API_VAppType

at line 746
public VMware_VCloud_API_VAppType instantiateOvf(VMware_VCloud_API_InstantiateOvfParamsType $params)

Instantiate a vApp or VM from an OVF.

Parameters

VMware_VCloud_API_InstantiateOvfParamsType $params

Return Value

VMware_VCloud_API_VAppType