This page is a quick reference for common BOS commands in the Cray CLI.
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.
(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
(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>
(ncn-mw#
) Monitor the overall boot progress of a single node:
watch "cray bos v2 components describe <node's xname>"
(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
(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>