The nctl experiment cancel command stops and cancels any experiment queued or in progress. Furthermore, the command also cancels any experiment based on the name of an experiment/pod/status of a pod. If any such object is found, the command queries these objects (one or more) and should be cancelled.
This section discusses the following main topics:
- Cancelling One or More Experiments
- Cancelling All Experiments with a Matching Pod-ID
- Cancelling All Experiments with a Matching Pod-Status
- Purging an Experiment
- Cancelling one more More Experiments Using the force Command
The nctl experiment cancel command stops and cancels any experiment queued or in progress. Furthermore, the command also cancels any experiment based on the name of an experiment/pod/status of a pod. If any such object is found, the command queries if these objects (one or more) and should be cancelled.
To cancel one or more experiments, execute the following command:
nctl experiment cancel [options] EXPERIMENT-NAME
The value of this argument should be created using rules described here. Use this command to cancel one or more experiments with matching or partially-matching names, a matching pod ID, matching pod status, or combinations of these criteria. For example, the following command will cancel all experiments with a matching or partially matching name:
Syntax: nctl experiment cancel --match EXPERIMENT-NAME
The following command will cancel all experiments with a matching pod-ID, using one or more comma-separated IDs:
Syntax: nctl experiment cancel –-pod-ids [pod_ID] EXPERIMENT-NAME
The following command will cancel all experiments with a matching pod-status, using one of the following statuses: [PENDING, RUNNING, SUCCEEDED, FAILED, UNKNOWN]:
nctl experiment cancel --pod-status [PENDING, RUNNING, SUCCEEDED, FAILED, UNKNOWN] EXPERIMENT-NAME
Note: Any of the above criteria can be combined.
You can also purge all experiment-related information using the -p or --purge option. For purge information, refer to Purging.
To cancel one or more experiments with the force command, execute the following command:
nctl experiment cancel -f [options] EXPERIMENT-NAME