Docs.bmc.com will undergo a brief maintenance outage 27 March 2025. The site will be unavailable for ten minutes starting at 6:30 AM CDT/5 PM IST.

  Important This documentation space contains information about PATROL Agents when deployed in a TrueSight Operations Management environment. If you are a BMC Helix Operations Management user, see PATROL Agent 22.1 for BMC Helix Operations Management.

internal()

Process a command internal to the PATROL Agent.

Format

internal(command)

Parameter

Parameter

Definition

command

text string that contains the command the PATROL Agent should process and its arguments

 

Description

The internal() function causes the PATROL Agent to process the string command internally and in a platform-specific manner. The internal() function returns the command output if successful. 

If the internal() function encounters an error, it returns the NULL string and sets the PSL variable errno according to the table below.

errno Value

Meaning

104

E_PSL_NOT_SUPPORTED 
internal() function was called from PSL standalone or on a platform that does not support internal()function.

122

E_PSL_INTERNAL_ARG_ERROR 
The command given to the internal() function was not supplied with the correct number of arguments, or the arguements could not be understood.

123

E_PSL_INTERNAL_PARSE_FAILED 
Could not parse the command string

124

E_PSL_INTERNAL_UNKNOWN_FUNCTION 
The command given to the internal() function was not recognized

125

E_PSL_INTERNAL_FUNCTION_FAILED 
The command string was recognized and parsed, but a failure was encountered while attemtping to execute it

127

E_PSL_INTERNAL_BAD_NAME 
Performace counter requested does not exists or is not supported.

 

The internal() function is designed to be used for user and process monitoring and resource inquiries that can be handled inside the PATROL Agent. In these cases, the internal() function is much more efficient than invoking a separate command that requires a call to the PSL interpreter or some other command processor.

Note

The internal() function is proprietary and FOR BMC SOFTWARE INTERNAL USE ONLY. BMC Software does not support its external use.