Command syntax

The syntax for Historical Server commands is:

hs_XXX arg1, arg2, arg3, ..., argn

where XXX is the command name. For example, a typical command is hs_create_recording_session.

Parameters must be separated by commas. You can omit parameters that are optional or that have default values; however, you must use the value NULL for those parameters as a placeholder if other parameter values follow them. For example, the following command uses the default value for most parameters:

hs_create_playback_session null, null, raw, null, null, client, null, null, null, null, 7

Command names, command keywords, the word null, data items, and statistic types are all case-insensitive. File names, view names, and other user-supplied names are case-sensitive.

If a parameter value contains embedded spaces (such as those in data items, statistic types, and date-time specifications), you must surround the value with quotes. Matched pairs of single-quote or double-quotes are valid delimiters.

If the parameter value contains an embedded quote that is the same as the character used to delimit the entire value, supply a pair of the quotes within the parameter value. Historical Server compresses the pair of quotes to a single character.

The word null within quotes is not considered a keyword.

You can enter Historical Server commands on multiple lines.