Skip to content

hubcli job list

Lists jobs. By default, only jobs in the default namespace and associated with the current user are returned.

The command has the following format:

hubcli job list [flags]

where:

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

The following flags are available:

--allNamespaces
Returns results from all namespaces, not only the hubcli default namespace. However, the results returned might be limited by access control.
--allUsers
Returns results from all users, not only the current user. However, the results returned might be limited by access control.
--completed
Limits the results returned to only those jobs that have completed.
-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.
--createdAfter time
Lists only jobs created after the specified time.
--createdBefore time
Lists only jobs created before the specified time.
--debug
Enables debug logging.
-h or --help
Returns help information for this command.
--json
Returns the list of job properties in JSON format.
-l int or --limit int
Lists only the number of jobs specified by int. By default 100 are listed. Counting begins from the first listed job.
-n name or --namespace name
Specifies the name of the namespace to which the job is attached.
--notCompleted
Limits results to only those jobs that have not yet completed.
-o int or --offset int
Skips the number of jobs specified by int at the beginning of the returned list. For example, if there are 200 jobs and int is set to 100, then the first 100 jobs are skipped and only the remaining jobs are listed. The sort order of the list is set before the offset takes effect; therefore the list returned is the offset of the sorted list. The list is ordered by default by the modification time, or by the setting of the --sort flag.
--orderBy string
Specifies the order for the list. You can specify:
created or -created Sorts the results by the time the job was created.
name or -name Sorts the results by the job name.
id or -id Sorts the results by the job identifier.

-r or --relativeTimes
Display times in the returned list as relative rather than absolute.
--state state
Limits results to those jobs with the specified state. state can be one of the following:
  • Creating
  • Pending
  • Cancelled
  • Executing
  • CompletedSuccess
  • CompletedError
  • Failed

Note: ls is an alias of list.