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
Task Objects
User Objects
activity history
logged on user
user
user attribute
Windows Mobile Device Objects
WMI Objects
World Objects

IBM Endpoint Manager wiki

User Objects

These Inspectors return information about local and current user accounts, including names, logins, passwords and more.

user

The <user> Inspectors allow you to list properties of all users, whether they are logged in or not.

Creation Methods

DeclarationDescriptionPlatforms (?)
local userItererates of all cached Active Directory local users. This Inspector only works in the client context when caching is enabled.Win:8.1, Mac:8.1
userReturns objects for all users of the computer, logged in or not.Win:8.1, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
user <string>Returns the user specified by <string>.Win:8.1, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
user of <logged on user>Returns a user object from a 'logged on' user. This is for Active Directory expressions to bridge the gaps between user types. This retains the domain information of the logged on user within the user object where other user types might not.Win:8.1, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.1, Ubu:8.2

Properties

DeclarationReturn typeDescriptionPlatforms (?)
active directory user of <user><active directory local user>

Plural: active directory users
Returns an <active directory local user> object from the specified logged-on user object. This bridges the gaps between user types when using Active Directory Inspectors. It retains the domain information of the logged-on user within the user object where other user types might not.Win:8.1, Mac:8.1
attribute <string> of <user><user attribute>

Plural: attributes
Returns the specified named user attribute for the given user. These attributes are gathered from the LocalHost node of Apple's OpenDirectory system.Mac
attribute of <user><user attribute>

Plural: attributes
Returns a list of attributes for the given user, logged in or not. These attributes are gathered from the LocalHost node of Apple's OpenDirectory system.Mac
home directory of <user><folder>

Plural: home directories
On a Mac, this Inspector returns the dsAttrTypeStandard:NFSHomeDirectory attribute of the specified user as a folder. Note: On a Windows system, this inspector has a different interpretation: it returns the directory (as a string) where the user files are stored for the specified user.Mac
id of <user><string>

Plural: ids
Returns the dsAttrTypeStandard:UniqueID attribute of the specified user.Mac
name of <user><string>

Plural: names
Returns the name of all the specified user, whether logged in or not.Win:8.1, Lin, Sol, HPUX, AIX, Mac, Ubu:8.1
primary group id of <user><string>

Plural: primary group ids
On a Mac, this Inspector returns the dsAttrTypeStandard:PrimaryGroupID attribute for the specified user.Note: On a Windows computer, this Inspector returns the gid as an integer, not a string.Mac

logged on user

These Windows and Macintosh Inspectors return information about the currently logged-on user. With the advent of Terminal Services and Fast User Switching, these Inspectors are designed to iterate over all logged on users. Windows Note: If Terminal Services are available (NT/2000/2003/XP/Vista) and enabled, these Inspectors iterate over the active and disconnected sessions as returned by WTSEnumerateSessions. Disconnected sessions are those where a user logs on, but is currently inactive. On Vista, the non-interactive session 0 (used for services isolation) is not included. If Terminal Services aren't available, the ACLs on the security descriptor of the "winsta0" window station are examined for user logons. On Windows 9x systems, these Inspectors return the user session associated with the registry value "Current User" of "SYSTEM\CurrentControlSet\Control" if it exists. Otherwise, if a shell process process such as Explorer.exe is running, they return a single session associated with an unnamed user (which occurs when the user cancels the 9x login dialog).

Creation Methods

DeclarationDescriptionPlatforms (?)
current userReturns the active, console (local) user, if logged on. Otherwise does not exist.

Example:
name of current user = "bigfix" - Returns true if BigFix is the current user object.
Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1
logged on userReturns zero or more users logged on to this computer. This Inspector iterates through all logged-on users, using Fast User Switching, Terminal Services, ACLs, and on Win 9x, the registry.Win, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac, WM, Ubu:8.2

Properties

DeclarationReturn typeDescriptionPlatforms (?)
active of <logged on user><boolean>

Plural: actives
Returns TRUE if the specified user session is active (either as a current Fast User or an active terminal services connection).Win, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac, WM, Ubu:8.2
name of <logged on user><string>

Plural: names
If Terminal Services is available and enabled under NT4/2000/2003/XP/Vista, this Inspector returns the result of WTSQuerySessionInformation with WTSUserName. With Terminal Services disabled, it examines the ACLs on the security descriptor of the "winsta0" window station. Under Windows 9x, returns the "Current User" of "SYSTEM\CurrentControlSet\Control" if it exists. Otherwise returns No Such Object.Win, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, WM, Ubu:8.2
remote of <logged on user><boolean>

Plural: remotes
Returns TRUE if the user session is a remote terminal services connection.Win, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac, WM, Ubu:8.2
session id of <logged on user><integer>

Plural: session ids
Returns the id number of the session for the logged on usersWin:8.2, Mac:8.2
session id of <logged on user><string>

Plural: session ids
Returns the session id, which uniquely identifies a logged on user session. A logged-on user is a subclass of a user, and adding the session id uniquely identifies the session.Mac
tty of <logged on user><string>

Plural: ttys
Returns the name of the connection the user is on. Result is platform specific. Examples are: "Console", "RDP-Tcp#0", "pts/1", ":0"Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2
user of <logged on user><user>

Plural: users
Returns a user object from a 'logged on' user. This is for Active Directory expressions to bridge the gaps between user types. This retains the domain information of the logged on user within the user object where other user types might not.Win:8.1, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.1, Ubu:8.2

user attribute

These Macintosh Inspectors provide information, such as user ID and home directory, about the specified user.

Creation Methods

DeclarationDescriptionPlatforms (?)
attribute <string> of <user>Returns the specified named user attribute for the given user. These attributes are gathered from the LocalHost node of Apple's OpenDirectory system.Mac
attribute of <user>Returns a list of attributes for the given user, logged in or not. These attributes are gathered from the LocalHost node of Apple's OpenDirectory system.

Example:
attributes of user "fizzle" - Returns a list of attributes, such as: dsAttrTypeStandard:RecordName: fizzle, dsAttrTypeStandard:UniqueID: 501, dsAttrTypeStandard:NFSHomeDirectory: /Users/fizzle...
Mac

Properties

DeclarationReturn typeDescriptionPlatforms (?)
<user attribute> as string<string>Returns a list of user attributes. These can be inspected for value and key, but this Inspector concatenates them so the cast yields a string of the form "key: value". These attributes are gathered from the LocalHost node of Apple's OpenDirectory system (much like ActiveDirectory). For more information, see the Apple developer site.Mac
key of <user attribute><string>

Plural: keys
Returns the key names of the specified user attribute, as specified by the LocalHost node of Apple's OpenDirectory system.Mac
value of <user attribute><string>

Plural: values
Returns the value of the specified user attribute, as specified by the LocalHost node of Apple's OpenDirectory system.Mac

activity history

The <activity history> Inspectors keep track of the activity of a single logged-on user. You may iterate over all logged-on users and get the history for each user separately. User information is purged at log off and power off/client off, even if the user immediately logs back in. These Inspectors retrieve information within a tracking window (defaulting to 14 days) or, if the window is still open, the start of that window. Information is in the form of a list of (interval, state) tuples. The first element of the list is the current state of the system. The event lists are fetched from the client each time 'activity history' is referenced, so you should avoid referencing these Inspectors more than once in a relevance statement. Note: Activity tracking only works while the Client UI is running. These Inspectors only work with Windows 2000 or better.

Creation Methods

DeclarationDescriptionPlatforms (?)

Properties

DeclarationReturn typeDescriptionPlatforms (?)