schedule_stop
coder schedule stop
Edit workspace stop schedule
Synopsis
Schedules a workspace to stop after a given duration has elapsed.
- Workspace runtime is measured from the time that the workspace build completed.
- The minimum scheduled stop time is 1 minute.
- The workspace template may place restrictions on the maximum shutdown time.
- Changes to workspace schedules only take effect upon the next build of the workspace, and do not affect a running instance of a workspace.
When enabling scheduled stop, enter a duration in one of the following formats:
- 3h2m (3 hours and two minutes)
- 3h (3 hours)
- 2m (2 minutes)
- 2 (2 minutes)
coder schedule stop <workspace-name> { <duration> | manual } [flags]
Examples
[48;2;235;229;236m [0m[38;2;255;70;113;48;2;235;229;236m$ coder schedule stop my-workspace 2h30m[0m[48;2;235;229;236m [0m
Options
-h, --help help for stop
Options inherited from parent commands
--global-config coder Path to the global coder config directory.
[38;2;88;88;88mConsumes $CODER_CONFIG_DIR[0m (default "/home/coder/.config/coderv2")
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
[38;2;88;88;88mConsumes $CODER_HEADER[0m
--no-feature-warning Suppress warnings about unlicensed features.
[38;2;88;88;88mConsumes $CODER_NO_FEATURE_WARNING[0m
--no-version-warning Suppress warning when client and server versions do not match.
[38;2;88;88;88mConsumes $CODER_NO_VERSION_WARNING[0m
--token string Specify an authentication token. For security reasons setting CODER_SESSION_TOKEN is preferred.
[38;2;88;88;88mConsumes $CODER_SESSION_TOKEN[0m
--url string URL to a deployment.
[38;2;88;88;88mConsumes $CODER_URL[0m
-v, --verbose Enable verbose output.
[38;2;88;88;88mConsumes $CODER_VERBOSE[0m
SEE ALSO
- coder schedule - Schedule automated start and stop times for workspaces
Auto generated by spf13/cobra on 26-Jan-2023
See an opportunity to improve our docs? Make an edit.