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

Declaration	Description	Platforms (?)
unique value of <service pack>	Returns a list of all unique service packs along with their respective counts.	AIX:8.2

Properties

Declaration	Return type	Description	Platforms (?)
multiplicity of <service pack with multiplicity>	<integer>	Returns an the number of times a service pack occurs.	AIX:8.2

service pack

Creation Methods

Declaration	Description	Platforms (?)
maximum of <service pack>	Returns the latest service pack.	AIX:8.2
minimum of <service pack>	Returns the earliest service pack.	AIX:8.2
current service pack of <operating system>	Returns the current service pack, or no such object if none have been applied at the current technology level.	AIX:8.2
service pack <string> of <operating system>	Returns the service pack that matches the string in the format "base-tl-sp-date". For example, AIX 5.3 at technology level 6 and service pack 3, which was released on the 32nd week of 2007, would be "5300-06-03-0732". Note: older service packs may not have a date portion, and the final service pack at a particular technology level has a SP value of 'CSP'.	AIX:8.2
service pack of <operating system>	Returns all service packs	AIX:8.2

Properties

Declaration	Return type	Description	Platforms (?)
<service pack> as string	<string>	Returns a string that uniquely identifies a service pack in the format "base-tl-sp-date". For example, AIX 5.3 at technology level 6 and service pack 3, which was released on the 32nd week of 2007, would be "5300-06-03-0732". Note: older service packs may not have a date portion, and the final service pack at a particular technology level has a SP value of 'CSP'.	AIX:8.2
abstract of <service pack>	<string>	Returns a string in the format "AIX base-tl-sp (Concluding) Service Pack", with 'Concluding' onyl for a CSP.	AIX:8.2
extrema of <service pack>	<( service pack, service pack )>	Returns a tuple with the oldest and newest service packs.	AIX:8.2
fileset version requirement <string> of <service pack>	<fileset version requirement>	Returns the fileset version requirements for the service pack if a fileset with an LPP name matching the string is a requirement of the service pack.	AIX:8.2
fileset version requirement of <service pack>	<fileset version requirement>	Returns all of the fileset version requirements for the service pack.	AIX:8.2
installed satisfied fileset version requirement of <service pack>	<fileset version requirement>	Returns all the fileset version requirements for the service pack that are installed and meet the version requirement.	AIX:8.2
installed unsatisfied fileset version requirement of <service pack>	<fileset version requirement>	Returns all the fileset version requirements for the service pack that are installed but do not meet the version requirement.	AIX:8.2
maximum of <service pack>	<service pack>	Returns the latest service pack.	AIX:8.2
minimum of <service pack>	<service pack>	Returns the earliest service pack.	AIX:8.2
name of <service pack>	<string>	Returns a string that uniquely identifies a service pack in the format "base-tl-sp-date". For example, AIX 5.3 at technology level 6 and service pack 3, which was released on the 32nd week of 2007, would be "5300-06-03-0732". Note: older service packs may not have a date portion, and the final service pack at a particular technology level has a SP value of 'CSP'.	AIX:8.2
technology level of <service pack>	<technology level>	Returns the technology associated of the service pack.	AIX:8.2
uninstalled fileset version requirement of <service pack>	<fileset version requirement>	Returns all the fileset version requirements for the service pack that are not installed.	AIX:8.2
unique value of <service pack>	<service pack with multiplicity>	Returns a list of all unique service packs along with their respective counts.	AIX:8.2

technology level with multiplicity

Creation Methods

Declaration	Description	Platforms (?)
unique value of <technology level>	Returns a list of all unique technology levels along with their respective counts.	AIX:8.2

Properties

Declaration	Return type	Description	Platforms (?)
multiplicity of <technology level with multiplicity>	<integer>	Returns an the number of times a technology level occurs.	AIX:8.2

technology level

Creation Methods

Declaration	Description	Platforms (?)
technology level of <service pack>	Returns the technology associated of the service pack.	AIX:8.2
maximum of <technology level>	Returns the highest technology level.	AIX:8.2
minimum of <technology level>	Returns the lowest technology level.	AIX:8.2
current technology level of <operating system>	Returns the current technology level. This also includes the base level information, similar to 'oslevel -r'.	AIX:8.2
technology level <string> of <operating system>	Returns the technology level that matches the string in the format "base-tl". For example, AIX 5.3 at technology level 6 is "5300-06".	AIX:8.2
technology level of <operating system>	Returns all technology levels.	AIX:8.2

Properties

Declaration	Return type	Description	Platforms (?)
<technology level> as string	<string>	Returns a string that uniquely identifies a technolgoy level in the format "base-tl". For example, AIX 5.3 at technology level 6 would be "5300-06".	AIX:8.2
abstract of <technology level>	<string>	Returns a string in the format "AIX base-tl Update".	AIX:8.2
extrema of <technology level>	<( technology level, technology level )>	Returns a tuple with the lowest and highest technology levels.	AIX:8.2
fileset version requirement <string> of <technology level>	<fileset version requirement>		AIX:8.2
fileset version requirement of <technology level>	<fileset version requirement>	Returns all the required filesets version requirements for the technology level.	AIX:8.2
installed satisfied fileset version requirement of <technology level>	<fileset version requirement>	Returns all the fileset version requirements for the technology level that are installed and meet the version requirement.	AIX:8.2
installed unsatisfied fileset version requirement of <technology level>	<fileset version requirement>	Returns all the fileset version requirements for the technology level that are installed but do not meet the version requirement.	AIX:8.2
maximum of <technology level>	<technology level>	Returns the highest technology level.	AIX:8.2
minimum of <technology level>	<technology level>	Returns the lowest technology level.	AIX:8.2
name of <technology level>	<string>	Returns a string that uniquely identifies a technolgoy level in the format "base-tl". For example, AIX 5.3 at technology level 6 would be "5300-06".	AIX:8.2
uninstalled fileset version requirement of <technology level>	<fileset version requirement>	Returns all the fileset version requirements for the technology level that are not installed.	AIX:8.2
unique value of <technology level>	<technology level with multiplicity>	Returns a list of all unique technology levels along with their respective counts.	AIX:8.2

fileset version record with multiplicity

Creation Methods

Declaration	Description	Platforms (?)
unique value of <fileset version record>	Returns a list of all unique fileset version records along with their respective counts.	AIX:8.2

Properties

Declaration	Return type	Description	Platforms (?)
multiplicity of <fileset version record with multiplicity>	<integer>	Returns an the number of times a fileset version record occurs.	AIX:8.2

fileset version record

Creation Methods

Declaration	Description	Platforms (?)
fileset version record <fileset version record>	A self cast, used only for simplifying relevance.	AIX:8.2
fileset version record <string>	Returns a fileset version record specified by the string in the format "ver.rel.mod.fix".	AIX:8.2
version record of <fileset>	Returns the version record corresponding to the specified fileset as a fileset version record.	AIX:8.2
<fileset version record> as fileset version record	A self cast, used only for simplifying relevance.	AIX:8.2
maximum of <fileset version record>	Returns the highest fileset version record from a collection for fileset version records.	AIX:8.2
minimum of <fileset version record>	Returns the lowest fileset version record from a collection for fileset version records.	AIX:8.2
version record of <fileset version requirement>	Returns the version of the fileset requirement.	AIX:8.2

Properties

Declaration	Return type	Description	Platforms (?)
<fileset version record> as fileset version record	<fileset version record>	A self cast, used only for simplifying relevance.	AIX:8.2
<fileset version record> as string	<string>	Returns a string containing the version of the fileset in the format "ver.rel.mod.fix".	AIX:8.2
extrema of <fileset version record>	<( fileset version record, fileset version record )>	Returns a tuple with the lowest and highest fileset version records from a collection for fileset version records.	AIX:8.2
fix_part of <fileset version record>	<integer>	Returns the fourth component from a fileset version in the format "ver.rel.mod.(fix)".	AIX:8.2
maximum of <fileset version record>	<fileset version record>	Returns the highest fileset version record from a collection for fileset version records.	AIX:8.2
minimum of <fileset version record>	<fileset version record>	Returns the lowest fileset version record from a collection for fileset version records.	AIX:8.2
mod_part of <fileset version record>	<integer>	Returns the third component from a fileset version in the format "ver.rel.(mod).fix".	AIX:8.2
rel_part of <fileset version record>	<integer>	Returns the second component from a fileset version in the format "ver.(rel).mod.fix".	AIX:8.2
unique value of <fileset version record>	<fileset version record with multiplicity>	Returns a list of all unique fileset version records along with their respective counts.	AIX:8.2
ver_part of <fileset version record>	<integer>	Returns the first component from a fileset version in the format "(ver).rel.mod.fix".	AIX:8.2

fileset version requirement

Creation Methods

Declaration	Description	Platforms (?)
fileset version requirement <fileset version requirement>	A self cast, used only for simplifying relevance.	AIX:8.2
fileset version requirement <string>	Returns a fileset version requirement specified by the string in the format "lpp_name ver.rel.mod.fix".	AIX:8.2
fileset version requirement <string> of <service pack>	Returns the fileset version requirements for the service pack if a fileset with an LPP name matching the string is a requirement of the service pack.	AIX:8.2
fileset version requirement of <service pack>	Returns all of the fileset version requirements for the service pack.	AIX:8.2
installed satisfied fileset version requirement of <service pack>	Returns all the fileset version requirements for the service pack that are installed and meet the version requirement.	AIX:8.2
installed unsatisfied fileset version requirement of <service pack>	Returns all the fileset version requirements for the service pack that are installed but do not meet the version requirement.	AIX:8.2
uninstalled fileset version requirement of <service pack>	Returns all the fileset version requirements for the service pack that are not installed.	AIX:8.2
fileset version requirement <string> of <technology level>		AIX:8.2
fileset version requirement of <technology level>	Returns all the required filesets version requirements for the technology level.	AIX:8.2
installed satisfied fileset version requirement of <technology level>	Returns all the fileset version requirements for the technology level that are installed and meet the version requirement.	AIX:8.2
installed unsatisfied fileset version requirement of <technology level>	Returns all the fileset version requirements for the technology level that are installed but do not meet the version requirement.	AIX:8.2
uninstalled fileset version requirement of <technology level>	Returns all the fileset version requirements for the technology level that are not installed.	AIX:8.2
<fileset version requirement> as fileset version requirement	A self cast, used only for simplifying relevance.	AIX:8.2
fileset version requirement <string> of <apar>	Returns the fileset version requirement for the APAR if a fileset with the LPP name that matches the string is a requirement for the APAR.	AIX:8.2
fileset version requirement of <apar>	Returns all the required filesets version requirements for the APAR.	AIX:8.2
installed satisfied fileset version requirement of <apar>	Returns all the fileset version requirements for the APAR that are installed and meet the version requirement.	AIX:8.2
installed unsatisfied fileset version requirement of <apar>	Returns all the fileset version requirements for the APAR that are installed but do not meet the version requirement.	AIX:8.2
uninstalled fileset version requirement of <apar>	Returns all the fileset version requirements for the APAR that are not installed.	AIX:8.2

Properties

Declaration	Return type	Description	Platforms (?)
<fileset version requirement> as fileset version requirement	<fileset version requirement>	A self cast, used only for simplifying relevance.	AIX:8.2
<fileset version requirement> as string	<string>	Returns a string contain the LLP name and the version of a fileset separated by a space.	AIX:8.2
latest installed fileset of <fileset version requirement>	<fileset>	Returns the filesets that are installed with the same LPP name, regardless of version.	AIX:8.2
lpp_name of <fileset version requirement>	<string>	Returns a string with the LPP name of the fileset.	AIX:8.2
satisfying fileset of <fileset version requirement>	<fileset>	Returns the filesets that are installed with the same LPP name and a greater or equal version.	AIX:8.2
version record of <fileset version requirement>	<fileset version record>	Returns the version of the fileset requirement.	AIX:8.2

grub block list

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

grub bootable image

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

grub color pair

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

grub color scheme

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

grub color

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

grub config file

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

grub device

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

grub file location

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

grub image choice

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

grub kernel

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

grub module

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

smf fmri

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

smf instance

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

smf property group

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

smf property

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

smf service

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

smf snapshot part

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

smf snapshot

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

smf time

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

smf value

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

smf

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

apar

Creation Methods

Declaration	Description	Platforms (?)
apar <string> of <operating system>	Returns the APAR whose APAR number exactly matches the string.	AIX:8.2
apar of <operating system>	Returns all APARs.	AIX:8.2

Properties

Declaration	Return type	Description	Platforms (?)
<apar> as string	<string>	Returns a string containing the APAR number.	AIX:8.2
abstract of <apar>	<string>	Returns a string containing a short description of the APAR.	AIX:8.2
fileset version requirement <string> of <apar>	<fileset version requirement>	Returns the fileset version requirement for the APAR if a fileset with the LPP name that matches the string is a requirement for the APAR.	AIX:8.2
fileset version requirement of <apar>	<fileset version requirement>	Returns all the required filesets version requirements for the APAR.	AIX:8.2
installed satisfied fileset version requirement of <apar>	<fileset version requirement>	Returns all the fileset version requirements for the APAR that are installed and meet the version requirement.	AIX:8.2
installed unsatisfied fileset version requirement of <apar>	<fileset version requirement>	Returns all the fileset version requirements for the APAR that are installed but do not meet the version requirement.	AIX:8.2
name of <apar>	<string>	Returns a string containing the APAR number.	AIX:8.2
symptom of <apar>	<string>	Returns a string with the visible symptoms exhibited by the APAR. The string may be empty.	AIX:8.2
uninstalled fileset version requirement of <apar>	<fileset version requirement>	Returns all the fileset version requirements for the APAR that are not installed.	AIX:8.2

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

Declaration	Description	Platforms (?)
<bios>	Create the bios object	Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
<bios>	<bios>	Create the bios object	Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
<bios> as string	<string>	This Windows-only Inspector returns a string that is the concatenation of the BIOS name and date. On a non-Windows operating system, it returns FALSE.	Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
date of <bios>	<string> Plural: dates	This Windows-only Inspector returns the date string stored in the bios. This string is formatted as MM/DD/YY. On a non-Windows operating system, it returns FALSE.	Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
version of <bios>	<string> Plural: versions	This Windows-only Inspector returns the first string of the multi-string version stored in the bios. This string may not exist. The format depends upon your BIOS manufacturer. On a non-Windows operating system, it returns FALSE.	Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1

operating system

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

Creation Methods

Declaration	Description	Platforms (?)
operating system	Returns the operating system object. See operating system.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
<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
apar <string> of <operating system>	<apar> Plural: apars	Returns the APAR whose APAR number exactly matches the string.	AIX:8.2
apar of <operating system>	<apar> Plural: apars	Returns all APARs.	AIX:8.2
architecture of <operating system>	<string> Plural: architectures	Returns the architecture of the operating system. This is the value of the 'machine' element of the utsname structure obtained by calling uname.	Win:8.2, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
boot time of <operating system>	<time> Plural: boot times	Returns the time of the last restart.	Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
build of <operating system>	<string> Plural: builds	Returns a string corresponding to the build number of the OS.	Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
codename of <operating system>	<string> Plural: codenames	This *NIX Inspector returns a string that corresponds to the codename of the given release. For example, Ubuntu 8.04 has the codename of 'hardy'.	Lin:8.1, Sol:8.1, HPUX:8.1, AIX:8.1, Ubu:8.1
current service pack of <operating system>	<service pack> Plural: current service packs	Returns the current service pack, or no such object if none have been applied at the current technology level.	AIX:8.2
current technology level of <operating system>	<technology level> Plural: current technology levels	Returns the current technology level. This also includes the base level information, similar to 'oslevel -r'.	AIX:8.2
mac of <operating system>	<boolean> Plural: macs	Returns TRUE if the client computer is a Macintosh.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
machine of <operating system>	<string> Plural: machines	Returns the architecture of the machine.	Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.2
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
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 <string> of <operating system>	<service pack> Plural: service packs	Returns the service pack that matches the string in the format "base-tl-sp-date". For example, AIX 5.3 at technology level 6 and service pack 3, which was released on the 32nd week of 2007, would be "5300-06-03-0732". Note: older service packs may not have a date portion, and the final service pack at a particular technology level has a SP value of 'CSP'.	AIX:8.2
service pack of <operating system>	<service pack> Plural: service packs	Returns all service packs	AIX:8.2
technology level <string> of <operating system>	<technology level> Plural: technology levels	Returns the technology level that matches the string in the format "base-tl". For example, AIX 5.3 at technology level 6 is "5300-06".	AIX:8.2
technology level of <operating system>	<technology level> Plural: technology levels	Returns all technology levels.	AIX:8.2
unix of <operating system>	<boolean> Plural: unixes	Returns TRUE if the local computer is a UNIX system.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
uptime of <operating system>	<time interval> Plural: uptimes	Returns a time interval that represents the elapsed time since the operating system was last booted. Note: Depending on the notebook, this interval may not include time spent in hibernation.	Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
version of <operating system>	<version> Plural: versions	Returns the version of the operating system.	Win:8.0, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.0, Ubu:8.2
windows of <operating system>	<boolean> Plural: windowses	Returns TRUE if the local computer is a Windows system.	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

cpupackage

Creation Methods

Declaration	Description	Platforms (?)
cpupackage		Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2

Properties

Declaration	Return type	Description	Platforms (?)
core of <cpupackage>	<integer>	Returns the number of physical cores in a single cpupackage (a single socket or physical CPU)	Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
count of <cpupackage>	<integer>	Returns the count of physical cpu packages packages (the number of sockets or physical CPUs). Multiply this number by the number of cores to get the total core count of the system.	Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
smt capable of <cpupackage>	<boolean>	If detectable, returns true if the cpupackage is capable of SMT threads (Simultaneous multithreading, called "Hyper-Threading" on some platforms)	Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
smt enabled of <cpupackage>	<boolean>	If detectable, returns true if the cpupackage is using SMT threads (Simultaneous multithreading, called Hyper-Threading on some platforms)	Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
thread of <cpupackage>	<integer>	Returns the number of SMT threads (Simultaneous multithreading, called Hyper-Threading on some platforms) in a single cpupackage (a single socket or physical CPU)	Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2

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

Declaration	Description	Platforms (?)
main processor	Returns the processor object corresponding to the main processor.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
processor	Returns 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

Declaration	Return type	Description	Platforms (?)
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
family of <processor>	<string> 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.	Sol, AIX
id of <processor>	<integer> Plural: ids	Returns an integer corresponding to the ID of the specified processor.	Sol, AIX
index of <processor>	<integer> Plural: indexes	Returns the ordinal number of the processor on a multi processor machine.	Lin, Sol, HPUX, AIX, Ubu:8.1
model of <processor>	<string> Plural: models	Returns the model number of the CPU as a string.Note: On Windows and Linux platforms, this Inspector returns an integer.	Sol, HPUX, AIX
speed of <processor>	<hertz> Plural: speeds	Returns the speed of the processor in Hertz.	Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
type of <processor>	<string> Plural: types	Numeric type of the CPU. Values include: 0 - standard1 - overdrive2 - dual CPU capable3 - reservedNote: this Inspector returns an <integer> type as on Windows platforms.	Sol, AIX, Mac

ram

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

Creation Methods

Declaration	Description	Platforms (?)
ram	Returns 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 memory	Same as above.	Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
free amount of <ram>	<integer> Plural: free amounts	Returns the amount of system RAM currently unused, in bytes.	Lin, Sol, HPUX, AIX, Ubu:8.1
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
total amount of <ram>	<integer> Plural: total amounts	Same as size of <ram>.	Lin, Sol, HPUX, AIX, Ubu:8.1
used amount of <ram>	<integer> Plural: used amounts	Returns the amount of system RAM currently used, in bytes.	Lin, Sol, HPUX, AIX, 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

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

local mssql database

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

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

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

Declaration	Description	Platforms (?)
main gather service	Returns a service object for the main gathering service, typically located on the main server.Note: On a Macintosh, returns <nothing>. Included for compatibility.	Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
relay service	Returns a service object for the relay component of BES. Note: On a Macintosh, this returns <nothing>.	Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
running service <string>	Returns the running service object matching the name provided.	Win, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1
service <string>	Returns the service object matching the name provided, regardless of its running state.On a Macintosh, returns a <dummy> type.	Win, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
proxy agent service	service Plural: proxy agent services	Returns a service object of the BESProxyAgent if one is present	Ubu:9.0, Lin:9.0, HPUX:9.0, AIX:9.0, Sol:9.0, Win:9.0
<service> as string	<string>	Returns a string containing the Service name, Display name, and State of the service.	Win, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.2
running of <service>	<boolean> Plural: runnings		Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Ubu:8.2
state of <service>	<string> Plural: states	Returns one of Continuing, Pausing, Paused, Running, Starting, Stopping, Stopped, Unknown.	Win, Lin, Sol, HPUX, AIX, Ubu:8.1
version of <service>	<version> Plural: versions	This Inspector takes the specified service property and retrieves its version (file version).	Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Ubu:8.1

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

Declaration	Description	Platforms (?)
process	Returns all process objects currently running.	Win:8.0, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
process <integer>	Returns the process object corresponding to the given integer pid.	Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
process <string>	Returns the process object corresponding to the name specified by <string>.	Lin, Sol, HPUX, AIX, Ubu:8.1
process of <socket>	Returns a <process> representing the local owner of the socket	Ubu:9.0, Lin:9.0, Mac:9.0, HPUX:9.0, AIX:9.0, Win:9.0

Properties

Declaration	Return type	Description	Platforms (?)
effective user of <process>	<user> Plural: effective users	Returns the effective user of the process specified	Ubu:9.0, Lin:9.0, HPUX:9.0, AIX:9.0, Sol:9.0
ppid of <process>	<integer> Plural: ppids	Returns the PPID of the process specified	Ubu:9.0, Lin:9.0, HPUX:9.0, AIX:9.0, Sol:9.0
command line argument <integer> of <process>	<string> Plural: command line arguments	Returns the Nth command line argument of the specified process.	Lin:8.0, Sol:8.0, AIX:8.0, Ubu:8.1
command line argument of <process>	<string> Plural: command line arguments	Returns the command line arguments of the specified process.	Lin:8.0, Sol:8.0, AIX:8.0, Ubu:8.1
id of <process>	<integer> Plural: ids	Returns the integer ID of the specified process.	Win:8.0, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
name of <process>	<string> Plural: names	Returns the name (as a string) of the specified process.	Win:8.0, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
pid of <process>	<integer> Plural: pids	Returns the integer process ID for the specified process.	Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
process id of <process>	<integer> Plural: process ids	Returns the integer process ID for the specified process.	Lin, Sol, HPUX, AIX, Mac, Ubu:8.1

swap

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

Creation Methods

Declaration	Description	Platforms (?)
swap	Returns an object containing information about the swap partition.	Lin, HPUX, AIX, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
free amount of <swap>	<integer> Plural: free amounts	Returns the amount of the swap partition currently unused, in bytes.	Lin, HPUX, AIX, Ubu:8.1
size of <swap>	<integer> Plural: sizes	Returns the size, in bytes, of the swap partition.	Lin, HPUX, AIX, Ubu:8.1
total amount of <swap>	<integer> Plural: total amounts	Same as size of <swap>.	Lin, HPUX, AIX, Ubu:8.1
used amount of <swap>	<integer> Plural: used amounts	Returns the amount of the swap partition currently in use, in bytes.	Lin, HPUX, AIX, Ubu:8.1

language

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

Creation Methods

Declaration	Description	Platforms (?)
system locale	Determines 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 language	Determines the default language of menus and dialogs, messages and help files.	Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
<language> as string	<string>	Returns the language of the system locale.	Win, Lin, Sol, HPUX, AIX, WM, Ubu:8.1
platform id of <language>	<string> Plural: platform ids	Returns the string resulting from a call to setlocale(LC_TYPE, ""). This call examines the system environment and returns a string representing the language and character set for any text-related system function. The string is of the form "en_US.UTF-8".	Lin, Sol, HPUX, AIX, 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

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

Properties

Declaration	Return type	Description	Platforms (?)
<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

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

registryroot

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

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

registrynode

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

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

scsibus

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

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

scsidevice

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

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

sound volume

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

Creation Methods

Declaration

Description

Platforms (?)

Operators

Declaration

Return Type

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

stereo volume

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

Creation Methods

Declaration

Description

Platforms (?)

Operators

Declaration

Return Type

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

usb

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

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

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

Declaration	Description	Platforms (?)
runlevel	Returns the current runlevel of the local machine.	Lin, Sol, HPUX, AIX, Ubu:8.1

Properties

Declaration	Return type	Description	Platforms (?)
<runlevel> as string	<string>	Casts a runlevel object as a string.	Lin, Sol, HPUX, AIX, Ubu:8.1
effective time of <runlevel>	<time> Plural: effective times	Returns the time at which the runlevel was set to its current value.	Lin, Sol, HPUX, AIX, Ubu:8.1
value of <runlevel>	<string> Plural: values	Returns the current runlevel. It evaluates to a platform-dependent string indicating the current runlevel. For instance, on Linux the value '3' indicates runlevel 3 and 'S' indicates single user mode.	Lin, Sol, HPUX, AIX, Ubu:8.1

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

Declaration

Description

Platforms (?)

Operators

Declaration

Return Type

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

event log

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

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

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

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

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

Declaration

Description

Platforms (?)

Operators

Declaration

Return Type

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

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

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

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

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

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

Declaration

Description

Platforms (?)

Operators

Declaration

Return Type

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

uuid with multiplicity

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

Creation Methods

Declaration

Description

Platforms (?)

Properties

Declaration

Return type

Description

Platforms (?)

Terminology

Platform

Contents

System Objects

service pack with multiplicity

Creation Methods

Properties

service pack

Creation Methods

Properties

technology level with multiplicity

Creation Methods

Properties

technology level

Creation Methods

Properties

fileset version record with multiplicity

Creation Methods

Properties

fileset version record

Creation Methods

Properties

fileset version requirement

Creation Methods

Properties

grub block list

Creation Methods

Properties

grub bootable image

Creation Methods

Properties

grub color pair

Creation Methods

Properties

grub color scheme

Creation Methods

Properties

grub color

Creation Methods

Properties

grub config file

Creation Methods

Properties

grub device

Creation Methods

Properties

grub file location

Creation Methods

Properties

grub image choice

Creation Methods

Properties

grub kernel

Creation Methods

Properties

grub module

Creation Methods

Properties

smf fmri

Creation Methods

Properties

smf instance

Creation Methods

Properties

smf property group

Creation Methods

Properties

smf property

Creation Methods

Properties

smf service

Creation Methods

Properties

smf snapshot part

Creation Methods

Properties

smf snapshot

Creation Methods

Properties

smf time