Creating a menu command - Documentation for BMC PATROL Agent 11.0

PropertyRequired/OptionalDefaultDescriptionGeneral propertiesCommand NameRequiredNone

The name that the PATROL product uses to manage the command and it is the title of the command as it appears on 
the pop-up menu. There are no restrictions on command name length; the menu expands to accommodate the name 
but the input field width is limited to 30 characters. Capitalizing the first letter of a command is standard and spaces are allowed.

Command or Task Command

Click Command to create a menu to execute as a command. Click Task to create a menu command that is a task. 
For more information, see Creating Menus.

Task Options None

If you specify that the command is executed as a task the following options are available:

• Show Timer displays the time that it takes for the menu command to run
• Popup Output Windows opens a task output window on task completion
• Task is Interactive requires user interaction, such as entering information, before the task executes

AvailabilityRequiredALWAYS_AVAILABLE

Availability indicates when the command is enabled on the object's command menu. A command can be available:

• ALWAYS_AVAILABLE; The menu command is always enabled, regardless of associated object's status.
• AVAILABLE_ONLINE ; The menu command is enabled only when the associated object is online.
• AVAILABLE_OFFLINE; The menu command is enabled only when the associated object is offline.

Command propertiesComputer ClassRequiredALL_COMPUTERS

The computer class against which the menu command is to be executed. Choose ALL_COMPUTERS to execute the same 
menu command syntax on every computer. If you need to define a different command syntax for each computer type, select 
the computer type and then define the appropriate syntax for that platform. In this way, you define the appropriate platform/command pair.

Command TypeRequiredOSChoose the language used to write the command script from the list of installed command types.CommandRequiredNoneClick the Command button to access the Command Text Editor window to define the menu command procedure.Save in KM or Save in FileRequiredSave in KM

Click Save in KM to save the parameter command as part of the PATROL KM file. Click Save to File to save the parameter 
command in a separate file in the PATROL PSL directory. Selecting this option allows the file to be referenced by other parameters, 
commands, etc. However, this technique is difficult to manage and many PATROL KM problems can result from selecting this technique.

Security propertiesSecurity TypeRequiredSECURITY_INHERIT

Choose the appropriate Security Type for the menu command:

• SECURITY_INHERIT --The menu command is executed using the PATROL Console login user name and password set for 
  the computer or application at the instance level, or, if not defined at that level, at the computer or application class level.
• SECURITY_PROMPT --Before the menu command is executed, the user is prompted to supply a valid user name and password 
  on whose authority, the menu command is executed.
• SECURITY_THIS --The menu command is executed under the authority of the user name and password typed in the associated 
  fields. Setting up command security is described in more detail in Specifying parameter security.

User NameConditionalNone

If the Security Type SECURITY_THIS is selected, type the user name of the account under whose authority the menu 
command is to be executed.

PasswordConditionalNoneIf the Security Type SECURITY_THIS is selected, type the password of the account under whose authority the command is to be executed.Environment propertiesNameOptionalNoneThe name of the environment variable.ValueOptionalNone

The value assigned to the environment variable. To change an existing environment variable, choose the variable from the 
Name/Value list and make the changes in the Name and Value text boxes

Icon propertiesSelect OK Icon for TaskRequiredDefault standard PATROL task iconType the file name for the OK Icon to be used for the menu command task.Select Attention Icon for TaskRequiredDefault standard PATROL task iconType the file name for the Attention (Not OK) Icon to be used for the menu command task.