Terminates the definition of a recording session, cancels the scheduled start of a recording session, or terminates a recording session in progress.
hs_terminate_recording session_id[,delete_option]
identifies the session you want to terminate. Historical Server assigns a session ID when a session is defined with hs_create_recording_session. Use the hs_list command to view session IDs.
specifies whether to delete the files associated with the recording session, if recording is in progress.
delete – deletes the files.
retain (the default) – does not delete the files. This parameter is ignored when you are cancelling a recording session that was not initiated.
This example terminates the active recording session with identifier 5 and then deletes all files associated with session 5.
hs_terminate_recording 5,delete
If you initiate a recording, you are the session owner.
To terminate a recording session, you must be the session owner or the Historical Server superuser.
The hs_terminate_recording_session command can cancel the definition of a recording session that was created in the current connection but never initiated. This allows you to define another recording session or to define a playback session using the current connection.
If you attempt to terminate an inactive recording session, this command returns an error.
