MachineDetails

Details of a machine.

JSON representation
{
  "uuid": string,
  "machineName": string,
  "createTime": string,
  "coreCount": integer,
  "memoryMb": integer,
  "powerState": enum (PowerState),
  "architecture": {
    object (MachineArchitectureDetails)
  },
  "guestOs": {
    object (GuestOsDetails)
  },
  "network": {
    object (MachineNetworkDetails)
  },
  "disks": {
    object (MachineDiskDetails)
  },
  "diskPartitions": {
    object (DiskPartitionDetails)
  },
  "platform": {
    object (PlatformDetails)
  }
}
Fields
uuid

string

Machine unique identifier.

machineName

string

Machine name.

createTime

string (Timestamp format)

Machine creation time.

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".

coreCount

integer

Number of logical CPU cores in the machine. Must be non-negative.

memoryMb

integer

The amount of memory in the machine. Must be non-negative.

powerState

enum (PowerState)

Power state of the machine.

architecture

object (MachineArchitectureDetails)

Architecture details (vendor, CPU architecture).

guestOs

object (GuestOsDetails)

Guest OS information.

network

object (MachineNetworkDetails)

Network details.

disks

object (MachineDiskDetails)

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.

platform

object (PlatformDetails)

Platform specific information.

PowerState

Machine power state.

Enums
POWER_STATE_UNSPECIFIED Power state is unknown.
PENDING The machine is preparing to enter the ACTIVE state. An instance may enter the PENDING state when it launches for the first time, or when it is started after being in the SUSPENDED state.
ACTIVE The machine is active.
SUSPENDING The machine is being turned off.
SUSPENDED The machine is off.
DELETING The machine is being deleted from the hosting platform.
DELETED The machine is deleted from the hosting platform.

MachineArchitectureDetails

Details of the machine architecture.

JSON representation
{
  "cpuArchitecture": string,
  "cpuName": string,
  "vendor": string,
  "cpuSocketCount": integer,
  "bios": {
    object (BiosDetails)
  },
  "firmwareType": enum (FirmwareType),
  "hyperthreading": enum (CpuHyperThreading)
}
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.

vendor

string

Hardware vendor.

cpuSocketCount

integer

Number of processor sockets allocated to the machine.

bios

object (BiosDetails)

BIOS Details.

firmwareType

enum (FirmwareType)

Firmware type.

hyperthreading

enum (CpuHyperThreading)

CPU hyper-threading support.

FirmwareType

Firmware type.

Enums
FIRMWARE_TYPE_UNSPECIFIED Unspecified or unknown.
BIOS BIOS firmware.
EFI EFI firmware.

CpuHyperThreading

CPU hyper-threading support.

Enums
CPU_HYPER_THREADING_UNSPECIFIED Unspecified or unknown.
DISABLED Hyper-threading is disabled.
ENABLED Hyper-threading is enabled.

MachineNetworkDetails

Details of network adapters and settings.

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

string

The primary IP address of the machine.

publicIpAddress

string

The public IP address of the machine.

primaryMacAddress

string

MAC address of the machine. This property is used to uniqly identify the machine.

defaultGateway

string

Default gateway address.

networkAdapters

object (NetworkAdapterList)

List of network adapters.

MachineDiskDetails

Details of machine disks.

JSON representation
{
  "totalCapacityBytes": string,
  "totalFreeBytes": string,
  "disks": {
    object (DiskEntryList)
  },
  "rawScanResult": string
}
Fields
totalCapacityBytes

string (int64 format)

Disk total Capacity.

totalFreeBytes

string (int64 format)

Total disk free space.

disks

object (DiskEntryList)

List of disks.

rawScanResult

string

Raw disk scan result. This field is intended for human inspection. The format of this field may be lsblk output or any another raw output. The exact format may change without notice and should not be relied upon.