Syntax Conventions

You will use the Appliance Controller to configure and manage NAS, iSCSI, and SNMP. The controller console has predefined tasks that you invoke through parameters. Parameters are comprised of objects, commands, options, and values that follow specific syntax conventions.

Parameters are made up of the following components.

Object

An object provides the item on which to perform the action, such as share or nascluster.

Commands (cmd)

A command provides an action to be performed, such as add, delete, or enable.

Options

Options are additional objects to which to apply the command, such as node. Not all commands have options.

Values

Values further define objects and options, such as providing the IP address for the node option. Values immediately follow the command or the option. Not all commands have values.

The syntax for CLI commands uses one of the following formats:

object cmd

object cmd option

object cmd <value>...

object cmd option <value>...

object cmd <value> option...

 

Syntax Characters

The following syntax characters are used in CLI commands.

Character

Description

< >

Angle brackets surrounding a value indicates that you need to replace it with an appropriate value.

Example

nascluster enable node <ip_addr>

The above command has the following components:

  • Object (nascluster)
  • Command (enable)
  • Option (node)
  • Value requiring an appropriate replacement (<ip_addr>)

Enter the command as follows, where 10.1.1.1 is the IP address of the node to enable for the NAS cluster:

nascluster enable node 10.1.1.1

[ ]

Square brackets surrounding options or values indicate that it is not mandatory to enter an option or value. If you do not specify an option or value, the CLI provides a default replacement.

Example

iscsi assign <ipaddr> [<username> <password>]

The above command has the following components:

  • Object (iscsi)
  • Command (assign)
  • Value requiring an appropriate replacement (<ip_addr>)
  • Options that you can use to define additional attributes (<username><password>)

Enter the command as follows, where iscsiadmin is the user name and newP@ssW0rd is the password.

iscsiadm assign 10.40.111.222 iscsiadmin newP@ssW0rd

|

The pipe character indicates that you need to specify only one of the possible options or values. Read this character as "OR".

( )

Parentheses surrounding options indicate that you must specify one or more of the displayed options.

Example

snmp agent enable (default | stornext | open-manage)

In the above command, you must specify whether to enable the default agent, StorNext agent, or Dell OpenManage agent.

{ }

Curly brackets are used to group options or values for readability purposes. Do not use these characters in the actual command.

,

A comma indicates that you can specify multiple options. Place a comma after each option to separate it from the next.