- JSON representation
- PowerState
- MachineArchitectureDetails
- BiosDetails
- FirmwareType
- CpuHyperThreading
- GuestOsDetails
- OperatingSystemFamily
- GuestConfigDetails
- FstabEntryList
- FstabEntry
- HostsEntryList
- HostsEntry
- NfsExportList
- NfsExport
- SeLinuxMode
- GuestRuntimeDetails
- RunningServiceList
- RunningService
- State
- StartMode
- RunningProcessList
- RunningProcess
- RuntimeNetworkInfo
- NetworkConnectionList
- NetworkConnection
- State
- GuestInstalledApplicationList
- GuestInstalledApplication
- OpenFileList
- OpenFileDetails
- MachineNetworkDetails
- NetworkAdapterList
- NetworkAdapterDetails
- NetworkAddressList
- NetworkAddress
- AddressAssignment
- MachineDiskDetails
- DiskEntryList
- DiskEntry
- InterfaceType
- DiskPartitionList
- DiskPartition
- VmwareDiskConfig
- BackingType
- VmdkMode
- RdmCompatibility
- PlatformDetails
- VmwarePlatformDetails
- AwsEc2PlatformDetails
- AzureVmPlatformDetails
- GenericPlatformDetails
- PhysicalPlatformDetails
Details of a machine.
JSON representation |
---|
{ "uuid": string, "machineName": string, "createTime": string, "coreCount": integer, "memoryMb": integer, "powerState": enum ( |
Fields | |
---|---|
uuid |
Machine unique identifier. |
machineName |
Machine name. |
createTime |
Machine creation time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
coreCount |
Number of CPU cores in the machine. Must be non-negative. |
memoryMb |
The amount of memory in the machine. Must be non-negative. |
powerState |
Power state of the machine. |
architecture |
Architecture details (vendor, CPU architecture). |
guestOs |
Guest OS information. |
network |
Network details. |
disks |
Disk details. |
platform |
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 ( |
Fields | |
---|---|
cpuArchitecture |
CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc. |
cpuName |
CPU name, e.g., "Intel Xeon E5-2690", "AMD EPYC 7571" etc. |
vendor |
Hardware vendor. |
cpuThreadCount |
Number of CPU threads allocated to the machine. |
cpuSocketCount |
Number of processor sockets allocated to the machine. |
bios |
BIOS Details. |
firmwareType |
Firmware type. |
hyperthreading |
CPU hyper-threading support. |
BiosDetails
Details about the BIOS.
JSON representation |
---|
{
"biosName": string,
"id": string,
"manufacturer": string,
"version": string,
"releaseDate": {
object ( |
Fields | |
---|---|
biosName |
BIOS name. |
id |
BIOS ID. |
manufacturer |
BIOS manufacturer. |
version |
BIOS version. |
releaseDate |
BIOS release date. |
smbiosUuid |
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 ( |
Fields | |
---|---|
osName |
The name of the operating system. |
family |
What family the OS belong to, if known. |
version |
The version of the operating system. |
config |
OS and app configuration. |
runtime |
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 ( |
Fields | |
---|---|
issue |
OS issue (typically /etc/issue in Linux). |
fstab |
Mount list (Linux fstab). |
hosts |
Hosts file (/etc/hosts). |
nfsExports |
NFS exports. |
selinuxMode |
Security-Enhanced Linux (SELinux) mode. |
FstabEntryList
Fstab content.
JSON representation |
---|
{
"entries": [
{
object ( |
Fields | |
---|---|
entries[] |
Fstab entries. |
FstabEntry
Single fstab entry.
JSON representation |
---|
{ "spec": string, "file": string, "vfstype": string, "mntops": string, "freq": integer, "passno": integer } |
Fields | |
---|---|
spec |
The block special device or remote filesystem to be mounted. |
file |
The mount point for the filesystem. |
vfstype |
The type of the filesystem. |
mntops |
Mount options associated with the filesystem. |
freq |
Used by dump to determine which filesystems need to be dumped. |
passno |
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 ( |
Fields | |
---|---|
entries[] |
Hosts entries. |
HostsEntry
Single /etc/hosts entry.
JSON representation |
---|
{ "ip": string, "hostNames": [ string ] } |
Fields | |
---|---|
ip |
IP (raw, IPv4/6 agnostic). |
hostNames[] |
List of host names / aliases. |
NfsExportList
NFS exports.
JSON representation |
---|
{
"entries": [
{
object ( |
Fields | |
---|---|
entries[] |
NFS export entries. |
NfsExport
NFS export.
JSON representation |
---|
{ "exportDirectory": string, "hosts": [ string ] } |
Fields | |
---|---|
exportDirectory |
The directory being exported. |
hosts[] |
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 ( |
Fields | |
---|---|
services |
Running background services. |
processes |
Running processes. |
network |
Runtime network information (connections, ports). |
lastBootTime |
Last time the OS was booted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
domain |
Domain, e.g. c.stratozone-development.internal. |
machineName |
Machine name. |
installedApps |
Installed applications information. |
openFileList |
Open files information. |
RunningServiceList
List of running guest OS services.
JSON representation |
---|
{
"entries": [
{
object ( |
Fields | |
---|---|
entries[] |
Running service entries. |
RunningService
Guest OS running service details.
JSON representation |
---|
{ "serviceName": string, "state": enum ( |
Fields | |
---|---|
serviceName |
Service name. |
state |
Service state (OS-agnostic). |
startMode |
Service start mode (OS-agnostic). |
exePath |
Service binary path. |
cmdline |
Service command line. |
pid |
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 ( |
Fields | |
---|---|
entries[] |
Running process entries. |
RunningProcess
Guest OS running process details.
JSON representation |
---|
{ "pid": string, "exePath": string, "cmdline": string, "user": string, "attributes": { string: string, ... } } |
Fields | |
---|---|
pid |
Process ID. |
exePath |
Process binary path. |
cmdline |
Process full command line. |
user |
User running the process. |
attributes |
Process extended attributes. An object containing a list of |
RuntimeNetworkInfo
Runtime networking information.
JSON representation |
---|
{
"scanTime": string,
"connections": {
object ( |
Fields | |
---|---|
scanTime |
Time of the last network scan. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
connections |
Network connections. |
NetworkConnectionList
Network connection list.
JSON representation |
---|
{
"entries": [
{
object ( |
Fields | |
---|---|
entries[] |
Network connection entries. |
NetworkConnection
JSON representation |
---|
{
"protocol": string,
"localIpAddress": string,
"localPort": integer,
"remoteIpAddress": string,
"remotePort": integer,
"state": enum ( |
Fields | |
---|---|
protocol |
Connection protocol (e.g. TCP/UDP). |
localIpAddress |
Local IP address. |
localPort |
Local port. |
remoteIpAddress |
Remote IP address. |
remotePort |
Remote port. |
state |
Network connection state. |
pid |
Process ID. |
processName |
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 ( |
Fields | |
---|---|
entries[] |
Application entries. |
GuestInstalledApplication
Guest installed application information.
JSON representation |
---|
{ "applicationName": string, "vendor": string, "installTime": string, "path": string, "version": string } |
Fields | |
---|---|
applicationName |
Installed application name. |
vendor |
Installed application vendor. |
installTime |
The time when the application was installed. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
path |
Source path. |
version |
Installed application version. |
OpenFileList
Open file list.
JSON representation |
---|
{
"entries": [
{
object ( |
Fields | |
---|---|
entries[] |
Open file details entries. |
OpenFileDetails
Open file Information.
JSON representation |
---|
{ "command": string, "user": string, "fileType": string, "filePath": string } |
Fields | |
---|---|
command |
Opened file command. |
user |
Opened file user. |
fileType |
Opened file file type. |
filePath |
Opened file file path. |
MachineNetworkDetails
Details of network adapters and settings.
JSON representation |
---|
{
"primaryIpAddress": string,
"publicIpAddress": string,
"primaryMacAddress": string,
"adapters": {
object ( |
Fields | |
---|---|
primaryIpAddress |
The primary IP address of the machine. |
publicIpAddress |
The public IP address of the machine. |
primaryMacAddress |
MAC address of the machine. This property is used to uniqly identify the machine. |
adapters |
List of network adapters. |
NetworkAdapterList
List of network adapters.
JSON representation |
---|
{
"entries": [
{
object ( |
Fields | |
---|---|
entries[] |
Network adapter entries. |
NetworkAdapterDetails
Details of network adapter.
JSON representation |
---|
{
"adapterType": string,
"macAddress": string,
"addresses": {
object ( |
Fields | |
---|---|
adapterType |
Network adapter type (e.g. VMXNET3). |
macAddress |
MAC address. |
addresses |
NetworkAddressList |
NetworkAddressList
List of allocated/assigned network addresses.
JSON representation |
---|
{
"entries": [
{
object ( |
Fields | |
---|---|
entries[] |
Network address entries. |
NetworkAddress
Details of network address.
JSON representation |
---|
{
"ipAddress": string,
"subnetMask": string,
"bcast": string,
"fqdn": string,
"assignment": enum ( |
Fields | |
---|---|
ipAddress |
Assigned or configured IP Address. |
subnetMask |
Subnet mask. |
bcast |
Broadcast address. |
fqdn |
Fully qualified domain name. |
assignment |
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 ( |
Fields | |
---|---|
totalCapacityBytes |
Disk total Capacity. |
totalFreeBytes |
Total disk free space. |
disks |
List of disks. |
DiskEntryList
VM disks.
JSON representation |
---|
{
"entries": [
{
object ( |
Fields | |
---|---|
entries[] |
Disk entries. |
DiskEntry
Single disk entry.
JSON representation |
---|
{ "capacityBytes": string, "freeBytes": string, "diskLabel": string, "diskLabelType": string, "interfaceType": enum ( |
Fields | |
---|---|
capacityBytes |
Disk capacity. |
freeBytes |
Disk free space. |
diskLabel |
Disk label. |
diskLabelType |
Disk label type (e.g. BIOS/GPT) |
interfaceType |
Disks interface type. |
partitions |
Partition layout. |
hwAddress |
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 |
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 ( |
Fields | |
---|---|
entries[] |
Partition entries. |
DiskPartition
Disk Partition details.
JSON representation |
---|
{
"type": string,
"fileSystem": string,
"mountPoint": string,
"capacityBytes": string,
"freeBytes": string,
"uuid": string,
"subPartitions": {
object ( |
Fields | |
---|---|
type |
Partition type. |
fileSystem |
Partition file system. |
mountPoint |
Mount pount (Linux/Windows) or drive letter (Windows). |
capacityBytes |
Partition capacity. |
freeBytes |
Partition free space. |
uuid |
Partition UUID. |
subPartitions |
Sub-partitions. |
VmwareDiskConfig
VMware disk config details.
JSON representation |
---|
{ "backingType": enum ( |
Fields | |
---|---|
backingType |
VMDK backing type. |
shared |
Is VMDK shared with other VMs. |
vmdkMode |
VMDK disk mode. |
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 |
Fields | |
---|---|
Union field
|
|
vmwareDetails |
VMware specific details. |
awsEc2Details |
AWS EC2 specific details. |
azureVmDetails |
Azure VM specific details. |
genericDetails |
Generic platform details. |
physicalDetails |
Physical machines platform details. |
VmwarePlatformDetails
VMware specific details.
JSON representation |
---|
{ "vcenterVersion": string, "esxVersion": string, "osid": string, "vcenterFolder": string, "vcenterUri": string, "vcenterVmId": string } |
Fields | |
---|---|
vcenterVersion |
vCenter version. |
esxVersion |
ESX version. |
osid |
|
vcenterFolder |
Folder name in vCenter where asset resides. |
vcenterUri |
vCenter URI used in collection. |
vcenterVmId |
vCenter VM ID. |
AwsEc2PlatformDetails
AWS EC2 specific details.
JSON representation |
---|
{ "machineTypeLabel": string, "location": string } |
Fields | |
---|---|
machineTypeLabel |
AWS platform's machine type label. |
location |
The location of the machine in the AWS format. |
AzureVmPlatformDetails
Azure VM specific details.
JSON representation |
---|
{ "machineTypeLabel": string, "location": string, "provisioningState": string } |
Fields | |
---|---|
machineTypeLabel |
Azure platform's machine type label. |
location |
The location of the machine in the Azure format. |
provisioningState |
Azure platform's provisioning state. |
GenericPlatformDetails
Generic platform details.
JSON representation |
---|
{ "location": string } |
Fields | |
---|---|
location |
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 |
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. |