This page is a quick reference for common CFS 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.
For more information about the CFS API, see Configuration Framework Service.
(ncn-mw#) Create or update a configuration:
cray cfs v3 configurations update <example-config> --file <./example-config.json>
See CFS Configurations for more information.
(ncn-mw#) Enable or disable automatic configuration for a component:
cray cfs v3 components update <xname> --enabled <true/false>
(ncn-mw#) Set the desired configuration for a component:
cray cfs v3 components update <xname> --desired-config <example-config>
(ncn-mw#) Clear the state of a component:
If this component has a desired configuration set, then this will trigger automatic configuration. See Automatic Configuration Management for more details.
cray cfs v3 components update <xname> --enabled true --state []
(ncn-mw#) View basic information about component status:
cray cfs v3 components describe <xname>
(ncn-mw#) View the list of all playbooks applied to a component:
cray cfs v3 components describe <xname> --state-details true
With CSM release 1.6.2 or later and craycli version 0.90.1 or later, users can update multiple components at once by using the updatemany command.
To check the version of the installed craycli run following command.
rpm -q craycli
(ncn-mw#) Enable or disable automatic configuration for a list of components:
cray cfs v3 components updatemany --filter-ids <xname1>,<xname2>,... --enabled <true/false>
(ncn-mw#) Set the desired configuration for a list of components:
cray cfs v3 components updatemany --filter-ids <xname1>,<xname2>,... --desired-config <example-config>
(ncn-mw#) Clear the state on a list of components:
For any of these components with a desired configuration set, this will trigger automatic configuration. See Automatic Configuration Management for more details.
cray cfs v3 components updatemany --filter-ids <xname1>,<xname2>,... --enabled true --state []
(ncn-mw#) Enable or disable automatic configuration for a list of components based on status:
cray cfs v3 components updatemany --filter-status <status> --enabled <true/false>
(ncn-mw#) Enable or disable automatic configuration for a list of components based on their configuration flag:
cray cfs v3 components updatemany --filter-enabled <true/false> --enabled <true/false>
(ncn-mw#) Enable or disable automatic configuration for a list of components based on their tag:
cray cfs v3 components updatemany --filter-tags <key1=value1>,<key2=value2>,... --enabled <true/false>
(ncn-mw#) Enable or disable automatic configuration for a list of components based on configuration name:
cray cfs v3 components updatemany --filter-config-name <configuration name> --enabled <true/false>
(ncn-mw#) Enable or disable automatic configuration for a list of components based on ID and their configuration flag:
cray cfs v3 components updatemany --filter-ids <xname1>,<xname2>,... --filter-enabled <true/false> --enabled <true/false>
See CFS Components for more information.
(ncn-mw#) Create a node personalization session:
cray cfs v3 sessions create --name <session name> --configuration-name <config name> --ansible-limit <xname1,xname2,...>
(ncn-mw#) Customize an image:
cray cfs v3 sessions create --name <session name> --configuration-name <config name> --target-definition image --target-group <group name, e.g. Compute> <source image id>
(ncn-mw#) Customize an image and specify the name of the resulting image:
cray cfs v3 sessions create --name <session name> --configuration-name <config name> --target-definition image --target-group <group name, e.g. Compute> <source image id> --target-image-map <source image id> <resulting image name>
(ncn-mw#) View session status:
cray cfs v3 sessions describe <session name>
(ncn-mw#) Delete a session:
cray cfs v3 sessions delete <session name>
See CFS Sessions for more information.
(ncn-mw#) Create a session that will remain after failure:
cray cfs v3 sessions create --name <session name> --configuration-name <config name> --ansible-limit <xname1,xname2,...> --debug-on-failure true
(ncn-mw#) Customize an image customization session that will remain after failure:
cray cfs v3 sessions create --name <session name> --configuration-name <config name> --target-definition image --target-group <group name, e.g. Compute> <source image id> --debug-on-failure true
(ncn-mw#) Create a test session for debugging from an Ansible container:
cray cfs v3 sessions create --name <session name> --configuration-name debug_fail --debug-on-failure true
See Troubleshoot CFS Issues for more information.