Chapter 4: Command Reference


Command summary

Table 4-1 summarizes the Historical Server commands.

Table 4-1: Historical Server commands

Activity

Commands

Creating recording sessions

Use these commands to create a recording session:

  • hs_create_recording_session – defines the characteristics of a recording session.

  • hs_create_view – defines a view, which is a collection of data to record.

  • hs_create_filter – specifies filtering criteria on a data item.

  • hs_create_alarm – specifies a threshold value for a data item that triggers an alarm action.

  • hs_initiate_recording – ends recording session definition and enables recording to begin at its predefined start time.

  • hs_terminate_recording – stops a recording session.

Viewing recording session definitions

  • hs_list – lists all of the views defined for a recording session and their data items.

Creating a playback session

Use these commands to create a playback session:

  • hs_create_playback_session – defines the characteristics of a playback session

  • hs_create_playback_view – specifies one or more views from the input recording sessions to include in the playback session.

  • hs_initiate_playback – ends playback session definition. Also starts playback to a file.

  • hs_playback_sample – plays back a sample to a client.

  • hs_terminate_playback – stops a playback session.

Administering Historical Server

Use these commands to manage Historical Server:

  • hs_delete_data – deletes the files containing the recorded data for specified recording sessions.

  • hs_status – displays the current status of Historical Server.

  • hs_shutdown – stops Historical Server.