 | IBM Endpoint Manager Inspectors Reference |
| IBM Endpoint Manager Inspectors Reference |
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.
These keywords query the properties of Fixlet sites to which the client is subscribed.
siteCreation Methods| Declaration | Description | Platforms (?) |
| current site | Returns the current site object. See site. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| site | Returns all the site objects that are currently loaded into memory. See site. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| site <string> | Returns a site object for the name provided. The name is the URL of the site location. See site. Example: exists site "actionsite" - TRUE when the action site exists on the target machine. Example: masthead path of site "BESSupport" - Typically returns a string such as: Macintosh HD:private:var:root:Library:Preferences:BigFix Enterprise:BES Support:__Local:Masthead. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| site of <fixlet> | Returns the site corresponding to the specified Fixlet message. | Win:8.1, Lin:8.1, Sol:8.1, HPUX:8.1, AIX:8.1, Mac:8.1, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| client folder of <site> | <folder> Plural: client folders | The folder containing the site content on the client machine. Site content is gathered into this location. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| evaluated of <site> | <boolean> Plural: evaluateds | Win:8.2, Lin:8.2, Sol:8.2, HPUX:8.2, AIX:8.2, Mac:8.2, Ubu:8.2 | |
| fixlet of <site> | <fixlet> Plural: fixlets | Iterates through the Fixlet messages of the specified site. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| gather schedule authority of <site> | <string> Plural: gather schedule authoritys | Returns a string corresponding to the authority of the site schedule, for example: Publisher, Custom, Manual or Disabled. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| gather schedule time interval of <site> | <time interval> Plural: gather schedule time intervals | Returns the time interval between automatic gathering of site content. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| group <integer> of <site> | <site group> Plural: groups | Returns an object corresponding to the numbered group of the specified site. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| last gather time of <site> | <time> Plural: last gather times | Returns the time of last successful gathering from the site. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| masthead of <site> | <file> Plural: mastheads | Each site has a masthead, and the masthead is saved into the site data folder upon successful creation. This property returns a file object that corresponds to the copy in the site data folder. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| name of <site> | <string> Plural: names | The name of the site. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| relevant fixlet of <site> | <fixlet> Plural: relevant fixlets | Iterates through the Relevant Fixlet messages for the specified site. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| relevant offer action of <site> | <action> Plural: relevant offer actions | 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 |
| setting <string> of <site> | <setting> Plural: settings | Returns the setting whose name matches the string provided from the Fixlet site settings. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| setting of <site> | <setting> Plural: settings | Returns one or more settings from the site settings. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| site tag of <site> | <string> Plural: site tags | Returns the last component of the specified site's url, eg. 'actionsite', 'enteprisesecurity', etcetera. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| site version list of <site> | <site version list> Plural: site version lists | Returns the last gathered site version list (manyversion) of the specified site. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| subscribe time of <site> | <time> Plural: subscribe times | Returns the time that the current machine began subscribing to the site. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| type of <site> | <string> Plural: types | Returns one of the following 4 literal strings:Master Action SiteOperator SiteCustom SiteFixlet Site. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| url of <site> | <string> Plural: urls | Returns the Locator found in the masthead. A site locator is used to synchronize with the site. It normally contains the URL of a remote file system folder, or the URL of a cgi-bin program that provides a remote directory listing of the site. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| version of <site> | <integer> Plural: versions | Returns the version number of the site content. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
site groupCreation Methods| Declaration | Description | Platforms (?) |
| group <integer> of <site> | Returns an object corresponding to the numbered group of the specified site. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| id of <site group> | <integer> Plural: ids | Returns the numeric ID of the specified site group. This is the number assigned to an automatic group when it is first defined. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| member of <site group> | <boolean> Plural: members | Returns TRUE if the current computer is a member of the specified group. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
site version listCreation Methods| Declaration | Description | Platforms (?) |
| <string> as site version list | Converts a string into a site version list. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| site version list <string> | Returns a textual representation of a site version list ("manyversion"). | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| site version list of <site> | Returns the last gathered site version list (manyversion) of the specified site. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| maximum of <site version list> | Returns the maximum value from a list of <site version list> types. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| minimum of <site version list> | Returns the minimum value from a list of <site version list> types. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Operators| Declaration | Return Type | Description | Platforms (?) |
| <site version list> {cmp} <site version list> | <boolean> | Compares two site version lists, component by component, where {cmp} is one of: <, <=, =. | Win, Lin, Sol, HPUX, AIX, Mac, WM |
Properties| Declaration | Return type | Description | Platforms (?) |
| <site version list> as string | <string> | Converts a site version list to a string. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| component <integer> of <site version list> | <integer> Plural: components | Returns the nth element (as specified by <integer>) of the given site version list. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| extrema of <site version list> | <( site version list, site version list )> Plural: extremas | Returns the minimum and maximum extreme values of the given list of <site version list> types. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| maximum of <site version list> | <site version list> Plural: maxima | Returns the maximum value from a list of <site version list> types. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| minimum of <site version list> | <site version list> Plural: minima | Returns the minimum value from a list of <site version list> types. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| unique value of <site version list> | <site version list with multiplicity> Plural: unique values | Returns the unique values of a given list of <site version list> types, removing duplicates and sorting by value. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
site version list with multiplicityCreation Methods| Declaration | Description | Platforms (?) |
| unique value of <site version list> | Returns the unique values of a given list of <site version list> types, removing duplicates and sorting by value. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| multiplicity of <site version list with multiplicity> | <integer> Plural: multiplicities | Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <site version list> types. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
bes siteCreation Methods| Declaration | Description | Platforms (?) |
| all bes site | This iterative Inspector returns a list of all external, master, operator, and custom sites. | Win |
| bes custom site | Returns a list of all custom sites. Deprecated as of version 7.0; instead use "all bes sites whose (custom site flag of it)". | Win |
| bes site | Returns a list of all the BES sites. | Win |
| current bes site | Returns the site that is the source of the current relevance evaluation. Items in a site that can evaluate relevance include Fixlet messages, Tasks, Baselines, Analyses, Wizards and Dashboards. | Win:8.0 |
| element of <bes site set> | Returns the elements of the specified set of BES sites. | Win:8.0 |
| subscribed site of <bes computer> | Returns a list of the BES sites subscribed to by the specified BES computer. | Win:8.0 |
| site of <bes computer group> | Returns the site corresponding to the specified BES Computer Group. | Win |
| custom site of <bes fixlet> | If the specified Fixlet message resides in a custom site, this Inspector returns the corresponding site object. | Win |
| site of <bes fixlet> | Returns the <bes site> object which contains the specified fixlet. | Win |
| action site of <bes user> | If the user is a master operator, this Inspector returns the Master Action site. Otherwise, it returns the operator site of the user. For example, "number of subscribed computers of action site of current console user". Example: number of subscribed computers of action site of current console user - Returns the number of computers currently subscribed to the specified user's Action site. | Win:8.0 |
| operator site of <bes user> | This Inspector returns the BES site object for the given (non-master) user. If the user is a Master Operator, this Inspector will throw NoSuchObject. | Win:8.0 |
| site of <bes wizard> | Returns the site hosting the specified BES Wizard. | Win |
| custom site of <bes domain> | Returns all the custom sites that have been created in the specified BES domain. | Win:8.0 |
Operators| Declaration | Return Type | Description | Platforms (?) |
| <bes site> = <bes site> | <boolean> | Returns TRUE if the two provided BES sites are equal. | Win:8.0 |
Properties| Declaration | Return type | Description | Platforms (?) |
| action of <bes site> | <bes action> Plural: actions | Win:8.2 | |
| action set of <bes site> | <bes action set> Plural: action sets | Win:8.2 | |
| creation date of <bes site> | <time> Plural: creation dates | Depending on the type of the BES site, this inspector returns the creation date:External and Master sites: Does not exist (added in version 7.0). Operator sites: The <moment> when the operator was created (added in version 7.0). Custom sites: The <moment> when the site was created. | Win |
| creator of <bes site> | <bes user> Plural: creators | Returns the <bes user> who created the specified custom site. Does not exist for External, Master or Operator sites. | Win |
| custom site flag of <bes site> | <boolean> Plural: custom site flags | Returns TRUE if and only if the specified site is a custom site. | Win |
| description of <bes site> | <string> Plural: descriptions | For a custom site, this is the description of the site that was specified by the creator. For External, Master or Operator sites, the description does not exist. | Win |
| display name of <bes site> | <string> Plural: display names | Beginning with version 7.1, a custom site can specify a display name that's different from the site name in the masthead. This inspector returns the display name; for the masthead name, use name of <bes site>. | Win |
| domain of <bes site> | <bes domain> Plural: domains | A domain is attached to a BES site when one is created. This Inspector returns the domain associated with the specified site. | Win:8.0 |
| domain set of <bes site> | <bes domain set> Plural: domain sets | Returns domains (as a set) related to the specified BES site. | Win:8.0 |
| explicit owner of <bes site> | <bes user> Plural: explicit owners | Returns a list of BES users that have been granted ownership of the specified site. Notice that the creator of this site is not included in the owner list.Note: This is a Console-only Inspector. | Win |
| explicit owner set of <bes site> | <bes user set> Plural: explicit owner sets | Returns the set of BES users who are owners (an iterated list) of the specified BES site. | Win |
| explicit reader of <bes site> | <bes user> Plural: explicit readers | Returns a list of BES users that have been granted reading privileges on the specified site. Notice that the creator, owners (unless explicitly added) and writers of this site are not included in this reader list.Note: This is a Console-only Inspector. | Win |
| explicit reader set of <bes site> | <bes user set> Plural: explicit reader sets | Returns the set of BES users who have read rights (the iterated list) on the specified BES custom site. | Win |
| explicit writer of <bes site> | <bes user> Plural: explicit writers | Returns a list of BES users that have been granted writing privileges on the specified site. Notice that the creator and owners (unless explicitly added) of this site are not included in this reader list.Note: This is a Console-only Inspector. | Win |
| explicit writer set of <bes site> | <bes user set> Plural: explicit writer sets | Returns the set of BES users who have write permissions (as an iterated list) on the specified BES site. | Win |
| external site flag of <bes site> | <boolean> Plural: external site flags | Returns TRUE if and only if the specified site is an external site. | Win |
| fixlet <integer> of <bes site> | <bes fixlet> Plural: fixlets | Returns the Fixlet with the specified ID from the given BES site. | Win |
| fixlet of <bes site> | <bes fixlet> Plural: fixlets | Returns a list all of the Fixlet objects in the given BES site. | Win |
| fixlet set of <bes site> | <bes fixlet set> Plural: fixlet sets | Returns the set of Fixlets that are associated with the specified BES Site. | Win |
| globally readable flag of <bes site> | <boolean> Plural: globally readable flags | The value of the globally readable flag depends on the type of site:External sites: True if and only if the site has been marked as readable by all users.Master sites: True.Operator sites: False. Custom sites: True if and only if the site has been marked as readable by all users. | Win |
| id of <bes site> | <integer> Plural: ids | Returns the numeric ID unique to the specified BES site. | Win |
| master site flag of <bes site> | <boolean> Plural: master site flags | Returns TRUE if and only if the specified site is a master site. | Win |
| name of <bes site> | <string> Plural: names | Returns the name of the specified BES site (undecorated). | Win |
| operator of <bes site> | <bes user> Plural: operators | Win:8.2 | |
| operator site flag of <bes site> | <boolean> Plural: operator site flags | Returns TRUE if and only if the specified site is an operator site. | Win |
| owner flag <bes user> of <bes site> | <boolean> Plural: owner flags | This Inspector is deprecated as of Version 7.0. Instead use "exists owner of <bes site> whose (it = <bes user>)". | Win |
| owner of <bes site> | <bes user> Plural: owners | Returns a list of BES users that have been granted ownership of the specified site. Notice that the creator of this site is not included in the owner list.Note: This is a Console-only Inspector. | Win |
| owner set of <bes site> | <bes user set> Plural: owner sets | Returns the set of BES users who are owners (an iterated list) of the specified BES site. | Win |
| reader of <bes site> | <bes user> Plural: readers | Returns a list of BES users that have been granted reading privileges on the specified site. Notice that the creator, owners (unless explicitly added) and writers of this site are not included in this reader list.Note: This is a Console-only Inspector. | Win |
| reader set of <bes site> | <bes user set> Plural: reader sets | Returns the set of BES users who have read rights (the iterated list) on the specified BES custom site. | Win |
| set of <bes site> | <bes site set> Plural: sets | Returns a set generated from the iterated list of BES Sites. This can be subjected to arithmetic set operations such as union and intersection. | Win:8.0 |
| site file of <bes site> | <bes site file> Plural: site files | Win:8.2 | |
| site file set of <bes site> | <bes site file set> Plural: site files sets | Win:8.2 | |
| site level relevance of <bes site> | <string> Plural: site level relevances | Win:8.2 | |
| subscribed <bes computer> of <bes site> | <boolean> Plural: subscribeds | Returns TRUE if the given computer is subscribed to the given BES site. | Win:8.0 |
| subscribed computer of <bes site> | <bes computer> Plural: subscribed computers | Returns the list of computers that are subscribed to the specified BES site. | Win |
| subscribed computer set of <bes site> | <bes computer set> Plural: subscribed computer sets | Returns the list of computers that are subscribed to the specified BES site. The list is formatted as a mathematical set for easier manipulation. | Win |
| subscription mode of <bes site> | <string> Plural: subscription modes | Returns the subscription mode for custom sites and external sites. The subscription mode is one of the following:All: all computers are subscribedNone: no computers are subscribedAdHoc: computers are subscribed via ad-hoc custom site subscription actionsCustom: computers are subscribed via a list of conditions. | Win:8.0 |
| tag of <bes site> | <string> Plural: tags | The site tag is used as an identifier for sites and is used to build the site's URL. | Win:8.0 |
| unique value of <bes site> | <bes site with multiplicity> Plural: unique values | Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <bes site> types. | Win:8.0 |
| url of <bes site> | <string> Plural: urls | Returns the gather URL for a given BES site. For example, the gather URL for BES Support is http://sync.bigfix.com/cgi-bin/bfgather/bessupport. | Win:8.0 |
| version of <bes site> | <integer> Plural: versions | Returns the version of an external site. Does not apply to custom sites. | Win:8.0 |
| wizard of <bes site> | <bes wizard> Plural: wizards | Returns the Wizards associated with the specified BES site. | Win:8.0 |
| wizard set of <bes site> | <bes wizard set> Plural: wizard sets | Returns the Wizards (as a set) associated with the specified BES site. | Win:8.0 |
| writer of <bes site> | <bes user> Plural: writers | Returns a list of BES users that have been granted writing privileges on the specified site. Notice that the creator and owners (unless explicitly added) of this site are not included in this reader list.Note: This is a Console-only Inspector. | Win |
| writer set of <bes site> | <bes user set> Plural: writer sets | Returns the set of BES users who have write permissions (as an iterated list) on the specified BES site. | Win |
bes site setCreation Methods| Declaration | Description | Platforms (?) |
| set of <bes site> | Returns a set generated from the iterated list of BES Sites. This can be subjected to arithmetic set operations such as union and intersection. | Win:8.0 |
| intersection of <bes site set> | Returns the intersection set derived from the specified set of BES Sites. | Win:8.0 |
| union of <bes site set> | Returns the union (as a set) derived from the specified set of BES Sites. | Win:8.0 |
| <bes site set> {op} <bes site set> | Operates on two sets of BES sites, where {op} is one of: -, *, + or 'contains'. Minus subtracts the elements of one set from the other, multiply performs an intersection, plus performs a union and 'contains' find subsets. | Win:8.0 |
| subscribed site set of <bes computer> | Returns a list of the BES sites subscribed to by the specified BES computer, organized as a set. | Win:8.0 |
| set of <bes site> | Returns a set generated from the iterated list of BES Sites. This can be subjected to arithmetic set operations such as union and intersection. | Win:8.0 |
| custom site set of <bes domain> | Returns all the custom sites (as a set) that have been created in the specified BES domain. | Win:8.0 |
Operators| Declaration | Return Type | Description | Platforms (?) |
| <bes site set> {op} <bes site set> | <bes site set> | Operates on two sets of BES sites, where {op} is one of: -, *, + or 'contains'. Minus subtracts the elements of one set from the other, multiply performs an intersection, plus performs a union and 'contains' find subsets. | Win:8.0 |
| <bes site set> = <bes site set> | <boolean> | Returns TRUE if the two provided BES site sets are equal. | Win:8.0 |
Properties| Declaration | Return type | Description | Platforms (?) |
| element of <bes site set> | <bes site> Plural: elements | Returns the elements of the specified set of BES sites. | Win:8.0 |
| intersection of <bes site set> | <bes site set> Plural: intersections | Returns the intersection set derived from the specified set of BES Sites. | Win:8.0 |
| size of <bes site set> | <integer> Plural: sizes | Returns the number of unique BES Sites in the specified set. | Win:8.0 |
| union of <bes site set> | <bes site set> Plural: unions | Returns the union (as a set) derived from the specified set of BES Sites. | Win:8.0 |
bes site with multiplicityCreation Methods| Declaration | Description | Platforms (?) |
| unique value of <bes site> | Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <bes site> types. | Win:8.0 |
| unique value of <bes site> | Sorts the list and returns the multiplicity, or count, of each unique element in the specified list of multiple <bes site> types. | Win:8.0 |
Properties| Declaration | Return type | Description | Platforms (?) |
| multiplicity of <bes site with multiplicity> | <integer> Plural: multiplicities | This unique values inspector returns the number of times each object occurrs in the original set of objects. | Win:8.0 |