CSCLI Reference (Release 2.1.0)

Explains CSCLI modes and handling of invalid parameters for ClusterStor systems.

CLI commands are organized by mode; certain commands are available depending on the mode (state) of the ClusterStor system. Two modes are relevant to customers: Site Configuration Mode and Daily Mode. A third mode, OEM Mode, is relevant only to Manufacturing and factory personnel. OEM Mode commands are not included in this document.

Site Configuration Mode/CustWizard Mode/Pre-Shipment Mode

Site Configuration (custWizard) Mode (also called "Pre-Shipment" mode) commands are available after the ClusterStor system has been fully provisioned and before the system runs in Daily Mode. These commands enable users to specify customer configuration settings, apply or reset network cluster settings, obtain FRU information, upgrade ClusterStor software on Lustre nodes, and toggle between Site Configuration and Daily Modes.

Daily Mode

Daily Mode commands are available after the ClusterStor system has been fully provisioned and configured for customer use. These commands enable users to fully manage the Lustre file system and cluster nodes, including mount/unmount, power-cycle, failover/failback, and control node filters and exports. Daily Mode commands also enable users to obtain FRU information and upgrade ClusterStor software on Lustre nodes.

Guest Mode

A guest account allows non-privileged users to run some commands to obtain information about the system, using read-only access to the system. Depending on the privileges, a subset of CSCLI commands is provided for a guest account.

Set the Mode

Determine which mode is active:

cscli cluster_mode –s

To change modes, run one of the following:

cscli cluster_mode --mode daily
cscli cluster_mode --mode custwiz

How CSCLI Handles Invalid Parameters

If CSCLI detects multiple invalid parameters, it may report an error for only one of them. After fixing the designated error and re-entering the command, an error is reported for the next invalid parameter, and so on.

For example, if there is a sequence of validation, when the validation of the first argument fails, the validation of upcoming arguments stops and an exception is raised.
Important: For all CSCLI commands, exercise caution before using the -y or --force  parameters, even if they are required.

Summary of Changes for Release 2.1.0

Please note:
  • The CNG feature is not supported in Release 2.1.0. To avoid confusion, the section on CNG-specific CSCLI commands has been removed from this document.
  • In Release 2.1.0, optional Additional DNE Units (ADUs) are now referred to as optional additional Metadata Management Units (MMUs). CSCLI commands that were previously used for ADUs are applicable to MMUs.

DailyMode – CSCLI Commands Added in Release 2.1.0

The following commands were added, changed, or removed in this software release 2.1.0:

Addition/ChangeCSCLI CommandDescriptionComponent
Addednetwork ean secondaryEAN Secondary interface configurationNetwork
Addednetwork ean routeEAN routing configurationNetwork
Addedssh_portSpecify SSH TCP port settingsNetwork
Addedremove_unitRemove unit(s) from clusterNode Control

Summary of Changes for Release 2.0.0

The following table shows commands that were added or changed in the previous release:
Addition/ChangeCLI CommandDescriptionComponent
Addedasync_journalEnables/Queries/Disables asynchronous journal for OST targetsOST Target
Addedconfigure_mdsConfigures MDS nodes (as part of ADU addition)ADU
Updatedservice_consoleConfigure service consoleServiceability
Updatedsupport_bundleAdditional log files are available in the support bundle for MDRAID examine output and Lustre users/groups or local users/groups for CNG nodes.Support Bundle Settings
Addedlustre_networkLustre network (HSN) IP addresses management.Lustre
Addedlist_rangesList ranges of IPs for HSNLustre
Addedfind_gapsShow unused IPs in ranges of HSNLustre
Addedadd_rangeAdd new range of IPs into HSNLustre
Addedextend_rangeExtend range of IPs for HSNLustre
Addedremove_rangeRemove range of IPs for HSNLustre
Addedlustre_perfThese commands are used to view the Lustre performanceLustre
Addedshow_new_nodesDisplays the nodes in ADUs when they are added to a systemADU
Added to existing CSCLI commandconfigure_hostsNodes in the ADU (MDS nodes) can be configured via this commandADU
Added to existing CSCLI commandshow_nodesNodes in the ADU (MDS nodes) will also display along with OSS nodesADU
Added to existing CSCLI commandfs_infoFile System information of nodes (MDS) in the ADU will also displayADU
AddedrackExtends the functionality of cscli get_rack_position and set_rack_position Rack
AddedUD CommandsUnresponsive Drives CommandsDisk Drive
AddeddmDM Service Configuration ManagementDisk Drive
AddeddwdDWD - Daemon Configuration ManagementDisk Drive