gpsscli remove

A newer version of this documentation is available. Click here to view the most up-to-date release of the Greenplum 5.x documentation.

gpsscli remove

Remove a Greenplum Stream Server job.

Synopsis

gpsscli remove job_name
     [--gpss-host host] [--gpss-port port]
     [-l | --log-dir directory] [-v | --verbose]

gpsscli remove {-h | --help}

Description

The gpsscli remove command removes a job from the job list of a specific Greenplum Stream Server (GPSS) instance. When you remove a job, GPSS un-registers the job and removes all job-related resources.

You must stop a job before you can remove it.

If the GPSS instance to which you want to send the request is not running on the default host (127.0.0.1) or the default port number (5000), you can specify the GPSS host and/or port via command line options.

Options

job_name
The identifier of a previously-submitted GPSS job. You can specify a job name when you run gpsscli submit, or the command returns a unique job identifier.
--gpss-host host
Specify the GPSS host. The default host address is 127.0.0.1.
--gpss-port port
Specify the GPSS port number. The default port number is 5000.
-l | --log-dir directory
Specify the directory to which GPSS writes client command log files. GPSS must have write permission to the directory. GPSS creates the log directory if it does not exist.
If you do not provide this option, GPSS writes gpsscli client log files to the $HOME/gpAdminLogs directory.
-v | --verbose
The default behaviour of the command utility is to display information and error messages to stdout. When you specify the --verbose option, GPSS also outputs debug-level messages about the operation.
-h | --help
Show command utility help, and then exit.

Examples

Remove the GPSS job identified by the name nsync_121118:

$ gpsscli remove nsync_121118