admin_execute/5—perform an action through remote execution on the Administration server

The admin_execute/5 primitive performs an action through remote execution on the  Administration server.

admin_execute($NAME,$OBJECT,$ACTION,$ARGS,$ACTEVENT)

admin_execute/5 syntax arguments

Argument

Mode

Type

Description

$NAME

Input

STRING

Specifies the name of the remote execution agent (Administration server or other external framework such as a cell or gateway.)

$OBJECT

Input

STRING

Specifies the object handle for the event or data on which the action is to be performed

$ACTION

Input

STRING

Specifies the name of the action to be performed

$ARGS

Input

LIST_OF ANY

Specifies a list of action arguments.
Required arguments for the action specified in $ACTION must be of the correct type specified in the action definition and must be included in the $ARGS list.

$ACTEVENT

Input

BOOLEAN

YES|NO—Specifies whether or not to generate an action result event

Use the admin_execute/5 to perform an action on the Administration server or other external framework by using remote execution. The Administration server or external framework must be defined in the mcell.dir directory, including the credentials to log on to it. The credentials must be provided as userid/password in the encryption key field.

The action will be performed on the Administration server or the external framework by using the credentials that are provided in the directory. 

admin_execute/5 example

action UserGetMetrics : EVENT($E) 
{
     admin_execute(ias1,$E,GetMetrics,[],YES);
}
END

In this example, the UserGetMetrics action retrieves metrics for an event from an Administration server.

The action performs the GetMetrics remote task on the ias1 Administration server. Credentials are assumed to be provided in mcell.dir for this server.

Was this page helpful? Yes No Submitting... Thank you

Comments