Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Remote action command parameters

The following parameters are valid for the Command option when you are creating a remote action in the Create Remote Actions dialog box:

  • $device - Device name 
  • $srcip - IP of the source agent on which the monitor instance is running. If there is no Source Agent attribute for a monitor or if it is a not a Infrastructure Management event, then this is the IP of the device 
  • $targetip - IP of the TargetIP attribute available for the monitor instance. If there is no TargetIP attribute for the monitor or if it is not a Infrastructure Management event, the value is N/A. 
  • $ip - If there is an attribute Target IP for the monitor, $IP displays the ServerIP. If there is no TargetIP attribute, this is the Device IP. 
  • $instancename - Name of the monitor instance while creating/updating a monitor instance. 
  • $monitortype - Name of a monitor type created by Infrastructure Management developers or external developers if users write an SDK monitor. 
  • $rulename - Event rule name that triggers this command. This is applicable only if the diagnostic command was triggered by an event rule. If not, a N/A would be displayed as a result for this parameter. 
  • $pronethome - Home directory where Infrastructure Management software is installed. 
  • $status - The status of an event (Open or Closed). Applicable only when the diagnostic command is triggered from the event list page and event history page. From other pages, N/A is displayed as output for this parameter. 
  • $severity - Severity of an event (Critical, Major, Minor). Applicable only when the diagnostic command is triggered from the event list page and Event history page. From other pages, N/A is displayed as output for this parameter. 
  • $mc_ueid - Universal event identifier. When an event is propagated, the receiving cell gets a new local identifier, event_handle, but the event keeps the old universal identifier mc_ueid. For example, t2000-alr-2356.
    • Events that are Infrastructure Management events have the format as <host><number>. 
    • Events that are Infrastructure Management abnormalities have the format as <host><number>. 
    • Events that are Infrastructure Management external/imported events have the format as <host><number>. 
  • $mc_location - Location at which the managed object resides. For example, labs.bmc.com 
  • $mc_host - Fully qualified name of the host on which the about occurred. For example, t2000.labs.bmc.com 

  • $mc_host_address - Network address corresponding to the mc_host slot. For example, 172.23.30.78

    Note

    This slot can contain some other type of information in which a host value is not meaningful.

  • $mc_object_class - Identifies the class of an object. For example, Windows Process. If the object class cannot be derived from the original event, it should be filled in during enrichment. 
  • $mc_object - Subcomponent of the host to which the event is related. For example, http://www.bmc.com or Drive = C:\Program Files\ProactiveNet, Target IP/Host Name = 172.22.173.108 
  • $mc_tool_class - A user-defined categorization of the tool reporting the event. For example, the mc_tool_class value for an SNMP adapter could be SNMP. And the mc_tool_Class value for an NT EventLog Adapter might be NT_EVLOG. The mc_tool_class value for native events is PNET. For Infrastructure Management events, this slot contains the string PNET. 
  • $mc_tool - Any event is within any value that can further distinguish whether the event is coming from within a mc_tool_class value. For example, for the NT Event Log Adapter, it could be the name of the log to which the incident was logged. If the mc_tool_class is a management tool such as PATROL or ITO, then the mc_tool should be a string that enables an action on the event to initiate a communication in context with the mc_tool. For Infrastructure Management events, this slot contains the fully-qualified DNS name of the BMC TrueSight Infrastructure Management Server. 
  • $status - Status value of the event. 
  • $severity - Severity value of the event. 

  • $mc_priority - Current priority of the event. Possible value include PRIORITY_5 is considered as lowest priority, followed by PRIORITY_4, PRIORITY_3,PRIORITY_2. PRIORITY_1 is considered to be the highest priority.

    Note

    Macros are whole-word substitutions and do not work the way regular expressions do.
    The following example illustrates the usage of macros in general.
    For example on usage of $MC_PRIORITY. If $MC_PRIORITY is used as /tmp/$MC_PRORITY, the macro replacement does not work.
    The correct usage for this macro is $MC_PRIORITY as a standalone word. It does not work if you use suffixes or prefixes with the macro.

  • $msg - Text description of the event. For example, Sybase ASA Intelliscope Forced Commits, 7.370 per sec is above All Baseline. 
  • $mc_notes - List of free text annotations added to the event. The contents of this slot is implementation dependant. Rules or users should not rely on a particular value in this slot. 
  • $mc_long_msg - Infrastructure Management events, more information is stored in mc_long_msg. 
  • $mc_owner - Current user assigned to the event. 
  • $mc_origin_class - Identifies the event management system type. This slot might have the same value as the mc_tool_class slot if this is only a two-layer implementation.

 

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