gpsscli submit

Submit one or more jobs to a VMware Tanzu Greenplum streaming server.

Synopsis

gpsscli submit <jobconfig.yaml> [...]
     [--name <job_name>]
     [-f | --force]
     [-p | --property <template_var=value>]
     [--config <gpsscliconfig.json>]
     [--gpss-host <host>] [--gpss-port <port>]
     [-U | --username <client_auth_user> -P | --password <client_auth_passwd>]
     [--no-check-ca] [-l | --log-dir <directory>] [--verbose]

gpsscli submit {-h | --help}

Description

The gpsscli submit command submits a load job to a specific Tanzu Greenplum streaming server (GPSS) instance. When you run the command, you provide one or more YAML-formatted configuration files that define the job parameters.

When you specify a single load configuration file, you may choose a name to identify the job. If you do not provide a name, GPSS uses the base name of the load configuration file as the job identifier. For example, if you invoke this command with the load configuration file /dir/jobconfig.yaml and do not provide the --name option, GPSS assigns the job the identifier jobconfig.

When you submit a job, GPSS registers the job in its job list. A job is in the Submitted state after it is submitted.

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

jobconfig.yaml [...]

One or more YAML-formatted configuration files that define the parameters of the job(s). If a filename provided is not an absolute path, VMware Tanzu Greenplum assumes the file system location is relative to the current working directory.

Note

GPSS uses the properties in a YAML configuration file to uniquely identify a load operation. Submit a configuration file only once. If you submit the same configuration file more than once, GPSS will create the job, but it will eventually error out.

--name job_name

Use job_name to identify the job. If you do not provide a name, the default job identifier is the base name of the load configuration file. Job names must be unique.

Note

GPSS does not support specifying a job_name when you provide more than one jobconfig.yaml load configuration file to the command.

-f | --force

Force GPSS to reload the configuration of a job. GPSS updates the job with the configuration specified in jobconfig.yaml. When the configuration reload completes, the job transitions to the Stopped state. If you previously named the job, you must provide --name job\_name when you force job configuration reload with this option.

Note

Do not attempt to update a configuration property that GPSS uses to uniquely identify a job. If you change any such configuration property, GPSS creates a new internal job and loads all available messages.

-p | --property template_var=value

Substitute value for instances of the property value template {{template_var}} referenced in the jobconfig.yaml load configuration file.

--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 deactivated 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

Deactivate 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.

-U | --username client_auth_username

The user name with which the GPSS server instance authenticates the client.

-P | --password client_auth_passwd

The password with which the GPSS server instance authenticates the client.

-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

Submit a GPSS job named nsync_121118 whose load parameters are defined by the configuration file named loadcfg.yaml:

$ gpsscli submit --name nsync_121118 loadcfg.yaml

See Also

gpss, gpsscli.yaml