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)
  },
  "platform": {
    object (PlatformDetails)
  }
}
Fields
uuid

string

Machine unique identifier.
machineName

string

Machine name.
createTime

string (Timestamp format)

Machine creation time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
coreCount

integer

Number of 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.
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,
  "cpuThreadCount": integer,
  "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.
cpuThreadCount

integer

Number of CPU threads allocated to the machine.
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.

BiosDetails

Details about the BIOS.

JSON representation 
{
  "biosName": string,
  "id": string,
  "manufacturer": string,
  "version": string,
  "releaseDate": {
    object (Date)
  },
  "smbiosUuid": string
}
Fields
biosName

string

BIOS name.
id

string

BIOS ID.
manufacturer

string

BIOS manufacturer.
version

string

BIOS version.
releaseDate

object (Date)

BIOS release date.
smbiosUuid

string

SMBIOS UUID.

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.

GuestOsDetails

Information from Guest-level collections.

JSON representation 
{
  "osName": string,
  "family": enum (OperatingSystemFamily),
  "version": string,
  "config": {
    object (GuestConfigDetails)
  },
  "runtime": {
    object (GuestRuntimeDetails)
  }
}
Fields
osName

string

The name of the operating system.
family

enum (OperatingSystemFamily)

What family the OS belong to, if known.
version

string

The version of the operating system.
config

object (GuestConfigDetails)

OS and app configuration.
runtime

object (GuestRuntimeDetails)

Runtime information.

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.

GuestConfigDetails

Guest OS config information.

JSON representation 
{
  "issue": string,
  "fstab": {
    object (FstabEntryList)
  },
  "hosts": {
    object (HostsEntryList)
  },
  "nfsExports": {
    object (NfsExportList)
  },
  "selinuxMode": enum (SeLinuxMode)
}
Fields
issue

string

OS issue (typically /etc/issue in Linux).
fstab

object (FstabEntryList)

Mount list (Linux fstab).
hosts

object (HostsEntryList)

Hosts file (/etc/hosts).
nfsExports

object (NfsExportList)

NFS exports.
selinuxMode

enum (SeLinuxMode)

Security-Enhanced Linux (SELinux) mode.

FstabEntryList

Fstab content.

JSON representation 
{
  "entries": [
    {
      object (FstabEntry)
    }
  ]
}
Fields
entries[]

object (FstabEntry)

Fstab entries.

FstabEntry

Single fstab entry.

JSON representation 
{
  "spec": string,
  "file": string,
  "vfstype": string,
  "mntops": string,
  "freq": integer,
  "passno": integer
}
Fields
spec

string

The block special device or remote filesystem to be mounted.
file

string

The mount point for the filesystem.
vfstype

string

The type of the filesystem.
mntops

string

Mount options associated with the filesystem.
freq

integer

Used by dump to determine which filesystems need to be dumped.
passno

integer

Used by the fsck(8) program to determine the order in which filesystem checks are done at reboot time.

HostsEntryList

Hosts content.

JSON representation 
{
  "entries": [
    {
      object (HostsEntry)
    }
  ]
}
Fields
entries[]

object (HostsEntry)

Hosts entries.

HostsEntry

Single /etc/hosts entry.

JSON representation 
{
  "ip": string,
  "hostNames": [
    string
  ]
}
Fields
ip

string

IP (raw, IPv4/6 agnostic).
hostNames[]

string

List of host names / aliases.

NfsExportList

NFS exports.

JSON representation 
{
  "entries": [
    {
      object (NfsExport)
    }
  ]
}
Fields
entries[]

object (NfsExport)

NFS export entries.

NfsExport

NFS export.

JSON representation 
{
  "exportDirectory": string,
  "hosts": [
    string
  ]
}
Fields
exportDirectory

string

The directory being exported.
hosts[]

string

The hosts or networks to which the export is being shared.

SeLinuxMode

Security-Enhanced Linux (SELinux) mode.

Enums
SE_LINUX_MODE_UNSPECIFIED SELinux mode unknown or unspecified.
SE_LINUX_MODE_DISABLED SELinux is disabled.
SE_LINUX_MODE_PERMISSIVE SELinux permissive mode.
SE_LINUX_MODE_ENFORCING SELinux enforcing mode.

GuestRuntimeDetails

Guest OS runtime information.

JSON representation 
{
  "services": {
    object (RunningServiceList)
  },
  "processes": {
    object (RunningProcessList)
  },
  "network": {
    object (RuntimeNetworkInfo)
  },
  "lastBootTime": string,
  "domain": string,
  "machineName": string,
  "installedApps": {
    object (GuestInstalledApplicationList)
  },
  "openFileList": {
    object (OpenFileList)
  }
}
Fields
services

object (RunningServiceList)

Running background services.
processes

object (RunningProcessList)

Running processes.
network

object (RuntimeNetworkInfo)

Runtime network information (connections, ports).
lastBootTime

string (Timestamp format)

Last time the OS was booted.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
domain

string

Domain, e.g. c.stratozone-development.internal.
machineName

string

Machine name.
installedApps

object (GuestInstalledApplicationList)

Installed applications information.
openFileList

object (OpenFileList)

Open files information.

RunningServiceList

List of running guest OS services.

JSON representation 
{
  "entries": [
    {
      object (RunningService)
    }
  ]
}
Fields
entries[]

object (RunningService)

Running service entries.

RunningService

Guest OS running service details.

JSON representation 
{
  "serviceName": string,
  "state": enum (State),
  "startMode": enum (StartMode),
  "exePath": string,
  "cmdline": string,
  "pid": string
}
Fields
serviceName

string

Service name.
state

enum (State)

Service state (OS-agnostic).
startMode

enum (StartMode)

Service start mode (OS-agnostic).
exePath

string

Service binary path.
cmdline

string

Service command line.
pid

string (int64 format)

Service pid.

State

Service state (OS-agnostic).

Enums
STATE_UNSPECIFIED Service state unspecified.
ACTIVE Service is active.
PAUSED Service is paused.
STOPPED Service is stopped.

StartMode

Service start mode (OS-agnostic).

Enums
START_MODE_UNSPECIFIED Start mode unspecified.
BOOT The service is a device driver started by the system loader.
SYSTEM The service is a device driver started by the IOInitSystem function.
AUTO The service is started by the operating system, at system start-up
MANUAL The service is started only manually, by a user.
DISABLED The service is disabled.

RunningProcessList

List of running guest OS processes.

JSON representation 
{
  "entries": [
    {
      object (RunningProcess)
    }
  ]
}
Fields
entries[]

object (RunningProcess)

Running process entries.

RunningProcess

Guest OS running process details.

JSON representation 
{
  "pid": string,
  "exePath": string,
  "cmdline": string,
  "user": string,
  "attributes": {
    string: string,
    ...
  }
}
Fields
pid

string (int64 format)

Process ID.
exePath

string

Process binary path.
cmdline

string

Process full command line.
user

string

User running the process.
attributes

map (key: string, value: string)

Process extended attributes.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

RuntimeNetworkInfo

Runtime networking information.

JSON representation 
{
  "scanTime": string,
  "connections": {
    object (NetworkConnectionList)
  }
}
Fields
scanTime

string (Timestamp format)

Time of the last network scan.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
connections

object (NetworkConnectionList)

Network connections.

NetworkConnectionList

Network connection list.

JSON representation 
{
  "entries": [
    {
      object (NetworkConnection)
    }
  ]
}
Fields
entries[]

object (NetworkConnection)

Network connection entries.

NetworkConnection

JSON representation 
{
  "protocol": string,
  "localIpAddress": string,
  "localPort": integer,
  "remoteIpAddress": string,
  "remotePort": integer,
  "state": enum (State),
  "pid": string,
  "processName": string
}
Fields
protocol

string

Connection protocol (e.g. TCP/UDP).
localIpAddress

string

Local IP address.
localPort

integer

Local port.
remoteIpAddress

string

Remote IP address.
remotePort

integer

Remote port.
state

enum (State)

Network connection state.
pid

string (int64 format)

Process ID.
processName

string

Process or service name.

State

Network connection state.

Enums
STATE_UNSPECIFIED Connection state is unknown or unspecified.
OPENING The connection is being opened.
OPEN The connection is open.
LISTEN Listening for incoming connections.
CLOSING The connection is being closed.
CLOSED The connection is closed.

GuestInstalledApplicationList

Guest installed application list.

JSON representation 
{
  "entries": [
    {
      object (GuestInstalledApplication)
    }
  ]
}
Fields
entries[]

object (GuestInstalledApplication)

Application entries.

GuestInstalledApplication

Guest installed application information.

JSON representation 
{
  "applicationName": string,
  "vendor": string,
  "installTime": string,
  "path": string,
  "version": string
}
Fields
applicationName

string

Installed application name.
vendor

string

Installed application vendor.
installTime

string (Timestamp format)

The time when the application was installed.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
path

string

Source path.
version

string

Installed application version.

OpenFileList

Open file list.

JSON representation 
{
  "entries": [
    {
      object (OpenFileDetails)
    }
  ]
}
Fields
entries[]

object (OpenFileDetails)

Open file details entries.

OpenFileDetails

Open file Information.

JSON representation 
{
  "command": string,
  "user": string,
  "fileType": string,
  "filePath": string
}
Fields
command

string

Opened file command.
user

string

Opened file user.
fileType

string

Opened file file type.
filePath

string

Opened file file path.

MachineNetworkDetails

Details of network adapters and settings.

JSON representation 
{
  "primaryIpAddress": string,
  "publicIpAddress": string,
  "primaryMacAddress": string,
  "adapters": {
    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.
adapters

object (NetworkAdapterList)

List of network adapters.

NetworkAdapterList

List of network adapters.

JSON representation 
{
  "entries": [
    {
      object (NetworkAdapterDetails)
    }
  ]
}
Fields
entries[]

object (NetworkAdapterDetails)

Network adapter entries.

NetworkAdapterDetails

Details of network adapter.

JSON representation 
{
  "adapterType": string,
  "macAddress": string,
  "addresses": {
    object (NetworkAddressList)
  }
}
Fields
adapterType

string

Network adapter type (e.g. VMXNET3).
macAddress

string

MAC address.
addresses

object (NetworkAddressList)

NetworkAddressList

NetworkAddressList

List of allocated/assigned network addresses.

JSON representation 
{
  "entries": [
    {
      object (NetworkAddress)
    }
  ]
}
Fields
entries[]

object (NetworkAddress)

Network address entries.

NetworkAddress

Details of network address.

JSON representation 
{
  "ipAddress": string,
  "subnetMask": string,
  "bcast": string,
  "fqdn": string,
  "assignment": enum (AddressAssignment)
}
Fields
ipAddress

string

Assigned or configured IP Address.
subnetMask

string

Subnet mask.
bcast

string

Broadcast address.
fqdn

string

Fully qualified domain name.
assignment

enum (AddressAssignment)

Whether DHCP is used to assign addresses.

AddressAssignment

Network address assignment.

Enums
ADDRESS_ASSIGNMENT_UNSPECIFIED Unknown (default value).
ADDRESS_ASSIGNMENT_STATIC Staticly assigned IP.
ADDRESS_ASSIGNMENT_DHCP Dynamically assigned IP (DHCP).

MachineDiskDetails

Details of machine disks.

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

string (int64 format)

Disk total Capacity.
totalFreeBytes

string (int64 format)

Total disk free space.
disks

object (DiskEntryList)

List of disks.

DiskEntryList

VM disks.

JSON representation 
{
  "entries": [
    {
      object (DiskEntry)
    }
  ]
}
Fields
entries[]

object (DiskEntry)

Disk entries.

DiskEntry

Single disk entry.

JSON representation 
{
  "capacityBytes": string,
  "freeBytes": string,
  "diskLabel": string,
  "diskLabelType": string,
  "interfaceType": enum (InterfaceType),
  "partitions": {
    object (DiskPartitionList)
  },
  "hwAddress": string,

  // Union field platform_specific can be only one of the following:
  "vmware": {
    object (VmwareDiskConfig)
  }
  // End of list of possible types for union field platform_specific.
}
Fields
capacityBytes

string (int64 format)

Disk capacity.
freeBytes

string (int64 format)

Disk free space.
diskLabel

string

Disk label.
diskLabelType

string

Disk label type (e.g. BIOS/GPT)
interfaceType

enum (InterfaceType)

Disks interface type.
partitions

object (DiskPartitionList)

Partition layout.
hwAddress

string

Disk hardware address (e.g. 0:1 for SCSI).
Union field platform_specific. Additional details for specific platforms. platform_specific can be only one of the following:
vmware

object (VmwareDiskConfig)

VMware disk details.

InterfaceType

Disks interface type.

Enums
INTERFACE_TYPE_UNSPECIFIED Interface type unknown or unspecified.
IDE IDE interface type.
SATA SATA interface type.
SAS SAS interface type.
SCSI SCSI interface type.
NVME NVME interface type.
FC FC interface type.
ISCSI iSCSI interface type.

DiskPartitionList

Disk partition list.

JSON representation 
{
  "entries": [
    {
      object (DiskPartition)
    }
  ]
}
Fields
entries[]

object (DiskPartition)

Partition entries.

DiskPartition

Disk Partition details.

JSON representation 
{
  "type": string,
  "fileSystem": string,
  "mountPoint": string,
  "capacityBytes": string,
  "freeBytes": string,
  "uuid": string,
  "subPartitions": {
    object (DiskPartitionList)
  }
}
Fields
type

string

Partition type.
fileSystem

string

Partition file system.
mountPoint

string

Mount pount (Linux/Windows) or drive letter (Windows).
capacityBytes

string (int64 format)

Partition capacity.
freeBytes

string (int64 format)

Partition free space.
uuid

string

Partition UUID.
subPartitions

object (DiskPartitionList)

Sub-partitions.

VmwareDiskConfig

VMware disk config details.

JSON representation 
{
  "backingType": enum (BackingType),
  "shared": boolean,
  "vmdkMode": enum (VmdkMode),
  "rdmCompatibility": enum (RdmCompatibility)
}
Fields
backingType

enum (BackingType)

VMDK backing type.
shared

boolean

Is VMDK shared with other VMs.
vmdkMode

enum (VmdkMode)

VMDK disk mode.
rdmCompatibility

enum (RdmCompatibility)

RDM compatibility mode.

BackingType

VMDK backing type possible values.

Enums
BACKING_TYPE_UNSPECIFIED Default value.
BACKING_TYPE_FLAT_V1 Flat v1.
BACKING_TYPE_FLAT_V2 Flat v2.
BACKING_TYPE_PMEM Persistent memory, also known as Non-Volatile Memory (NVM).
BACKING_TYPE_RDM_V1 Raw Disk Memory v1.
BACKING_TYPE_RDM_V2 Raw Disk Memory v2.
BACKING_TYPE_SESPARSE SEsparse is a snapshot format introduced in vSphere 5.5 for large disks.
BACKING_TYPE_SESPARSE_V1 SEsparse v1.
BACKING_TYPE_SESPARSE_V2 SEsparse v1.

VmdkMode

VMDK disk mode.

Enums
VMDK_MODE_UNSPECIFIED VMDK disk mode unspecified or unknown.
DEPENDENT Dependent disk mode.
INDEPENDENT_PERSISTENT Independent - Persistent disk mode.
INDEPENDENT_NONPERSISTENT Independent - Nonpersistent disk mode.

RdmCompatibility

RDM compatibility mode.

Enums
RDM_COMPATIBILITY_UNSPECIFIED Compatibility mode unspecified or unknown.
PHYSICAL_COMPATIBILITY Physical compatibility mode.
VIRTUAL_COMPATIBILITY Virtual compatibility mode.

PlatformDetails

Information about the platform.

JSON representation 
{

  // Union field vendor_details can be only one of the following:
  "vmwareDetails": {
    object (VmwarePlatformDetails)
  },
  "awsEc2Details": {
    object (AwsEc2PlatformDetails)
  },
  "azureVmDetails": {
    object (AzureVmPlatformDetails)
  },
  "genericDetails": {
    object (GenericPlatformDetails)
  },
  "physicalDetails": {
    object (PhysicalPlatformDetails)
  }
  // End of list of possible types for union field vendor_details.
}
Fields

Union field vendor_details.

vendor_details can be only one of the following:
vmwareDetails

object (VmwarePlatformDetails)

VMware specific details.
awsEc2Details

object (AwsEc2PlatformDetails)

AWS EC2 specific details.
azureVmDetails

object (AzureVmPlatformDetails)

Azure VM specific details.
genericDetails

object (GenericPlatformDetails)

Generic platform details.
physicalDetails

object (PhysicalPlatformDetails)

Physical machines platform details.

VmwarePlatformDetails

VMware specific details.

JSON representation 
{
  "vcenterVersion": string,
  "esxVersion": string,
  "osid": string,
  "vcenterFolder": string,
  "vcenterUri": string,
  "vcenterVmId": string
}
Fields
vcenterVersion

string

vCenter version.
esxVersion

string

ESX version.
osid

string

VMware os enum - 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.
vcenterFolder

string

Folder name in vCenter where asset resides.
vcenterUri

string

vCenter URI used in collection.
vcenterVmId

string

vCenter VM ID.

AwsEc2PlatformDetails

AWS EC2 specific details.

JSON representation 
{
  "machineTypeLabel": string,
  "location": string
}
Fields
machineTypeLabel

string

AWS platform's machine type label.
location

string

The location of the machine in the AWS format.

AzureVmPlatformDetails

Azure VM specific details.

JSON representation 
{
  "machineTypeLabel": string,
  "location": string,
  "provisioningState": string
}
Fields
machineTypeLabel

string

Azure platform's machine type label.
location

string

The location of the machine in the Azure format.
provisioningState

string

Azure platform's provisioning state.

GenericPlatformDetails

Generic platform details.

JSON representation 
{
  "location": string
}
Fields
location

string

Free text representation of the machine location. The format of this field should not be relied on. Different VMs in the same location may have different string values for this field.

PhysicalPlatformDetails

Platform specific details for Physical Machines.

JSON representation 
{
  "location": string
}
Fields
location

string

Free text representation of the machine location. The format of this field should not be relied on. Different machines in the same location may have different string values for this field.