User Interaction

The User Interaction section consists of the following subsections:

Types of Commands

Command output depends on the nature of the service and result of the command's execution. This section consists of the following subsections:

Informative Commands

Informative commands provide information about an object's state or configuration.

They list objects:

VTL> customer list
Admin
John

They list objects based on a given range:

VTL> vtape list [index] [count] 
VTL> vtape list index=10 count=5 
vlib1_vol11
vlib1_vol12
vlib1_vol13
vlib1_vol14
vlib1_vol15

Note

  • Both index and count are optional parameters.

  • The default value of index is 0.

  • The default value of count is all entries.

Use informative commands to obtain information about objects. You can specify that the output appear in any of the following formats:

  • XML format

  • Simple name format

  • Parsable name format

  • Tabular format

The following is an example of XML format:

VTL> display format xml
VTL> customer show John
<customer> <name>John</name> <id>104</id> <contact>John Smith</contact>
<day_phone>12345678</day_phone> <night_phone>87654321</night_phone>
<mobile_phone>9988776655</mobile_phone> <pager>5566778899</pager></customer>

The following is an example of simple name format (with a value pair per line):

 VTL> display format simple
VTL> customer show John
                      Name: John
               Customer ID: 104
        Allocated Capacity: 5 GB
             Used Capacity: 1.2 GB
              Contact Name: John Smith  
                 E-Mail ID: johns@netapp.com
                 Day Phone: 12345678
               Night Phone: 87654321
                    Mobile: 9988776655
                     Pager: 5566778899

The following is an example of parsable name format (with value pairs separated by the or symbol (|) for scripting purposes):

VTL> display format parsable
VTL> customer show John
Name: John|Customer ID: 104|Allocated Capacity: 5 GB|Used Capacity: 
1.2 GB|Contact Name: John Smith|E-Mail ID: johnx@netapp.com|Day Phone: 
12345678|Night Phone: 87654321| Mobile: 9988776655|Pager:  5566778899

The following is an example of tabular format:

VTL> display format tabular
VTL> customer show John
Name    CustomerID  E-Mail ID       DayPhone   NightPhone   Mobile
John    104         john@abc.com    12345678   87654321     1234        
Tom     58          tom@xyz.com     11223344   55667788     4321        

When you want to use a display format command to control the output of another command, you can enter the commands separately, as shown in the previous examples. However, as an alternative, you can enter both commands at the same time, provided that they are separated by a semicolon, as shown:

VTL> display format parsable;customer show John
Name: John|Customer ID: 104|Allocated Capacity: 5 GB|Used Capacity: 
1.2 GB|Contact Name: John Smith|E-Mail ID: johnx@netapp.com|Day Phone: 
12345678|Night Phone: 87654321| Mobile: 9988776655|Pager:  5566778899

Configuration Commands

Use configuration commands to create objects, remove objects, or update existing objects in the appliance.

The following is an example of how to create an object:

VTL> customer add John passwd 456 “John S”

The following is an example of how to remove an object:

VTL> customer remove John

The following is an example of how to update object information:

VTL> customer update John customer_id

Note

The user can specify only the fields to be updated.

The following is an example of how to set the password:

VTL> customer set_passwd
Enter new password>***** 
Confirm password>***** 

Note

The password should not be cleartext.

Command Errors

In case of command error, the system displays a message, as shown:

Error: Error Message 

Note

Error: precedes all error messages.

This section consists of the following subsections:

Execution Errors

Execution errors are described, as shown:

VTL> customer remove ABCD
Error: Customer not found

Syntax Errors

Syntax errors are displayed with a usage message, as in the following examples.

This example shows the result of a request for an object or service that does not exist:

VTL> virtual list
Error: Invalid Command

This example shows the result of a user providing fewer parameters than required:

VTL> sp add SP1
Error: Insufficient Parameters
Add a Storage Pool to the Appliance.
Usage: sp add name description

This example shows the result of a user providing superfluous parameters:

VTL> sp add SP1 "new storage pool" temp
Error: Superfluous Parameters
Add a Storage Pool to the Appliance.
Usage: sp add name description

This example shows the result of a user providing two or more values for the same parameter:

VTL> snmp set station=1.2.3.4 station=4.5.6.7
Error: Duplicate Params
Update SNMP Configuration.
Usage: snmp set [station] [community] [version] [enable]

This example shows the result of a user providing a parameter that is not supported:

VTL> snmp set station=1.2.3.4 client=5.6.7.8
Error: Invalid Parameters
Update SNMP Configuration.
Usage: snmp set [station] [community] [version] [enable]

This example shows the result of a user providing a parameter value that is invalid:

VTL> snmp set station=snmp_server
Error: Invalid Values assigned to Parameters
Update SNMP Configuration.
Usage: snmp set [station] [community] [version] [enable]

Copyright © 1994-2006, Network Appliance, Inc. All rights reserved.
Part number 210-03617_A0
Comments