MRL functions and primitives

The primitives and functions in this section are grouped by usage. This table allows you to look up the location of the function and primitive descriptions alphabetically. 

Alphabetical list of primitives and functions

Primitive/function name

Description

Page

abs/2

Determine the absolute value of a numeric value.

acos/2

Return the arc cosine of a specified number.

action_requestor/1

Retrieve the identification of the requestor of an action.

action_requestor/2

Retrieve the user ID and password of the console user triggering the action.

action_requestor/3

Retrieve the user ID and password of the console user and the type of rule triggering the action.

action_return/2

Terminate an internal action and return a value.

add_to_list/2

Add an element at the beginning of a list slot.

apply_match_entry/4

Obtain output values from a match table entry.

admin_execute/5

Perform an action through remote execution on the Administration Server.

admin_execute/7

Perform an action through remote execution on IAS, providing the Administration Server credentials.

asin/2

Return the arc sine of a specified number.

atan/2

Return the arc tangent of a specified number.

atan2/3

Return the arc tangent of the ratio of two numbers.

cellcontrol/1

Perform a cell control command.

cellinfo/2

Retrieve cell-specific information.

char/2

Produce a string containing a single character with a specified numeric internal representation.

class_path/2

Obtain the class hierarchy of a class.

code/2

Retrieve the internal numeric representation of a character.

concat/2

Concatenate a list of strings.

confirm_external/2

Run an external program and wait for its termination to continue to process the current event.

cos/2

Return the cosine of an angle.

decr/1

Decrement an integer or enumeration slot by 1.

decr/2

Decrement an integer or enumeration slot by a specified value.

decr/2 and prev/2

Return an integer or enumeration slot value decremented by 1.

decr/3

Retrieve the value of an integer or enumeration slot decremented by a specified value.

decr/3

Decrement an integer or enumeration slot by a specified value within a given limit.

decr/4

Return an integer or enumeration slot value decremented by a specified value within a given limit.

drop_new/0

Drop a new event object.

execute/4

Run a program as an external process.

exp/2

Raise e (2.718281828...) to a specified power.

find_match/5

Find an entry in a match table and retrieve calculated values from it.

find_match_entry/4

Find an entry in a match table.

gcd/3

Return the greatest common divisor of two numbers.

generate_event/2

Generate a new event.

get_env/2

Retrieve the value of an environment variable.

get_external/4

Run an external program and wait for its termination to continue to process the current event, using data retrieved through an interface object.

get_list_slotvalues/3

Retrieve a list of slots from one or more objects.

has_substring/2

Verify the occurrence of a substring within a string or list of strings.

has_substring/3

Verify the occurrence of a substring within a string or list of strings using a comparison modifier.

incr/1

Increment an integer or enumeration slot by 1.

incr/2

Increment an integer or enumeration slot by a specified value.

incr/2 and next/2

Return an integer or enumeration slot value incremented by 1.

incr/3

Return an integer or enumeration slot value incremented by a specified value.

incr/3

Increment an integer or enumeration slot by a specified value within a specified limit.

incr/4

Retrieve the value of an integer or enumeration slot incremented by a given value within a specified limit.

int/2

Truncate a numeric value to an integer value.

int_to_hex/2

Convert an integer value to a string containing its hexadecimal notation.

int_to_hex/3

Convert an integer value to a string containing its hexadecimal notation in a specified field width.

inttostring/2

Convert an integer value to a string value.

kbversion/1

Retrieve global Knowledge Base module version information.

kbversion/2

Retrieve Knowledge Base module version information.

key_verify/2

Validate and retrieve fields from a license key.

key_verify/3

Validate and retrieve fields from a license key.

key_version/2

Retrieve the version from a license key.

listappend/3

Concatenate two lists.

listdelete/3

Remove all occurrences of an element from a list.

listdisjoint/2

Verify that two lists do not have any common elements.

listgetelt/3

Retrieve a list element located at a specified position within a list.

listintersect/3

Determine the common elements of two lists.

listlen/2

Determine the length of a list.

listmember/2

Verify that an element is included in a list.

listremdup/2

Remove duplicate elements from a list.

listsubtract/3

Remove the elements that occur in one list from another list.

listunion/3

Determine the union of two lists.

listwalk/2

Run instructions against each element in a list.

log/2

Return the natural logarithm of a specified number.

log10/2

Return the decimal logarithm of a specified number.

mapslots/3

Format a series of expressions that refer to objects into a string.

mapslots/4

Format a series of expressions that refer to event and data objects into a string.

match_regex/3

Match a string with a regular expression.

match_regex/4

Match a string with a regular expression and retrieve all fields from it.

match_regex/5

Match a string with a regular expression and retrieve a given number of fields from it.

max/3

Determine the maximum of two values.

min/3

Determine the minimum of two values.

new_data/3

Create a new data object.

ntadd/2

Add a note to an event.

ntcnt/2

Count the notes attached to an event.

ntget/5

Return the time stamp, author, and text of a note attached to an event.

ntset/3

Modify the text of a note attached to an event.

opadd/3

Add an operation to an event.

opadd/4

Add a policy operation to an event.

opcnt/2

Count the operations of an event.

opget/6

Retrieve an operation of an event.

opget/7

Retrieve a policy operation of an event.

opget_action/3

Retrieve the action name of an operation of an event.

opget_args/3

Retrieve the argument list of an operation of an event.

opget_author/3

Retrieve the author of an operation of an event.

opget_time/3

Retrieve the time stamp of an operation of an event.

opqry/5

Retrieve the arguments and sequence number of an operation.

opset/4

Modify the action and arguments of an operation of an event.

opset/5

Modify the policy name, action, and arguments of an operation of an event.

perform/3

Perform a specified action.

perform/5

Perform a specified action and return a value.

pointertostring/2

Convert a pointer value to a string value.

pow/3

Raise a number to a specified power.

propagated_to/3

Verify that an event has been propagated to a specified destination.

random/3

Return a random integer that falls between two specified numbers.

real/2 and float/2

Convert a numeric value to a real value.

realtostring/2

Convert a real value to a string value.

relate/1

Establish the relation of an event to a source event.

rem_from_list/2

Remove the first occurrence of an element from a list slot.

remove_data/1

Delete a data object.

reset_default/1

Reset a slot to its default value.

round/2

Convert a numeric value to an integer value by rounding the number.

send_to/2

Send an event to another cell or gateway.

send_to/3

Send an event modification to another cell or gateway.

send_to_ext/4

Send an extended event to another cell or gateway.

set_list_slotvalues/3

Assign values to a list of slots for one or more objects.

set_timer/3

Set a timer on an event object that will expire after a specified delay.

set_timer_at/3

Set a timer on an event object that will expire at a specified time.

set_timer_at/4

Set a timer on an event object that will expire at a specified time represented by a text string.

sign/2

Determine whether a numeric value is positive, negative, or zero.

sin/2

Return the sine of an angle.

smcomps/5

Search for certain Service Model components.

sprintf/3

Format a series of values into a string.

sqrt/2

Determine the square root of a numeric value.

str_to_time_stamp/3

Convert a string to a time stamp.

strextract/4

Retrieve a string of a specified length that begins at a specified position within a larger string.

string/2

Convert any non-list value to a string value.

stringtoint/2

Convert a string value to an integer value.

stringtopointer/2

Convert a string value to a pointer value.

stringtoreal/2

Convert a string value to a real value.

strip/2

Strip leading and trailing blank spaces from a string.

strip/3

Remove blank spaces from specified parts of a string.

strip/4

Remove specified characters from specified parts of a string.

strlen/2 and len/2

Determine the length of a string.

strmatch/3

Match a string with a simple pattern and retrieve fields from it.

strnpart/4

Determine the start position of a specified occurrence of a part of a string.

strpart/3

Determine the starting position of a partial string within a larger string.

strtolist/3

Divide a string into parts at specified separators.

substring/3

Retrieve a string that begins at a specified position within a larger string and continues through the end of the larger string.

substring/4

Retrieve a substring of a specified length beginning at a specified offset.

tan/2

Return the tangent of an angle.

tf_active/1

Verify whether one or more time frames are active.

tf_active/2

Verify whether one or more time frames are active at a given time.

tf_current_end/2

Obtain the end time of the current active interval of a time frame.

tf_current_end/3

Obtain the end time of the active interval of a time frame at a specified time.

tf_current_interval/2

Obtain the start and end time of the current active interval of a time frame.

tf_current_interval/3

Obtain the start and end time of the active interval of a time frame at a given time.

tf_current_start/2

Obtain the start time of the current active interval of a time frame.

tf_current_start/3

Obtain the start time of the active interval of a time frame at a specified time.

tf_duration/3

Calculate the duration of all active intervals of a time frame from a specified start time to the current time.

tf_duration/4

Calculate the duration of all active intervals of a time frame during a specified time period.

tf_next_end/2

Obtain the end time of the next active interval of a time frame.

tf_next_end/3

Obtain the end time of the next active interval of a time frame at a specified time.

tf_next_interval/2

Obtain the start and end time of the next active interval of a time frame.

tf_next_interval/3

Obtain the start and end time of the next active interval of a time frame at a specified time.

tf_next_start/2

Obtain the start time of the next active interval of a time frame.

tf_next_start/3

Obtain the start time of the next active interval of a time frame at a given time.

tf_prev_end/2

Obtain the end time of the previous active interval of a time frame.

tf_prev_end/3

Obtain the end time of the previous active interval of a time frame at a given time.

tf_prev_interval/2

Obtain the start and end time of the previous active interval of a time frame.

tf_prev_interval/3

Obtain the start and end time of the previous active interval of a time frame at a specified time.

tf_prev_start/2

Obtain the start time of the previous active interval of a time frame.

tf_prev_start/3

Obtain the start time of the previous active interval of a time frame at a given time.

tf_udid_active/1

Verify whether one or more time frames specified by mc_udid are active at the current time.

tf_udid_active/2

Verify whether one or more time frames specified by mc_udid are active at a specified time.

time_extract/3

Retrieve fields from a time stamp.

time_stamp/1

Retrieve the current time.

time_stamp_to_cim/2

Convert a time stamp to CIM (Common Information Model) format.

time_stamp_to_str/2

Convert a time stamp to the default DateFormat format.

time_stamp_to_str/3

Convert a time stamp to a specified format.

tolowercase/2 and lower/2

Convert a string to all lowercase characters.

touppercase/2 and upper/2

Convert a string to all uppercase characters.

trunc/2

Truncate a real number to an integer (symmetric around 0).

unrelate/1

Remove a relation of a related event to a source event.

unset_cause/0

Break the cause-to-effect relationship from a correlate rule.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*