hubcli job runpkg

Invokes a program from a Hub package that has been authored in Altair Analytics Workbench and uploaded into Altair SLC Hub.

The command has the following format:

hubcli job runpkg [flags]

where:

flags

One or more flags for the command that provide additional control over execution.

The following flags are mandatory:

-G group or --group group

The name of the program package group.

-N package or --name package

The program package name.

-P string or --program string

Path of program within the package.

-R string or --repository string

Program package repository name.

The following flags are optional:

--allowExitCodes string

Treats jobs that return non-zero exit codes as successful. A non-zero code can be specified to string. You can specify more than one exit code, separated by commas.
For example, you could specify --allowExitCodes 1,2,3,5-10.

--allowWarnings

Treats SLC jobs that return warnings as successful.

-c string or --connection string

Specifies the name of the connection to use. If you do not specify this option, then the default connection is used. If there is no default connection, then you must specify a connection. The first connection created for the Altair SLC Hub instance is set by default as the default Hub instance, but a different default connection can be set using the hubcli connection use command.

-d or --download

Downloads job results when the job has finished to either the default directory, or the directory specified by the -o option.
The default directory is ./connection_name_jobid, where connection_name is the name of the connection used for the job and job_id is the job identifier for the job.
This flag must be specified with the --wait flag.

--debug

Enables debug logging.

-e name=value or --env name=value

Sets the environment variable name to the specified value to the job. The default is [].

-p string or --execution-profile string

Specifies the name of the execution profile to use for the job. If an execution profile is not specified, the default profile is used. A default profile can be specified using the hubcli exprof use command.

-h or --help

Returns help information for this command.

--jobName jobname

A name to assign to the job.
If this flag is not specified, a default job name is created in the form:
< group >:< name >:< version >:< program > For example: mygroup:mypackage:1.2.3:examples/example1.

-n string or --namespace string

Specifies the name of the namespace to use. If you do not specify this option, then the default namespace is used, if a default is available. A default namespace for the current connection is created using the hubcli namespace use command.

-o dir or --outputDir dir

Specifies the directory into which the results of the job are downloaded. By default the directory is ./connectionname_jobid. for download, ./ for downloadZip.

--passwordFile string

Specifies the path to a file containing an operating system password.

--promptOSPass

Specifies that an operating system password is required to run the job.

-r list or --result list

Specifies a comma-separated list of result artifacts to download. Each artifact has the format 'result-name=worker-path', where result-name is the name of a result, and worker-path is the worker path used to run the job.

--rm

Removes the job after it has completed.
This flag must be specified with the --wait flag.

-V string or --version string

Specifies the program package version to use. By default, the latest version is used.

-w or --wait

Waits until the job has completed before returning

-t duration or --waitTimeout duration

Specifies the amount of time duration to wait for the job to finish. The duration can be specified in common units such as s (seconds), m (minutes), and h (hours); for example, 30s, 5m, 2h. The default is to wait forever.

-z or --downloadZip

Downloads job results as a zip file when the job has finished to either the default directory or the directory specified by the -o option.
The default directory is ./ (the current working directory).
This flag must be specified with the --wait flag.