class VMware_VCloud_SDK_Vm extends VMware_VCloud_SDK_VApp_Abstract
public string
getEntityId()
Get vCloud ID of the vCloud resource entity from its data object.
public VMware_VCloud_API_TaskType
deploy(VMware_VCloud_API_DeployVAppParamsType $params)
Deploy the vApp or VM.
public VMware_VCloud_API_TaskType
undeploy(VMware_VCloud_API_UndeployVAppParamsType $params)
Undeploy the vApp or VM.
public VMware_VCloud_API_TaskType
delete()
Delete the vApp or VM.
The vApp or VM has to be powered off and undeployed before it can be deleted.
public VMware_VCloud_API_TaskType
powerOn()
Power on the VM or all Vms contained in the vApp.
public VMware_VCloud_API_TaskType
powerOff()
Power off the VM or all VMs contained in the vApp.
public VMware_VCloud_API_TaskType
reset()
Reset the VM or all VMs contained in the vApp.
public VMware_VCloud_API_TaskType
reboot()
Reboot the VM or all VMs contained in the vApp.
public VMware_VCloud_API_TaskType
suspend()
Suspend the VM or all VMs contained in the vApp.
public VMware_VCloud_API_TaskType
discardSuspendedState()
Discard suspended state of the VM or all VMs contained in the vApp.
public VMware_VCloud_API_TaskType
shutdown()
Shutdown the VM or all VMs contained in the vApp.
public VMware_VCloud_API_MetadataType|VMware_VCloud_API_MetadataValueType|null
getMetadata(string $key = null, string $domain = null)
Get metadata associated with the vApp/VM or metadata associated with the vApp/VM for the specified key in the specified domain.
public VMware_VCloud_API_TaskType
mergeMetadata(VMware_VCloud_API_MetadataType $meta)
Merges the metadata for the vApp or VM with the information provided.
public 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 or VM to the value provided.
Note: This will replace any existing metadata information.
public VMware_VCloud_API_TaskType
deleteMetadataByKey(string $key, string $domain = null)
Deletes the metadata for the particular key in the specified domain for the vApp or VM.
public VMware_VCloud_API_ReferenceType
getVmRef()
Get a reference to a VMware vCloud VM entity.
public VMware_VCloud_API_VmType
getVm()
Get a VMware vCloud VM entity.
public string
getId()
Constructs the vCloud entity ID of this VM from its UUID.
public VMware_VCloud_API_LinkType|null
getContainerVAppRef()
Get the link to the container of the VM.
public VMware_VCloud_API_VAppType|null
getContainerVApp()
Get the container of the VM.
public VMware_VCloud_API_OVF_VirtualHardwareSection_Type
getVirtualHardwareSettings()
Get virtual hardware settings of this VM.
public VMware_VCloud_API_TaskType
modifyVirtualHardwareSettings(VMware_VCloud_API_OVF_VirtualHardwareSection_Type $vhSection)
Modify the guest virtual hardware settings.
public VMware_VCloud_API_OVF_RASD_Type
getVirtualCpu()
Get the CPU settings of this VM.
public VMware_VCloud_API_TaskType
modifyVirtualCpu(VMware_VCloud_API_OVF_RASD_Type $cpu)
Modify the CPU settings of this VM.
public VMware_VCloud_API_OVF_RASD_Type
getVirtualMemory()
Get the memory settings of this VM.
public VMware_VCloud_API_TaskType
modifyVirtualMemory(VMware_VCloud_API_OVF_RASD_Type $mem)
Modify the memory settings of this VM.
public VMware_VCloud_API_RasdItemsListType
getVirtualDisks()
Get a RASD list object representing virtual disks of this VM.
public VMware_VCloud_API_TaskType
modifyVirtualDisks(VMware_VCloud_API_RasdItemsListType $rasdItems)
Modify virtual disk(s) of this VM.
public VMware_VCloud_API_RasdItemsListType
getVirtualNetworkCards()
Get a RASD list object representing virtual network cards of this VM.
public VMware_VCloud_API_TaskType
modifyVirtualNetworkCards(VMware_VCloud_API_RasdItemsListType $rasdItems)
Modify virtual network card(s) of this VM.
public VMware_VCloud_API_RasdItemsListType
getVirtualMedia()
Get a RASD list object representing virtual floppy and CD/DVD drives of this VM.
public VMware_VCloud_API_OVF_OperatingSystemSection_Type
getOperatingSystemSettings()
Get the operating system settings of this VM.
public VMware_VCloud_API_TaskType
modifyOperatingSystemSettings(VMware_VCloud_API_OVF_OperatingSystemSection_Type $os)
Modify the operating system settings of this VM.
public VMware_VCloud_API_TaskType
reconfigureVm(VMware_VCloud_API_VmType $params)
Updates Vm name, Description, and any or all of the following sections.
VirtualHardwareSection OperatingSystemSection NetworkConnectionSection GuestCustomizationSection
public VMware_VCloud_API_NetworkConnectionSectionType
getNetworkConnectionSettings()
Get the network connection settings of this VM.
public VMware_VCloud_API_TaskType
modifyNetworkConnectionSettings(VMware_VCloud_API_NetworkConnectionSectionType $net)
Modify the network connection settings of this VM.
public VMware_VCloud_API_GuestCustomizationSectionType
getGuestCustomizationSettings()
Get guest customization settings.
public VMware_VCloud_API_TaskType
modifyGuestCustomizationSettings(VMware_VCloud_API_GuestCustomizationSectionType $cs)
Modify the customization settings of this VM.
public VMware_VCloud_API_TaskType
insertMedia(VMware_VCloud_API_MediaInsertOrEjectParamsType $params)
Insert a virtual media.
public VMware_VCloud_API_TaskType
ejectMedia(VMware_VCloud_API_MediaInsertOrEjectParamsType $params)
Eject a virtual media.
public null
getScreenThumbnailImage(string $thumbnail)
Get a VM screen thumbnail image.
public VMware_VCloud_API_ScreenTicketType
getScreenTicket()
Get a VM screen ticket.
public array
getScreenTicketTokens()
Get a VM screen ticket tokens, in IP address, VM MOF, and encided-ticket
public VMware_VCloud_API_MksTicketType
acquireMksTicket()
Retrieve a mks ticket that you can use to gain access to the console of a running VM.
public VMware_VCloud_API_VmPendingQuestionType
getPendingQuestion()
Get a VM pending question.
public null
answerPendingQuestion(VMware_VCloud_API_VmQuestionAnswerType $answer)
Answer a VM pending question.
public int
getStatus()
Get the status of this VM.
The following are the possible VM status:
public VMware_VCloud_API_TaskType
modify(string $name = null, string $description = null)
Modify name and/or description of this VM.
public VMware_VCloud_API_TaskType
installVMwareTools()
Installs VMware tools to the VM.
public VMware_VCloud_API_RuntimeInfoSectionType
getRuntimeInfo()
Get the runtime info section of the VM.
public array|null
getProductInfo()
Get the installed software information of the VM.
public VMware_VCloud_API_TaskType
modifyProductInfo(VMware_VCloud_API_OVF_ProductSection_Type $productInfo)
Modify the installed software information of the VM.
public VMware_VCloud_API_TaskType
consolidate()
Consolidates the VM.
public VMware_VCloud_API_TaskType
relocate(VMware_VCloud_API_RelocateParamsType $params)
Relocates the VM.
public VMware_VCloud_API_TaskType
upgradeHardwareVersion()
Upgrade virtual hardware version of the VM.
public VMware_VCloud_API_TaskType
attachDisk(VMware_VCloud_API_DiskAttachOrDetachParamsType $params)
Attach a disk to a VM.
public VMware_VCloud_API_TaskType
detachDisk(VMware_VCloud_API_DiskAttachOrDetachParamsType $params)
Detach a disk to a VM.
public VMware_VCloud_API_TaskType
enableNestedHypervisor()
Enable nested hypervisor of the VM.
public VMware_VCloud_API_TaskType
disableNestedHypervisor()
Disable nested hypervisor of the VM.
public VMware_VCloud_API_TaskType
CheckCompliance()
Perform storage profile compliance check on a VM.
public VMware_VCloud_API_SnapshotSectionType
getSnapshotSection()
Retrieve SnapshotSection element for a vApp or VM.
public VMware_VCloud_API_ComplianceResultType
getComplianceResult()
Get storage profile compliance result of the VM.
public VMware_VCloud_API_VmCapabilitiesType
getVmCapabilities()
Get capability of the VM.
public VMware_VCloud_API_TaskType
updateVmCapabilities(VMware_VCloud_API_VmCapabilitiesType $capType)
Update capability of the VM.
public VMware_VCloud_API_TaskType
createSnapshot(VMware_VCloud_API_CreateSnapshotParamsType $params)
Creates new snapshot of a virtual machine or of all the virtual machines in a vApp.
Prior to creation of the new
snapshots, any existing user created snapshots associated with the virtual machines are removed.
public VMware_VCloud_API_TaskType
removeAllSnapshots()
Removes all user created snapshots for a vApp or virtual machine.
public VMware_VCloud_API_TaskType
revertToCurrentSnapshot()
Reverts a vApp or virtual machine to the current snapshot, if any.
public array
getShadowVmsRefs(string $name = null)
Get collection of shadow vm references.
vAppTemplate VM contains the shadow vm references. Applicable for vAppTemplate VM not for vApp VM.