- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- VmwareVmsDetails
- AwsVmsDetails
- AwsVmDetails
- PowerState
- BootOption
- AwsSecurityGroup
- VmVirtualizationType
- VmArchitecture
- AzureVmsDetails
- AzureVmDetails
- PowerState
- OSDisk
- Disk
- OSDescription
- BootOption
List remote source's inventory of VMs. The remote source is the onprem vCenter (remote in the sense it's not in Compute Engine). The inventory describes the list of existing VMs in that source. Note that this operation lists the VMs on the remote source, as opposed to listing the MigratingVms resources in the vmmigration service.
HTTP request
GET https://vmmigration.googleapis.com/v1alpha1/{source=projects/*/locations/*/sources/*}:fetchInventory
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
source |
Required. The name of the Source. Authorization requires the following IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
forceRefresh |
If this flag is set to true, the source will be queried instead of using cached results. Using this flag will make the call slower. |
pageSize |
The maximum number of VMs to return. The service may return fewer than this value. For AWS source: If unspecified, at most 500 VMs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. For VMWare source: If unspecified, all VMs will be returned. There is no limit for maximum value. |
pageToken |
A page token, received from a previous When paginating, all other parameters provided to |
Request body
The request body must be empty.
Response body
Response message for fetchInventory
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "updateTime": string, "nextPageToken": string, // Union field |
Fields | |
---|---|
updateTime |
Output only. The timestamp when the source was last queried (if the result is from the cache). A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
nextPageToken |
Output only. A token, which can be sent as |
Union field
|
|
vmwareVms |
The description of the VMs in a Source of type Vmware. |
awsVms |
The description of the VMs in a Source of type AWS. |
azureVms |
The description of the VMs in a Source of type Azure. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
VmwareVmsDetails
VmwareVmsDetails describes VMs in vCenter.
JSON representation |
---|
{
"details": [
{
object ( |
Fields | |
---|---|
details[] |
The details of the vmware VMs. |
AwsVmsDetails
AWSVmsDetails describes VMs in AWS.
JSON representation |
---|
{
"details": [
{
object ( |
Fields | |
---|---|
details[] |
The details of the AWS VMs. |
AwsVmDetails
AwsVmDetails describes a VM in AWS.
JSON representation |
---|
{ "vmId": string, "displayName": string, "sourceId": string, "sourceDescription": string, "powerState": enum ( |
Fields | |
---|---|
vmId |
The VM ID in AWS. |
displayName |
The display name of the VM. Note that this value is not necessarily unique. |
sourceId |
The id of the AWS's source this VM is connected to. |
sourceDescription |
The descriptive name of the AWS's source this VM is connected to. |
powerState |
Output only. The power state of the VM at the moment list was taken. |
cpuCount |
The number of cpus the VM has. |
memoryMb |
The memory size of the VM in MB. |
diskCount |
The number of disks the VM has. |
committedStorageMb |
The total size of the storage allocated to the VM in MB. |
osDescription |
The VM's OS. |
bootOption |
The VM Boot Option. |
instanceType |
The instance type of the VM. |
vpcId |
The VPC ID the VM belongs to. |
securityGroups[] |
The security groups the VM belongs to. |
tags |
The tags of the VM. An object containing a list of |
zone |
The AWS zone of the VM. |
virtualizationType |
The virtualization type. |
architecture |
The CPU architecture. |
PowerState
Possible values for the power state of the VM.
Enums | |
---|---|
POWER_STATE_UNSPECIFIED |
Power state is not specified. |
ON |
The VM is turned on. |
OFF |
The VM is turned off. |
SUSPENDED |
The VM is suspended. This is similar to hibernation or sleep mode. |
PENDING |
The VM is starting. |
BootOption
The possible values for the vm boot option.
Enums | |
---|---|
BOOT_OPTION_UNSPECIFIED |
The boot option is unknown. |
EFI |
The boot option is UEFI. |
BIOS |
The boot option is LEGACY-BIOS. |
AwsSecurityGroup
AwsSecurityGroup describes a security group of an AWS VM.
JSON representation |
---|
{ "id": string, "name": string } |
Fields | |
---|---|
id |
The AWS security group id. |
name |
The AWS security group name. |
VmVirtualizationType
Possible values for the virtualization types of the VM.
Enums | |
---|---|
VM_VIRTUALIZATION_TYPE_UNSPECIFIED |
The virtualization type is unknown. |
HVM |
The virtualziation type is HVM. |
PARAVIRTUAL |
The virtualziation type is PARAVIRTUAL. |
VmArchitecture
Possible values for the architectures of the VM.
Enums | |
---|---|
VM_ARCHITECTURE_UNSPECIFIED |
The architecture is unknown. |
I386 |
The architecture is I386. |
X86_64 |
The architecture is X86_64. |
ARM64 |
The architecture is ARM64. |
X86_64_MAC |
The architecture is X86_64_MAC. |
AzureVmsDetails
AzureVmsDetails describes VMs in Azure.
JSON representation |
---|
{
"details": [
{
object ( |
Fields | |
---|---|
details[] |
The details of the Azure VMs. |
AzureVmDetails
AzureVmDetails describes a VM in Azure.
JSON representation |
---|
{ "vmId": string, "powerState": enum ( |
Fields | |
---|---|
vmId |
The VM full path in Azure. |
powerState |
The power state of the VM at the moment list was taken. |
vmSize |
VM size as configured in Azure. Determines the VM's hardware spec. |
cpuCount |
The number of cpus the VM has. |
memoryMb |
The memory size of the VM in MB. |
diskCount |
The number of disks the VM has, including OS disk. |
committedStorageMb |
The total size of the storage allocated to the VM in MB. |
osDisk |
Description of the OS disk. |
disks[] |
Description of the data disks. |
osDescription |
Description of the OS. |
bootOption |
The VM Boot Option. |
tags |
The tags of the VM. An object containing a list of |
computerName |
The VM's ComputerName. |
PowerState
Possible values for the power state of the VM.
Enums | |
---|---|
POWER_STATE_UNSPECIFIED |
Power state is not specified. |
STARTING |
The VM is starting. |
RUNNING |
The VM is running. |
STOPPING |
The VM is stopping. |
STOPPED |
The VM is stopped. |
DEALLOCATING |
The VM is deallocating. |
DEALLOCATED |
The VM is deallocated. |
UNKNOWN |
The VM's power state is unknown. |
OSDisk
A message describing the OS disk.
JSON representation |
---|
{ "type": string, "name": string, "sizeGb": integer } |
Fields | |
---|---|
type |
The disk's type. |
name |
The disk's full name. |
sizeGb |
The disk's size in GB. |
Disk
A message describing a data disk.
JSON representation |
---|
{ "name": string, "sizeGb": integer, "lun": integer } |
Fields | |
---|---|
name |
The disk name. |
sizeGb |
The disk size in GB. |
lun |
The disk's Logical Unit Number (LUN). |
OSDescription
A message describing the VM's OS. Including OS, Publisher, Offer and Plan if applicable.
JSON representation |
---|
{ "type": string, "publisher": string, "offer": string, "plan": string } |
Fields | |
---|---|
type |
OS type. |
publisher |
OS publisher. |
offer |
OS offer. |
plan |
OS plan. |
BootOption
The possible values for the vm boot option.
Enums | |
---|---|
BOOT_OPTION_UNSPECIFIED |
The boot option is unknown. |
EFI |
The boot option is UEFI. |
BIOS |
The boot option is BIOS. |