velocity-shutdown

Synopsis

velocity-shutdown [-force]
    [-h|-help]
    [-installation-dir /path/to/engine/installation]
    [-quiet]
    [-reason "Reason for shutdown"]
    [-yes]

Description

The velocity-shutdown command is located in the bin subdirectory of a Watson Explorer Engine installation. (On Microsoft Windows systems, this command has the .exe file extension.) Executing this command with the -yes option or by answering 'y' to all of its prompts initiates the Watson Explorer Engine shutdown process, which cleanly terminates all Watson Explorer Engine, prevents these services from restarting, and prevents any other Watson Explorer Engine services from being started.

Options

• -force: Terminates all Watson Explorer Engine processes immediately, without waiting for those processes to terminate cleanly. Using this option can cause delays when restarting Watson Explorer Engine if crawls were in progress when Watson Explorer Engine was shut down. You should specify this option if you are using the Collection Broker.
• -h|-help: Displays a usage message and exits without attempting to shut down Watson Explorer Engine.
• -installation-dir/path/to/engine/installation: Enables you to specify the location of the Watson Explorer Engine installation that you want to shut down. If no installation directory is specified, the velocity-shutdown command assumes that the Watson Explorer Engine installation directory is the parent of the directory in which the velocity-shutdown command is located.
• -quiet: Suppresses normal output and warnings. Errors will still be displayed. Specifying this option implies the -yes option. On Windows systems, this option also suppresses the "Press return to continue" message that is shown at the end of each Watson Explorer Engine administrative command.
• -reason "Reason for shutdown": provides Reason for shutdown as the reason that Watson Explorer Engine was shut down, storing this information in files named maintenance-mode that are located in the top level and bin directories of /path/to/engine/installation. If you do not specify a reason, the default reason "System Administrator requested shutdown" is used.
• -yes: Proceeds without prompting for confirmation

Messages

The velocity-shutdown command displays the message "Velocity has been shutdown" when a shutdown is successful. Depending on the command-line options that you specify, you may be prompted for other information or see additional messages, such as the following:

• "Is it okay to shutdown Velocity?": This message is displayed if you do not specify the -yes option. The default response if you simply press return is 'N' (no), which causes the velocity-shutdown command to exit without attempting to stop Watson Explorer Engine.
• "Press Return to continue": (Microsoft Windows only) Shown after the velocity-shutdown completes the shutdown process but before it exits, in order to enable you to see any messages that may have been generated in the command window during the shutdown process.

See the Watson Explorer Engine Message Reference Manual for detailed information about any other messages that you may receive from the velocity-shutdown command.

Exit Status

Exits with status 0 when the command is successful.