VirtualMachineDetails

JSON representation
OperatingSystemFamily
VirtualMachineArchitectureDetails
- JSON representation
HyperThreading
VirtualMachineNetworkDetails
- JSON representation
VirtualMachineDiskDetails
- JSON representation

Details of a VirtualMachine.

JSON representation

JSON representation
{ "coreCount" : integer , "memoryMb" : integer , "osName" : string , "vmUuid" : string , "vmName" : string , "osFamily" : enum ( `OperatingSystemFamily` ) , "vmArchitecture" : { object ( `VirtualMachineArchitectureDetails` ) } , "vmNetwork" : { object ( `VirtualMachineNetworkDetails` ) } , "vmDisks" : { object ( `VirtualMachineDiskDetails` ) } , "diskPartitions" : { object ( `DiskPartitionDetails` ) } , "guestOs" : { object ( `GuestOsDetails` ) } , "vcenterFolder" : string , "vcenterUrl" : string , "vcenterVmId" : string , "powerState" : string , "platform" : { object ( `PlatformDetails` ) } , "osVersion" : string , "createTime" : string }

 { 
 "coreCount" 
 : 
 integer 
 , 
 "memoryMb" 
 : 
 integer 
 , 
 "osName" 
 : 
 string 
 , 
 "vmUuid" 
 : 
 string 
 , 
 "vmName" 
 : 
 string 
 , 
 "osFamily" 
 : 
 enum (  OperatingSystemFamily 
 
) 
 , 
 "vmArchitecture" 
 : 
 { 
 object (  VirtualMachineArchitectureDetails 
 
) 
 } 
 , 
 "vmNetwork" 
 : 
 { 
 object (  VirtualMachineNetworkDetails 
 
) 
 } 
 , 
 "vmDisks" 
 : 
 { 
 object (  VirtualMachineDiskDetails 
 
) 
 } 
 , 
 "diskPartitions" 
 : 
 { 
 object (  DiskPartitionDetails 
 
) 
 } 
 , 
 "guestOs" 
 : 
 { 
 object (  GuestOsDetails 
 
) 
 } 
 , 
 "vcenterFolder" 
 : 
 string 
 , 
 "vcenterUrl" 
 : 
 string 
 , 
 "vcenterVmId" 
 : 
 string 
 , 
 "powerState" 
 : 
 string 
 , 
 "platform" 
 : 
 { 
 object (  PlatformDetails 
 
) 
 } 
 , 
 "osVersion" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 }

Fields
`coreCount`	`integer` Number of logical CPU cores in the VirtualMachine. Must be non-negative.
`memoryMb`	`integer` The amount of memory in the VirtualMachine. Must be non-negative.
`osName`	`string` The name of the operating system running on the VirtualMachine.
`vmUuid`	`string` Virtual Machine unique identifier.
`vmName`	`string` Virtual Machine display name.
`osFamily`	`enum ( OperatingSystemFamily )` What family the OS belong to, if known.
`vmArchitecture`	`object ( VirtualMachineArchitectureDetails )` VM architecture details (vendor, cpu arch).
`vmNetwork`	`object ( VirtualMachineNetworkDetails )` VM network details.
`vmDisks`	`object ( VirtualMachineDiskDetails )` VM disk details.
`diskPartitions`	`object ( DiskPartitionDetails )` Optional. Disk partitions details. Note: Partitions are not necessarily mounted on local disks and therefore might not have a one-to-one correspondence with local disks.
`guestOs`	`object ( GuestOsDetails )` Guest OS information.
`vcenterFolder`	`string` Folder name in vCenter where asset resides.
`vcenterUrl`	`string` vCenter URL used in collection.
`vcenterVmId`	`string` vCenter VM ID.
`powerState`	`string` Power state of VM (poweredOn or poweredOff).
`platform`	`object ( PlatformDetails )` Platform information.
`osVersion`	`string` The version of the operating system running on the virtual machine.
`createTime`	`string ( Timestamp format)` VM creation timestamp. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"` , `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"` .

OperatingSystemFamily

Known categories of operating systems.

Enums
`OS_FAMILY_UNKNOWN`
`OS_FAMILY_WINDOWS`	Microsoft Windows Server and Desktop.
`OS_FAMILY_LINUX`	Various Linux flavors.
`OS_FAMILY_UNIX`	Non-Linux Unix flavors.

VirtualMachineArchitectureDetails

Details of the VM architecture.

JSON representation

JSON representation
{ "cpuArchitecture" : string , "cpuName" : string , "cpuManufacturer" : string , "vendor" : string , "cpuThreadCount" : integer , "cpuSocketCount" : integer , "bios" : { object ( `BiosDetails` ) } , "firmware" : string , "hyperthreading" : enum ( `HyperThreading` ) }

 { 
 "cpuArchitecture" 
 : 
 string 
 , 
 "cpuName" 
 : 
 string 
 , 
 "cpuManufacturer" 
 : 
 string 
 , 
 "vendor" 
 : 
 string 
 , 
 "cpuThreadCount" 
 : 
 integer 
 , 
 "cpuSocketCount" 
 : 
 integer 
 , 
 "bios" 
 : 
 { 
 object (  BiosDetails 
 
) 
 } 
 , 
 "firmware" 
 : 
 string 
 , 
 "hyperthreading" 
 : 
 enum (  HyperThreading 
 
) 
 }

Fields
`cpuArchitecture`	`string` CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
`cpuName`	`string` CPU name, e.g., "Intel Xeon E5-2690", "AMD EPYC 7571" etc.
`cpuManufacturer`	`string` CPU manufacturer, e.g., "Intel", "AMD".
`vendor`	`string` Hardware vendor.
`cpuThreadCount (deprecated)`	`integer` This item is deprecated! Deprecated: use VirtualMachineDetails.core_count instead. Number of CPU threads allocated to the machine.
`cpuSocketCount`	`integer` Number of processor sockets allocated to the machine.
`bios`	`object ( BiosDetails )` BIOS Details.
`firmware`	`string` Firmware (BIOS/efi).
`hyperthreading`	`enum ( HyperThreading )` CPU hyperthreading support.

HyperThreading

CPU hyperthreading support.

Enums
`HYPER_THREADING_UNSPECIFIED`	Unknown (default value).
`HYPER_THREADING_DISABLED`	Hyperthreading is disabled.
`HYPER_THREADING_ENABLED`	Hyperthreading is enabled.

VirtualMachineNetworkDetails

Details of network adapters and settings.

JSON representation
{ "primaryIpAddress" : string , "networkAdapters" : { object ( `NetworkAdapterList` ) } , "defaultGw" : string , "primaryMacAddress" : string , "publicIpAddress" : string }

Fields
`primaryIpAddress`	`string` IP address of the machine.
`networkAdapters`	`object ( NetworkAdapterList )` List of network adapters.
`defaultGw`	`string` Default gateway address.
`primaryMacAddress`	`string` MAC address of the machine. This property is used to uniqly identify the machine.
`publicIpAddress`	`string` Public IP address of the machine.

VirtualMachineDiskDetails

Details of VM disks.

JSON representation
{ "hddTotalCapacityBytes" : string , "hddTotalFreeBytes" : string , "disks" : { object ( `DiskEntryList` ) } , "lsblkJson" : string }

Fields
`hddTotalCapacityBytes`	`string ( int64 format)` Disk total Capacity.
`hddTotalFreeBytes`	`string ( int64 format)` Total Disk Free Space.
`disks`	`object ( DiskEntryList )` List of disks.
`lsblkJson`	`string` Raw lsblk output in json.