Command Prompt Conventions

Conventions for ClusterStor prompts, host names, user names, and the Lustre filesystem name in command examples

Host Names and Accounts in Command Prompts

The host name in a command prompt indicates where the command must be run. The account that must run the command is also indicated in the prompt.
  • The root or super-user account always has the # character at the end of the prompt.
  • Any non-root account is indicated with a $. A user account that is neither root nor admin is referred to as user.
MGMT0#Run the command on the primary ClusterStor management node as root.
MGMT0$Run the command on the primary ClusterStor management node as admin.
MGMT1#Run the command on the secondary ClusterStor management node as root.
MGMT1$Run the command on the secondary ClusterStor management node as admin.
OSS#Run the command on an OSS node as root.
OSS$Run the command on an OSS node as a non-root user.
MGS#Run the command on an MGS node as root.
MGS$Run the command on an MGS node as a non-root user.
MDS#Run the command on an MDS node as root.
MDS$Run the command on an MDS node as a non-root user.
client$Run the command on a Lustre client node as any non-root user.
client#Run the command on a Lustre client node as root.
user@hostname$Run the command on the specified system as a non-root user.

Sample commands and command output used throughout this publication are shown with a generic filesystem name of cls12345.

Lustre filesystem names

The name of the Lustre filesystem seen in command examples is cls12345, and is mounted by Lustre clients at /lus, as demonstrated by the command below:
client$ lfs df -h
UUID                        bytes        Used   Available  Use% Mounted on
cls12345-MDT0000_UUID         2.0T       59.1G        1.9T   4% /lus[MDT:0]
cls12345-MDT0001_UUID         2.0T       97.6M        1.9T   1% /lus[MDT:1]
cls12345-OST0000_UUID       112.0T        5.1T      105.8T   5% /lus[OST:0]
cls12345-OST0001_UUID       112.0T        5.1T      105.8T   5% /lus[OST:1]
cls12345-OST0002_UUID        15.3T      425.8G       14.8T   3% /lus[OST:2]
cls12345-OST0003_UUID        15.3T      423.4G       14.8T   3% /lus[OST:3]

filesystem_summary:       254.6T       11.0T      241.1T   5% /lus

Directory Path in Command Prompt

Example prompts do not include the directory path, because long paths can reduce the clarity of examples. Most of the time, the command can be executed from any directory. When it matters which directory the command is invoked within, the cd command is used to change into the necessary directory.

For example, here are actual prompts as they appear on the system: 
client:~ # cd /etc 
client:/etc# cd /var/tmp 
client:/var/tmp# ls file
or
[root@cls12345n000 ~]# cd /etc 
[root@cls12345n000 etc]# cd /var/tmp
[root@cls12345n000 tmp]# ls file

And here are the same prompts as they appear in this publication: 
client# cd /etc 
client# cd /var/tmp 
client# ls file
or
cls12345n000# cd /etc 
cls12345n000# cd /var/tmp
cls12345n000# ls file