- JSON representation
- OperatingSystemFamily
- VirtualMachineArchitectureDetails
- BiosDetails
- HyperThreading
- VirtualMachineNetworkDetails
- NetworkAdapterList
- NetworkAdapterDetails
- NetworkAddressList
- NetworkAddress
- AddressAssignment
- VirtualMachineDiskDetails
- DiskEntryList
- DiskEntry
- DiskPartitionList
- DiskPartition
- VmwareDiskConfig
- BackingType
- GuestOsDetails
- GuestConfigDetails
- FstabEntryList
- FstabEntry
- HostsEntryList
- HostsEntry
- NfsExportList
- NfsExport
- Selinux
- GuestRuntimeDetails
- RunningServiceList
- RunningService
- RunningProcessList
- RunningProcess
- RuntimeNetworkInfo
- NetworkConnectionList
- NetworkConnection
- DateTime
- TimeZone
- GuestInstalledApplicationList
- GuestInstalledApplication
- OpenFileList
- OpenFileDetails
- PlatformDetails
- VmwarePlatformDetails
- AwsEc2PlatformDetails
- AzureVmPlatformDetails
- GenericPlatformDetails
- PhysicalPlatformDetails
Details of a VirtualMachine.
JSON representation |
---|
{ "coreCount": integer, "memoryMb": integer, "osName": string, "vmUuid": string, "vmName": string, "osFamily": enum ( |
Fields | |
---|---|
coreCount |
Number of CPU cores in the VirtualMachine. Must be non-negative. |
memoryMb |
The amount of memory in the VirtualMachine. Must be non-negative. |
osName |
The name of the operating system running on the VirtualMachine. |
vmUuid |
Virtual Machine unique identifier. |
vmName |
Virtual Machine display name. |
osFamily |
What family the OS belong to, if known. |
vmArchitecture |
VM architecture details (vendor, cpu arch). |
vmNetwork |
VM network details. |
vmDisks |
VM disk details. |
guestOs |
Guest OS information. |
vcenterFolder |
Folder name in vCenter where asset resides. |
vcenterUrl |
vCenter URL used in collection. |
vcenterVmId |
vCenter VM ID. |
powerState |
Power state of VM (poweredOn or poweredOff). |
platform |
Platform information. |
osVersion |
The version of the operating system running on the virtual machine. |
createTime |
VM creation timestamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
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 |
---|
{ "cpuArchitecture": string, "cpuName": string, "cpuManufacturer": 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. |
cpuManufacturer |
CPU manufacturer, e.g., "Intel", "AMD". |
vendor |
Hardware vendor. |
cpuThreadCount |
Number of CPU threads allocated to the machine. |
cpuSocketCount |
Number of processor sockets allocated to the machine. |
bios |
BIOS Details. |
firmware |
Firmware (BIOS/efi). |
hyperthreading |
CPU hyperthreading support. |
BiosDetails
Details about the BIOS.
JSON representation |
---|
{ "biosName": string, "biosManufacturer": string, "biosVersion": string, "biosReleaseDate": string, "smbiosUuid": string } |
Fields | |
---|---|
biosName |
BIOS name. |
biosManufacturer |
BIOS manufacturer. |
biosVersion |
BIOS version. |
biosReleaseDate |
BIOS release date. |
smbiosUuid |
SMBIOS UUID. |
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 ( |
Fields | |
---|---|
primaryIpAddress |
IP address of the machine. |
networkAdapters |
List of network adapters. |
defaultGw |
Default gateway address. |
primaryMacAddress |
MAC address of the machine. This property is used to uniqly identify the machine. |
publicIpAddress |
Public IP address of the machine. |
NetworkAdapterList
List of network adapters.
JSON representation |
---|
{
"networkAdapters": [
{
object ( |
Fields | |
---|---|
networkAdapters[] |
Network adapter descriptions. |
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 |
---|
{
"addresses": [
{
object ( |
Fields | |
---|---|
addresses[] |
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). |
VirtualMachineDiskDetails
Details of VM disks.
JSON representation |
---|
{
"hddTotalCapacityBytes": string,
"hddTotalFreeBytes": string,
"disks": {
object ( |
Fields | |
---|---|
hddTotalCapacityBytes |
Disk total Capacity. |
hddTotalFreeBytes |
Total Disk Free Space. |
disks |
List of disks. |
lsblkJson |
Raw lsblk output in json. |
DiskEntryList
VM disks.
JSON representation |
---|
{
"entries": [
{
object ( |
Fields | |
---|---|
entries[] |
Disk entries. |
DiskEntry
Single disk entry.
JSON representation |
---|
{ "totalCapacityBytes": string, "totalFreeBytes": string, "diskLabel": string, "diskLabelType": string, "status": string, "interfaceType": string, "partitions": { object ( |
Fields | |
---|---|
totalCapacityBytes |
Disk capacity. |
totalFreeBytes |
Disk free space. |
diskLabel |
Disk label. |
diskLabelType |
Disk label type (e.g. BIOS/GPT) |
status |
Disk status (e.g. online). |
interfaceType |
Disks interface type (e.g. SATA/SCSI) |
partitions |
Partition layout. |
hwAddress |
Disk hardware address (e.g. 0:1 for SCSI). |
vmwareConfig |
VMware disk details. |
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 (e.g. BIOS boot). |
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. |
vmdkDiskMode |
VMDK disk mode. |
rdmCompatibilityMode |
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. |
GuestOsDetails
Information from Guest-level collections.
JSON representation |
---|
{ "config": { object ( |
Fields | |
---|---|
config |
OS and app configuration. |
runtime |
Runtime information. |
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. |
selinux |
SELinux details. |
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. |
Selinux
SELinux details.
JSON representation |
---|
{ "enabled": boolean, "mode": string } |
Fields | |
---|---|
enabled |
Is SELinux enabled. |
mode |
SELinux mode enforcing / permissive. |
GuestRuntimeDetails
Guest OS runtime information.
JSON representation |
---|
{ "services": { object ( |
Fields | |
---|---|
services |
Running background services. |
processes |
Running processes. |
networkInfo |
Runtime network information (connections, ports). |
lastUptime |
Date since last booted (last uptime date). |
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 |
---|
{
"services": [
{
object ( |
Fields | |
---|---|
services[] |
Running service entries. |
RunningService
Guest OS running service details.
JSON representation |
---|
{ "name": string, "state": string, "startMode": string, "status": string, "exePath": string, "cmdline": string, "pid": string } |
Fields | |
---|---|
name |
Service name. |
state |
Service state (raw, OS-agnostic). |
startMode |
Service start mode (raw, OS-agnostic). |
status |
Service status. |
exePath |
Service binary path. |
cmdline |
Service command line. |
pid |
Service pid. |
RunningProcessList
List of running guest OS processes.
JSON representation |
---|
{
"processes": [
{
object ( |
Fields | |
---|---|
processes[] |
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 |
---|
{ "netstat": string, "connections": { object ( |
Fields | |
---|---|
netstat |
Netstat (raw, OS-agnostic). |
connections |
Network connections. |
netstatTime |
Netstat time collected. |
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": string, "pid": string, "processName": string } |
Fields | |
---|---|
protocol |
Connection protocol (e.g. TCP/UDP). |
localIpAddress |
Local IP address. |
localPort |
Local port. |
remoteIpAddress |
Remote IP address. |
remotePort |
Remote port. |
state |
Connection state (e.g. CONNECTED). |
pid |
Process ID. |
processName |
Process or service name. |
DateTime
Represents civil time (or occasionally physical time).
This type can represent a civil time in one of a few possible ways:
- When utcOffset is set and timeZone is unset: a civil time on a calendar day with a particular offset from UTC.
- When timeZone is set and utcOffset is unset: a civil time on a calendar day in a particular time zone.
- When neither timeZone nor utcOffset is set: a civil time on a calendar day in local time.
The date is relative to the Proleptic Gregorian Calendar.
If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively.
This type may also be used to represent a physical time if all the date and time fields are set and either case of the time_offset
oneof is set. Consider using Timestamp
message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field.
This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.
JSON representation |
---|
{ "year": integer, "month": integer, "day": integer, "hours": integer, "minutes": integer, "seconds": integer, "nanos": integer, // Union field |
Fields | |
---|---|
year |
Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. |
month |
Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. |
day |
Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. |
hours |
Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
minutes |
Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. |
seconds |
Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. |
nanos |
Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. |
Union field time_offset . Optional. Specifies either the UTC offset or the time zone of the DateTime. Choose carefully between them, considering that time zone data may change in the future (for example, a country modifies their DST start/end dates, and future DateTimes in the affected range had already been stored). If omitted, the DateTime is considered to be in local time. time_offset can be only one of the following: |
|
utcOffset |
UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. A duration in seconds with up to nine fractional digits, ending with ' |
timeZone |
Time zone. |
TimeZone
Represents a time zone from the IANA Time Zone Database.
JSON representation |
---|
{ "id": string, "version": string } |
Fields | |
---|---|
id |
IANA Time Zone Database time zone, e.g. "America/New_York". |
version |
Optional. IANA Time Zone Database version number, e.g. "2019a". |
GuestInstalledApplicationList
Guest installed application list.
JSON representation |
---|
{
"entries": [
{
object ( |
Fields | |
---|---|
entries[] |
Application entries. |
GuestInstalledApplication
Guest installed application information.
JSON representation |
---|
{ "name": string, "vendor": string, "time": string, "path": string, "version": string, "licenses": [ string ] } |
Fields | |
---|---|
name |
Installed application name. |
vendor |
Installed application vendor. |
time |
Date application was installed. |
path |
Source path. |
version |
Installed application version. |
licenses[] |
License strings associated with the installed application. |
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. |
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 } |
Fields | |
---|---|
vcenterVersion |
vCenter version. |
esxVersion |
ESX version. |
osid |
|
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. |