Reference documentation and code samples for the Google Cloud Vm Migration V1 Client class VmwareVmDetails.
VmwareVmDetails describes a VM in vCenter.
Generated from protobuf message google.cloud.vmmigration.v1.VmwareVmDetails
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ vm_id |
string
The VM's id in the source (note that this is not the MigratingVm's id). This is the moref id of the VM. |
↳ datacenter_id |
string
The id of the vCenter's datacenter this VM is contained in. |
↳ datacenter_description |
string
The descriptive name of the vCenter's datacenter this VM is contained in. |
↳ uuid |
string
The unique identifier of the VM in vCenter. |
↳ display_name |
string
The display name of the VM. Note that this is not necessarily unique. |
↳ power_state |
int
The power state of the VM at the moment list was taken. |
↳ cpu_count |
int
The number of cpus in the VM. |
↳ memory_mb |
int
The size of the memory of the VM in MB. |
↳ disk_count |
int
The number of disks the VM has. |
↳ committed_storage_mb |
int|string
The total size of the storage allocated to the VM in MB. |
↳ guest_description |
string
The VM's OS. See for example https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold. |
↳ boot_option |
int
Output only. The VM Boot Option. |
getVmId
The VM's id in the source (note that this is not the MigratingVm's id).
This is the moref id of the VM.
| Returns | |
|---|---|
| Type | Description |
string | |
setVmId
The VM's id in the source (note that this is not the MigratingVm's id).
This is the moref id of the VM.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDatacenterId
The id of the vCenter's datacenter this VM is contained in.
| Returns | |
|---|---|
| Type | Description |
string | |
setDatacenterId
The id of the vCenter's datacenter this VM is contained in.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDatacenterDescription
The descriptive name of the vCenter's datacenter this VM is contained in.
| Returns | |
|---|---|
| Type | Description |
string | |
setDatacenterDescription
The descriptive name of the vCenter's datacenter this VM is contained in.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUuid
The unique identifier of the VM in vCenter.
| Returns | |
|---|---|
| Type | Description |
string | |
setUuid
The unique identifier of the VM in vCenter.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
The display name of the VM. Note that this is not necessarily unique.
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
The display name of the VM. Note that this is not necessarily unique.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPowerState
The power state of the VM at the moment list was taken.
| Returns | |
|---|---|
| Type | Description |
int | |
setPowerState
The power state of the VM at the moment list was taken.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCpuCount
The number of cpus in the VM.
| Returns | |
|---|---|
| Type | Description |
int | |
setCpuCount
The number of cpus in the VM.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMemoryMb
The size of the memory of the VM in MB.
| Returns | |
|---|---|
| Type | Description |
int | |
setMemoryMb
The size of the memory of the VM in MB.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDiskCount
The number of disks the VM has.
| Returns | |
|---|---|
| Type | Description |
int | |
setDiskCount
The number of disks the VM has.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCommittedStorageMb
The total size of the storage allocated to the VM in MB.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setCommittedStorageMb
The total size of the storage allocated to the VM in MB.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGuestDescription
The VM's OS. See for example https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold.
| Returns | |
|---|---|
| Type | Description |
string | |
setGuestDescription
The VM's OS. See for example https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html for types of strings this might hold.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBootOption
Output only. The VM Boot Option.
| Returns | |
|---|---|
| Type | Description |
int | |
setBootOption
Output only. The VM Boot Option.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |