Contents

Commands

vakna suspend: suspend a box

Note
This page is generated from a mock CLI, and its numbers are placeholders.

Verified against vakna 0.0.0-mock on · generated from the CLI's own definitions

vakna suspend: suspend a box; its processes and ports wait, compute isn't billed. Proposed: the real CLI doesn't have this command yet.

Synopsis

sh
vakna suspend <box>

Flags

Flag Default What it does
--format <format> text text, or json: one JSON object per line
--json off the same as --format json
-h, --help off this help

Examples

Example

sh
vakna suspend web
prints suspended web · compute not billed until it resumes 0.14s

Exit code 0.

Another example

sh
vakna suspend web --format json
prints {"v":1,"event":"suspended","box":"web","id":"sbx_eu1a_01JB81M3N4P5Q6R7S8T9V0W1X2","ms":140,"mocked":true}

Exit code 0.

When it fails

sh
vakna suspend apj
prints vakna: no box "apj" hint: vakna list # did you mean api?

Exit code 1.

Exit codes

Code Meaning
0 ok
1 vakna failed; under shell, run, try or fork, the command in the box failed
2 usage: a missing argument, an unknown flag or command

JSON output

With --format json (or --json) every line is one JSON object. v is the format's version; mocked marks numbers from the mock.

sh
vakna suspend web --format json
prints {"v":1,"event":"suspended","box":"web","id":"sbx_eu1a_01JB81M3N4P5Q6R7S8T9V0W1X2","ms":140,"mocked":true}

Errors

--help

This page and the help text come from one definition.

Output
vakna suspend · suspend a box; its processes and ports wait, compute isn't billed Proposed: the real CLI doesn't have this command yet. usage vakna suspend <box> flags --format <format> text, or json: one JSON object per line (default: text) --json the same as --format json (default: off) -h, --help this help (default: off) examples vakna suspend web vakna suspend web --format json exit codes 0 ok 1 vakna failed; under shell, run, try or fork, the command in the box failed 2 usage: a missing argument, an unknown flag or command

View as Markdown