Command-Line Interface

Describes how the MapR CLI command syntax is documented.

The MapR CLI commands are documented using the following conventions:

  • [Square brackets] indicate an optional parameter
  • <Angle brackets> indicate a value to enter

The following syntax example shows that the volume mount command requires the -name parameter, for which you must enter a list of volumes, and all other parameters are optional:

maprcli volume mount
      [ -cluster <cluster> ]
      -name <volume list>
      [ -path <path list> ]

For clarity, the syntax examples show each parameter on a separate line; in practical usage, the command and all parameters and options are typed on a single line. Example:

maprcli volume mount -name test-volume -path /test