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
action
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
Task Objects
User Objects
Windows Mobile Device Objects
WMI Objects
World Objects

IBM Endpoint Manager wiki

Action Objects

These are the keywords associated with properties that can be inspected while BigFix Actions are being executed.

action

The <action> objects are the keywords associated with properties available for inspection during the execution of BigFix Actions.

Creation Methods

DeclarationDescriptionPlatforms (?)
actionReturns the action currently being parsed.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
action <integer>Returns the action matching the <integer> id.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
active actionReturns the action currently executing.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
relevant offer action of <site>Returns the list of relevant actions that are offers for the specified site. This Inspector could be useful in a client UI dashboard listing the current set of relevant offers.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1

Properties

DeclarationReturn typeDescriptionPlatforms (?)
active of <action><boolean>

Plural: actives
Returns TRUE if the action is currently running (active).Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
active start time of <action><time>

Plural: active start times
Returns the time the action started.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
complete time of <action><time>

Plural: complete times
Returns the time the action completed.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
constrained of <action><boolean>

Plural: constraineds
Returns TRUE if action is unable to run yet.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
exit code of <action><integer>

Plural: exit codes
Returns an integer corresponding to the exit code of the specified action. This value will not exist if the action has not yet produced an exit code.Win:8.0, Lin:8.0, Sol:8.0, HPUX:8.0, AIX:8.0, Mac:8.0, Ubu:8.1
group leader of <action><boolean>

Plural: group leaders
Returns TRUE if the action is a group action and the action component is the group leader. When you deploy a mult-action from the BES Console, it constructs a group action with a group leader to control the overall behavior of the action. This inspector is used internally to manage the progress of the group action.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
id of <action><integer>

Plural: ids
Returns the numeric ID associated with the specified Action.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
last change time of <action><time>

Plural: last change times
Returns the time when the action state last changed.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
offer accepted of <action><boolean>

Plural: offer accepteds
Returns TRUE when users indicated they want to run the action by accepting the offer presented by the BES Client UI. When an offer has been accepted, the Client evaluates its constraints and runs as soon as conditions allow.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
offer of <action><boolean>

Plural: offers
Returns TRUE when the Action is presented as an offer (as indicated by the header "x-offer: 1").Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
origin fixlet id of <action><integer>

Plural: origin fixlet ids
Returns the Fixlet id that contained the action.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
parameter <string> of <action><string>

Plural: parameters
Returns the value of parameter <string> for the active Action. Parameters only live as long as the action is active. Among the inspectable parameters is the 'action issue date' that is added to each Action by the BigFix Console at issue time.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pending login of <action><boolean>

Plural: pending logins
Returns TRUE if the specified action included an 'action requires login' command, and a login has not yet occurred since the action has run.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pending of <action><boolean>

Plural: pendings
Returns TRUE if action is available to run.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pending restart of <action><boolean>

Plural: pending restarts
Returns TRUE if the specified action included an 'action requires restart' command and a restart has not occurred since the action has run.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
pending time of <action><time>

Plural: pending times
Returns the time the action became pending.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
status of <action><string>

Plural: statuss
Returns one of the following strings: Running = when the action is currently active. Executed = no longer relevant and action has completed. Not Relevant = action was not relevant. Waiting = action is relevant, but waiting to run. Not Executed = action is relevant, unconstrained, but has not yet started. Failed = action is relevant, unconstrained, has completed, but is still relevant.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
waiting for download of <action><boolean>

Plural: waiting for downloads
Returns TRUE if client is waiting for mirroring server to have downloads required by the action.Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1