gpsscli remove

gpsscli remove

Remove one or more Greenplum Streaming Server jobs.

Synopsis

gpsscli remove {job_name | job_id}
     [--all]
     [--config gpsscliconfig.json]
     [--gpss-host host] [--gpss-port port]
     [--no-check-ca] [-l | --log-dir directory] [--verbose]

gpsscli remove {-h | --help}

Description

The gpsscli remove command removes a job from the job list of a specific Greenplum Streaming Server (GPSS) instance. You must stop a job before you can remove it.

Specify the --all flag to the command to remove all stopped jobs.

When you remove a job, GPSS un-registers the job and removes all job-related resources.

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 | job_id
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.
--all
Remove all stopped and errored jobs.
--config gpsscliconfig.json
The GPSS configuration file. This file includes properties that identify the gpss instance that services the command. When SSL encryption is enabled between the GPSS client and server, you also use this file to identify the file system location of the client SSL certificates. Refer to gpss.json for detailed information about the format of this file and the configuration properties supported.
Note: gpsscli subcommands read the configuration specified in the ListenAddress block of the gpsscliconfig.json file, and ignore the gpfdist configuration specified in the Gpfdist block of the file.
--color
Enable the use of color when displaying front-end log messages. When specified, GPSS colors the log level in messages that it writes to stdout. Color is disabled by default.
GPSS ignores the --color option if you also specify --csv-log.
--csv-log
Write front-end log messages in CSV format. By default, GPSS writes log messages to stdout using spaces between fields for a more human-readable format.
--gpss-host host
The GPSS host. The default host address is 127.0.0.1. If specified, overrides a ListenAddress:Host value provided in gpsscliconfig.json
--gpss-port port
The GPSS port number. The default port number is 5000. If specified, overrides a ListenAddress:Port value provided in gpsscliconfig.json
--no-check-ca
Disable certificate verification when SSL is enabled between the GPSS client and server. By default, GPSS checks the certificate authority (CA) each time that you invoke a gpsscli subcommand.
-l | --log-dir directory
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.
--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