IBM Endpoint Manager Inspectors Reference

Terminology

Win: Windows
Lin: Red Hat and SUSE Linux
Sol: SUN Solaris
HPUX: Hewlett-Packard UNIX version
AIX: IBM AIX
Mac: Apple Macintosh
Ubu: Ubuntu/Debian
WM: Windows Mobile

The version (e.g. Lin:8.1) corresponds to the version of the IEM product (8.1) in which the inspector was introduced in the client on that platform.
The version number is not shown if it is less than 8.0.


Platform


Contents

Action Objects
Authorization Objects
Client Objects
Directory Services
Environment Objects
Filesystem Objects
Firewall Objects
Fixlet Objects
Formatting Objects
Installed System Software
Introspectors
License Objects
Microsoft IIS Metabase Objects
Miscellaneous
Networking Objects
Power Objects
Primitive Objects
Registry Objects
Session Objects
Session Statistics
Site Objects
SMBIOS objects
System Objects
active device
apar
bios
computer
cpupackage
event log
event log event type
event log record
fileset version record
fileset version record with multiplicity
fileset version requirement
grub block list
grub bootable image
grub color
grub color pair
grub color scheme
grub config file
grub device
grub file location
grub image choice
grub kernel
grub module
language
local mssql database
operating system
operating system product type
primary language
process
processor
ram
registrynode
registryroot
runlevel
scsibus
scsidevice
service
service pack
service pack with multiplicity
smf
smf fmri
smf instance
smf property
smf property group
smf service
smf snapshot
smf snapshot part
smf time
smf value
sound volume
stereo volume
swap
technology level
technology level with multiplicity
usb
uuid
uuid with multiplicity
zone
zone network interface
Task Objects
User Objects
Windows Mobile Device Objects
WMI Objects
World Objects

IBM Endpoint Manager wiki

System Objects

These are the keywords available for querying various aspects of the system, including the name and version of the operating sytem. This chapter also covers the keywords used to describe the vendors and types of the various processors that coexist in a typical computer system. Some of these Inspectors are system-specific, but are included to provide cross-platform compatibility.

service pack with multiplicity

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

service pack

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

technology level with multiplicity

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

technology level

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

fileset version record with multiplicity

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

fileset version record

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

fileset version requirement

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

grub block list

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

grub bootable image

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

grub color pair

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

grub color scheme

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

grub color

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

grub config file

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

grub device

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

grub file location

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

grub image choice

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

grub kernel

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

grub module

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

smf fmri

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

smf instance

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

smf property group

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

smf property

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

smf service

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

smf snapshot part

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

smf snapshot

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

smf time

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

smf value

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

smf

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

apar

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

bios

On Windows computers, this object returns strings that identify the version of the BIOS. On other computers, all bios expressions will fail gracefully, rather than generating an error.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

operating system

The operating system object provides access to several important properties of the system.

Creation Methods

DeclarationDescriptionPlatforms (?)
operating systemReturns the operating system object. See operating system.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<operating system> as string<string>Returns a string containing the name of the operating system concatenated with the release.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
build number high of <operating system><integer>

Plural: build number highs
Numeric representation of the most significant 16 bits of the build number.Win, WM
build number low of <operating system><integer>

Plural: build number lows
Numeric representation of the least significant 16 bits of the build number.Win, WM
csd version of <operating system><string>

Plural: csd versions
Returns the Corrective Service Disk version of the operating system. The szCSDVersion as returned by the GetVersionEx system call. The format varies depending on the installed service packs. For WinNT it contains a string such as "Service Pack 3", for Win95 it can contain a string such as "B".Win, WM
ia64 of <operating system><boolean>

Plural: ia64s
Returns TRUE iff the BES Client is running on Itanium.Win, WM
major version of <operating system><integer>

Plural: major versions
Returns integer which is the dwMajorVersion returned by the GetVersionEx system call. Note that while the WinNT major version tracks the release (3 for 3.51, 4 for 4.0, and 5.0 for Windows 2000, 5.1 for Windows XP), the major version for Win95 and Win98 is always 4.Win, WM
minor version of <operating system><integer>

Plural: minor versions
Numeric representation of the minor version of the operating system.Win, WM
name of <operating system><string>

Plural: names
Returns the name of the operating system as a string. Names might include Win98, WinNT, etcetera.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
performance counter frequency of <operating system><hertz>

Plural: performance counter frequencies
The rate at which the performance counter is being incremented (per second).Win, WM
performance counter of <operating system><integer>

Plural: performance counters
Retrieves a 64-bit performance counter value.Win, WM
platform id of <operating system><integer>

Plural: platform ids
Returns the dwPlatformId as returned by the GetVersionEx system call. Possible values are 1 (Win95/95) and 2 (WinNT).Win, WM
product info numeric of <operating system><integer>

Plural: product info numerics
This Windows-specific inspector returns the integer from the Windows GetProductInfo API. The inspector only provides meaningful results for Windows Vista and newer versions of the OS. The major/minor version of the OS must be 6.0 or greater for the result to be meaningful. For more information, refer to the Microsoft article at http://msdn2.microsoft.com/en-us/library/ms724358(VS.85).aspx.Win, WM
product info string of <operating system><string>

Plural: product info strings
On Windows versions 6.0 and newer (Vista minimum), this inspector returns a string derived from the GetProductInfo API. It will be one of the following values:UnlicensedBusinessCluster ServerServer DatacenterServer Datacenter CoreEnterpriseServer EnterpriseServer Enterprise CoreServer Enterprise ItaniumHome BasicHome ServerServer for Small BusinessSmall Business ServerSmall Business Server PremiumServer StandardServer Standard CoreStarterStorage Server EnterpriseStorage Server StandardStorage Server WorkgroupUltimateWeb ServerUnknown.Win, Mac:8.2, WM
product type of <operating system><operating system product type>

Plural: product types
Returns the product type of the operating system, which includes Workstations, Domain Controllers and Servers.Win, WM
release of <operating system><string>

Plural: releases
Information about the release of the operating system, formatted as a <version> on the Macintosh, but a <string> on UNIX and Windows.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
service pack major version of <operating system><integer>

Plural: service pack major versions
Returns the major version number of the current service pack of the specified OS.Win, WM
service pack minor version of <operating system><integer>

Plural: service pack minor versions
Returns the minor version number of the current service pack of the specified OS.Win, WM
suite mask of <operating system><operating system suite mask>

Plural: suite masks
Returns the bit-mapped suite mask for the operating system, which contains further fine-grain information about the version.Win, WM
x64 of <operating system><boolean>

Plural: x64s
Returns TRUE if the current operating system is 64-bits.Win, WM

cpupackage

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

processor

The <processor> object is used to identify the number and properties of processors in the system. You can identify the manufacturer of the CPU as well as the speed and other features. Many operating systems provide for multiple processors. You can inspect any one of them by their ordinal number.For more information on Windows processors, see the Resource section at the end of this guide.

Creation Methods

DeclarationDescriptionPlatforms (?)
main processorReturns the processor object corresponding to the main processor.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
processorReturns all the processor objects defined on the machine. See processor.

Example:
number of processors > 1 - Returns TRUE if the computer is a multi-processor system.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
processor <integer>Returns a processor object for the numbered processor. Processors are numbered from 1.Win, Lin, Sol, HPUX, AIX, Mac:8.2, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
brand id of <processor><integer>

Plural: brand ids
This inspector returns the integer known as the brand id, returned from the assembly language cpuid extended instruction.Win, Mac:8.2, WM
brand string of <processor><string>

Plural: brand strings
Returns the vendor-defined brand names for newer processors.Win, Lin:8.2, Sol:8.2, Mac:8.2, WM, Ubu:8.2
extended family of <processor><integer>

Plural: extended families
Integer representing the extended family of CPU. See the notes for the meaning of these numbers.Win, Mac:8.2, WM
extended model of <processor><integer>

Plural: extended models
Integer representing the extended model of CPU. See the notes for the meaning of these numbers.Win, Mac:8.2, WM
family name of <processor><string>

Plural: family names
Returns the family name of the CPU, dependent on the type of client computer, for instance Pentium, Sparc, PowerPC G4, etcetera.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
family of <processor><integer>

Plural: families
Returns an integer representing the family of the CPU. See the notes for the meaning of these numbers. As of BES 6.0, this Inspector returns a string on Solaris and AIX computers.Win, Lin, Sol, AIX, Mac:8.2, WM, Ubu:8.1
feature mask of <processor><integer>

Plural: feature masks
Returns the feature flags from the CPUID instruction. The feature mask contains bits that identify extra features the processor may provide such as MMX support or if the Processor ID is enabled on the processor.Win, Mac:8.2, WM
model of <processor><integer>

Plural: models
Returns the model number of the CPU.Note: On Solaris, HPUX and AIX computers, this Inspector returns a <string> as of BES 6.0.Win, Lin, Mac:8.2, WM, Ubu:8.1
speed of <processor><hertz>

Plural: speeds
Returns the speed of the processor in Hertz.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
stepping of <processor><integer>

Plural: steppings
Returns the stepping number of the processor. This item can be helpful in identifying very specific processor features or limitations.Win, Lin, Mac:8.2, WM, Ubu:8.1
type of <processor><integer>

Plural: types
Numeric type of the CPU. Values include: 0 - standard1 - overdrive2 - dual CPU capable3 - reservedNote: this Inspector returns a <string> type as of BES version 6.0 on UNIX machines and version 5.1 on the Macintosh.Win, WM
vendor name of <processor><string>

Plural: vendor names
The manufacturer of the CPU. Names include: GenuineIntelAuthenticAMDCyrixInsteadCentaurHaulsAmbiguousCPU.Win, Lin, Mac:8.2, WM, Ubu:8.1

ram

The <ram> object is used to inspect properties of the computer's random access memory.

Creation Methods

DeclarationDescriptionPlatforms (?)
ramReturns a ram object for inspecting the properties of Random Access Memory installed on the machine. See ram.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
random access memorySame as above.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
available of <ram><integer>

Plural: availables
Returns the total amount of RAM (in bytes) currently available on the Windows Mobile device. This is the same as for for the Windows client.WM
load of <ram><integer>

Plural: loads
Returns the amount of memory being used on the Windows Mobile device as a percentage. 0 = no memory used, 100 = all memory used. This is the same as for the Windows client.WM
size of <ram><integer>

Plural: sizes
Returns the number of bytes of random access memory on the current machine.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

active device

On Windows NT systems (including XP and 2K), the <active device> Inspectors returns a set of objects corresponding to the active devices on the machine, for example: modems, graphics cards, printers, and more.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

local mssql database

The <local mssql database> Inspectors retrieve the properties of the MS SQL databases on the local machine.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

service

The <service> Inspectors provide access to all services configured on Windows NT, 2K and XP systems. On a non-Windows system, expressions using these objects will fail gracefully instead of generating an error.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

process

Processes allocate the various resources needed to execute a program. Processes have a process identifier, a virtual address space, associated code, a priority class, security settings, environment variables, min and max working set sizes, and at least one executing thread. Processes are typically started with a single primary thread which in turn can spawn additional threads.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

swap

This object lets you inspect the properties of your swap space.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

language

A language is composed of a primary language (for example, Swiss) and a sub-language (for example, Swiss German).

Creation Methods

DeclarationDescriptionPlatforms (?)
system localeDetermines which bitmap fonts, and OEM, ANSI, and MAC code pages are defaults for the system. This only affects applications that are not fully Unicode.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
system ui languageDetermines the default language of menus and dialogs, messages and help files.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
user localeDetermines which settings are used for formatting dates, times, currency, and numbers as a default for each user. Also determines the sort order for sorting text.Win, WM
user ui languageNon-MUI: Same as system UI Language.MUI: Determines the language of menus and dialogs, messages, and help files.Win, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<language> as string<string>Returns the language of the system locale.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
primary language of <language><primary language>

Plural: primary languages
Extracts the primary language identifier from a language.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1

primary language

A primary language identifier indicates the written/spoken language that is used by the system. However, to identify the language that is used in a country or region you must combine the primary language with a sub-language identifier to form language identifiers.

Creation Methods

DeclarationDescriptionPlatforms (?)
primary language of <language>Extracts the primary language identifier from a language.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<primary language> as string<string>Returns the primary language.Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1

computer

The <computer> Inspectors provide access to the name of the computer.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

registryroot

The <registryroot> objects are the Inspectors for the planes of the IOKit Registry

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

registrynode

The <registrynode> Inspectors provide access to the nodes of the IOKit Registry.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

scsibus

The <scsibus> Inspectors refer to the Small Computer System Interface bus components.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

scsidevice

The <scsidevice> Inspectors refer to the Small Computer System Interface devices connected to the Client computer.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

sound volume

The <sound volume> Inspectors are for inspecting the sound volume settings.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

stereo volume

The <stereo volume> Inspectors are for inspecting the stereo volume settings.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

usb

The <usb> objects are the Universal Serial Bus Inspectors.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

runlevel

The <runlevel> Inspectors refer to a mode of operation in various Unix systems. Typically, when a computer enters runlevel zero, it halts and when it enters runlevel six, it reboots. The intermediate runlevels differ widely among operating systems.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

operating system product type

The <operating system product type> Inspectors return the product type of the operating system, which includes Workstations, Domain Controllers and Servers.

Creation Methods

DeclarationDescriptionPlatforms (?)
operating system product type <integer>Returns an object corresponding to the numbered OS product type.Win, WM
product type of <operating system>Returns the product type of the operating system, which includes Workstations, Domain Controllers and Servers.Win, WM

Operators

DeclarationReturn TypeDescriptionPlatforms (?)
<operating system product type> = <operating system product type><boolean>Compare two operating system product types for equality.Win, WM

Properties

DeclarationReturn typeDescriptionPlatforms (?)

event log

The <event log> Inspectors return information about the specified Windows Event logs, including the System, Security and the Application log.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

event log record

The <event log record> Inspectors return individual records from the Windows Event logs, which record information about operating system events.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

event log event type

The <event log event type> Inspectors return information about the types of Windows Event log entries, which record various operating system events including errors, warnings and general information.

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

zone

The Solaris OS allows you to set up zones, which provide a virtual view of the runtime environment that is segregated from other zones. Solaris Zones act as completely isolated virtual servers within a single operating system instance. These Inspectors allow you to monitor the user's zone configurations.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

zone network interface

The <zone network interface> objects allow you to inspect the network interfaces (IP layers) installed when booting a Solaris Zone.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

uuid

UUID is a Universally Unique IDentifier code given to each storage device on your Solaris system. UUIDs are used to identify DVD drives, removable media and drive partitions. The UUID is a hexadecimal string such as c73a37c8-ef7f-40e4-b9de-8b2f81038441. UUID values may be compared to each other using the arithmetic operators (=, <, >, and more.).

Creation Methods

DeclarationDescriptionPlatforms (?)

Operators

DeclarationReturn TypeDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)

uuid with multiplicity

The <uuid with multiplicity> Inspectors deal with arrays of UUIDs, allowing you to extract unique IDs and count them.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)