VMware_VCloud_SDK_VAppTemplate

class VMware_VCloud_SDK_VAppTemplate 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	getVAppTemplateRef() Get a reference to a VMware vCloud vApp template entity.
VMware_VCloud_API_VAppTemplateType	getVAppTemplate() Get a VMware vCloud vApp template entity.
string	getId() Constructs vCloud ID of this vApp template from its UUID.
VMware_VCloud_API_LinkType|null	getVdcRef() Get the link to the container of the vApp template.
VMware_VCloud_API_VdcType|null	getVdc() Get the container of the vApp template.
int	getStatus() Get status of a vApp template.
VMware_VCloud_API_TaskType	relocate(VMware_VCloud_API_RelocateParamsType $params, string $name) Relocate a VM to a different datastore.
VMware_VCloud_API_TaskType	enableDownload(boolean $wait = true) Enable a vApp template for downloading.
null	disableDownload() Disable a vApp template for downloading.
VMware_VCloud_API_OVF_EnvelopeType	getOVFDescriptor() Retrieve the OVF descriptor of a vApp Template directly.
String	getOVFDescriptorAsString() Retrieve the OVF descriptor of a vApp Template directly as string.
null	downloadOVFFiles(string $destDir = '.') Download files to form OVF package.
null	downloadLosslessOVFFile(string $destDir = '.') Download lossless vAppTemplate OVF.
VMware_VCloud_API_OVF_NetworkSection_Type	getNetworkSettings() Get the network settings of this vApp template.
VMware_VCloud_API_NetworkConfigSectionType	getNetworkConfigSettings() Get the network configure settings of this vApp template.
VMware_VCloud_API_CustomizationSectionType	getCustomizationSettings() Get customization information of this vApp template.
VMware_VCloud_API_TaskType	modifyCustomizationSettings(VMware_VCloud_API_CustomizationSectionType $customizationSection) Modify customization settings of this vApp template.
VMware_VCloud_API_LeaseSettingsSectionType	getLeaseSettings() Get the lease settings of this vApp template.
VMware_VCloud_API_TaskType	modifyLeaseSettings(VMware_VCloud_API_LeaseSettingsSectionType $leaseSettings) Modify the lease settings of this vApp template.
VMware_VCloud_API_TaskType	delete() Delete this vApp template.
VMware_VCloud_API_LinkType|null	getCatalogItemLink() Get a reference to a VMware vCloud catalog entity.
boolean	isPartOfCatalogItem() Returns true if vApp template is in Catalog, otherwise false.
VMware_VCloud_API_TaskType	deleteVAppTemplate() Deletes vApp template and its catalog item.
VMware_VCloud_API_TaskType	modify(string $name = null, string $description = null) Modify name or/and description of this vApp template.
array|null	getContainedVms($name $name = null) Get contained VMs in the vApp template.
VMware_VCloud_API_OwnerType	getOwner() Get vApp template owner.
VMware_VCloud_API_LinkType|null	getShadowVmsLink($name $name = null) Get a link to the shadow VMs of the VM in the vApp template.
array	getShadowVmsRefs(string $name) Get collection of shadow vm references.
VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null	getMetadata(string $key = null, string $domain = null) Get metadata associated with the vApp template or metadata associated with the vApp template for the specified key in the specified domain.
VMware_VCloud_API_TaskType	mergeMetadata(VMware_VCloud_API_MetadataType $meta) Merges the metadata for a vApp template with the information provided.
VMware_VCloud_API_TaskType	setMetadataByKey(string $key, VMware_VCloud_API_MetadataValueType $value, string $domain = null) Sets the metadata for the particular key in the specified domain for the vApp template to the value provided.
VMware_VCloud_API_TaskType	deleteMetadataByKey(string $key, string $domain = null) Deletes the metadata for the particular key in the specified domain for the vApp template.

Details

in VMware_VCloud_SDK_Abstract at line 85

public string getEntityId()

at line 10

public VMware_VCloud_API_ReferenceType getVAppTemplateRef()

at line 22

public VMware_VCloud_API_VAppTemplateType getVAppTemplate()

at line 33

public string getId()

at line 44

public VMware_VCloud_API_LinkType|null getVdcRef()

at line 55

public VMware_VCloud_API_VdcType|null getVdc()

at line 85

public int getStatus()

at line 99

public VMware_VCloud_API_TaskType relocate(VMware_VCloud_API_RelocateParamsType $params, string $name)

at line 119

public VMware_VCloud_API_TaskType enableDownload(boolean $wait = true)

at line 132

public null disableDownload()

at line 145

public VMware_VCloud_API_OVF_EnvelopeType getOVFDescriptor()

at line 158

public String getOVFDescriptorAsString()

at line 198

public null downloadOVFFiles(string $destDir = '.')

at line 245

public null downloadLosslessOVFFile(string $destDir = '.')

at line 315

public VMware_VCloud_API_OVF_NetworkSection_Type getNetworkSettings()

at line 326

public VMware_VCloud_API_NetworkConfigSectionType getNetworkConfigSettings()

at line 337

public VMware_VCloud_API_CustomizationSectionType getCustomizationSettings()

at line 349

public VMware_VCloud_API_TaskType modifyCustomizationSettings(VMware_VCloud_API_CustomizationSectionType $customizationSection)

at line 362

public VMware_VCloud_API_LeaseSettingsSectionType getLeaseSettings()

at line 375

public VMware_VCloud_API_TaskType modifyLeaseSettings(VMware_VCloud_API_LeaseSettingsSectionType $leaseSettings)

at line 389

public VMware_VCloud_API_TaskType delete()

at line 403

public VMware_VCloud_API_LinkType|null getCatalogItemLink()

at line 424

public boolean isPartOfCatalogItem()

at line 438

public VMware_VCloud_API_TaskType deleteVAppTemplate()

at line 457

public VMware_VCloud_API_TaskType modify(string $name = null, string $description = null)

at line 492

public array|null getContainedVms($name $name = null)

at line 506

public VMware_VCloud_API_OwnerType getOwner()

at line 519

public VMware_VCloud_API_LinkType|null getShadowVmsLink($name $name = null)

at line 546

public array getShadowVmsRefs(string $name)

at line 569

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

at line 581

public VMware_VCloud_API_TaskType mergeMetadata(VMware_VCloud_API_MetadataType $meta)

at line 600

public VMware_VCloud_API_TaskType setMetadataByKey(string $key, VMware_VCloud_API_MetadataValueType $value, string $domain = null)

at line 617

public VMware_VCloud_API_TaskType deleteMetadataByKey(string $key, string $domain = null)

---