VMware Asset Discovery Plugin Inspectors

Bios

vm bios: bios

The vm bios inspector returns contains the uuid of the bios property.

uuid of <bios>: string

The 128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in the 12345678-abcd-1234-cdef-123456789abc format.

Bios (Guest)

version of <vm bios>: string

The current BIOS version of the physical chassis.

release date of <vm bios>: time

The release date for the BIOS.

Bios (Host)

host bios : <host bios> 

The Host BIOS inspector returns information about the system BIOS of the host.

model of <host bios>: string

The Host BIOS model identification.

platform of <host bios>: platform

Returns the platform object of the Host BIOS.

serial number of <platform>: string

The serial number of the Host BIOS, taken from the platform object.

Computer Name

computer name: string

The display name of the device. The name of the virtual machine for Guest devices and the host name for Host devices.

Credentials Label

credentials label: string

The credentials label is a custom string defined by the user when installing the plugin. It uniquely identifies a user’s set of credentials.

Custom Attributes

custom attributes: plural custom attribute

This inspector returns the custom attributes. An array of base types for storing values.

attribute of <custom attribute>: string

The attribute name of the custom attribute.

value of <custom attribute>: string

The string value of the custom attribute.

Data Source

data source: string

The data source is the name of the system where data is coming from. For the VMware Plugin, it is set to “Proxy – VMware” by default.

Device

device: device

The overall alarm status on this node. In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property.

Device (Guest)

status of <device>: string

The current power state of the virtual machine.

state of <device>: string

The current state of the virtual machine.

vm uuid of <device>: string

The VC-specific identifier of the virtual machine.

bios uuid of <device>: string

The virtual machine BIOS identification.

description of <device>: string

The description for the virtual machine.

vm path name of <device>: string

The path name to the configuration file for the virtual machine

clean power off of <device>: string

For a powered off virtual machine, it indicates whether the virtual machine's last shutdown was an orderly power off or not. Unset if the virtual machine is running or suspended.

virtual disk count of <device>: integer

The number of virtual disks attached to the virtual machine.

ethernet card count of <device>: integer

The number of virtual network adapters.

modification time of <device>: time

The last executed task.

template of <device>: boolean

This data object type describes a template virtual machine configuration file.

Device (Host)

bios release date of <device>: time

The release date for the bios.

bios version of <device>: string

The current bios version of the physical chassis.

bios uuid of <device>: string

The hardware BIOS identification.

file system type of <device>: string

Represents the list of supported file system volume types.

maintenance mode of <device>: boolean

The flag to indicate whether or not the host is in maintenance mode. This flag is set when the host has entered the maintenance mode. It is not set during the entering phase of maintenance mode.

model of <device>: string

The system model identification.

network adapters of <device>: string

The number of network adapters.

pending restart of <device>: boolean

Indicates whether or not the host requires a reboot due to a configuration change.

port number of <device>: string

The port number.

status of <device>: string

The overall alarm status of the host.

vendor of <device>: string

The vendor type.

vmotion of <device>: boolean

The flag to indicate whether or not VMotion is enabled on this host.

vswitches of <device>: plural vswitches

The virtual switches.

portgroups of <vswitches>: plural string

The port groups of the virtual switches.

name of <vswitches>: string

The name of the virtual switches.

hostd log enabled of <device>: boolean

The flag to indicate if hostd log file exists.

messages log enabled of <device>: boolean

The flag to indicate if messages log file exists.

vmkernel log enabled of <device>: boolean

The flag to indicate if vmkernel log file exists.

Device ID

device id: string

The device ID is a unique identifier for each device. For VMware Guest devices, it corresponds to the instance UUID, which is the VC-specific identifier of the virtual machine. For VMware Hosts, it corresponds to the Host name with the “Host - “ prefix prepended.

Disk

disk: disk

The disk inspectors return data concerning the storage used by a machine.

provisioned storage of <disk> : string

The total storage space, in bytes, both committed and uncommitted to this virtual machine on all datastores.

used storage of <disk> : string

The total storage space, in bytes, committed to this virtual machine across all datastores.

unshared storage of <disk> : string

The total storage space, in bytes, occupied by the virtual machine across all datastores, that is not shared with any other virtual machine.

Drive (Guest)

drive: drive

drives: plural drive

The drive inspectors return data about the file system.

name of <drive>: string

The name of the virtual disk in the guest operating system. For example: C:\

free space of <drive>: integer

The free space on the disk, in bytes. This is retrieved by the VMware Tools.

total space of <drive>: integer

The total capacity of the disk, in bytes. This is part of the virtual machine configuration.

Guest VM

 guest vms: plural guest vm

These inspectors retrieve properties for the guest virtual machine.

name of <guest vm>: string

The guest name configured on the virtual machine.

network of <guest vm>: network

The network configured on the virtual machine.

operating system of <guest vm>: operating system

The operating system on the virtual machine.

host of <guest vm>: host

The host name.

 tool of <guest vm>: tool

The tool on the virtual machine.

processor of <guest vm>: processor

The processor on the virtual machine.

ram of <guest vm>: ram

The RAM on the virtual machine.

usage statistic of <guest vm>: usage statistic

The usage statistic of the virtual machine.

drives of <guest vm>: drive

The drives of the virtual machine.

device of <guest vm>: device

The devices configured on the virtual machine.

snapshots of <guest vm>: snapshot

The snaphots of the virtual machine.

Hardware

hardware: hardware

This inspector holds properties about the hardware type of the VMware representation of an instance. By default, the virtual and proxied properties return true on cloud plugins representations.

virtual of <hardware>: boolean

Returns true if the client is running on a virtual machine.

proxied of <hardware>: boolean

Returns true if the device reports to the BES Plugin Portal. Otherwise, it returns false.

Host (Guest)

host: host

The Host inspectors report the name of the host of the current guest.

name of <host>: string

The name of the host.

Services (Host)

[host service, host services]: plural host service

The Host Service inspectors return information about each configured service that runs on a host.

key name of <host service> : string

The brief identifier for the service.

label of <host service> : string

Displays the label for the service.

policy of <host service> : string

The service activation policy.

required of <host service> : string

The flag indicating whether the service is required and cannot be disabled.

running status of <host service> : string

The flag indicating whether the service is currently running.

Network

The network inspector is defined in the common section. The following properties are available for the VMware cloud plugin.

ip interfaces of <network>: plural ip interface

Returns all the IP interfaces of the network.

address of <ip interface>: string

The primary IP address assigned to the guest operating system, if known. Otherwise, the preferred one.

loopback of <ip interface>: boolean

The routing of electronic signals or digital data streams back to their source without intentional processing or modification.

mac address of <ip interface>: string

The MAC address of the adapter.

Network (Guest)

The VNIC inspectors provide Guest information about network adapters, if known.

vnics of <network>: plural vnic

Returns the VNICs of the network.

vnic counter of <network>: integer

Represents the virtual network identity cards counter.

name of <vnic>: string

The label for the device.

up of <vnic>: boolean

The flag indicating whether or not the virtual device is connected.

mac address of <vnic>: string

The MAC address of the adapter.

[address, addresses] of <vnic>: plural string

Zero, one or more manual (static) assigned IP addresses to be configured on a given interface.

dhcp enabled of <vnic>: boolean

Indicates whether or not dynamic host control protocol (DHCP) is used to configure DNS configuration.

connected of <vnic>: boolean

The flag indicating whether or not the virtual device is connected.

device config id of <vnic>: integer

The link to the corresponding virtual device.

label of <vnic>: string

The display label of the VNIC.

address counter of <vnic>: string

The number of addresses found.

vnic counter of <network>: string

The number of VNICs found.

OS

The operating system inspector is defined in the common section.

name of <operating system>: string

The complete product name, including the version information, if known. Otherwise, the short form of the product name.

version of <operating system>: string

The dot-separated version string.

OS (Guest)

[family, families] of <operating system>: string

The guest operating system family, if known.

id of <operating system>: string

The guest operating system identifier short name, if known.

OS (Host)

api version of <operating system>: version

The version of the API as a dot-separated string.

api type of <operating system>: string

Indicates whether or not the service instance represents a standalone host. If the service instance represents a standalone host, then the physical inventory for that service instance is fixed to that single host. VirtualCenter server provides additional features over single hosts.

boot time of <operating system>: time

Represents the time when the host was booted.

build number of <operating system>: integer

The OS host build number.

license product name of <operating system>: string

The name of the license product.

license product version of <operating system>: string

The version of the license product.

locale build of <operating system>: string

The build number for the current session's locale. Typically, this is a small number reflecting a localization change from the normal product build.

locale version of <operating system>: string

The version of the message catalog for the current session's locale.

major version of <operating system>: version

The first number of the OS Version property as a dot-separated string.

minor version of <operating system>: version

The second number of the OS Version property as a dot-separated string.

os type of <operating system>: string

The operating system type and architecture.

product line id of <operating system>: string

The product ID which is a unique identifier for a product line.

vendor of <operating system>: string

The name of the vendor of this product.

Patch Status (Host)

[patch status, patch statuses]: plural patch status

This inspector collects the information about the patch enforcement of the ESXi.

package name of <patch status>: string

The identifier that uniquely identifies the software package.

package install date of <patch status>: string

The time when the package was installed. On Autodeploy stateless installations, there is no value set.

package version of <patch status>: string

The version string that uniquely identifies the software package.

package vendor of <patch status>: string

The corporate entity that created the software package.

package acceptance of <patch status>: string

The acceptance level definitions. See here for details.

Processor

processor: processor

The processor inspector is defined in the common section. It returns processor objects defined on the machine.

speed of <processor>: hertz

Returns the speed of the processor in Hertz. Defaults to -1.

family name of <processor>: string

Returns the family name of the CPU. For the VMware cloud plugin it is left empty.

Processor (Guest)

count of <processor>: integer

The number of processors in the virtual machine.

resource settings of <processor>: resource setting

The resource settings specifies the reserved resource requirement as well as the limit (maximum allowed usage) for a given kind of resource. CPU allocation is specified in MHz.

Processor (Host)

logical processor count of <processor>: integer

The number of physical CPU threads on the host.

physical processor count of <processor>: integer

The number of physical CPU packages on the host.

power management currenty policy of <processor>: string

The information about the current CPU power management policy.

power management hardware support of <processor>: string

The information about the supported CPU power management.

total processor core count of <processor>: integer

The number of physical CPU cores on the host.

cpu packages of <processor>: plural cpu package

The CPU packages of the processor.

cpu pkg bus hz of <cpu package>: integer

The bus speed in HZ.

cpu pkg description of <cpu package>: string

The string summary description of the CPU.

cpu pkg hz of <cpu package>: integer

The CPU speed in HZ.

cpu pkg vendor of <cpu package>: string

The CPU vendor name. Possible names currently are "Intel", "AMD", "arm", "hygon", or "unknown".

RAM

The RAM inspector is defined in the common section.

size of <ram>: integer

Returns the number of bytes of random access memory on the current machine.

RAM (Guest)

The amount of memory resource (in bytes) that will be used by the virtual machine above its guest memory requirements. This value is set if and only if the virtual machine is registered on a host that supports memory resource allocation features. For powered off VMs, this is the minimum overhead required to power on the VM on the registered host. For powered on VMs, this is the current overhead reservation, a value which is almost always larger than the minimum overhead, and which grows with time.

overhead of <ram>: integer

The bytes of memory used by the virtual machine above its guest memory requirements.

resource settings of <ram>: resource setting

Resource settings specifies the reserved resource requirement as well as the limit (maximum allowed usage) for a given kind of resource. Memory allocation is specified in MB.

Resource Setting

The properties below are common to ram and processor.

reservation of <resource setting>: integer

The amount of resource that is guaranteed available to the virtual machine or resource pool. Reserved resources are not wasted if they are not used. If the utilization is less than the reservation, the resources can be utilized by other running virtual machines. Units are MB for memory, MHz for CPU.

limit of <resource setting>: string

The utilization of a virtual machine/resource pool will not exceed this limit, even if there are available resources. This is typically used to ensure a consistent performance of virtual machines / resource pools independent of available resources. If set to -1, then there is no fixed limit on resource usage (only bounded by available resources and shares). Units are MB for memory, MHz for CPU.

overhead limit of <resource setting>: string

The maximum allowed overhead memory. For a powered on virtual machine, the overhead memory reservation cannot be larger than its overheadLimit. This property is only applicable to powered on virtual machines and is not persisted across reboots. This property is not applicable for resource pools. If set to -1, then there is no limit on reservation. Units are MB.

shares of <resource setting>: string

The allocation level. The level is a simplified view of shares. Levels map to a pre-determined set of numeric values for shares. If the shares value does not map to a predefined size, then the level is set as custom.

Snapshot (Guest)

snapshots: plural snapshot

The snapshot inspectors report all the read-only data produced by a snapshot.

creation time of <snapshot>: time

The date and time the snapshot was taken.

description of <snapshot>: string

The description of the snapshot.

name of <snapshot>: string

The name of the snapshot.

id of <snapshot>: integer

The unique identifier that distinguishes this snapshot from other snapshots of the virtual machine.

quiesced of <snapshot>: boolean

The flag to indicate whether or not the snapshot was created with the "quiesce" option, ensuring a consistent state of the file system.

replay supported of <snapshot>: boolean

The flag to indicate whether this snapshot is associated with a recording session on the virtual machine that can be replayed.

type of <snapshot>: string

The name of the managed object type of this snapshot.

value of <snapshot>: string

The specific instance of the managed object of this snapshot.

vm state of <snapshot>: string

The power state of the virtual machine when this snapshot was taken.

children of <snapshot>: snapshots

The snapshot data for all snapshots for which this snapshot is the parent.

Tool (Guest)

tool : <tool>

The tool inspectors report data about the VMware Tools.

status of <tool>: string

The current version status of VMware Tools, if known.

running status of <tool>: string

The current running status of VMware Tools in the guest operating system, if known.

version of <tool>: string

The current version of VMware Tools, if known.

version status of <tool>: string

The current version status of VMware Tools in the guest operating system, if known.

Usage Statistic (Guest)

usage statistic: usage statistic

The Usage Statistic inspector returns a set of statistics for a Virtual Machine.

overall cpu of <usage statistic>: hertz

The basic CPU performance statistics, in MHz. Valid while the virtual machine is running.

memory of <usage statistic>: integer

The guest memory utilization statistics, in MB. This is also known as active guest memory. The number can be between 0 and the configured memory size of the virtual machine. Valid while the virtual machine is running.

maximum cpu of <usage statistic>: hertz

The current upper-bound on CPU usage.

[maximum memory, maximum memories] of <usage statistic>: integer

The current upper-bound on memory usage.

[host memory, host memories] of <usage statistic>: integer

The Host memory utilization in bytes, including the overhead memory of the MV. The value ranges between 0 and the configured resource limit and it is valid while the virtual machine is running. Also known as the consumed host memory.

USB Device (Host)

[usb device, usb devices] : plural usb device

The USB device inspector returns a set of properties.

name of <usb device>: string

The USB device name.

description of <usb device>: string

A user visible name of the USB device.

family of <usb device>: string

The device class families. For possible values, see VirtualMachineUsbInfoFamily.

physicalpath of <usb device>: string

An autoconnect pattern which describes the device physical path. This is the path to the specific port on the host where the USB device is attached.

product of <usb device>: integer

The product ID of the USB device.

speed of <usb device>: string

The possible device speeds detected by the server. For possible values, see VirtualMachineUsbInfoSpeed.

vendor of <usb device>: integer

The vendor ID of the USB device.

usage summary of <usb device>: usage summary

The summary information about the virtual machine that is currently using this device, if any.

vm name of <usage summary>: string

The name of the virtual machine

vm path of <usage summary>: string

The path name to the configuration file for the virtual machine.

Virtualization inspectors

datacenters: plural datacenter

The Virtualization inspectors return a set of datacenter properties.

Virtualization inspectors for datacenters

name of <datacenter>: string

The name of the datacenter.

datastores of <datacenter>: plural datastore

A collection of references to the datastore objects available in this datacenter.

name of <datastore>: string

The name of the datastore.

free space of <datastore>: string

The free space of this datastore, in bytes. The server periodically updates this value. It can be explicitly refreshed with the Refresh operation.

max file size of <datastore>: string

The maximum size of a file that can reside on this file system volume.

timestamp of <datastore>: string

The time when the free-space and capacity values in DatastoreInfo and DatastoreSummary were updated.

url of <datastore>: string

The unique locator for the datastore.

iso images of <datastore>: plural iso image

The ISO images of the datastore.

path of <iso image>: string

The path relative to the folder path in the search results.

Virtualization inspectors for hard drivers

disk of <guest vm>: disk

The disk.

hard driver counter of <guest vm>: string

The number of hard drivers.

hard drivers of <guest vm>: plural hard driver

The hard drivers.

hard drivers: plural hard driver

Array.

unitnumber of <hard driver>: string

The unit number of this device on its controller. This property is null if the controller property is null (for example, when the device is not attached to a specific controller object).

datastore name of <hard driver>: string

The name of the datastore.

controllerkey of <hard driver>: string

The object key for the controller object for this device. This property contains the key property value of the controller device object.

label of <hard driver>: string

The label of the disk.

capacity of <hard driver>: string

The total capacity of the disk, in bytes. This is part of the virtual machine configuration.

key of <hard driver>: string

A unique key that distinguishes this device from other devices in the same virtual machine. Keys are immutable but may be recycled; that is, a key does not change as long as the device is associated with a particular virtual machine. However, once a device is removed, its key may be used when another device is added. This property is not read-only, but the client cannot control its value. Persistent device keys are always assigned and managed by the server, which guarantees that all devices will have non-negative key values. When adding new devices, it may be necessary for a client to assign keys temporarily in order to associate controllers with devices in configuring a virtual machine. However, the server does not allow a client to reassign a device key, and the server may assign a different value from the one passed during configuration. Clients should ensure that existing device keys are not reused as temporary key values for the new device to be added (for example, by using unique negative integers as temporary keys). When editing or deleting a device, clients must use the server-provided key to refer to an existing device.

Virtualization inspectors for disk for last time refreshed

last time refreshed: string

Last time refreshed simply refers to the report production time for the disk discovery. The layout should be: <year> <month> <day> <hour>:<min>:<sec>.

last time refreshed of <guest vm>: string

Last time refreshed simply refers to the report production time for the disk discovery. The layout should be: <year> <month> <day> <hour>:<min>:<sec>.

Virtualization inspector for VM name

name: string

Name of the Guest or Host, unique relative to its parent. Could contain escaped characters.