VMware ESX Server 2.0
Features | Documentation | Knowledge Base | Discussion Forums
 Prev
Contents
Last
Next 
VMware ESX Server SNMP Variables
VMware ESX Server SNMP Variables
The VMware enterprise tree is at .iso.dod.org.internet.private.enterprises.vmware. (.1.3.6.1.4.1.6876.) The tree consists of several groups; the variables in each of the groups are shown in the tables below.
Note: All variables are read-only.
The data type field refers to the SNMP type described by the structure of management information (SMI).
vmware.vmwSystem
vmware.vmwSystem
This group consists of three simple variables providing basic information about the system.
Name
|
Data type
|
Description
|
vmwProdName
|
Display string
|
Product name.
|
vmwProdVersion
|
Display string
|
Product version.
|
vmwProdOID
|
ObjectID
|
A unique identifier for this product in the VMware MIB. This
ID is unique with respect to versions of the same product
also.
|
vmware.vmwVirtMachines
vmware.vmwVirtMachines
This group consists of virtual machine configuration information in six tables.
vmTable —
a table containing information on virtual machines that have been configured on the system. Each row provides information about a particular virtual machine.
Name
|
Data type
|
Description
|
vmIdx
(Index field)
|
Integer
|
This is a dummy number for an index.
|
vmDisplayName
|
Display string
|
Name by which this virtual machine is displayed.
|
vmConfigFile
|
Display string
|
Path to the configuration file for this virtual machine.
|
vmGuestOS
|
Display string
|
Operating system running on this virtual machine.
|
vmMemSize
|
Integer
|
Memory configured for this virtual machine in MB.
|
vmState
|
Display string
|
Virtual machine on or off.
|
vmVMID
|
Integer
|
If a virtual machine is active, an ID is assigned to it (like a pid).
Not all virtual machines may be active, so this cannot be used
as the index.
|
vmGuestState
|
Display string
|
Guest operating system on or off.
|
hbaTable —
a table of disk adapters seen by this virtual machine.
Name
|
Data type
|
Description
|
vmIdx
(Index field)
|
Integer
|
This number corresponds to the index of the virtual machine in
vmTable.
|
hbaIdx
(Index field)
|
Integer
|
There is a correspondence to the order of the SCSI device
module loaded into the VMkernel.
|
hbaNum
|
Display string
|
Device number (format: scsi*).
|
hbaVirtDev
|
Display string
|
Virtual device name for this adapter.
|
hbaTgtTable —
a table of SCSI targets seen by this virtual machine.
Name
|
Data type
|
Description
|
vmIdx
(Index field)
|
Integer
|
This number corresponds to the index of the virtual machine
in vmTable.
|
hbaTgtIdx (Index
field)
|
Integer
|
This is a dummy target index.
|
hbaTgtNum
|
Display string
|
Target description (format: scsi<hba>:<tgt>).
|
netTable —
a table of network adapters seen by this virtual machine.
Name
|
Data type
|
Description
|
vmIdx
(Index field)
|
Integer
|
This number corresponds to the index of the virtual machine
in vmTable.
|
netIdx
(Index field)
|
Integer
|
Index for this table.
|
netNum
|
Display string
|
Device number. (format: ethernet*)
|
netName
|
Display string
|
Device name of VMkernel device that this virtual network
adapter is mapped to. (format: vmnic* or vmnet*)
|
netConnType
|
Display string
|
Connection type (user or virtual machine monitor device).
|
floppyTable —
a table of floppy drives seen by this virtual machine.
Name
|
Data type
|
Description
|
vmIdx
(Index field)
|
Integer
|
This number corresponds to the index of the virtual machine in
vmTable.
|
fdIdx
(Index field)
|
Integer
|
Index into floppy table. Order of the floppy device on this
virtual machine.
|
fdName
|
Display string
|
Device number/name (/dev/fd0, etc. NULL if not present).
|
fdConnected
|
Display string
|
Is the floppy drive connected (mounted)?
|
cdromTable —
a table of CD-ROM drives seen by this virtual machine.
Name
|
Data type
|
Description
|
vmIdx
(Index field)
|
Integer
|
This number corresponds to the index of the virtual
machine in vmTable.
|
cdromIdx
(Index field)
|
Integer
|
Index into CD-ROM table. Order of the CD-ROM device on
this virtual machine.
|
cdromName
|
Display string
|
Device number/name (/dev/CDROM, etc. NULL if not
present).
|
cdromConnected
|
Display string
|
Is the CD-ROM drive connected (mounted)?
|
vmware.vmwResources
vmware.vmwResources
This group contains statistics on the physical machine's resources categorized into several subgroups.
vmware.vmwResources.vmwCPU
vmware.vmwResources.vmwCPU
This group contains CPU-related information in one simple variable and one table.
Name
|
Data type
|
Description
|
numCPUs
|
Integer
|
Number of physical CPUs on the system.
|
cpuTable —
CPU usage by virtual machine.
Name
|
Data type
|
Description
|
vmID
(Index field)
|
Integer
|
ID allocated to running virtual machine by the VMkernel.
|
cpuShares
|
Integer
|
Share of CPU allocated to virtual machine by VMkernel.
|
cpuUtil
|
Integer
|
Amount of time the virtual machine has been running on the CPU
(seconds).
|
vmware.vmwResources.vmwMemory
vmware.vmwResources.vmwMemory
This group contains RAM information in three simple variables and one table.
Name
|
Data type
|
Description
|
memSize
|
Integer
|
Amount of physical memory present on machine (KB).
|
memCOS
|
Integer
|
Amount of physical memory used by the service console (KB).
|
memAvail
|
Integer
|
Amount of physical memory available/free (KB).
|
memTable —
a table of memory usage by virtual machine.
Name
|
Data type
|
Description
|
vmID
(Index field)
|
Integer
|
ID allocated to running virtual machine by the VMkernel.
|
memShares
|
Integer
|
Shares of memory allocated to virtual machine by VMkernel.
|
memConfigured
|
Integer
|
Amount of memory the virtual machine was configured
with (KB).
|
memUtil
|
Integer
|
Amount of memory utilized by the virtual machine (KB;
instantaneous).
|
vmware.vmwResources.vmwHBATable
vmware.vmwResources.vmwHBATable
This group contains physical disk adapter and targets information in one table.
vmwHBATable —
the disk adapter and target information table.
Name
|
Data type
|
Description
|
hbaIdx
(Index field)
|
Integer
|
Index into table for HBA (corresponds to the order of the adapter on
the physical computer).
|
hbaName
|
Display string
|
String describing the disk. (format: <devname#>:<tgt>:<lun>)
|
vmID
|
Integer
|
ID assigned to running virtual machine by the VMkernel.
|
diskShares
|
Integer
|
Share of disk bandwidth allocated to this virtual machine.
|
numReads
|
Integer
|
Number of reads to this disk since disk module was loaded.
|
kbRead
|
Integer
|
KB read from this disk since disk module was loaded.
|
numWrites
|
Integer
|
Number of writes to this disk since disk module was loaded.
|
kbWritten
|
Integer
|
KB written to this disk since disk module was loaded.
|
vmware.vmwResources.vmwNetTable
vmware.vmwResources.vmwNetTable
This group contains network statistics organized by network adapter and virtual machine, in one table.
vmwNetTable —
network adapter statistics.
Name
|
Data type
|
Description
|
netIdx
(Index field)
|
Integer
|
Index into table for Net (corresponds to the order of the adapter on
the physical computer).
|
netName
|
Display string
|
String describing the network adapter (format: vmnic* or vmnet*).
|
vmID
|
Integer
|
ID assigned to running virtual machine by the VMkernel.
|
ifAddr
|
Display string
|
MAC address of virtual machine's virtual network adapter.
|
netShares
|
Integer
|
Share of net bandwidth allocated to this virtual machine. (reserved
for future use)
|
pktsTx
|
Integer
|
Number of packets transmitted on this network adapter since
network module was loaded.
|
kbTx
|
Integer
|
KB sent from this network adapter since network module was
loaded.
|
pktsRx
|
Integer
|
Number of packets received on this network adapter since network
module was loaded.
|
kbRx
|
Integer
|
KB received on this network adapter since system start.
|
vmware.vmwProductSpecific
vmware.vmwProductSpecific
This group contains variables categorized into product-specific subgroups.
vmware.vmwProductSpecific.vmwESX
vmware.vmwProductSpecific.vmwESX
This group contains variables specific to VMware ESX Server.
vmware.vmwProductSpecific.vmwESX.esxVMKernel
vmware.vmwProductSpecific.vmwESX.esxVMKernel
This group contains variables specific toVMware ESX Server's VMkernel. It contains one simple variable.
Name
|
Data type
|
Description
|
vmkLoaded
|
Display string
|
Has the VMkernel been loaded? (yes/no)
|
Note: If the variable showing the state of the VMkernel says no, any values reported
for quantitative variables should be regarded as invalid.
vmware.vmwTraps
vmware.vmwTraps
This group contains the variables defined for VMware traps and related variables for use by the trap receiver (for example, snmptrapd).
Name
|
Data type
|
Description
|
vmPoweredOn
|
Trap
|
This trap is sent when a virtual machine is powered on.
|
vmPoweredOff
|
Trap
|
This trap is sent when a virtual machine is powered off.
|
vmHBLost
|
Trap
|
This trap is sent when a virtual machine detects a loss in guest
heartbeat.
|
vmHBDetected
|
Trap
|
This trap is sent when a virtual machine detects or regains the
guest heartbeat.
|
vmID
|
Integer
|
This is the vmID of the affected virtual machine in the
preceding traps. If the vmID is nonexistent, (such as for a power-
off trap) -1 is returned.
|
vmConfigFile
|
Display string
|
This is the configuration file of the affected virtual machine in
the preceding traps.
|
vmware.vmwOID
vmware.vmwOID
There are no variables in this group. This group is used to allocate a unique identifier for the product denoted by the vmwSystem.vmwOID variable.
vmware.vmwExperimental
vmware.vmwExperimental
There are currently no variables in this group. This group is reserved for VMware ephemeral, experimental variables.
Prev
Contents
Last
Next
|