Skip to content

Latest commit

 

History

History
101 lines (65 loc) · 2.49 KB

Cheatsheet.md

File metadata and controls

101 lines (65 loc) · 2.49 KB
Raw

BOS Commands Cheat Sheet

This page is a quick reference for common BOS CLI commands.

To find the API versions of any commands listed, add -vvv to the end of the CLI command, and the CLI will print the underlying call to the API in the output.

BOS v2 commands

Full system commands (v2)

(ncn-mw#) Boot all nodes in a template:

cray bos v2 sessions create --template-name SESSION_TEMPLATE_NAME --operation Boot

(ncn-mw#) Reboot all nodes in a template:

cray bos v2 sessions create --template-name SESSION_TEMPLATE_NAME --operation Reboot

(ncn-mw#) Shutdown all nodes in a template:

cray bos v2 sessions create --template-name SESSION_TEMPLATE_NAME --operation Shutdown

(ncn-mw#) Stage a reboot for all nodes in a template:

cray bos v2 sessions create --template-name SESSION_TEMPLATE_NAME --operation Reboot --staged True

Single node commands (v2)

(ncn-mw#) Boot a single node:

cray bos v2 sessions create --template-name SESSION_TEMPLATE_NAME --operation Boot --limit <node's xname>

(ncn-mw#) Reboot a single node:

cray bos v2 sessions create --template-name SESSION_TEMPLATE_NAME --operation Reboot --limit <node's xname>

(ncn-mw#) Shutdown a single node:

cray bos v2 sessions create --template-name SESSION_TEMPLATE_NAME --operation Shutdown --limit <node's xname>

(ncn-mw#) Stage a reboot for a single node:

cray bos v2 sessions create --template-name SESSION_TEMPLATE_NAME --operation Reboot --staged True --limit <node's xname>

BOS v1 commands

Full system commands (v1)

(ncn-mw#) Boot all nodes in a template:

cray bos v1 session create --template-name SESSION_TEMPLATE_NAME --operation Boot

(ncn-mw#) Reboot all nodes in a template:

cray bos v1 session create --template-name SESSION_TEMPLATE_NAME --operation Reboot

(ncn-mw#) Shutdown all nodes in a template:

cray bos v1 session create --template-name SESSION_TEMPLATE_NAME --operation Shutdown

Single node commands (v1)

(ncn-mw#) Boot a single node:

cray bos v1 session create --template-name SESSION_TEMPLATE_NAME --operation Boot --limit <node's xname>

(ncn-mw#) Reboot a single node:

cray bos v1 session create --template-name SESSION_TEMPLATE_NAME --operation Reboot --limit <node's xname>

(ncn-mw#) Shutdown a single node:

cray bos v1 session create --template-name SESSION_TEMPLATE_NAME --operation Shutdown --limit <node's xname>