Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
1727 lines (936 sloc) 55.7 KB

type: string

Strings are typically core objects, but some string inspectors may be client-specific. Note: A string literal is written within double quotes. Special characters must be inserted by using the percent sign followed by 2 hex digits. Special characters include those characters with ASCII codes less than the 'space' character (hex 20) or greater than 'tilde' character (hex 7f) as well as the percent character itself (25 hex). For example, to create a string containing a null character and a percent character use "a null is %00, the percent itself is %25". Conversion to upper and lower case is also provided. String works in combination with the string position and substring data types. A string position is a point within a string. It can be compared to an integer, but it also acts as a pointer within a string so that the preceding and following text can be extracted. A substring is a part of a larger string. All operations allowed on a string can be performed on a substring. There are two substrings "be" in the string "To be or not to be". The substrings only differ in their positions within the string.

abbr <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in an <abbr> tag modified by the first given string.

{% qna %} Q: abbr "title=%22BigFix%22" of "bf" A: <abbr title="BigFix">bf</abbr> I: singular html {% endqna %}

abbr of <string> : html

Returns an HTML snippet containing the specified string enclosed in an <abbr> tag.

account with privilege <string> : security account

Returns a security account constant corresponding to an account with the privilege specified in the string.

acronym <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in an <acronym> tag modified by the first given string.

acronym of <string> : html

Returns an HTML snippet containing the specified string enclosed in an <acronym> tag.

active device file <string> : file

Under Windows NT, returns a file object corresponding to the name provided. See file.

address <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in an <address> tag modified by the first given string.

address of <string> : html

Returns an HTML snippet containing the specified string enclosed in an <address> tag.

anchor <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in an <a> tag modified by the first given string.

anchor of <string> : html

Returns an HTML snippet containing the specified string enclosed in an <a> tag.

application <string> : application

Returns the named applications (bundles) and executables as filesystem objects.

application <string> : filesystem object

This Inspector was replaced by another Inspector returning an application type.

application usage <string> : timed( time range, integer )

No documentation exists.

application usage summary <string> : application usage summary

Returns the usage summary for the application specified in <string>.

b <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <b> tag modified by the first given string.

b of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <b> tag.

base <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <base> tag modified by the first given string.

base of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <base> tag.

base64 decode <string> : string

Decode the string from Base64.

{% qna %} Q: base64 decode "SGVsbG8sIHdvcmxkIQ==" A: Hello, world! I: singular string {% endqna %}

base64 encode <string> : string

Encode the string into Base64.

{% qna %} Q: base64 encode "Hello, world!" A: SGVsbG8sIHdvcmxkIQ== I: singular string {% endqna %}

bes deployment option <string> : bes deployment option

Returns the value associated with the deployment option named by the <string>.

bes domain <string> : bes domain

Returns the first BES Domain whose title matches the specified name.

bes property <string> : bes property

Returns the first property whose name matches the given string. Note that it is not safe to assume that there is only one property with a given name.

big <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <big> tag modified by the first given string.

big of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <big> tag.

binary operator <string> : binary operator

Returns the various possible binary inspectors that use the specified operators.

{% qna %} Q: binary operators "starts with" A: starts with : boolean A: starts with : boolean {% endqna %}

binary_string <string> : binary_string

No documentation exists.

bit set <string> : bit set

Returns the bits of the binary number given by the string.

{% qna %} Q: bit set "1010" A: 1010 I: singular bit set {% endqna %}

blockquote <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <blockquote> tag modified by the first given string.

blockquote of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <blockquote> tag.

body <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <body> tag modified by the first given string.

body of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <body> tag.

boolean <string> : boolean

Returns a boolean. For example, boolean "TRUE".

br <string> : html

Creates an HTML <br/> tag with an included modifier, such as class.

bundle <string> : bundle

Returns a bundle (CFBundle) by name.

capability <string> : capability

Converts a string to a capability object for rpm dependency version comparisons. Strings with version information take the form capability relation version, where relation is one of {<,>,>=,<=,=}. If a relation and version are not specified, then comparisons will assume a capability at any version number.

caption <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <caption> tag modified by the first given string.

caption of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <caption> tag.

case insensitive regex <string> : regular expression

Returns a case-insensitive regular expression from the supplied string.

case insensitive regular expression <string> : regular expression

Same as case insensitive regex <string>.

cast <string> : cast

Returns a list of the objects that can be cast into the type specified by <string>.

catalog <string> : message_catalog

Returns the named catalog.

character <integer> of <string> : substring

Returns a string of length 1 made by taking the character identified by <integer> from the string. Numbering begins at zero.

{% qna %} Q: character 1 of "hello" A: e I: singular substring {% endqna %}

character of <string> : substring

Returns the characters from the string.

{% qna %} Q: characters of "hello" A: h A: e A: l A: l A: o I: plural substring {% endqna %}

cite <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <cite> (citation) tag modified by the first given string.

cite of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <cite> (citation) tag.

code <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <code> (fixed-width font) tag modified by the first given string.

code of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <code> (fixed-width font) tag.

col <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <col> (column) tag modified by the first given string.

col of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <col> (column) tag.

colgroup <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <colgroup> (column group) tag modified by the first given string.

colgroup of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <colgroup> (column group) tag.

concatenation <html> of <string> : html

This inspector concatenates the string items in the second argument with a separator defined by the first argument.

concatenation <string> of <string> : string

This inspector concatenates the string items in the second argument with a separator defined by the string argument.

{% qna %} Q: concatenation ", " of ("foo"; "bar"; "baz") A: foo, bar, baz I: singular string {% endqna %}

concatenation of <string> : string

Combines the supplied strings into a single string, end-to-end.

{% qna %} Q: concatenation of ("foo"; "bar"; "baz") A: foobarbaz I: singular string {% endqna %}

control panel <string> : enableable_file

No documentation exists.

country <string> : country

Maps a country script string (for example verAfrikaans) to its region code.

custom site subscription effective date <string> : time

Returns the date the custom site (specified by <string>) was last subscribed or unsubscribed. It is used internally by BES to manage custom site subscriptions.

date <string> : date

Converts the given string into a date. The string should be of the form 'Day Month Year' and the returned date will be of the form 'Day of week, Day Month Year'.

{% qna %} Q: date "11 Mar 1984" A: Sun, 11 Mar 1984 I: singular date {% endqna %}

day_of_month <string> : day of month

Converts the given string value (must be an integer from 1-31) to a day of month type.

day_of_week <string> : day of week

Converts the given string value to a day of week type, eg. Monday, Tuesday, etcetera.

dd <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <dd> (definition) tag modified by the first given string.

dd of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <dd> (definition) tag.

debian package version <string> : debian package version

Returns a Debian package version object from the given string.

debian package version epoch <string> : debian package version epoch

Returns a Debian package version 'epoch' object from the given string.

debian package version revision <string> : debian package version revision

Returns a Debian package version revision object from the given string.

debian package version upstream <string> : debian package upstream version

Returns a Debian package upstream_version object from the supplied string.

definition list <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <dl> (definition) tag modified by the first given string.

definition list of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <dl> (definition) tag.

del <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <del> tag modified by the first given string.

del of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <del> tag.

device file <string> : device file

Returns the device file with the specified name.

dfn <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <dfn> (definition) tag modified by the first given string.

dfn of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <dfn> (definition) tag.

disabled control panel <string> : enableable_file

No documentation exists.

disabled extension <string> : enableable_file

No documentation exists.

disabled shutdown item <string> : enableable_file

No documentation exists.

disabled startup item <string> : enableable_file

No documentation exists.

distinguished name <string> : distinguished name

Interprets a distinguished name in the textual format described by RFC 2253 and used by LDAP/Active Directory.

{% qna %} Q: distinguished name "CN=bearmo,OU=bears,DC=example,DC=com" A: CN=bearmo,OU=bears,DC=example,DC=com {% endqna %}

div <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <div> (division or section) tag modified by the first given string.

div of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <div> (division or section) tag.

domain user <string> : local user

Returns the user object corresponding to the specified name.

Since version 8.1.535.0, "domain user <string>" returns <{{'user' | linkType}}> type. See domain user <string> : user.

domain user <string> : user

No documentation exists.

download file <string> : file

This inspector is available in relevance subsitution action processing. It returns a file object with the given name from the client's download folder.

This is equivalent to:

file "name" of download folder

download path <string> : string

This inspector is available in relevance subsitution action processing. It returns a string corresponding to the download path of the specified file. This inspector, along with download folder and download file, is designed to be used during the prefetch process of action execution.

This is equivalent to something like:

(pathname of download folder) & "\myfile".

drive <string> : drive

No documentation exists.

drive <string> : filesystem

Returns the volume corresponding to the named drive.

drive <string> : volume

No documentation exists.

dt <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <dt> (definition) tag modified by the first given string.

dt of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <dt> (definition) tag.

em <string> of <string> : html

Emphasize the specified string inside an <em string></em> tag.

em of <string> : html

Emphasize the specified string inside an <em></em> tag.

enabled control panel <string> : enableable_file

No documentation exists.

enabled extension <string> : enableable_file

No documentation exists.

enabled shutdown item <string> : enableable_file

No documentation exists.

enabled startup item <string> : enableable_file

No documentation exists.

encoding <string> : encoding

Returns an encoding object corresponding to the name provided in string. The name should be a name of encoding defined by the International Components for Unicode (ICU). An encoding object can be used with a file object to read it in the specified encoding.

error <string> : undefined

This expression allows you to output your own user-defined error message, typically in the 'else' clause of an 'if/then/else' statement.

{% qna %} Q: error "hodor!" E: User-defined error: hodor! {% endqna %}

escape of <string> : string

Returns a string containing a \ for every \ character found. Useful for setting registry key values to strings in regset action commands.

event log <string> : event log

Returns the named event log, which contains historical information that help to track down system and security problems. There are several distinct logs that you can specify, including:Application log: records application eventsSecurity log: recirds global or local policy audit eventsSystem log: records OS events.

execution <string> : execution

No documentation exists.

expand environment string of <string> : string

Uses the Windows ExpandEnvironmentStrings API to translate a string containing special Windows environment variables.

{% qna %} Q: expand environment string of "%25windir%25\my.dll" A: C:\Windows\my.dll I: singular string {% endqna %}

expand x32 environment string of <string> : string

Uses the Windows ExpandEnvironmentStrings API to translate a string containing special Windows environment variables.

{% qna %} Q: expand x32 environment string of "%25windir%25\my.dll" A: C:\Windows\my.dll I: singular string {% endqna %}

expand x64 environment string of <string> : string

Given an environment string such as %ProgramFiles%, this inspector expands it to 'C:\Program Files (x86)'. Although similar to 'expand environment string of <string>', this inspector works on 64-bit Windows systems only. On a 32-bit system, it returns 'No Such Object'.

extension <string> : enableable_file

No documentation exists.

fifo file <string> : fifo file

Returns the FIFO file (named pipe) with the given name.

file <string> : file

Returns a filesystem object corresponding to the full pathname provided in <string>.

file signature <string> : file signature

Turn a string into a file signature (four letters, for example FNDR).

file type <string> : file type

The phrase 'file type' can be used to create a file type object from a string.

fileset version record <string> : fileset version record

Returns a fileset version record specified by the string in the format "ver.rel.mod.fix".

fileset version requirement <string> : fileset version requirement

Returns a fileset version requirement specified by the string in the format "lpp_name ver.rel.mod.fix".

filesystem <string> : filesystem

Returns the filesystem corresponding to the specified name. On a Macintosh, this inspector returns a <volume> object.

filesystem <string> : volume

No documentation exists.

first <integer> of <string> : substring

Returns a substring containing the number of characters specified from the given string.

{% qna %} Q: first 5 of "To be or not to be" A: To be {% endqna %}

first <string> of <string> : substring

Returns a substring containing the first occurrence of the name provided.

{% qna %} Q: preceding text of first "." of "access.log.1" A: access {% endqna %}

first match <regular expression> of <string> : regular expression match

Creates an object containing the first match to the regular expression in the given string

floating point <string> : floating point

Creates a floating point number from the provided string.

folder <string> : folder

Returns a folder object for the name provided. See drive.

format <string> : format

Returns the specified string into a format type which can be used to print formatted variables.

framework <string> : folder

No documentation exists.

full wmi <string> : wmi

Returns a wmi object which can retrieve all values, including system values.

fxf encoding concatenation <string> of <string> : string

Returns the same output as concatenation <string> of <string> : string, but input values are filtered to the current fxf encoding.

fxf encoding concatenation of <string> : string

Returns the same output as concatenation of <string> : string, but input values are filtered to the current fxf encoding.

gestalt <string> : integer

This reads a 32 bit integer from the MacOS. The selector name is the four character OSType that chooses which item is being inspected. The interpretation of the result depends on the selector. It might represent an integer or a version, for instance.

grub config file <string> : grub config file

Returns the grub config file at the path specified by the string.

h1 <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in an <h1> (header) tag modified by the first given string.

h1 of <string> : html

Returns an HTML snippet containing the specified string enclosed in an <h1> (header) tag.

h2 <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in an <h2> (header) tag modified by the first given string.

h2 of <string> : html

Returns an HTML snippet containing the specified string enclosed in an <h2> (header) tag.

h3 <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in an <h3> (header) tag modified by the first given string.

h3 of <string> : html

Returns an HTML snippet containing the specified string enclosed in an <h3> (header) tag.

h4 <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in an <h4> (header) tag modified by the first given string.

h4 of <string> : html

Returns an HTML snippet containing the specified string enclosed in an <h4> (header) tag.

h5 <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in an <h5> (header) tag modified by the first given string.

h5 of <string> : html

Returns an HTML snippet containing the specified string enclosed in an <h5> (header) tag.

h6 <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in an <h6> (header) tag modified by the first given string.

h6 of <string> : html

Returns an HTML snippet containing the specified string enclosed in an <h6> (header) tag.

head <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <head> tag modified by the first given string.

head of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <head> tag.

hexadecimal integer <string> : integer

Creates an integer from the provided hexadecimal value.

hexadecimal string <string> : string

Creates a string from the given hexadecimal value.

hfs file <string> : file

Returns the hierachical file system (HFS) file specified by <string>.

hfs folder <string> : folder

Returns the hierachical file system (HFS) folder specified by <string>.

hfs item <string> : filesystem object

Returns a filesystem object with the specified item name. The Macintosh has two different path types it can output. HFS (Hierarchical File System) was an OS9 format where the path separator was ':' and there were multiple roots (each volume). POSIX has superseded HFS and is single rooted with '/' as a separator. All of the Macintosh inspectors that are not otherwise specified default to the POSIX version.

hr <string> : html

Creates a horizontal line tag with an option specfied by the string <hr string/>.

html <string> : html

Embeds the specified string between <html></html> tags.

html <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <html> tag modified by the first given string.

html of <string> : html

Returns an HTML snippet containing the specified string enclosed in an <html> tag.

html tag <string> of <string> : html

Returns an HTML snippet with the second string enclosed in a tag specified by the first string.

ins <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <ins> (insert) tag modified by the first given string.

ins of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <ins> (insert) tag.

integer <string> : integer

Returns integer for name provided.

ips repo <string> : ips repo

No documentation exists.

ipv4 address <string> : ipv4 address

Returns an ipv4 address for the string provided.

ipv4or6 address <string> : ipv4or6 address

Returns an ipv4or6 address object as described by the given string.

ipv6 address <string> : ipv6 address

Converts a string representations of an IPv6 address (with colons and/or dots) into an IPv6 address type.

italic <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <i> tag modified by the first given string.

italic of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <i> tag.

item <string> : filesystem object

Returns a filesystem object with the given name, either a file or a folder.

javascript array <string> of <string> : html

No documentation exists.

json of <string> : json value

Returns a JSON object for the string.

{% qna %} Q: json of "[1, 2, 3]" A: [1,2,3] {% endqna %}

kbd <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <kbd> (keyboard entry) tag modified by the first given string.

kbd of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <kbd> (keyboard entry) tag.

last <integer> of <string> : substring

Returns a substring containing the number of characters specified.

{% qna %} Q: last 5 of "Hello Kitty" A: Kitty {% endqna %}

last <string> of <string> : substring

{% qna %} Q: following text of last "." of "hello.exe" A: exe {% endqna %}

length of <string> : integer

Returns the number of characters in the string.

li <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <li> (list) tag modified by the first given string.

li of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <li> (list) tag.

link <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <link> tag modified by the first given string.

link of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <link> tag.

local encoding concatenation <string> of <string> : string

Returns the same output as concatenation <string> of <string> : string, but the input values are filtered to the current local encoding.

local encoding concatenation of <string> : string

Returns the same output as concatenation of <string> : string, but the input values are filtered to the current local encoding.

local group <string> : local group

Returns a local group corresponding to the given name, such as Adminstrator, Guests, and others. For backward compatibility, the 'as string' cast of this inspector only returns the user name, not the other components of the sid. For all parts, use 'component string' instead.

local mssql database <string> : local mssql database

Returns the local Microsoft SQL (MSSQL) database object identified by the name provided.

local time <string> : time

Returns a time object for the name provided. See time.

local user <string> : local user

Returns the Active Directory local user object for the specified local user. This allows inspection of AD properties for that user, whether cached or currently logged in.

Since version 8.1.535.0, "local user <string>" returns <{{'user' | linkType}}> type. See local user <string> : user.

local user <string> : user

Returns the local user object specified by the name <string>.

On Unix/Linux platform with Bigfix client version below 9.5, this returns only logged-on users. Since 9.5, this returns all local users, logged in or not.

match <regular expression> of <string> : regular expression match

Creates an object containing all the matches to the regular expression in the given string.

md5 of <string> : string

Returns the md5 of the string. This inspector is not available in FIPS mode.

{% qna %} Q: md5 of "bigfix" A: 19ef736567bdec67fdca33c30f6e280f {% endqna %}

meta <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <meta> tag modified by the first given string.

meta of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <meta> tag.

module <string> : module

For BigFix internal use only.

month <string> : month

Returns a month type corresponding to the given <string>.

native application <string> : application

No documentation exists.

native file <string> : file

No documentation exists.

native folder <string> : folder

No documentation exists.

network option <string> : network_option

Returns the network parameter object corresponding to the specified string.

network share <string> : network share

Creates a named network shared object.

numeric value of <string> : integer

Returns an integer for the first numeric value in the string.Example: numeric value of "string 123 xyz 45" = 123 - Returns True.

ol <string> of <string> : html

Creates an ordered list out of <string2> with an optional style specified by <string1>.

ol of <string> : html

Creates an ordered list out of the <string>.

ordered list <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in an <ol><li> tag, where the <ol> tag is modified by the first given string.

ordered list of <string> : html

Returns an HTML snippet containing the specified string enclosed in an <ol><li> tag.

p <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in an <p> tag modified by the first given string.

p of <string> : html

Returns an HTML snippet containing the specified string enclosed in an <p> tag.

palm device <string> : palm device

No documentation exists.

parameter <string> : string

This inspector is a synonym for the parameter <string> of <action>. It looks up the value of the action parameter specified by <string>. This is used in conjunction with the parameter set command.

pending restart <string> : boolean

Immediately after running an action requires restart command like:

action requires restart "PatchGroupX"

The following expression will be true until the next restart:

pending restart "PatchGroupX"

percent decode <string> : string

No documentation exists.

percent encode <string> : string

No documentation exists.

position <integer> of <string> : string position

Returns a string position pointing to the character position specified. The first character is at position 0.

position of <string> : string position

Returns the positions of the string.

posix file <string> : file

Returns the POSIX file specified by <string>.

posix folder <string> : folder

Returns the POSIX folder specified by <string>.

posix item <string> : filesystem object

Returns a filesystem object with the given name, either a file or a folder, using POSIX formatting.

pre <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in an <pre> (preformatted) tag modified by the first given string.

pre of <string> : html

Returns an HTML snippet containing the specified string enclosed in an <pre> (preformatted) tag.

preference <string> : preference

The named set of preferences.

process <string> : process

Returns the process object corresponding to the specified name.

{% qna %} Q: pid of process "node" A: 1 {% endqna %}

property <string> : property

Typically used in the plural, returns the "line" inspector properties.

q <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <q> (quotation) tag modified by the first given string.

q of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <q> (quotation) tag.

recent application <string> : application

Returns an application for the name provided it has recently executed. The name is assumed to be the last part of an executable file name.

regapp <string> : application

Returns an application object for the name provided. See application and regapp.

regex <string> : regular expression

Creates a regex object from the given string.

regex escape of <string> : string

Creates a new string that escapes the special characters .[]{}()*+?|^$,-.

regular expression <string> : regular expression

Same as regex <string>.

rope <string> : rope

Creates a rope object from the given string.

rpm <string> : rpmdatabase

Returns an object corresponding to the database named by <string>.

rpm package release <string> : rpm package release

Returns the named RPM package release.

rpm package version <string> : rpm package version

Returns the named RPM package version.

rpm package version record <string> : rpm package version record

Returns the named RPM package version record.

running application <string> : application

Returns an application for the name provided it is currently executing. The name is assumed to be the last part of an executable file name.

running service <string> : service

Returns the running service object matching the name provided.

samp <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <samp> (sample) tag modified by the first given string.

samp of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <samp> (sample) tag.

scheduled task <string> : scheduled task

Returns a scheduled task with the specified name. It attempts to use the 2.0 interface if available, otherwise it uses the 1.0 interface. This method only looks in the root folder for 2.0 tasks, whch include hidden tasks.

security account <string> : security account

This is a named inspector that uses the LookupAccountName API function to return an object representing a user or group.

security descriptor <string> : security descriptor

No documentation exists.

selinux boolean <string> : SELinux Boolean

Returns the SELinux Boolean matching the name provided.

service <string> : dummy

No documentation exists.

service <string> : service

Returns the service object matching the name provided, regardless of its running state.On a Macintosh, returns a <dummy> type.

set of <string> : string set

Creates a set from the given list of semicolon-separated strings.

sha1 of <string> : string

Returns the sha1 of the string.

{% qna %} Q: sha1 of "bigfix" A: 43af5f9db6b65e1bc3dd7048808d1fce1038ffbc {% endqna %}

sha224 of <string> : string

Returns the sha2-224 of the string.

{% qna %} Q: sha224 of "bigfix" A: b6396d1e9b44898da4d9823b5230ea462b4112c88b4a8dbfe66c6fe9 {% endqna %}

sha256 of <string> : string

Returns the sha2-256 of the string.

{% qna %} Q: sha256 of "bigfix" A: d71451abd87cc3fe47d90616fc7498f89d41bbf7e760d50897950d6b59a65b5b {% endqna %}

sha2_224 of <string> : string

Returns the sha2-224 of the string.

{% qna %} Q: sha2_224 of "bigfix" A: b6396d1e9b44898da4d9823b5230ea462b4112c88b4a8dbfe66c6fe9 {% endqna %}

sha2_256 of <string> : string

Returns the sha2-256 of the string.

{% qna %} Q: sha2_256 of "bigfix" A: d71451abd87cc3fe47d90616fc7498f89d41bbf7e760d50897950d6b59a65b5b {% endqna %}

sha2_384 of <string> : string

Returns the sha2-384 of the string.

{% qna %} Q: sha2_384 of "bigfix" A: 073f25784413df63213f501404737ddb37c9d796d4e43c5d0877dd190b2d5da0761fc28d91e799b12748fe6b1320f869 {% endqna %}

sha2_512 of <string> : string

Returns the sha2-512 of the string.

{% qna %} Q: sha2_512 of "bigfix" A: 2d142f89401703e3227bd27d77f6e24dabac79e50dd4b4388e8d2d712e68c2b307a1661d647b24538f796428696e7a8a6c5a051a6b4c50a605c61001ff29c96d {% endqna %}

sha384 of <string> : string

Returns the sha2-384 of the string.

{% qna %} Q: sha2_384 of "bigfix" A: 073f25784413df63213f501404737ddb37c9d796d4e43c5d0877dd190b2d5da0761fc28d91e799b12748fe6b1320f869 {% endqna %}

sha512 of <string> : string

Returns the sha2-512 of the string.

{% qna %} Q: sha512 of "bigfix" A: 2d142f89401703e3227bd27d77f6e24dabac79e50dd4b4388e8d2d712e68c2b307a1661d647b24538f796428696e7a8a6c5a051a6b4c50a605c61001ff29c96d {% endqna %}

shutdown item <string> : enableable_file

No documentation exists.

sid <string> : security identifier

No documentation exists.

site <string> : site

Returns a site object for the name provided. The name is the URL of the site location. See site.

site version list <string> : site version list

Returns a textual representation of a site version list ("manyversion").

small <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <small> tag modified by the first given string.

small of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <small> tag.

socket file <string> : socket file

Returns the named socket file.

span <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <span> tag modified by the first given string.

span of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <span> tag.

stage <string> : stage

No documentation exists.

startup item <string> : enableable_file

No documentation exists.

string <string> : string

Returns a string for the name provided. The keyword string is optional. For example, string "hi" = "hi".

strong <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <strong> tag modified by the first given string.

strong of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <strong> tag.

strverscmp version <string> : strverscmp version

Creates a strverscmp version, which is compared to other versions using the OS supplied strverscmp function.

sub <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <sub> (subscript) tag modified by the first given string.

sub of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <sub> (subscript) tag.

substring <( integer, integer )> of <string> : substring

Returns a substring of the specified string as defined by the start and length. The first integer is the start and the second integer is the length.

{% qna %} Q: substring (2, 2) of "abcdef" A: cd {% endqna %}

{% qna %} Q: substrings (integers in (0, length of it, 2), 2) of "abcdef" A: ab A: cd A: ef {% endqna %}

substring <string> of <string> : substring

Iterates through the string returning all the substrings matching the name given.

{% qna %} Q: number of substrings "be" of "to be or not to be" A: 2 {% endqna %}

{% qna %} Q: preceding texts of substrings "be" of "to be or not to be" A: to A: to be or not to {% endqna %}

substring after <string> of <string> : substring

Returns the substrings that come after the first string delimiter.

{% qna %} Q: substring after "=" of "name=value" A: value {% endqna %}

substring before <string> of <string> : substring

Returns the substrings that come before the first string delimiter.

{% qna %} Q: substring before "=" of "name=value" A: name {% endqna %}

substring between <string> of <string> : substring

Returns the substring in the second string found between two instances of the first string.

{% qna %} Q: substrings between "." of "abc.def.hij.klm" A: def A: hij {% endqna %}

substring separated by <string> of <string> : substring

Returns a substring (or set of substrings) delimited by the first string.

{% qna %} Q: substrings separated by "," of "1,2,3" A: 1 A: 2 A: 3 {% endqna %}

sup <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <sup> (superscript) tag modified by the first given string.

sup of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <sup> (superscript) tag.

symlink <string> : symlink

Returns a symlink from the specified string.

system file <string> : file

Returns a file object corresponding to the relative pathname provided.

system ini device file <string> : file

Returns a file object corresponding to a device file loaded as a result of a device= line of the system.ini file.

system x32 file <string> : file

No documentation exists.

system x64 file <string> : file

No documentation exists.

table <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <table> tag modified by the first given string.

table of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <table> tag.

task folder <string> : task folder

Gets the task folder with the given string name.

tbody <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <tbody> tag modified by the first given string.

tbody of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <tbody> tag.

td <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <td> (table cell) tag modified by the first given string.

td of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <td> (table cell) tag.

tfoot <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <tfoot> (table foot) tag modified by the first given string.

tfoot of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <tfoot> (table foot) tag.

th <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <th> (table header) tag modified by the first given string.

th of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <th> (table header) tag.

thead <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <thead> (table header) tag modified by the first given string.

thead of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <thead> (table header) tag.

time <string> : time

Returns a time object for the name provided. See time.

time interval <string> : time interval

Creates a time interval from the string.

time zone <string> : time zone

Returns a time zone object for the name provided.

time_of_day <string> : time of day

Creates a time of day object out of the given string.

title <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <title> tag modified by the first given string.

title of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <title> tag.

tr <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <tr> (table row) tag modified by the first given string.

tr of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <tr> (table row) tag.

tt <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <tt> (teletype font) tag modified by the first given string.

tt of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <tt> (teletype font) tag.

tuple item of <string> : tuple item

No documentation exists.

tuple string item <integer> of <string> : string

Parses the given string as if it were a tuple result string and returns the string which is the nth item of the tuple. The tuple inspectors used to be session-only, but as of version 8.0, they are core inspectors, available to all platforms at all times.

tuple string item of <string> : string

Parses the given string as if it were a tuple result string and iterates over the <string> objects that make up the tuple. The tuple inspectors used to be session-only, but as of version 8.0, they are core inspectors, available to all platforms at all times.

tuple string of <string> : string

No documentation exists.

type <string> : type

No documentation exists.

ul <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <ul> (unordered list) tag modified by the first given string.

ul of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <ul> (unordered list) tag.

unary operator <string> : unary operator

Typically used in the plural, this inspector returns a list of objects that use the specified operator.

unique value of <string> : string with multiplicity

Returns the unique values of a given list of <string> types, removing duplicates and sorting by value. As of version 6.0 of BES, this inspector returns a <string with multiplicity>.

universal time <string> : time

Returns a time object for the name provided. See time.

unordered list <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <ul><li> (unordered list item) tag modified by the first given string.

unordered list of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <ul><li> (unordered list item) tag.

user <string> : user

Returns the user specified by <string>.

uuid <string> : uuid

Returns the named UUID (Universally Unique ID).

var <string> of <string> : html

Returns an HTML snippet with the specified string enclosed in a <var> (variable type) tag modified by the first given string.

var of <string> : html

Returns an HTML snippet containing the specified string enclosed in a <var> (variable type) tag.

version <string> : version

Short hand for 'file version'.

volume <string> : volume

A numbered property returning the specified volume.

windows display time <string> : time

Returns a string that may match the time shown in the Windows file system.

windows file <string> : file

Returns a file object corresponding to the relative pathname (within the Windows folder) provided. See file.

winrt package <string> : winrt package

No documentation exists.

wmi <string> : wmi

Returns the wmi object corresponding to the namespace string provided.

x32 application <string> : application

Returns an object corresponding to the 32-bit application specified by <string>.

x32 file <string> : file

Returns an object corresponding to a 32 bit file with name specified by <string>.

x32 folder <string> : folder

Returns a filesystem object corresponding to a 32-bit folder.

x64 application <string> : application

Returns an object corresponding to the 64-bit application specified by <string>. On a 32-bit computer, this is equivalent to a normal application inspector, but on a 64-bit machine, this inspector returns an object that has filesystem redirection disabled.

x64 file <string> : file

Returns an object corresponding to a 64 bit file with pathname specified by <string>. On a 32-bit computer, this is equivalent to a normal file inspector, but on a 64-bit machine, this inspector returns an object that has filesystem redirection disabled.

x64 folder <string> : folder

Returns a filesystem object corresponding to a 64-bit folder with the given pathname. On a 32-bit computer, this is equivalent to a normal folder inspector, but on a 64-bit machine, this inspector returns an object that has filesystem redirection disabled. This action is transitive: any resulting filesystem objects will also have redirection disabled. For example, "pathnames of files of x64 folder <path>" will disable redirection when locating the folder, iterating over the files in the folder and calculating pathnames.

xinetd service <string> : Xinetd Service

Retrurns the xinetd service corresponding to the name provided.

xml document of <string> : xml dom document

Converts the provided string to an xml dom document object.

year <string> : year

Creates a year object from the specified string.

zone <string> : zone

Returns the named global Solaris zone.

zoned time_of_day <string> : time of day with time zone

Returns a 'time of day with time zone' object from the specified string.

<string> as binary_string : binary_string

Works as "<var> as utf16 binary_string" on Windows systems, and as "<var> as utf8 binary_string" on other operating systems.

<string> as boolean : boolean

Returns a boolean value for the string. All possible capitalization's of "TRUE" and "FALSE" will convert successfully.

<string> as date : date

Casts a string as a date type.

<string> as day_of_month : day of month

Casts a string as a day of the month (eg. 28).

<string> as day_of_week : day of week

Casts a string as a day of the week.

<string> as floating point : floating point

Converts the contents of a string into a floating point number.Example: "4.5" as floating point - Returns 4.5.

<string> as fxf binary_string : binary_string

First transcodes the string into the fxf character set, and then converts the binary data transcoded into a binary_string.

<string> as hexadecimal : string

Converts a string to a hexadecimal number.

<string> as html : html

Casts a string into html.

<string> as integer : integer

Returns an integer value for the string provided. If the string contains anything but ASCII digits, the conversion will fail. Use numeric value for more liberal parsing rules.

<string> as ipv4or6 address : ipv4or6 address

Converts a string version of an IP address into the flexible ipv4or6 address format.

<string> as ipv6 address : ipv6 address

Converts a string representations of an IPv6 address (with colons and/or dots) as an IPv6 address type.

<string> as left trimmed string : string

Trims the leading spaces from a string.

<string> as local binary_string : binary_string

First transcodes the string into the local character set, and then converts the binary data transcoded into a binary_string.

<string> as local time : time

Returns a local time object from a properly formatted string. See <time>.

<string> as local zoned time_of_day : time of day with time zone

Converts a string to a time of day with local time zone.

<string> as lowercase : string

Returns a lowercase version of the string provided.

<string> as month : month

Converts a string into a month.

<string> as right trimmed string : string

Trims the trailing spaces from a string.

<string> as site version list : site version list

Converts a string into a site version list.

<string> as string : string

Returns the string provided.

<string> as strverscmp version : strverscmp version

Converts a string to strverscmp version, which is compared to other versions using the OS supplied strverscmp function.

<string> as time : time

Returns a time object from a properly formatted string. See <time>.

<string> as time interval : time interval

Returns a time interval object from a properly formatted string. Expects strings formatted as ddd days, HH:MM:SS.mmmmmm.

<string> as time zone : time zone

Returns a time zone object from a properly formatted string. See <time zone>.

<string> as time_of_day : time of day

Converts a string to a time_of_day type.

<string> as trimmed string : string

Trims the leading and trailing spaces off of the specified string.

<string> as universal time : time

Returns a universal time object from a properly formatted string.

<string> as universal zoned time_of_day : time of day with time zone

Converts a string into a universal zoned time of day.

<string> as uppercase : string

Returns an uppercase version of the string provided.

<string> as utf16 binary_string : binary_string

First transcodes the string into the utf16 character set, and then converts the binary data transcoded into a binary_string.

<string> as utf8 binary_string : binary_string

First transcodes the string into the utf8 character set, and then converts the binary data transcoded into a binary_string.

<string> as version : version

Returns a version if the string can be parsed as a version. The first numeric set of characters delimited with period, comma or comma-space is returned.

<string> as windows display time : time

Returns a Windows display time object from a properly formatted string. See <Time>.

<string> as year : year

Converts a string into a year.

<string> as zoned time_of_day : time of day with time zone

Converts a string into a zoned time of day.

<string> & <string> : string

Concatenates two strings, producing a new string.

<string> < <string> : boolean

No documentation exists.

<string> <= <string> : boolean

No documentation exists.

<string> = <string> : boolean

No documentation exists.

<string> contains <string> : boolean

Returns a boolean TRUE if the first string contains the second string.

<string> ends with <string> : boolean

Returns a boolean TRUE if the first string ends with the second string.

<string> starts with <string> : boolean

Returns a boolean TRUE if the first string starts with the second string.

You can’t perform that action at this time.