hubcli job runpgm

Invokes a SAS language program using Altair SLC. The program must be on a network path accessible to the worker node on which the SAS language program is run.

The command has the following format:

hubcli job runpgm [flags] filename

where:

flags

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

filename The filename of the package to run.

The following flags are available:

--allowExitCodes code

Specifies that that the non-zero exit codes defined in code are treated as successful. 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.

--appendOption name=value

Appends the specified value to the end of the current value of the system option specified by name. This is only valid for SAS language programs. The default is [].

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

--insertOption name=value

Prepends the specified value at the beginning of the current value of the system option specified by name (only valid for SAS language programs). The default is []).

--jobName string

A name to assign to the job.
If this flag is not specified, a default name is the basename of the program, for example Program1.sas.

-n string or --namespace string

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 name=value or --option name=value

Sets the SLC system option name to value for the job. This is only valid for SAS language programs. The default is [].

-o string or --outputDir string

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.
0 This flag must be specified with the --wait flag.

-T string or --type string

Specifies that the specified file extension defines a file that contains an executable job (that is, an Altair SLC program, shell script or operating system batch job).

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

Note: run is an alias of runpgm