Skip to main content
The jobs command manages jobs in NexusOne.

​
delete

The delete subcommand deletes a specific job and its corresponding data.
​
string
required
Unique ID of the job to delete.
​
string
API key or the NX1_API_KEY variable.
​
string
YAML config file.
​
Shows help messages and exit.
​
string
API host.
​
Disables SSL verification.
​
string
Output format. Allowed values: json, yaml, or table.
​
string
Profile name from ~/.nx1/profiles.
​
integer
Requests when to timeout. Default is 30.
​
Verbose output.

​
get

The get subcommand retrieves the job details of a specified job.
​
string
required
Unique ID of the job to get.
​
string
API key or the NX1_API_KEY variable.
​
string
YAML config file.
​
Shows help messages and exit.
​
string
API host.
​
Disables SSL verification.
​
string
Output format. Allowed values: json, yaml, or table.
​
string
Profile name from ~/.nx1/profiles.
​
integer
Requests when to timeout. Default is 30.
​
Verbose output.

​
list

The list subcommand retrieves a list of all jobs accessible to you along with its job details.
​
string
API key or the NX1_API_KEY variable.
​
string
YAML config file.
​
Shows help messages and exit.
​
string
API host.
​
Disables SSL verification.
​
string
Output format. Allowed values: json, yaml, or table.
​
string
Profile name from ~/.nx1/profiles.
​
integer
Requests when to timeout. Default is 30.
​
Verbose output.

​
trigger

The trigger subcommand manually triggers a specific job to run immediately.
​
string
required
Unique ID of the job to trigger.
​
string
API key or the NX1_API_KEY variable.
​
string
YAML config file.
​
Shows help messages and exit.
​
string
API host.
​
Disables SSL verification.
​
string
Output format. Allowed values: json, yaml, or table.
​
string
Profile name from ~/.nx1/profiles.
​
integer
Requests when to timeout. Default is 30.
​
Verbose output.

​
wait

The wait subcommand waits for a specific job to complete.
​
string
required
Unique ID of the job to wait for.
​
string
required
Number of seconds between status checks. Default: 5.
​
int
required
Maximum number of seconds to wait for the job to complete. Default: 300.
​
string
API key or the NX1_API_KEY variable.
​
string
YAML config file.
​
Shows help messages and exit.
​
string
API host.
​
Disables SSL verification.
​
string
Output format. Allowed values: json, yaml, or table.
​
string
Profile name from ~/.nx1/profiles.
​
integer
Requests when to timeout. Default is 30.
​
Verbose output.