Instructions - Onstor Command Line

ONStor™ Bobcat 2200 Series
NAS Gateway
Command Reference
Customer Order Number: ONS-DOC-CR-2200, Rev E1

Text Part Number: 690-0013-0001E1
ONStor, Inc.
254 East Hacienda Ave.
Campbell, CA USA 95008
(408) 963-2400
Copyright © 2005-2007 ONStor, Incorporated. All rights reserved.
This document exists for use with the products of ONStor, Inc. and is intended for use by employees,
representatives, assigns, and clientele of ONStor, Inc. This document cannot be copied, reproduced,
transmitted, or stored electronically, in part or in whole, without first obtaining the express consent and
agreement of ONStor, Inc.
This document can contain the names of products and services of other companies. Such products and
services are the property of their owners, and ONStor, Inc. makes no implications or claims, express or
implicit, to the ownership of such products and services. ONStor, Inc. has, in good faith, made efforts to
represent trademarked and copyrighted products and services as the property of their respective owners.
Contents
Chapter 1: Admin Password Command...................................................1-1

Admin Password ................................................................................................................... 1-2
Chapter 2: ARP Commands ......................................................................2-1

ARP Add ............................................................................................................................... 2-2
ARP Delete............................................................................................................................ 2-4
ARP Show ............................................................................................................................. 2-6
Chapter 3: Auditing Commands ...............................................................3-1

Audit Clear ............................................................................................................................ 3-2
Audit Disable......................................................................................................................... 3-3
Audit Enable.......................................................................................................................... 3-4
Audit Set Circular.................................................................................................................. 3-5
Audit Set Fail Flag ................................................................................................................ 3-8
Audit Set Failure Privilege.................................................................................................. 3-10
Audit Set File Size............................................................................................................... 3-12
Audit Set Success Privilege................................................................................................. 3-14
Audit Show Config.............................................................................................................. 3-17
Audit Show Log .................................................................................................................. 3-18
Audit Unset Failure Privileges ............................................................................................ 3-21
Audit Unset Success Privilege ............................................................................................ 3-26
Chapter 4: Autosupport Commands ........................................................4-1

Autosupport Clear Statistics.................................................................................................. 4-2
Autosupport EMRS Proxy Disable ....................................................................................... 4-2
Autosupport EMRS Proxy Enable ........................................................................................ 4-3
690-0013-0001E1 ONStor™ 2200 Series NAS Gateway Command Reference

Autosupport EMRS Send Disable ......................................................................................... 4-6
Autosupport EMRS Send Enable .......................................................................................... 4-6
Autosupport EMRS Show Config ......................................................................................... 4-7
Autosupport Email From....................................................................................................... 4-9
Autosupport Email Note To ................................................................................................ 4-10
Autosupport Email To ......................................................................................................... 4-11
Autosupport Email Server ................................................................................................... 4-13
Autosupport Generate Report.............................................................................................. 4-14
Autosupport Schedule ......................................................................................................... 4-14
Autosupport Show Config................................................................................................... 4-20
Autosupport Show Statistics................................................................................................ 4-21
Autosupport State Enable or Disable .................................................................................. 4-25
Chapter 5: CIFS Commands......................................................................5-1

CIFS Server Create................................................................................................................ 5-2
CIFS Server Delete................................................................................................................ 5-2
CIFS Server Show ................................................................................................................. 5-3
CIFS Share Add..................................................................................................................... 5-4
CIFS Share Delete ............................................................................................................... 5-12
CIFS Share Modify.............................................................................................................. 5-13
CIFS Show........................................................................................................................... 5-21
Chapter 6: CIFS-GNS Commands.............................................................6-1

GNS Add Directory............................................................................................................... 6-2
GNS Add Junction................................................................................................................. 6-5
GNS Add Root ...................................................................................................................... 6-7
GNS Delete.......................................................................................................................... 6-12
GNS Modify Directory........................................................................................................ 6-14
GNS Modify Junction.......................................................................................................... 6-18
GNS Modify Root ............................................................................................................... 6-21
GNS Show ........................................................................................................................... 6-27
Chapter 7: Cluster Commands..................................................................7-1

Cluster Add NAS Gateway ................................................................................................... 7-2
Cluster Add Group ................................................................................................................ 7-4
ONStor™ 2200 Series NAS Gateway Command Reference 690-0013-0001E1

Cluster Commit ..................................................................................................................... 7-5
Cluster Delete NAS Gateway................................................................................................ 7-6
Cluster Delete Group............................................................................................................. 7-8
Cluster Move NAS Gateway................................................................................................. 7-9
Cluster Show Cluster........................................................................................................... 7-11
Cluster Show Group ............................................................................................................ 7-13
Cluster Show Summary....................................................................................................... 7-14
Cluster Uncommit ............................................................................................................... 7-16
Chapter 8: Domain Commands.................................................................8-1

Domain Add LDAP............................................................................................................... 8-2
Domain Add NIS................................................................................................................... 8-6
Domain Add Windows.......................................................................................................... 8-8
Domain Delete..................................................................................................................... 8-13
Domain Modify LDAP........................................................................................................ 8-15
Domain Modify LDAP Schema.......................................................................................... 8-19
Domain Modify NIS............................................................................................................ 8-25
Domain Modify Windows................................................................................................... 8-27
Domain Show...................................................................................................................... 8-30
Domain Show LDAP Schema............................................................................................. 8-33
Domain Verify LDAP ......................................................................................................... 8-34
Domain Verify NIS ............................................................................................................. 8-37
Chapter 9: Elog Commands ......................................................................9-1

Elog Clear Log ...................................................................................................................... 9-2
Elog Display Enable or Disable ............................................................................................ 9-2
Elog Facility Level ................................................................................................................ 9-3
Elog Find ............................................................................................................................... 9-4
Elog Host............................................................................................................................... 9-7
Elog Level ............................................................................................................................. 9-8
Elog Show Config ............................................................................................................... 9-10
Elog Show Log.................................................................................................................... 9-11
Elog State Enable or Disable............................................................................................... 9-14
Chapter 10: Filesystem Commands .......................................................10-1

Filesystem Convert.............................................................................................................. 10-3
Filesystem Quota Disable.................................................................................................... 10-3
Filesystem Quota Enable..................................................................................................... 10-5
Filesystem Quota Group Config.......................................................................................... 10-7
Filesystem Quota Group Set.............................................................................................. 10-14
Filesystem Quota Group Show.......................................................................................... 10-19
Filesystem Quota Log Clear.............................................................................................. 10-23
Filesystem Quota Log Facility .......................................................................................... 10-24
Filesystem Quota Log Host ............................................................................................... 10-25
Filesystem Quota Log Show ............................................................................................. 10-26
Filesystem Quota Log Show Config ................................................................................. 10-28
Filesystem Quota Tree Config........................................................................................... 10-29
Filesystem Quota Tree Remove ........................................................................................ 10-34
Filesystem Quota Tree Set................................................................................................. 10-36
Filesystem Quota Tree Show............................................................................................. 10-40
Filesystem Quota User Config .......................................................................................... 10-45
Filesystem Quota User Set ................................................................................................ 10-51
Filesystem Quota User Show ............................................................................................ 10-55
Filesystem Revert .............................................................................................................. 10-59
Filesystem Show Stats Cache............................................................................................ 10-59
Filesystem Show Stats Cache Hash................................................................................... 10-64
Filesystem Show Stats Cache Verbose.............................................................................. 10-73
Filesystem Stats Performance............................................................................................ 10-83
Filesystem Show Stats Performance Daemon................................................................... 10-87
Filesystem Show Stats Performance I/O ........................................................................... 10-94
Filesystem Show Stats Resource ..................................................................................... 10-100
Chapter 11: ID Mapping Commands.......................................................11-1

ID Map Delete ..................................................................................................................... 11-2
ID Map Edit......................................................................................................................... 11-4
ID Map Insert ...................................................................................................................... 11-7
ID Map Notify Change...................................................................................................... 11-11
ID Map Show .................................................................................................................... 11-13
Chapter 12: Interface Commands ...........................................................12-1

Interface Create ................................................................................................................... 12-2

Interface Delete ................................................................................................................... 12-5
Interface Modify.................................................................................................................. 12-6
Interface Show................................................................................................................... 12-10
Chapter 13: Localmap Commands .........................................................13-1

Localmap Edit ..................................................................................................................... 13-2
Localmap Import ................................................................................................................. 13-3
Chapter 14: Logical Ports Commands ...................................................14-1

Lport Create......................................................................................................................... 14-2
Lport Delete......................................................................................................................... 14-6
Lport Modify ....................................................................................................................... 14-7
Lport Prefer ....................................................................................................................... 14-11
Lport Show........................................................................................................................ 14-14
Chapter 15: LUN Commands...................................................................15-1

LUN Label........................................................................................................................... 15-2
LUN Rescan ........................................................................................................................ 15-4
LUN Show........................................................................................................................... 15-5
LUN Show All .................................................................................................................... 15-8
LUN Show Device ............................................................................................................ 15-11
LUN Show Disk ................................................................................................................ 15-14
LUN Show Port................................................................................................................. 15-18
LUN Show Tape................................................................................................................ 15-21
LUN Topology .................................................................................................................. 15-23
LUN Unlabel ..................................................................................................................... 15-24
Chapter 16: Mirror Commands................................................................16-1

Mirror Create....................................................................................................................... 16-2
Mirror Delete....................................................................................................................... 16-8
Mirror Demote..................................................................................................................... 16-9
Mirror Disable .................................................................................................................. 16-10
Mirror Enable .................................................................................................................... 16-11

Mirror Kill ......................................................................................................................... 16-12
Mirror Modify ................................................................................................................... 16-13
Mirror Pause ...................................................................................................................... 16-16
Mirror Promote.................................................................................................................. 16-18
Mirror Resume................................................................................................................... 16-19
Mirror Reverse................................................................................................................... 16-20
Mirror Schedule................................................................................................................. 16-21
Mirror Show ...................................................................................................................... 16-25
Mirror Start........................................................................................................................ 16-27
Mirror Testconnect ............................................................................................................ 16-29
Chapter 17: NDMP Commands ...............................................................17-1

NDMP Delete Session......................................................................................................... 17-2
NDMP Disable .................................................................................................................... 17-4
NDMP Enable ..................................................................................................................... 17-5
NDMP Reset........................................................................................................................ 17-5
NDMP Set Alternative Tape Model .................................................................................... 17-7
NDMP Set DMA ................................................................................................................. 17-9
NDMP Set Port.................................................................................................................. 17-10
NDMP Set Tape Block Size .............................................................................................. 17-11
NDMP Set Trace ............................................................................................................... 17-14
NDMP Set Version............................................................................................................ 17-15
NDMP Show Configuration .............................................................................................. 17-16
NDMP Show Detail........................................................................................................... 17-17
NDMP Show Log .............................................................................................................. 17-25
NDMP Show Status........................................................................................................... 17-27
NDMP Show Trace ........................................................................................................... 17-37
Chapter 18: NFS Commands...................................................................18-1

NFS Cache Delete Mounts .................................................................................................. 18-2
NFS Cache Show Mounts ................................................................................................... 18-4
NFS Share Add.................................................................................................................... 18-6
NFS Share Delete .............................................................................................................. 18-18
NFS Share Disable ............................................................................................................ 18-19
NFS Share Enable.............................................................................................................. 18-21
NFS Share Modify............................................................................................................. 18-23

NFS Show ......................................................................................................................... 18-35
Chapter 19: Port Commands...................................................................19-1

Port Autonegotiation ........................................................................................................... 19-2
Port Disable ......................................................................................................................... 19-4
Port Enable .......................................................................................................................... 19-6
Port Modify ......................................................................................................................... 19-7
Port Reset ............................................................................................................................ 19-8
Port Show All .................................................................................................................... 19-10
Port Show Detail ............................................................................................................... 19-11
Port Show Loadstats.......................................................................................................... 19-14
Port Show Stats ................................................................................................................. 19-15
Chapter 20: Privilege Commands ...........................................................20-1

Priv Add Allow ................................................................................................................... 20-2
Priv Add Deny..................................................................................................................... 20-8
Priv Delete Allow.............................................................................................................. 20-12
Priv Delete Deny ............................................................................................................... 20-15
Priv Show .......................................................................................................................... 20-18
Chapter 21: Route Commands................................................................21-1

Route Add ........................................................................................................................... 21-2
Route Delete........................................................................................................................ 21-4
Route Show ......................................................................................................................... 21-7
Chapter 22: SCSI Commands..................................................................22-1

SCSI Discover Device......................................................................................................... 22-2
SCSI Discover LUN............................................................................................................ 22-4
SCSI Failback...................................................................................................................... 22-5
SCSI Move .......................................................................................................................... 22-8
SCSI Release Tape ............................................................................................................ 22-10
SCSI Show All .................................................................................................................. 22-11
SCSI Show Arraywwn ...................................................................................................... 22-14

SCSI Show Configuration ................................................................................................. 22-16
SCSI Show Detail.............................................................................................................. 22-17
SCSI Show Stats................................................................................................................ 22-21
Chapter 23: Snapshot Commands..........................................................23-1

Snapshot Create ................................................................................................................... 23-2
Snapshot Delete ................................................................................................................... 23-4
Snapshot Disable ................................................................................................................. 23-6
Snapshot Enable .................................................................................................................. 23-7
Snapshot Pin ........................................................................................................................ 23-8
Snapshot Rename .............................................................................................................. 23-10
Snapshot Revert................................................................................................................. 23-13
Snapshot Schedule............................................................................................................. 23-15
Snapshot Show .................................................................................................................. 23-18
Snapshot Unpin ................................................................................................................. 23-22
Chapter 24: SNMP Commands................................................................24-1

SNMP Add Community ...................................................................................................... 24-2
SNMP Add Trap.................................................................................................................. 24-3
SNMP Add Trapspec........................................................................................................... 24-5
SNMP Delete All................................................................................................................. 24-9
SNMP Delete Community................................................................................................. 24-10
SNMP Delete Trap ............................................................................................................ 24-10
SNMP Delete Trapspec ..................................................................................................... 24-12
SNMP Modify System Location or System Contact......................................................... 24-13
SNMP Show Configuration............................................................................................... 24-15
Chapter 25: Stats Show Ldavg Command .............................................25-1

Stats Show Ldavg ................................................................................................................ 25-2
Chapter 26: Symbolic Link Commands..................................................26-1

Symbolic Link Add ............................................................................................................. 26-2
Symbolic Link Delete.......................................................................................................... 26-5
Symbolic Link Show ........................................................................................................... 26-7

Chapter 27: System Commands .............................................................27-1
System Compare ................................................................................................................. 27-3
System Config Copy ........................................................................................................... 27-5
System Config Reset ........................................................................................................... 27-6
System Config Restore........................................................................................................ 27-8
System Copy All ................................................................................................................. 27-9
System Copy Init............................................................................................................... 27-10
System Create Core Volume ............................................................................................. 27-11
System Create Management Volume................................................................................ 27-13
System Delete Core Volume ............................................................................................. 27-19
System Disable Readahead ............................................................................................... 27-21
System DNSconfigure Hosts............................................................................................. 27-22
System DNSconfigure Resolver........................................................................................ 27-23
System DNSconfigure Show............................................................................................. 27-26
System Enable Readahead ................................................................................................ 27-27
System Get All .................................................................................................................. 27-28
System Get Config ............................................................................................................ 27-34
System Get Logs ............................................................................................................... 27-39
System Get Stats................................................................................................................ 27-42
System Get TSE ................................................................................................................ 27-48
System Halt ....................................................................................................................... 27-53
System Modify Core Dump Max Saved Files .................................................................. 27-54
System Modify Core Dump Off........................................................................................ 27-55
System Modify Core Dump On ........................................................................................ 27-56
System Modify Volumeexceptiondump............................................................................ 27-57
System Ping....................................................................................................................... 27-60
System Reboot................................................................................................................... 27-62
System Show Chassis........................................................................................................ 27-64
System Show Core Dump ................................................................................................. 27-66
System Show Node Name................................................................................................. 27-67
System Show Read Ahead Performance........................................................................... 27-68
System Show Read Ahead State ....................................................................................... 27-69
System Show Summary .................................................................................................... 27-70
System Show Temperature................................................................................................ 27-72
System Show Uptime ........................................................................................................ 27-73
System Show Username.................................................................................................... 27-73
System Show Version ....................................................................................................... 27-74
System Time NTP Disable................................................................................................ 27-77

System Time NTP Server.................................................................................................. 27-78
System Time Set................................................................................................................ 27-80
System Time Show............................................................................................................ 27-82
System Time Zone............................................................................................................. 27-85
System Traceroute ............................................................................................................. 27-88
System Upgrade................................................................................................................. 27-89
System Version.................................................................................................................. 27-93
Chapter 28: Tape Commands..................................................................28-1

Tape Alias Clear .................................................................................................................. 28-2
Tape Alias Set...................................................................................................................... 28-3
Tape Alias Show.................................................................................................................. 28-4
Tape Close ........................................................................................................................... 28-5
Tape Display Device List .................................................................................................... 28-6
Tape Display Device State ................................................................................................ 28-11
Tape Display Media Changer List..................................................................................... 28-12
Tape Media Changer Alias Clear ...................................................................................... 28-13
Tape Media Changer Alias Set.......................................................................................... 28-14
Tape Media Changer Alias Show...................................................................................... 28-16
Tape Release...................................................................................................................... 28-16
Chapter 29: User Account Commands...................................................29-1

Useraccount Add ................................................................................................................. 29-2
Useraccount Delete.............................................................................................................. 29-4
Useraccount Modify Password............................................................................................ 29-5
Useraccount Show ............................................................................................................... 29-7
Chapter 30: Virtual Server Commands...................................................30-1

Virtual Server Clear............................................................................................................. 30-2
Virtual Server Clear Autocreate .......................................................................................... 30-2
Virtual Server Clear Domain............................................................................................... 30-3
Virtual Server Set Unprotected ........................................................................................... 30-5
Virtual Server Clear WINS Server ...................................................................................... 30-5
Virtual Server Create........................................................................................................... 30-6
Virtual Server Delete......................................................................................................... 30-10

Virtual Server Disable....................................................................................................... 30-12
Virtual Server Enable ........................................................................................................ 30-13
Virtual Server Move.......................................................................................................... 30-15
Virtual Server Set AutoCreate........................................................................................... 30-16
Virtual Server Set Context ................................................................................................ 30-19
Virtual Server Set Domain ................................................................................................ 30-20
Virtual Server Set Name Generic...................................................................................... 30-24
Virtual Server Set Name Netbios ...................................................................................... 30-25
Virtual Server Set Protected.............................................................................................. 30-26
Virtual Server Set WINS Server ....................................................................................... 30-27
Virtual Server Show .......................................................................................................... 30-30
Virtual Server Statistics..................................................................................................... 30-33
Chapter 31: Virus Scan Commands .......................................................31-1

Virus Scan Disable Incoming.............................................................................................. 31-2
Virus Scan Disable Outgoing.............................................................................................. 31-3
Virus Scan Enable Incoming............................................................................................... 31-4
Virus Scan Enable Outgoing ............................................................................................... 31-6
Virus Scan Extension Add .................................................................................................. 31-8
Virus Scan Extension Delete............................................................................................. 31-10
Virus Scan Extension Reset .............................................................................................. 31-12
Virus Scan Extension Set .................................................................................................. 31-13
Virus Scan Extension Show .............................................................................................. 31-15
Virus Scan Log Clear ........................................................................................................ 31-17
Virus Scan Log Facility..................................................................................................... 31-18
Virus Scan Log Host ......................................................................................................... 31-19
Virus Scan Log Show........................................................................................................ 31-20
Virus Scan Log Show Config............................................................................................ 31-23
Virus Scan Server Add...................................................................................................... 31-24
Virus Scan Server Delete .................................................................................................. 31-26
Virus Scan Server Show.................................................................................................... 31-27
Chapter 32: Volume Commands .............................................................32-1

Volume Add Virtual Server ................................................................................................ 32-2
Volume Add Array.............................................................................................................. 32-4
Volume Create..................................................................................................................... 32-6

Volume Delete................................................................................................................... 32-17
Volume Import .................................................................................................................. 32-19
Volume Modify ................................................................................................................. 32-21
Volume Offline.................................................................................................................. 32-30
Volume Online .................................................................................................................. 32-31
Volume Share Export ........................................................................................................ 32-33
Volume Share Import ........................................................................................................ 32-36
Volume Show .................................................................................................................... 32-38

Preface
This preface contains the front matter for the Command Reference for the ONStor™
2200 family of NAS Gateway products. This preface contains the following sections:
• “Audience” on page iii
• “Scope” on page iv
• “Document Organization” on page v
• “Related Documentation” on page vi
• “Revision Trail” on page vii
• “Syntax Usage” on page viii

iii
Audience
This Command Reference is intended for IT professionals that administer the ONStor
Bobcat 2200 Series NAS Gateway (NAS Gateway) products and their company’s
storage area network (SAN). This book is intended to serve IT professionals and
storage administrators of varying levels of experience.

iv
Scope
This Command Reference is designed to help you understand the syntax, formation,
and usage of NAS Gateway commands. Each description of commands contains the
following information:
• Details about the arguments and options that are available to each command
• The results that occur from running the command with different argument or
option setting
• An example of how to run the command
This document is a reference guide. It is not intended as a complete overview of the
NAS Gateway products, storage or networking protocols, or a task-oriented guide
documenting procedures. For more comprehensive material about the NAS Gateway,
refer to the additional NAS Gateway product documentation listed in Table F-1
“Related Documentation” on page i-vi.

v
Document Organization
This document is organized in chapters alphabetically by command name. Because
commands are listed alphabetically, you can locate the commands either through the
Table of Contents or by following alphabetic sequence through the book. You can
locate the command names of each chapter on the first page of a chapter.

vi
Related Documentation
This document is part of a set of product documentation for the NAS Gateway.
Table F-1 shows the related documentation. This Command Reference is most closely
related to the System Administrator’s Guide because this book expands command
syntax documented in the System Administrator’s Guide.
Table F-1 ONStor Product Documentation
Document Name Part Number Revision Level
ONStor Bobcat 2200 Series NAS ONS-DOC-CR-2200 E1

Gateway Command Reference
ONStor Bobcat 2200 Series NAS ONS-DOC-GMGR E1

Gateway Manager Administrator’s and
User’s Guide
ONStor Bobcat 2200 Series NAS ONS-DOC-CMA B1

Cluster Manager Administrator’s and
User’s Guide
ONStor Bobcat NAS Gateway System ONS-DOC-SAG-2200 F1

Administrator’s Guide
Release notes are available with every release of EverON™ software. The release
notes contain additional information about bugs and fixes in the product,
documentation errata or omissions, and new features or enhancements.

vii
Revision Trail
This document is regularly reviewed and revised. Table F-2 shows the history of
revision for this document. ONStor recommends to get the latest information
whenever possible. You can retrieve the latest documentation from our website:
www.onstor.com. At the ONStor web site, select the service & support drop-down list,
then select ONStor ASSIST. Type your user name and password. If you do not have a
user name and password, you can register for an account at this web page.
Table F-2 Product Documentation Revision History
Revision Revision
Document Name Part Number
Level Date
ONStor Bobcat 2200 ONS-DOC-CR-2200 A1 01/18/05

Series NAS Gateway
Command Reference
ONStor Bobcat 2200 ONS-DOC-CR-2200 B1 03/15/06

Series NAS Gateway
Command Reference
ONStor Bobcat 2200 ONS-DOC-CR-2200 C1 08/17/06

Series NAS Gateway
Command Reference
ONStor Bobcat 2200 ONS-DOC-CR-2200 D1 01/23/07

Series NAS Gateway
Command Reference
ONStor Bobcat 2200 ONS-DOC-CR-2200 E1 05/18/07

Series NAS Gateway
Command Reference

viii
Syntax Usage
The NAS Gateway’s command-line interpreter uses different syntax markers to
indicate specific conditions of usage. Table F-3 shows the different syntax markers
used in the command-line interpreter, and explains what each marker means.
Table F-3 Syntax Markers
Syntax Marker Description Example
- (dash) You are specifying an option -a
blank space You are delimiting words, arguments, arp show

or options in a command
bold text Command syntax list
italic capital letters A mandatory variable. You need to IPADDR

enter input for capitalized arguments.
[ ] (squared brackets) Input is optional. The command [-n NODE]

completes with or without the optional
argument.
| (pipe) A logical or operation. You need to disk|tape|all

select one of the choices for the
command to complete.
{ } (braces) A choice is contained within the {enable|disable}

braces. The open brace ({) indicates
the beginning of the choice list, and
the closed brace (}) indicates the end
of the choice list. Choice lists use
pipes (described above) to delimit
each element in the choice list. You
need to enter one of the elements in
the choice list exactly as it occurs in
the list.

ix

Chapter 1: Admin Password
Command
This chapter documents the admin password command.

1-2
Admin Password
Synopsis
admin password
Description
Use the admin password command to change the administrative user’s password.
When you run the command, the ONStor™ NAS Gateway prompts you twice for the
new password. The second of the new passwords is for verification in case you make
an error when you set the new password the first time. Passwords can have up to 16
alphanumeric characters. Passwords can contain special characters such as *, ?,
quotation marks, and blank spaces. When the NAS Gateway prompts you for a new
password, all characters appear as asterisks (*) so that the actual password is not
displayed on the monitor while being entered.
Example
cluster1-4>admin password
Changing local password for root.
New password:
Retype new password:
cluster1-4>
In this example, the administrator password for the root administrator is changed.
When the password has been correctly entered twice, the NAS Gateway accepts the
changed password.

Chapter 2: ARP Commands
This chapter documents the following ARP commands:
• “ARP Add” on page 2-2
• “ARP Delete” on page 2-4
• “ARP Show” on page 2-6

2-2
ARP Add
Synopsis
arp add IPADDR -a MACADDR [-n NODE]
Description
Use the arp add command to add a static address resolution protocol (ARP) entry to
the ARP table. Add and delete static ARP entries manually; they do not automatically
age out of the ARP table. With the arp add command you can associate a media
access control (MAC) address of the device at the far end of a physical link with a
specific IP interface on the ONStor™ NAS Gateway.

2-3
Options
Table 2-1 : Options for arp add command
Option Object Description
IPADDRE Specifies the IP address that is

associated with the device’s
MAC address.
-a MACADDR Specifies the MAC address of
the device at the far end of a
physical link. Type the MAC
address in the following format:
XX:XX:XX:XX:XX:XX
Separate each address pair by a
colon (:).
-n NODE An optional argument that
specifies the node on which to
run the command. The NODE
argument needs to be a valid
node name.
Example
cluster1-4> arp add 10.1.1.89 -a 00:01:d2:c3:a4:21 -n cluster1-3

cluster1-4>
In this example, a static ARP entry is added to the NAS Gateway. The command
syntax indicates the following:
• An ARP entry is added to interface 10.1.1.89.
• The MAC address of the device at the far end of the interface is 00:01:d2:c3:a4:21
• The ARP entry is added to the cluster1-3 node.

2-4
Related Commands
arp delete Deletes and ARP entry from any NAS Gateway
in the cluster.
arp show Shows the ARP table.
ARP Delete
Synopsis
arp delete IPADDR [-n NODE]
Description
Use the arp delete command to remove a static ARP entry. Remove static ARP
entries manually; they do not automatically age out of the ARP Table. If you have
created a static ARP entry with the arp add command, you can delete the ARP entry
from a specific IP interface in the NAS Gateway with the arp delete command.

2-5
Options
Table 2-2 : Options for arp delete command
IPADDR The IP address that is associated

with the device’s MAC address.
specifies the node on which to
run the command. The NODE
argument needs to be a valid
node name.
Example
cluster1-4> arp delete 10.1.1.89 -n cluster1-3

cluster1-4>
In this example, the static ARP entry is deleted. The command syntax indicates the
following:
• The ARP entry for interface 10.1.1.89 is deleted.
• The entry is deleted from the node on which it was configured — in this example,
the cluster1-3 node.
Related Commands
arp add Adds a static ARP to any NAS Gateway within
the cluster.
arp show Shows the ARP table.

2-6
ARP Show
Synopsis
arp show -n NODE [-a IPADDR] (NAS Gateway context)
arp show [-a IPADDR] (virtual server context)
Description
Use the arp show command to display the contents of the NAS Gateway’s ARP table.
The NAS Gateway’s ARP table contains only static ARP entries. Static entries are
broadcast entries or those that have been added with the arp add command. You can
display the ARP table contents in four different ways:
• The entire ARP table for the NAS Gateway
• The entire ARP table for the virtual server
• A specific ARP table entry in NAS Gateway context, by specifying the interface
that hosts the ARP entry you want to view
• A specific ARP table entry in virtual server context, by specifying the interface
that hosts the ARP entry you want to view
The NAS Gateway contains a central ARP table on the System Switch and Controller
(SSC). The NAS Gateway’s file processing (FP) controller contains an ARP table,
however, it is smaller and contains only the entries for the devices connected to it
directly. Each virtual server can also have its own ARP table.
Note!
The output of this command differs depending on the context in which you run
the command. If you are in the NAS Gateway context when you run the
command, the display shows information for the whole NAS Gateway. If you
are in the virtual server context, the display shows only the information for that
specific virtual server.

2-7
Options
Table 2-3 : Options for the arp show command
-n NODE The node on which to run the

command. The NODE argument
needs to be a valid node name.
-a IPADDR An optional argument that
specifies the IP address
associated with the device’s
MAC address. If you use this
argument, only the entry
associated with this IP interface
is shown.
The ARP table Shows the following columns:

• The dest column shows the IP addresses supported on the interface.
• The mac column shows the hardware address of the device associated with the
destination IP address.
• The age column shows the amount of time that the ARP entry has been in the ARP
table. ARP entries on the NAS Gateway age out after an inactivity interval of 20
minutes. If the ARP entry is used within that 20 minutes, the inactivity timer resets
and another 20-minute inactivity interval is counted.
• The interface column shows the port that supports connection with the device
owning the listed MAC address.

2-8
Example
The following example shows the ARP table for all NAS Gateways in the cluster.
eng6> arp show

ARP Table
-------------------------------------------------------------
dest mac age interface
-------------------------------------------------------------
10.2.0.1 00:01:30:b8:4b:80 1081549108 sc1
10.2.0.2 00:d0:b7:b7:a2:a1 1081549088 sc1
10.2.15.32 00:07:e9:23:53:5b 1081549114 sc1
10.2.255.255 00:00:00:00:00:00 1080866008 sc1
192.167.255.255 00:00:00:00:00:00 1081042276 fp0
192.168.192.34 08:08:01:01:01:02 0 fp0
eng6>
The following example shows the ARP table for the NAS Gateway on IP address
10.1.1.123.
cluster1-4> arp show -n cluster2 -a 10.1.1.123

ARP Table
-------------------------------------------------------------
-------------------------------------------------------------
10.1.1.123 00:04:76:41:97:26 1018107553 sc1
cluster1-4>
The following example shows the ARP table for the virtual server VS_PUBSTEST_1.
eng6 VS_PUBSTEST_1> arp show

ARP Table
-------------------------------------------------------------
-------------------------------------------------------------
10.3.0.253 00:01:30:17:72:a0 489696 fp.0
10.3.0.254 00:e0:2b:a0:50:00 489674 fp.0
10.3.9.250 00:0a:04:92:49:00 489705 fp.0
10.3.255.255 ff:ff:ff:ff:ff:ff 0 fp.0
10.3.0.5 00:03:47:ae:9d:86 489703 fp.0
10.3.0.1 00:01:30:b8:4b:80 489692 fp.0
eng6 VS_PUBSTEST_1>

2-9
Related Commands
arp add Adds a static ARP to any NAS Gateway within
the cluster.
arp delete Deletes an ARP entry from any NAS Gateway
within the cluster.

2-10

Chapter 3: Auditing Commands
This chapter documents the following audit commands:
• “Audit Clear” on page 3-2
• “Audit Disable” on page 3-3
• “Audit Enable” on page 3-4
• “Audit Set Circular” on page 3-5
• “Audit Set Fail Flag” on page 3-8
• “Audit Set Failure Privilege” on page 3-10
• “Audit Set File Size” on page 3-12
• “Audit Set Success Privilege” on page 3-14
• “Audit Show Config” on page 3-17
• “Audit Show Log” on page 3-18
• “Audit Unset Failure Privileges” on page 3-21
• “Audit Unset Success Privilege” on page 3-26

3-2
Audit Clear
Synopsis
audit clear VOLNAME
Description
You can manually clear the audit log file by running the audit clear command. This
command erases the audit log file’s contents without erasing the audit log file itself.
When the audit log file is cleared, the volume space used by the file is cleared.
You can run this command at any time; the command is not dependent on the audit log
file’s behavior when it reaches capacity. If you run this command when the audit log
file is configured for circular write, the circular write feature remains configured and
wraps to the beginning of the file the next time the audit log reaches capacity. This
command is useful for audit log files that are not configured with circular write
feature. By running this command on such files, you can empty the file so that new
entries can be written to the audit log.
Note!
The audit clear command is immediate. The ONStor™ NAS Gateway does
not offer confirmation or a way to undo the clear.
Run this command on each volume whose audit log file you want to clear.
Options
The VOLNAME variable is the name of the volume that contains
the audit log file you want to clear. All entries in the audit log file
are erased, and the empty audit log file remains configured and
ready to accept new entries.

3-3
Example
eng31 PUBSTEST> audit clear techpubs

eng31 PUBSTEST>
In this example, the audit log file for techpubs is cleared. If file auditing is still enabled
when you clear the audit log file, new entries begin filling the log.
Related Commands
audit enable Enables logging of audit records.
audit disable Disables logging of audit records.
audit show config Shows the audit configuration settings.
audit show log Shows the audit log records.
Audit Disable
Synopsis
audit disable VOLNAME
Description
You can disable the file auditing software on each volume by running the audit
disable command. By default, file auditing is disabled, but with this command you
can deactivate the auditing software on a volume where file auditing was enabled. The
audit disable command controls the operational state of the file auditing feature for
an individual volume, so run this command on each volume where you want file
auditing disabled.
When you disable file auditing, the NAS Gateway halts future file auditing on a
volume until the feature is reenabled. However, all entries in the audit log file and the
audit log file’s configuration are retained. If file auditing is disabled, it remains
inactive indefinitely, and no new audit events are tracked and added to the audit log
file.

3-4
Options
The VOLNAME variable is the name of the volume on which you
want to disable file auditing.
Example
eng31 PUBSTEST> audit disable techpubs

eng31 PUBSTEST>
In this example, the auditing feature is disabled for the volume techpubs.
Related Commands
audit enable Enables logging of audit records.
audit clear Clears the audit log file for the specified volume.
Audit Enable
Synopsis
audit enable VOLNAME
Description
Use file auditing to view various operations that have occurred on a volume or
directory. The NAS Gateway’s software supports the enabling of the file auditing
software on each volume with the audit enable command. By default, file auditing
is disabled. When you enable file auditing for the first time, the NAS Gateway creates
the audit log file on disk for the specified volume, and the same audit log file is used
for subsequent audits regardless of how many times the auditing software is enabled or
disabled on that volume.

3-5
Note!
File auditing can have an impact on the NAS Gateway while enabled, based on
the volume of transactions and amount of data that is scanned in each file
transaction.
File auditing operates on successful and failed file access events.
Options
The VOLNAME variable is the name of the volume on which the
NAS Gateway performs file auditing.
Example
eng31 PUBSTEST> audit enable techpubs

eng31 PUBSTEST>
In this example, file auditing is enabled on the volume techpubs. This command
controls the overall state of the file auditing feature.You also need to set file auditing
parameters, such as the audit log size and the success and failure parameters.
Related Commands
audit clear Clears the audit log file for the specified volume.
audit disable Disables logging of audit records.
audit set The family of audit set commands sets file
auditing parameters.
Audit Set Circular
Synopsis
audit set circular VOLNAME {yes|no}

3-6
Description
Because the audit file has a finite capacity, it behaves in one of two ways when it
reaches capacity:
• It performs a circular write operation, by wrapping to the beginning of the file and
writing new entries over the existing entries. For example, if the file is configured
for 56 audit log records, the 57th audit log record is written at location 1 of the file.
• It does not write any more entries, and instead sends an audit log file notification
that the file is full.
You can control the audit file’s behavior at capacity by running the audit set
circular command. Use this command to control the audit file by activating or
deactivating the circular write operation. By default, the circular write feature is
disabled.
Note!
If you do not want to enable the circular write feature, you can clear the audit
log file by running the audit clear command. This command erases stale
entries from the file and allows writing of new entries to the audit log.

3-7
Options
Table 3-1 : Options for the audit set circular command
VOLNAME The name of the volume on which to

enable or disable the circular write
feature. Type the name of the volume
whose audit log you want to set the
circular write feature.
yes|no A choice list that sets the state of the
circular write feature in one of the
following ways:
yes activates circular writing of new
entries when the audit log file reaches
capacity.
no causes the file not to write new
entries when the audit log file reaches
capacity.
Example
eng31 PUBSTEST> audit set circular techpubs yes

eng31 PUBSTEST>
In this example, the audit log file is set to operate in circular write mode on the volume
techpubs.
Related Commands
audit set fail_flag Specifies whether file access should fail if the
auditing operation fails when auditing is
enabled.

3-8
audit set fail_privilege Specifies which privileges used for file access
should cause recording of an audit event if the
access fails.
audit set filesize Specifies the maximum size to which audit log
file can grow.
audit set success_privilege Specifies which privileges used for file access
access succeeds.
Audit Set Fail Flag
Synopsis
audit set fail_flag VOLNAME {yes|no}
Description
The NAS Gateway’s ability to record operations in the audit log file can affect the
completion of file operations. With the audit set fail_flag command, you can
configure the NAS Gateway to disallow an attempted file operation if that operation
cannot be recorded in the audit log file. For example, if file_open operations cannot be
written to the audit log file because the audit log file is full, you can specify not to
permit these operations. If you specify not to permit an operation, it fails and the client
is not allowed to perform the operation because the audit log file cannot record it.
If you disallow file operations because the audit log file cannot record them, ensure
that the audit log file is configured to behave to your file size and file behavior
specifications.
Audit logging can fail for reasons other than the success or failure parameters that you
set. The fail flag you set with the audit set fail_flag command disallows access
to the file if auditing fails for any reason, not just your configured parameters.

3-9
Options
Table 3-2 : Options for the audit set fail_flag command
VOLNAME The name of the volume on which to set

the fail flag.
yes|no A choice list that sets the state of
denying a file operation that the audit
log file cannot record in one of the
following ways:
• Specifying yes denies the file access
operation if the audit log file cannot
record it.
• Specifying no allows the file access
operation even if the audit log file cannot
record it. The default value is no.
Example
eng31 PUBSTEST> audit set fail_flag techpubs yes

eng31 PUBSTEST>
In this example, the audit fail flag is set for the volume techpubs.
Related Commands
audit set circular Specifies whether the audit log file is a circular
file.
access fails.
file can grow.

3-10
access succeeds.
Audit Set Failure Privilege
Synopsis
audit set fail_privilege VOLNAME PRIVILEGES
[security|backup|restore|takeownership|traverse]
Description
As part of file auditing, specify the audit parameters to be tracked. You can track audit
parameters for negative events on the volume, such as failed file operations. The
determination of a failed file operation is made by a comparison of privilege levels,
such as backup, take-ownership, or restore. If this comparison results in denial of the
operation, the file operation fails.
You can specify which failed file operations to track by configuring a failure
parameter. This parameter specifies all the file operations that the audit log should list
when a comparison of the system access control list (SACL) on the file prevents the
operation from occurring. For example, if you add take-ownership as a failure
parameter, the NAS Gateway audits all attempts that use the take-ownership privilege.
Any failed attempts that use the take-ownership privilege are posted to the audit log
file. If you don’t configure a failure parameter, the NAS Gateway does not audit failed
file operations.
Note!
You cannot explicitly configure actual permissions, for example backup, with
any auditing commands. You only specify the permissions that create an audit
record in the audit log file.
The NAS Gateway compares the permission that is attempting a file access
with the permission required for that file access. In the case of failure
parameters, the NAS Gateway then adds a record to the audit log file whenever
the comparison disallows file access.

3-11
Options
Table 3-3 : Options for the audit set fail_privilege command
VOLUME The name of the volume on which to

track file operations that fail.
PRIVILEGES One or more file privileges that you
want the NAS Gateway to track for
failures. The following are valid
privileges:
• security
• backup
• restore
• take-ownership
• traverse
Separate multiple privileges with a blank
space.
Example
eng31 PUBSTEST> audit set fail_privilege techpubs

security backup restore takeownership traverse
eng31 PUBSTEST>
In this example, file auditing failure parameters are configured for the volume
techpubs. The NAS Gateway is configured to track failed file access attempts for
security, backup, restore, take-ownership, or traverse events.

3-12
Related Commands
enabled.
audit set circular Specifies the audit log file is a circular file.
file can grow.
access succeeds.
Audit Set File Size
Synopsis
audit set filesize VOLNAME FILESIZE
Description
The audit log is created automatically when you enable file auditing for the first time,
and it is populated automatically whenever the audit log file’s contents are configured
with success or failure parameters. The amount of entries in the audit log file can vary,
depending on how large you want the file.
You can set the size of the audit log file by running the audit set filesize
command. Use this command to customize the audit log file’s capacity based on your
use of file auditing. For example, if you intend to track few file operations for success
or failure, you can set the audit log file to a smaller size. Conversely, if you want to
enforce very strict and detailed auditing, you can set a large audit log file. Consider the
following when setting the audit log file size:
• Smaller audit log files consume less disk space for the volume, but do not store an
extensive audit trail.
• Larger audit log files consume more disk space for the volume, but provide a more
detailed audit trail.

3-13
The audit log file’s size is set in kilobytes. The default size of the file is 0 for unlimited
space. Behavior of the file depends on whether is configured as a circular file:
• If the file size is 0 and the file is circular, the file does not wrap.
• If the file size is 0 and the file is not circular, it continues to grow until it reaches
the maximum disk space minus the amount of user data. At this point, the file no
longer accepts new audit log entries. However, if the volume is configured for
automatic growth before the file reaches the truncation point, the NAS Gateway
can automatically add more disk space.
Because the audit log file contains a full path, the size of each record in the file can
vary, and therefore, the size of each file can vary. If you create success and failure
parameters that track many or all privileges, set your audit log file to a larger size than
if you have fewer success or failure parameters. ONStor recommends to start with 10
kilobytes, but monitor the audit log frequently after its initial configuration, so you can
increase or decrease the file size based on your needs.
Options
Table 3-4 : Options for the audit set filesize command
VOLNAME The name of the volume on which to set

the audit log file capacity.
FILESIZE The total size, in number of kilobytes, of
the audit log file.
Example
eng31 PUBSTEST> audit set filesize techpubs 10

eng31 PUBSTEST>
In this example, the audit log file is set to 10 kilobytes for the volume techpubs. This is
the file’s capacity, and entries are added to the file until it reaches capacity. At that
point, entries are either discarded or wrap around and write over the first (oldest)

3-14
entries in the audit log file. The file’s behavior at capacity is set with the audit set
circular command.
Related Commands
file.
access fails.
access succeeds.
Audit Set Success Privilege
Synopsis
audit set success_privilege VOLNAME PRIVILEGES
Description
As part of file auditing, specify the audit parameters to be tracked. You can track audit
parameters for positive events on the volume, such as successful file operations. The
determination of a successful file operation is made by a comparison of privilege
levels, such as backup, take-ownership, or restore. If this comparison results in
acceptance of the operation, the file operation is successful.
You can specify which successful file operations to track by configuring a success
parameter. This parameters specifies all the file operations that you want to appear in
the audit log when a comparison of the SACL on the file allows the operation to occur.
For example, if you add backup as a success parameters, the NAS Gateway audits all
events that use the backup privilege. Any successful events that use the backup
privilege are posted to the audit log. If you don’t configure any success parameters, the
NAS Gateway does not audit successful file operations.

3-15
Note!
You cannot explicitly configure actual permissions, for example backup, with
any auditing commands. You only specify the permissions that create an audit
record in the audit log file.
The NAS Gateway compares the permission that is attempting a file access
with the permission required for that file access. In the case of success
parameters, the NAS Gateway then adds a record to the audit log file whenever
the comparison allows the file access.

3-16
Options
Table 3-5 : Options for the audit set success_privilege command
VOLNAME The name of the volume on which to

track file operations that resolve.
PRIVILEGES One or more file privileges that you
want the NAS Gateway to track for
success. The following are valid
privileges:
• security
• backup
• restore
• take-ownership
• traverse
space.
Example
eng31 PUBSTEST> audit set success_privilege techpubs

security backup restore takeownership traverse
eng31 PUBSTEST>
In this example, success parameters are configured for the volume techpubs. The NAS
Gateway is configured to track successful file access attempts for security, backup,
restore, take ownership, or traverse events.

3-17
Related Commands
enabled.
access fails.
file can grow.
file.
Audit Show Config
Synopsis
audit show config VOLNAME
Description
You can view the file auditing configuration at any time by running the audit show
config command. This command shows the configured file audit parameters for a
specified volume. Run this command on each volume whose configuration you want
to view.
Options
The VOLNAME variable is the name of the volume for which you
want to display the currently configured file auditing parameters.

3-18
Example
eng31 PUBSTEST> audit show config techpubs

Volume: techpubs
Auditing state: Enabled
Success privileges: security backup restore takeownership traverse
Fail privileges: security backup restore takeownership traverse
Fail Flag: yes
File size: 10 KB
Circular Mode: Yes
eng31 PUBSTEST>
This example shows the current file auditing configuration.
Related Commands
audit show log Shows the audit log records for the specified
volume.
Audit Show Log
Synopsis
audit show log VOLNAME [MAXRECORDS]
Description
You can display the audit log file at any time to view the contents. ONStor
recommends to check the audit log file frequently while you are configuring file
auditing features to facilitate any corrections to the file auditing configuration or the
success or failure parameters. You can display a volume’s audit log file by running the
audit show log command. Run this command for each volume whose audit log file
you want to view.
Note!
When you run the audit show log command, Windows clients, or Windows
servers cannot display the audit log file through the Windows Event Viewer.

3-19
Options
Table 3-6 : Options for the audit show log command
VOLNAME The name of the volume for which to

display the audit log file.
MAXRECORDS A numeric value from 1 to 20 that
determines how many entries in the
audit log to display at once. The default
is 20.

3-20
Example
eng31 PUBSTEST> audit show log techpubs 4
Tue Aug 5 13:39:08 GMT 2003 -- Audit clear

user : user1@domainX
Tue Aug 5 14:44:04 GMT 2003 -- Audit modify

Tue Aug 5 14:49:13 GMT 2003 -- File access

Path name: /test.tst
Access granted: yes
Request type: Access file
Access mask: 00020000 - RC
Privileges used: restore

user : domainY\user2
Access granted: yes
eng31 PUBSTEST>
In this example, four audit log file entries are displayed. This log contains
configuration records and audit records. In the example, the configuration records are
smaller; they have a title that is anything other than file access; and the titles indicate
which action was performed. For example, the first two entries in this example are
configuration records. These entries indicates that the UNIX user user1@domainX
changed the auditing configuration by first clearing the audit log file, then modifying
the auditing configuration.
The remaining entries are audit records as indicated by their title file access. The audit
log contains the following information in each audit record:
• The date and timestamp at which the audit record was created, and the reason for
the record. In these examples, a file access request was sent.
• User name information, including the domain in which the user is requesting
access to a file.

3-21
• The path that the user used to attempt access to the file.
• The access information about the request, including whether file access was
allowed or denied,
• The type of request the NAS Gateway received from the user.
• The access mask, which is the string of numerals and the file access abbreviations
that indicate which actions were attempted on the file. These abbreviations map
closely to access mask values used by Windows devices, but the abbreviation for
each label is related to the EverON™ software file system.
• The privileges used to access the file.
Related Commands
Audit Unset Failure Privileges
Synopsis
audit unset fail_privilege VOLNAME PRIVILEGES
Description
You can remove a configured failure parameter by running the audit unset
fail_privilege command. When you run this command, a configured failure
parameter is deleted from the auditing software. Therefore, failed file operations for
the deleted privilege are no longer tracked in the audit log file.
Note!
A deleted failure parameter is not automatically tracked as a success parameter,
Use the audit set success_privilege command to configure auditing for
success parameters.

3-22
Options
Table 3-7 : Options for the audit unset fail_privilege command

stop tracking failed file operations.
PRIVILEGES One or more failed file privileges that
you no longer want tracked. The
following are valid privileges:
• security
• backup
• restore
• take-ownership
• traverse
space.

3-23
Example
eng31 PUBSTEST> audit show log pubstest 5

user : root@local

user name: domainY\user2

Access granted: yes
Privileges used: security

Access granted: no

Access granted: yes
Access mask: 00020080 - RA RC
Privileges used: traverse
eng31 PUBSTEST> audit unset fail_privilege pubstest restore
In the preceding example the failure notification for the restore privilege is unset, and
the audit log file is displayed. The restore privilege is configured for failure because of
the setting Access Granted=no. However, after the audit unset fail_privilege
command is run for the restore privilege, access attempts with the restore privilege are
no longer posted to the audit log when they fail to complete. With this command, you
are removing the NAS Gateway’s ability to track failed file access attempts for events

3-24
that require restore privilege. A subsequent display of the audit log file would show no
further entries for the restore privilege, as shown in the following example display:

user : root@local

Access granted: yes

Access granted: yes

Access granted: yes
Privileges used: takeownership
eng31 PUBSTEST>
In the example display, the first audit entry, which is a configuration record, indicates
that the administrator changed the auditing configuration as shown by Audit modify.
This entry notes the issuance of the audit unset fail_privilege command.

3-25
Because the command completed, operations that require the restore privilege on the
file or directory are no longer posted to the audit log on failures.

user : root@local

Access granted: yes

Access granted: yes

Access granted: yes
eng31 PUBSTEST>
Note!
When you unset a failure privilege and you have no success privilege
configured, no auditing for that privilege occurs, which leaves you unable to
track file or directory access for that privilege.
Related Commands
audit unset success_privilege Unsets the audit event logging for successes
associated with specific privileges.

3-26
Audit Unset Success Privilege
Synopsis
audit unset success_privilege VOLNAME PRIVILEGES
Description
You remove a success parameter by running the audit unset success_privilege
command. When you run this command, a configured success parameter is deleted
from the auditing software. Therefore, successful file operations for the deleted
privilege are no longer tracked in the audit log file.
Note!
A deleted success parameter is not automatically tracked as a failure parameter,
Use the audit set fail_privilege command to configure auditing for failure
parameters.

3-27
Options
Table 3-8 : Options for the audit unset success_privilege command

stop tracking successful file operations.
PRIVILEGES One or more file privileges that you no
longer want tracked. The following are
valid privileges:
• security
• backup
• restore
• take-ownership
• traverse
space.

3-28
Example

user : root@local

user name: domainY\user2

Access granted: yes

Access granted: yes

Access granted: yes
eng31 PUBSTEST> audit unset success_privilege techpubs restore
The preceding example, success for the restore privilege is unset, and the audit log file
is displayed. The restore privilege is configured for success as indicated by Access
Granted=yes. However, after the audit unset success_privilege command is run
for the restore privilege, access attempts with the restore privilege are no longer
posted to the audit log when they successfully complete. With this command, you are
removing the NAS Gateway’s ability to track successful file access attempts for events
that require the restore privilege. A subsequent display of the audit log file would

3-29
show no further entries for the restore privilege, as shown in the following example
display:

user : root@local

Access granted: yes

Access granted: yes

Access granted: yes
eng31 PUBSTEST>
In this example display, the first audit entry, which is a configuration record, indicates
that the administrator changed the auditing configuration as shown by Audit modify.
This entry notes the issuance of the audit unset success_privilege command.
Because the command completed, access attempts that require the restore privilege are
no longer posted to the audit log on successful completion.
Note!
When you unset a success privilege and you have no failure privilege
configured, no auditing for that privilege occurs, which leaves you unable to
track file or directory access for that privilege.

3-30
Related Commands
audit unset fail_privilege Unsets the audit event logging for failures
associated with specific privileges.

Chapter 4: Autosupport Commands
This chapter documents the following autosupport commands:
• “Autosupport Clear Statistics” on page 4-2
• “Autosupport EMRS Proxy Enable” on page 4-3
• “Autosupport EMRS Proxy Enable” on page 4-3
• “Autosupport EMRS Send Disable” on page 4-6
• “Autosupport EMRS Send Enable” on page 4-6
• “Autosupport EMRS Show Config” on page 4-7
• “Autosupport Email From” on page 4-9
• “Autosupport Email Note To” on page 4-10
• “Autosupport Email To” on page 4-11
• “Autosupport Generate Report” on page 4-14
• “Autosupport Schedule” on page 4-14
• “Autosupport Show Config” on page 4-20
• “Autosupport Show Statistics” on page 4-21
• “Autosupport State Enable or Disable” on page 4-25

4-2
Autosupport Clear Statistics
Synopsis
autosupport clear statistics
Description
The ONStor™ NAS Gateway tracks the occurrences of system events in the
Autosupport Statistics Summary. The statistics are tracked in runtime, so if the NAS
Gateway is reset, the statistics automatically reset to zero and begin incrementing
again. However, you can manually reset the statistics by running the autosupport
clear statistics command. This command sets all the autosupport statistics
counters to zero so that they can begin incrementing again whenever a system event
occurs.
Example
cluster1-4> autosupport clear statistics

cluster1-4>
Related Commands
autosupport show statistics Shows autosupport statistics.
Autosupport EMRS Proxy Disable
Synopsis
autosupport emrs proxy disable
Description
You can disable proxy support for the EMRS feature at any time by running the
autosupport emrs proxy disable command. This command deactivates the
transmission of EMRS information through any configured proxy. When the proxy is

4-3
disabled, the NAS Gateway transmits the information directly to the ONStor secure
server. For details about the EMRS feature, see “Autosupport EMRS Proxy Enable”
on page 4-3.
Example
In the following example, the EMRS information is no longer transmitted from the
proxy.
eng63> autosupport emrs proxy disable

eng63>
Related Commands
autosupport emrs proxy enable Enables proxy support for the EMRS
information.
autosupport emrs show config Shows the configuration of the EMRS
information.
Autosupport EMRS Proxy Enable
Synopsis
autosupport emrs proxy enable -i IPADDR -p PORT [-u USER -P
PASSWORD]
Description
The EMRS feature lets you transmit configuration information and performance
statistics through HTTPS from a NAS Gateway to a secure server at ONStor. The
EMRS feature facilitates diagnosing and troubleshooting the NAS Gateway. You can
use the autosupport emrs proxy enable command to set up a proxy for routing
traffic to the Internet. By default the proxy is disabled.
By default, the EMRS feature transmits information to the secure ONStor server in
any of the following ways:

4-4
• The information transfer is initiated by the administrator with the output of the
system get command. This type of information transfer requires an ONStor
Customer Support case number before you can upload the information to the
ONStor server, so you need to open a case with ONStor Customer Support.
• The information is transferred nightly at midnight through a cron job.
• The information transfer is initiated by selected system events. The information is
sent to the ONStor secure server asynchronously after CPU events occur. The
information is transmitted when a CPU reboots.
When you configure the settings for the EMRS feature, the information is written into
the cluster database, so all NAS Gateways in a cluster use the same information.
However, information is collected and transmitted separately for each NAS Gateway
in a cluster, so in a multinode cluster you need to run the system get command for
each NAS Gateway in the cluster.
Consider the following prerequisites for using the EMRS feature:
• Your network needs to support HTTPS traffic to the Internet.
• You need to have administrator privileges on the NAS Gateway and in your
network.
• If your network uses a proxy to route traffic to the Internet, you need the proxy’s IP
address, the port number that supports traffic, and any user name and password
required to access the proxy.

4-5
Options
Table 4-1 : Options for the autosupport emrs proxy enable command
-i IPADDR The proxy’s IP address.

-p PORT The number of the port that the proxy
uses to transmit the EMRS information.
-u USER An optional argument for specifying the
user name for authenticating the NAS
Gateway with the proxy.
-P PASSWORD An optional argument for specifying the
password for authenticating the NAS
Gateway with the proxy.
Example
eng57> autosupport emrs proxy enable -i 10.1.2.15 -p 9000

eng57
In the this example, the NAS Gateway is configured to use the network device at
10.1.2.15 as a proxy and port 9000 to send EMRS information to the proxy. The NAS
Gateway accesses the proxy with the user name netadmin5 and the password phpass.
Related Commands
autosupport emrs proxy disable Disables proxy support for the EMRS feature.
autosupport emrs show config Shows the configuration of the EMRS feature.

4-6
Autosupport EMRS Send Disable
Synopsis
autosupport emrs send disable
Description
By default the EMRS feature is enabled. But you can explicitly disable this feature by
using the autosupport emrs send disable command. When you disable the
EMRS feature, the NAS Gateway stops sending system information through nightly or
event-initiated uploads to the ONStor server, and the EMRS configuration is removed
from the cluster. For more details about the EMRS feature, see “Autosupport EMRS
Proxy Enable” on page 4-3.
Example
In the following example, the EMRS feature is disabled.
eng63> autosupport emrs send disable

eng63>
Related Commands
autosupport emrs send enable Enables the EMRS feature.
Autosupport EMRS Send Enable
Synopsis
autosupport emrs send enable

4-7
Description
By default the EMRS feature is enabled. But if this feature is disabled, you can
explicitly enable it with the autosupport emrs send enable command. For more
details about the EMRS feature, see “Autosupport EMRS Proxy Enable” on page 4-3.
Example
In the following example, the EMRS feature is enabled.
eng63> autosupport emrs send enable

eng63>
Related Commands
autosupport emrs send disable Disables the EMRS feature.
Autosupport EMRS Show Config
Synopsis
autosupport emrs show config
Description
Use the autosupport emrs show config command to display the configuration
information of the EMRS feature. The output of this command shows the current
settings and operational state of the EMRS feature configured on a NAS Gateway. For
more details about the EMRS feature, see “Autosupport EMRS Proxy Enable” on
page 4-3.

4-8
Example
eng63> autosupport emrs show config

Auto Support EMRS configuration
--------------------------
EMRS sending: Enabled
EMRS proxy: Enabled
proxy addr : 192.168.1.101
proxy port : 8095
proxy username : netadmin5
proxy password : *****
eng63>
This example displays the following EMRS configuration for NAS Gateway eng63>:
• The EMRS feature is enabled.
• A proxy server for transmitting EMRS information to the ONStor secure server is
enabled.
• The IP address of the proxy server is 192.168.1.101.
• The proxy port on which the NAS Gateway transmits the EMRS information is
8095.
• The user name that the NAS Gateway uses to access the proxy server is netadmin5.
• The password that the NAS Gateway uses to authenticate with the proxy server is
entered. For security reasons, the actual password is replaced by five asterisks (*)
representing the password.
Note!
If no proxy server is configured, the display shows an asterisk (*) next to each
proxy parameter field.
Related Commands
autosupport emrs send disable Disables the EMRS feature.
autosupport emrs send enable Enables the EMRS feature.

4-9
Autosupport Email From
Synopsis
autosupport email from EMAIL
Description
You can configure the address from which you are sending autosupport email by
running the autosupport email from command.
Note!
You can specify only one email ID in the EMAIL field.
If you don’t configure the email address, it defaults to the NAS Gateway node name.
Options
The EMAIL variable is the email address from which all
autosupport email is being sent on generation of important events
and on demand. You can enter any email address.
Example
eng24 ENG30-VS1> autosupport email from 123@yahoo.com

eng24 ENG30-VS1> autosupport show config
Auto Support configuration
--------------------------
Auto Support State: Disabled
Auto Support TO address: --Not-Set--
Auto Support NOTETO address: --Not-Set--
Auto Support FROM address: 123@yahoo.com
Auto Support MAIL SERVER: 0.0.0.0
Auto Support Schedule:
min : 45
hour : 12
date : *
month: *
day : *
eng24 ENG30-VS1>
In this example, autosupport email is set as 123@yahoo.com.

4-10
Related Commands
autosupport email noteto Specifies the email address to send a brief
autosupport note.
autosupport email to Specifies the email address of the recipient.
autosupport show config Shows current autosupport configuration
information.
Autosupport Email Note To
Synopsis
autosupport email noteto EMAIL
Description
The autosupport feature supports sending an email note when certain critical events
occur. For more information, see the ONStor Bobcat 2200 Series NAS Gateway System
Administrator’s Guide.
Options
The EMAIL variable is the email address of your administrator or
ONStor support contact who is managing the NAS Gateway.
Type a valid email address from 1 to 256 characters, including the
email suffix. The NAS Gateway supports all common domain
suffixes, such as .com, .org, .gov, and .edu.
The email address does not have to exist prior to entering it as
part of the autosupport feature. However, the email alias needs to
exist for the NAS Gateway to successfully forward the
notification messages. If you intend to configure the autosupport
email address first, then create the actual email address later,
make sure that the address you type on the NAS Gateway
matches with the email address that you will later configure.

4-11
Example
cluster1-4> autosupport email noteto paulw@onstor.com

cluster1-4>
In this example, the recipient of the autosupport notes is set as paulw@onstor.com. An

additional system message type, a notification, exists and can be forwarded to the
same or different email address.
Related Commands
autosupport email to Specifies the email address to send a detailed
autosupport note.
autosupport generate report Generates and sends instant autosupport report.
information.
Autosupport Email To
Synopsis
autosupport email to EMAIL
Description
The autosupport feature supports sending an email notification, which is a detailed
message about any of the following events that occur in runtime:
• Node failures or resets
• Card failures or resets
• CPU failures or resets
• Volume failures or volume space violations

4-12
A notification includes a summary of the NAS Gateway’s configuration at the time of

the event and the summary of the system event. The configuration summary is copied
from the NAS Gateway’s configuration file, agile.conf.
You can specify the email alias to which the NAS Gateway forwards notifications by
running the autosupport email to command. This command sets the address for
detailed notifications.
Options
The EMAIL variable is the email address of your administrator or
ONStor support contact who is managing the NAS Gateway.
Type a valid email address from 1 to 256 characters, including the
email suffix. The NAS Gateway supports all common domain
suffixes, such as .com, .org, .gov, and .edu.
The email address does not have to exist prior to entering it as
part of the autosupport feature. However, the email address needs
to exist for the NAS Gateway to successfully forward the
notification messages. If you intend to configure the autosupport
email address first, then create the actual email address later,
make sure that the address you type on the NAS Gateway
matches with the email address that you will later configure.
Example
cluster1-4> autosupport email to paulw@onstor.com

cluster1-4>
In this example, the recipient of the autosupport notification is set as

paulw@onstor.com. An additional system message type, a note, exists and you can
forward it to the same or a different email. A note is only the system event. It has no
configuration information.
Related Commands
autosupport email noteto Specifies the email address to send a brief
autosupport note.

4-13
autosupport generate report Generates and sends instant autosupport report.

information.
Autosupport Email Server
Synopsis
autosupport email server SERVER
Description
You can configure the simple mail transfer protocol (SMTP) server to which to direct
autosupport emails by specifying the IP address of the SMTP server. To configure the
SMTP server to which to route autosupport emails run the autosupport email server
command.
The default mail server is automatically determined using DNS MX records, so run
this command only when you want to override the default SMTP server.
Options
The SERVER variable is the IP address of the SMTP server to
which to route autosupport email. To specify the default IP
address use 0.0.0.0.
Related Commands
autosupport note.
information.

4-14
Autosupport Generate Report
Synopsis
autosupport generate report
Description
The autosupport generate report command instantly generates an autosupport
report and sends it to the emailto and noteto addresses configured to receive it. This is
also known as on-demand autosupport report generation. You can schedule
autosupport reports to occur at regular intervals with the autosupport schedule
command. For details see “Autosupport Schedule” on page 4-14.
Example
cluster1-4> autosupport generate report

cluster1-4>
Related Commands
autosupport note.
autosupport email noteto Specifies the therefore address to send a brief
autosupport note.
information.
Autosupport Schedule
Synopsis
autosupport schedule [-m MINUTE] [-h HOUR] [-d DATE] [-M MONTH] [-
D DAY]

4-15
Description
You can schedule autosupport reports to occur at regular intervals by running the
autosupport schedule command. Use this command to create a schedule of times at
which the report is generated. With this command, you can set the following
parameters for system report generation:
• The minutes, between 0 and 59, of the hour at which to generate the system report.
• The hour, from 0 to 23, at which to generate the system report. Hours start at
midnight, which is hour 0, and increment sequentially until 23, which is 11 p.m.
• The date on which to generate a report.
• The month, from 1 to 12, in which to generate the system report. Month 1 is
January, and months increment sequentially to month 12, which is December.
• The day, from 1 to 7, on which to generate the system report. Day 1 is Sunday, and
days increment sequentially to day 7, which is Saturday.
Note!
At initial configuration, all parameters in the autosupport parameters are
configured with no specific value. Instead, they are configured with an asterisk
(*) which indicates that the autosupport feature report can occur at all times in
the range. For example, when the minutes field contains *, the reports are
generated every minute. When the hour field contains *, the reports are
generated every hour. If all fields contain *, reports are generated every minute
of every hour of every day in every month on any date. This default
configuration can cause numerous e-mails. ONStor recommends that you
configure the autosupport schedule with custom values before enabling the
autosupport feature. To return the report schedule to its defaults, run the
autosupport schedule command with all parameters as asterisks.

4-16
Options
Table 4-2 : Options for the autosupport schedule command
-m MINUTE A numeric value from 0 to 59 that

indicates the minutes in the hour at
which to generate the system report. For
example, if you set 30, the system report
is generated on the half hour of the hour
you specify. You can type multiple
values for this argument by specifying a
comma-separated list of values. The
default value is 0.
-h HOUR A numeric value from 0 to 23 that
indicates, in 24-hour time, the hour at
which to generate the system report. For
is generated at midnight; if you set 12,
the system report is generated at noon.
You can use the MINUTE argument to
specify the generation of the system
report at a time other than the top of the
hour. You can enter multiple values for
this argument by specifying a comma-
separated list of values.

4-17
Table 4-2 : Options for the autosupport schedule command (Continued)
-d DATE The date on which to generate the

system report. Type one of the
following:
The numeric date of a particular day in
the month. For example, to generate a
system report on the first day of each
month, type 1. You can type a comma-
separated list of dates.
A specific date in the year. For example,
to generate a system report on the 27th
of September, 2003, specify the date as
092703.
Do not separate the numbers with any

special characters.
-M MONTH A numeric value from 1 to 12 that
indicates the month of the year in which
to generate the system report. For
is generated in the month of June. You
can further refine the time at which to
generate the system report by using the
WEEK, DAY, HOUR, and MINUTE
arguments. You can type multiple values
for this argument by specifying a
comma-separated list of values.

4-18
Table 4-2 : Options for the autosupport schedule command (Continued)
-D DAY A numeric value from 1 to 7 that

indicates the day of the week in which to
generate the system report. For example,
if you set 1, the report is generated on a
Sunday. You can type multiple values
for this argument by specifying a
comma-separated list of values.
Example
In the following example, the autosupport report schedule is configured with custom
values.
cluster1-4> autosupport schedule -m 30 -h 2 -M 3,6,9,12

cluster1-4>
In this example, a report schedule is created. According to this schedule, the

autosupport reports are forwarded to an email at 2:30 a.m., every day of the last month
of each quarter. details of the schedule are as follows:
• -m 30 indicates that the report occurs at the bottom of the hour (the 30th minute).
• -h 2 indicates that the report occurs at 0200 hours (2:00 a.m.).
• No value was configured for the date, so the reports is forwarded every date in a
month.
• -M 3,6,9,12 indicates that the reports is generated in the third, sixth, ninth, and
twelfth month of the year (the last month of every quarter).
• No value was configured for the day, so the report is forwarded every day of the
week.

4-19
In the following example, the autosupport report schedule is configured with custom
values.
cluster1-4> autosupport schedule -m 45 -h 0,12 -d 1,15,30

cluster1-4>
According to this schedule, the autosupport reports are forwarded to an email at 12:45
a.m. and 12:45 p.m., on the first, fifteenth, and thirtieth day of every month. Details of
the schedule are as follows:
• -m 45 indicates that the report occurs at the 45th minute of the hour.
• -h 0,12 indicates that the report occurs at midnight and noon.
• -d 1,15,30 indicates that the report occurs on day 1, 15, and 30 of the month.
• No value is specified for the month, so reports occurs every month in the year.
• No value was configured for the day, so the report occurs every day of the week.
In the following example, the autosupport report schedule is configured with default
values.
cluster1-4> autosupport schedule -m * -h * -d * -M * -D *

cluster1-4>
According to this schedule, the autosupport reports are forwarded to an email every
minute. Details of the schedule are as follows:
• -m * indicates that the reports is forwarded every minute in the hour.
• -h * indicates that the reports is forwarded every hour of the day.
• -d * indicates that the reports is forwarded every date in the month.
• -M * indicates that the reports is forwarded every month in the year.
• -D * indicates that the reports is forwarded every day in the week.
Related Commands
autosupport show config Shows the current autosupport configuration.

4-20
Autosupport Show Config
Synopsis
autosupport show config
Description
The NAS Gateway stores the configured autosupport parameters in memory as the
Autosupport Configuration List. You can view the autosupport configuration at any
time, by running the autosupport show config command. This command shows the
autosupport configuration on the local node only.
Example
eng28> autosupport show config

Auto Support configuration
--------------------------
Auto Support State: Disabled
Auto Support TO address: --Not-Set--
Auto Support NOTETO address: --Not-Set--
Auto Support FROM address: eng28@onstor.com
Auto Support MAIL SERVER: 0.0.0.0
Auto Support Schedule:
min : 0
hour : 8
date : *
month: *
day : *
eng28>
This example shows the autosupport configuration list. This list shows the following
parameters:

4-21
• The operational state, either enabled or disabled, for the NAS Gateway’s
autosupport feature.
• The configured email address for autosupport notifications.
• The noteto is used as a CC.
• The autosupport schedule’s configured parameters.
• min shows the minutes at which the report is forwarded to a configured email. If
min contains an asterisk, the report is generated at every minute in the hour.
• hour shows the hours at which the report is forwarded to a configured email. If
hour contains an asterisk, the report is forwarded every hour.
• date shows the days in the month at which the report is forwarded to a configured
email. If date contains an asterisk, the report is forwarded every day in the month.
• month shows the months at which the report is forwarded to a configured email. If
month contains an asterisk, the report is forwarded every month of the year.
• day shows the days in the week at which the report is forwarded to a configured
email. If day contains an asterisk, the report is forwarded every day of the week.
In this example, the schedule is configured to forward the autosupport reports at 12:45
a.m. and 12:45 p.m. of the 1st, 15th, and 30th of every month regardless of the day in
the week.
Autosupport Show Statistics
Synopsis
autosupport show statistics
Description
The NAS Gateway tracks performance and operation statistics for the system events it
encounters. These statistics are listed in the autosupport statistics summary. The
autosupport statistics are gathered in realtime whenever the system event is forwarded
to the administrator in a notification or a note. The statistics are tracked in runtime, so
if the NAS Gateway is reset, the statistics reset to zero and begin incrementing again

4-22
whenever a system event occurs. You can clear statistics by running the autosupport
clear statistics command.

4-23
Example
eng46> autosupport show statistics

Event Type Count Last Event Time
-----------------------------------------------------------------
Node 0 None
PCC 0 None
SCC 0 None
Card 0 None
CPU 0 None
Volume 0 None
IP i/f 0 None
Port 0 None
NFS 0 None
Route 0 None
Quota Rebuild Start 0 None
Quota Rebuild Done 0 None
Quota Rebuild Aborted 0 None
Quota Tree Enabled 0 None
Quota Tree Disabled 0 None
Quota Tree Warn 0 None
Quota Tree Limit 0 None
Quota User Enabled 0 None
Quota User Disabled 0 None
Quota User Warn 0 None
Quota User Limit 0 None
Quota Group Enabled 0 None
Quota Group Disabled 0 None
Quota Group Warn 0 None
Quota Group Limit 0 None
Mkfs 0 None
IdMap 0 None
Privs 0 None
Vsvr 0 None
Coredump 0 None
Power Supply 0 None
Domain 0 None
Cluster DB Ver Change 0 None
Temperature 0 None
Fan 0 None
DNS 0 None
-----------------------------------------------------------------
eng46>
In this example, the autosupport statistics summary is displaying the following system
events.

4-24
In addition to the listed statistics, this display shows when the event last occurred or
the NAS Gateway was last reset:
• The number of node failures or resets
• The number of primary cluster controller (PCC) failures or resets.
• The number of secondary cluster controller (SCC) failures or resets.
• The number of card failures or resets.
• The number of CPU failures or resets.
• The number of logical volume failures or volume space violations.
• The number of IP interface failures or resets.
• The number of port failures or resets.
• The number of NFS file access protocol failures, resets, or violations.
• The number of route flaps, resets, or losses.
• The number of times a file system quota rebuild was started.
• The number of times a file system quota rebuild was completed.
• The number of times a file system quota rebuild was cancelled.
• The number of times a file system quota tree was enabled.
• The number of times a file system quota tree was disabled.
• The number of times a warning level for the file system quota tree was set.
• The number of times a limit for the file system quota tree was set.
• The number of times a file system user quota was enabled.
• The number of times a file system user quota was disabled.
• The number of times a warning level for the file system user quota was set.
• The number of times a limit for the file system user quota was set.
• The number of times a file system group quota was enabled.
• The number of times a file system group quota was disabled.

4-25
• The number of times a warning level for the file system group quota was set.
• The number of times a limit for the file system group quota was set.
• Mkfs show the number of volume creations.
• The number of ID mapping events.
• The number of privilege events.
• The number of virtual server events.
• the number of core dump events.
• The number of power supply events.
• The number of domain events.
• The number of cluster database version changes.
• The number of temperature changes.
• The number of fan failures and resets.
• The number of domain name service (DNS) events.
Related Commands
autosupport show config Shows current autosupport configuration.
Autosupport State Enable or Disable
Synopsis
autosupport state enable|disable
Description
You can enable or disable autosupport. When the autosupport feature is disabled, the
NAS Gateway does not forward autosupport email notifications or notes, and reports
are not written nor are existing reports available for viewing. No statistics are tracked
when autosupport is disabled.

4-26
If autosupport is enabled, and you disable it, the NAS Gateway retains all the
configured autosupport parameters for when you reenable the feature. You can enable
or disable the autosupport feature by running the autosupport state command.
Autosupport is disabled by default.
Options
The enable|disable options specify the operational state that you
are setting for the autosupport feature. Enable activates the
autosupport feature. Disable deactivates the autosupport feature.
Autosupport is disabled by default.
Example
In the following example, the autosupport feature is enabled.
cluster1-4> autosupport state enable

cluster1-4>
The autosupport feature begins forwarding notes and notifications to any configured
email address at the times specified in the autosupport schedule. While autosupport is
enabled, all configured autosupport features and statistics are operational.
In the following example the autosupport feature is disabled.
cluster1-4> autosupport state disable

cluster1-4>
While autosupport is disabled, all configured autosupport features and statistics

remain configured but inactive until you reenable autosupport.
Related Commands
autosupport show config Shows current autosupport configuration.

Chapter 5: CIFS Commands
This chapter documents the following CIFS commands:
• “CIFS Server Create” on page 5-2
• “CIFS Server Delete” on page 5-2
• “CIFS Server Show” on page 5-3
• “CIFS Share Add” on page 5-4
• “CIFS Share Delete” on page 5-12
• “CIFS Share Modify” on page 5-13
• “CIFS Show” on page 5-21

5-2
CIFS Server Create
Synopsis
cifs server create NAME
Description
You can add a CIFS server to a virtual server with the cifs server create command
at any time. You need to be in the virtual server context. The virtual server does not
need to be disabled to do this.
The intent of this command is to add additional network names to a virtual server so
that you can use any one of them to reach the CIFS shares.
Options
The NAME variable is the name of the CIFS server to add.
Example
eng46 TECHPUBSVS> cifs server create cifsserver2

eng46 TECHPUBSVS>
In this example, the CIFS server cifsserver2 is created for the virtual server
techpubsvs.
Related Commands
cifs server delete Delete a CIFS server name.
cifs server show Show the list of CIFS server names.
CIFS Server Delete
Synopsis
cifs server delete NAME

5-3
Description
You can delete a CIFS server from a virtual server with the cifs server delete
command at any time. You need to be in the virtual server context, and the virtual
server does not need to be disabled to do this.
Options
The NAME variable is the name of the CIFS server to delete.
Example
eng46 TECHPUBSVS> cifs server delete cifsserver2

eng46 TECHPUBSVS>
In this example, the CIFS server cifsserver2 is deleted from the virtual server
techpubsvs.
Related Commands
cifs server create Add a CIFS server name.
cifs server show Show the list of CIFS server names.
CIFS Server Show
Synopsis
cifs server show
Description
You can display a list of CIFS servers for a virtual server with the cifs server show
command at any time. You need to be in the virtual server context, and the virtual
server does not need to be disabled to do this.

5-4
Example
eng46 TECHPUBSVS> cifs server show
CIFS server names on the virtual server:

----------------------------------------
CIFSSERVER1
CIFSSERVER2
eng46 TECHPUBSVS>
This example shows a list of CIFS servers for the virtual server techpubsvs.
Related Commands
cifs server create Add a CIFS server name.
cifs server delete Delete a CIFS server name.
CIFS Share Add
Synopsis
cifs share add VOLNAME SHARENAME PATHNAME [-A
DOMAIN\USERGROUP:AUDITTYPE:RIGHTS] [-a ACCESSBASEDENUM] [-c
COMMENT] [-d DOMAIN\USERGROUP:RIGHTS] [-g
DOMAIN\USERGROUP:RIGHTS] [-o CACHING] [-s SESSIONS] [-w
WIDELINKS]
Description
CIFS advertises file systems. The share consists of the following parts:
• The volume that is shared with clients.
• The name of the share.
• The path to the volume and directory that is shared with the clients. The directory
that you reference with the path needs to exist in the file system.
• The access control rights.

5-5
• The access-based enumeration feature.

• An optional comment string that includes some text about the share.
• A deny list ACL entry.
• A grant list ACL entry.
• Client-side caching options.
• The maximum number of client sessions.
• Support for widelinks.
When you create the share, you are creating an export path for the directory and you
are providing clients with a mount point into the file system.
Note!
You must be in a virtual server context, the virtual server must be enabled, and
the path name must exist.
Table 5-1 : Options for the cifs share add command
VOLNAME The name of the volume on which the

share is created. Type the volume name
as an alphanumeric character string of
up to 128 characters. A volume name
can only contain letters, digits, hyphens
(-), or underscores (_).

5-6
Table 5-1 : Options for the cifs share add command (Continued)
SHARENAME An alphanumeric character string of up

to 128 characters that describes the share
that you are creating. The share name is
an identifier only, so it does not contain
any path, access, or permission
information. Each share name needs to
be unique.
Do not use special characters such as *,
?, and /|. If you want a share to be hidden
from end users, you can end a share
name with a dollar sign ($).
SHARENAME is case insensitive.
PATHNAME The absolute path to the volume and
directory that is shared. Type the path
starting from the root of the volume.
When you specify the path, include the
back slashes ( \ ). The path can have up
to 1024 characters.
If you are creating the share from the
NAS Gateway’s command-line interface
(CLI), specify the volume and path
portions of the share separately. You do
not need to provide a network drive
mapping. For example, the NAS
Gateway would reject C:\vol1 if you
entered it at the command line, but the
NAS Gateway would accept vol1.
If PATHNAME contains embedded
spaces, it must be enclosed in double
quotes.

5-7
-A DOMAIN\USERGROUP: Specifies an ACL entry that should be

AUDITTYPE:RIGHTS added to the Audit ACL. These entries
are users or groups for which audit
records should be generated when they
successfully use certain access rights, or
when they fail to use certain access
rights.
The administrator must have
SECURITY privileges to change the
Audit ACL.
• DOMAIN - The domain associated
with the user or group.
• USERGROUP - The name of the user
or group to which the ACL applies.
• AUDITTYPE - The type of Audit
ACL. The acceptable values are:
- success - Audit
successful accesses when
they use the specified
RIGHTS
- failed - Audit failed
accesses when they use
the specified RIGHTS.

5-8
-A DOMAIN\USERGROUP: • RIGHTS - These are the rights

AUDITTYPE:RIGHTS whose usage would generate an audit
(Continued) log entry. The acceptable values are:
- r - Read access
- c - Change access
- f - Full access
-a ACCESSBASEDENUM This option sets the access-based
enumeration feature to enabled or
disabled. When enabled, CIFS users
only see files and directories for which
they have read rights.
This enables or disables the access-
based enumerations support for this
share. Acceptable values are:
• enabled
• disabled
The default value is disabled.
-c COMMENT This is the comment string that will be
reported to CIFS clients when the
enumerate the shares on any virtual
server. The default value is no comment.
If COMMENT contains embedded
spaces, it must be enclosed in double
quotes. COMMENT is limited to 256
bytes in size.

5-9
-d DOMAIN\USERGROUP: Specifies an ACL entry that is to be

RIGHTS added to the deny list. These entries are
users or groups that are explicitly denied
certain access rights.
• RIGHTS - The access rights to deny.
The acceptable values are:
- r - Read access
- c - Change access
- f - Full access
-g DOMAIN\USERGROUP: Specifies an ACL entry that is to be
RIGHTS added to the granted list. These entries
are users or groups that are explicitly
granted certain access rights.
• RIGHTS - The access rights to grant.
- r - Read access
- c - Change access
- f - Full access

5-10
-o CACHING Sets the client-side caching options. This

controls how clients cache files for use
when working offline.The default value
is manual. The acceptable values are:
• none - Clients should not cache files
to make them available when
working offline.
• manual - Users must manually
specify any files they want available
when working offline. To ensure
proper file sharing, the server
version of the file is always opened.
• documents - Opened files are
automatically downloaded and made
available when working offline.
Older copies are automatically
deleted to make way for newer and
more recently accessed files. To
ensure proper file sharing, the server
version of the file is always opened.
• programs - Opened files are
available when working offline.
Older copies are automatically
deleted to make way to newer and
more recently accessed files. File
sharing is not ensured.
-s SESSIONS The maximum number of client sessions
on this share at any one time.

5-11
-w WIDELINKS This enables or disables support for

widelinks on this share. When enabled,
CIFS clients can be redirected by using
widelinks, but this CIFS share cannot be
a target of a GNS junction.
Acceptable values are enabled and
disabled. The default value is disabled.
The -A, -d, and -g options can appear multiple times to build a larger ACL.
Note!
This command supports a maximum of 25 arguments.
Example
eng31 PUBSTEST3> cifs share add pubstest techpubs \techpubs "Share

for product
documentation"
eng31 PUBSTEST3>
In this example, the virtual server pubstest3 is configured with a CIFS share. The
directory \techpubs on the volume pubstest is shared through the share techpubs.
Related Commands
cifs share delete Deletes a share.
cifs share modify Modifies a share.
cifs show Displays the share names of all exported file
systems and show information on the specified
share.
vol create Creates a logical volume, brings it online,
creates and mounts a file.

5-12
volume share export Export shares from a volume to a file.

volume share import Imports shares from a file to a volume.
CIFS Share Delete
Synopsis
cifs share delete SHARENAME
Description
You can delete a CIFS share at any time by running the cifs share delete
command. This command deletes the share, and the shared file system resource
becomes unavailable.
Note!
You cannot delete the system hidden share IPC$.
Options
The SHARENAME variable is an alphanumeric character string of
up to 128 characters that describes the share that you want to
delete.
Example
eng31 PUBSTEST3> cifs share delete techpubs

eng31 PUBSTEST3>
In this example, the CIFS share techpubs is deleted. Any resource that was shared
through techpubs is no longer available through that share. However, if a different
share is configured to export the resource, it is available to the clients through that
alternate share.
Related Commands
cifs share add Adds a specified share or path for CIFS users.

5-13

cifs show Displays the share names of all exported file
systems and shows information on the specified
share.
volume share export Exports shares from a volume to a file.
volume share import Imports share from a file to a volume.
CIFS Share Modify
Synopsis
cifs share modify SHARENAME [-A
DOMAIN\USERGROUP:AUDITTYPE:RIGHTS] [-a ACCESSBASEDENUM] [-c
COMMENT] [-d DOMAIN\USERGROUP:RIGHTS] [-g
DOMAIN\USERGROUP:RIGHTS] [-o CACHING] [-R
DOMAIN\USERGROUP:AUDITTYPE] [-r DOMAIN\USERGROUP] [-s SESSIONS]
[-w WIDELINKS]
Description
The NAS Gateway supports the Microsoft Windows feature access-based enumeration
(ABE) of CIFS shares.
With this feature, more control exists over what users see when they enumerate a
directory to only those files and directories for which they have
FILE_GENERIC_READ rights. ABE provides more security. For more information
about access based enumeration, you can search the Microsoft web site. You can use
the cifs share modify command to enable or disable ABE on a CIFS share. By
default ABE is disabled.

5-14
Options
Table 5-2 : Option for the cifs share modify command
SHARENAME An alphanumeric character string of up to

128 characters that describes the share that
you want to modify. Type the name of the
share.

5-15
Table 5-2 : Option for the cifs share modify command (Continued)
-A DOMAIN\USERGROUP: This option specifies an addition to the Audit

AUDITTYPE:RIGHTS ACL. These entries are users or groups for
which audit records should be generated
when they successfully use certain access
rights, or when they fail to use certain access
rights. Success or failure is controlled by the
AUDITTYPE setting. The administrator must
have SECURITY privileges to change the
Audit ACL. This option can appear multiple
times.
• DOMAIN - The domain associated with
the user or group.
• USERGROUP - The name of the user or
group to which the ACL applies.
• AUDITTYPE - The type of Audit ACL.
- success - Audit successful
accesses when they use the
specified RIGHTS
- failed - Audit failed accesses
when they use the specified
RIGHTS.
• RIGHTS - The access rights to grant or
deny. The acceptable values are:
- r - Read access
- c - Change access
- f - Full access

5-16
-a ACCESSBASEDENUM Sets the access-based enumerations feature to

enabled or disabled.
• When enabled, CIFS users only see files
and directories on which they have
FILE_GENERIC_READ rights.
• When disabled, CIFS users see an
unfiltered directory listing.
The default is disabled.
-c COMMENT This is the comment string that will be
reported to CIFS clients when the enumerate
the shares on any virtual server. The default
value is no comment.
If COMMENT contains embedded spaces, it
needs to be enclosed in double quotes.
-d DOMAIN\USERGROUP:R Specifies an ACL entry that is to be added to
IGHTS the deny list. These entries are users or
groups that are explicitly denied certain
access rights. This option can appear multiple
times.
the user or group.
deny. The acceptable values are:
- r - Read access
- c - Change access
- f - Full access

5-17
-g DOMAIN\USERGROUP:R Specifies an ACL entry that is to be added to

IGHTS the granted list. These entries are users or
groups that are explicitly granted certain
access rights. This option can appear multiple
times.
the user or group.
• RIGHTS - The access rights to grant. The
acceptable values are:
- r - Read access
- c - Change access
- f - Full access

5-18

controls how clients cache files for use when
working offline.The default value is manual.
• none - Clients should not cache files to
make them available when working
offline.
• manual - Users must manually specify
any files the want available when
working offline. To ensure proper file
sharing, the server version of the file is
always opened.
available when working offline. Older
copies are automatically deleted to make
way for newer and more recently
accessed file. To ensure proper file
always opened.
way to newer and more recently accessed
files. File sharing is not ensured.

5-19
-R DOMAIN\USERGROUP:A Specifies an ACL entry that should be removed

UDITTYPE from the Audit success or failure ACL list
depending on the AUDITTYPE setting. This
option can appear multiple times. The
administrator must have SECURITY privileges
to change the Audit ACL.
the user or group.
• AUDITTYPE - The type of Audit ACL.
- success - Audit successful
accesses when they use the
specified RIGHTS
- failed - Audit failed accesses
when they use the specified
RIGHTS.
-r DOMAIN\USERGROUP Removes the ACL entry associated with the user
or group. This option can appear multiple times.
the user or group.
-s SESSIONS The maximum number of client sessions on
this share at any one time.

5-20
-w WIDELINKS This enables or disables support for

widelinks on this share. When enabled, CIFS
clients can be redirected by using widelinks,
but this CIFS share cannot be a target of a
GNS junction.
Acceptable values are enabled and disabled.
The default value is disabled.
Example
eng11> cifs share modify \techpubs\ftp -a enable

eng11>
In this example, ABE is being enabled on the share \techpubs\ftp.
Related Commands
cifs share add Adds a share name for the specified path.
cifs share delete Deletes a share.
cifs show Displays the share names of all
exported file systems and shows
information on the specified share.
volume share export Exports shares from a volume to a file.

5-21
CIFS Show
Synopsis
cifs show [SHARENAME]|[all]|[-v VOLNAME [-P PAGENUMBER [-S PAGESIZE]]]
Description
When you configure a CIFS share, it is added to a list of shares. This list contains the
share definition and path and parameter information for the share. SHARENAME
displays information about a specific share.
The shares list shows regular file system shares and shares that are hidden from
clients. A dollar sign ($) indicates that a share is hidden from clients. The NAS
Gateway supports the IPC$ share by default.
Note!
You can view the list of configured shares through standard CIFS client
browsing, for example, through the Network Neighborhood display when
using a Windows client. The resulting list of Network Places is the contents of
the CIFS shares list.
Options
Table 5-3 : Options for the cifs show command
SHARENAME An optional alphanumeric character

string of up to 128 characters that is the
share name.
If you do not specify a share name, the
NAS Gateway shows all shares in the
virtual server.
all Displays all CIFS shares on a virtual
server

5-22
Table 5-3 : Options for the cifs show command (Continued)
-v VOLNAME Displays all CIFS shares on a specified

volume.
-P PAGENUMBER Specifies the number of the page to
display.
-S PAGESIZE Specifies the page size in number of
records to display.
Example
In the following example, all shares configured in the virtual server are displayed.
eng31 PUBSTEST3> cifs show

techpubs
engineering
marketing
VSCAN$
IPC$
eng31 PUBSTEST3>
In this example, the virtual server pubstest3 is configured with a CIFS share. Because
the command does not include a specific share name, the NAS Gateway shows all the
shares configured in the virtual server, including the hidden shares IPC$ and VSCAN$
(for virus scanning).

5-23
The following example shows information about a specific share.
eng61 ENG61-VS1> cifs show sharenewx

Name : sharenewx
Volume : eng61vs1
Path : share2
Comment :
Session Limit : Unlimited
Caching : manual
Options : AccessBasedEnumerations: disabled
: Widelinks: enabled
Security :
ACL :
Allowed ACE: MATRIX\Domain Users:r
Allowed ACE: MATRIX\qacifs7077:frc
Audit ACL : None
eng61 ENG61-VS1>
This example shows detailed information for the share sharenewx, which includes the
• The name of the share
• The name of the volume that is shared
• The path to the volume that is shared
• An optional comment
• The session limit
• The caching option
• Additional options
• The security level
• The ACL
Related Commands
cifs server Manage CIFS sever names on a virtual server.
cifs share add Add a share for the specified path.

5-24
volume share export Exports share from a volume to a file.


Chapter 6: CIFS-GNS Commands
This chapter documents the following CIFS-GNS commands:
• “GNS Add Directory” on page 6-2
• “GNS Add Junction” on page 6-5
• “GNS Add Root” on page 6-7
• “GNS Delete” on page 6-12
• “GNS Modify Directory” on page 6-14
• “GNS Modify Junction” on page 6-18
• “GNS Modify Root” on page 6-21
• “GNS Show” on page 6-27

6-2
GNS Add Directory
Synopsis
gns add dir cifs ROOTNAME\PATH [-d DOMAIN\USERGROUP:RIGHTS]
[-g DOMAIN\USERGROUP:RIGHTS]
Description
This command adds a new global name space directory to every virtual server.
Options
Table 6-1 : Options for the gns add directory command
ROOTNAME The name of the root. ROOTNAME is

case insensitive.
PATH One or more directory names
delimited by a backslash (\). The last
name in the path must not exist, but
the previous ones in the path must
already exist. PATH is case
insensitive. PATH is limited to 255
characters.

6-3
Table 6-1 : Options for the gns add directory command (Continued)
-d DOMAIN\USERGROUP:RIGHTS Specifies an ACL entry that should be

added to the deny list. These entries
are users or groups that are explicitly
denied certain access rights. It is
required that the caller be in some
virtual server context if they are going
to set deny ACL entries. This option
can appear multiple times.
• USERGROUP - The name of the
user or group to which the ACL
applies.
• RIGHTS - The access rights to
deny. The acceptable value is r for
read access.

6-4
Table 6-1 : Options for the gns add directory command (Continued)
-g DOMAIN\USERGROUP:RIGHTS Specifies an ACL entry that should be

added to the granted list. These
entries are users or groups that are
explicitly granted certain access
rights. It is required that the caller be
in some virtual server context if they
are going to set grant ACL entries.
This option can appear multiple
times.
• USERGROUP - The name of the
user or group to which the ACL
applies.
grant. The acceptable value is r
for read access.
Example
The following example adds the global name space directory maryroot3\dirtest.
eng53> gns add dir cifs maryroot3\dirtest

eng53> gns show cifs maryroot3\dirtest
Created : Fri Mar 23 10:53:51 2007
LastWriteTime : Fri Mar 23 10:53:51 2007
Inode : 126
Security :
ACL :
Allowed ACE: Everyone:r
Children : None
eng53>

6-5
Related Commands
gns delete cifs Deletes a CIFS global name space object.
gns modify dir cifs Modifies a CIFS virtual directory in the global
name space.
gns show cifs Displays CIFS global name space objects.
GNS Add Junction
Synopsis
gns add junction cifs ROOTNAME\PATH [-t TARGET]
Description
This command adds a new global name space junction to every virtual server.
Options
Table 6-2 : Options for the gns add junction command
ROOTNAME Name of the parent global

name space root.
ROOTNAME is case
insensitive.
PATH One or more directory
names delimited by a
backslash (\). The last
name must not exist, but
the previous ones must
already exist. PATH is case
insensitive. PATH is limited
to 255 characters.

6-6
Table 6-2 : Options for the gns add junction command (Continued)
-t TARGET A target path to which DFS

clients will be redirected.
For example,
\\server\share\path.
This option can appear up
to 8 times to create
multiple targets.
Note! There is a Windows
restriction that there can
only be a single target path
when it is a domain-based
DFS path. A domain-based
DFS path is one where the
DFS path is stored in the
Active Directory. An
example of such a path is
\\onstor.com\public.
Example
The following example adds a junction with a ROOTNAME\PATH of
maryroot5\junction1 and with a target path of \\eng61-vs1\share1.
eng61 ENG61-VS2> gns add junction cifs maryroot5\junction1 -t

\\eng61-vs1\share1
Related Commands
gns modify junction cifs Modifies a CIFS junction in the global name
space.

6-7
GNS Add Root
Synopsis
gns add root cifs ROOTNAME [-a ACCESSBASEDENUM] [-c COMMENT]
[-d DOMAIN\USERGROUP:RIGHTS] [-g DOMAIN\USERGROUP:RIGHTS]
[-o CACHING]
Description
A GNS root is logically the top of the global name space. There can be more than one
GNS root, such as one for Marketing and another for Engineering. Each one might
lead to a different, but overlapping, set of virtual servers and shares.
This command creates a new GNS root that is exported by every virtual server in the
cluster as the CIFS share \\vsvr\ROOTNAME.

6-8
Options
Table 6-3 : Options for the gns add root command
ROOTNAME The name of the root. This name cannot

match any existing root or CIFS share name
in the cluster. ROOTNAME is case
insensitive. ROOTNAME is limited to 250
characters.
Note!
Win32 applications cannot access a path greater
than 260 total bytes. If ROOTNAME is too long,
then the combined virtual server names and
ROOTNAME will not be a path that clients can
use in applications like the Explorer. In practice
the length of \\Server\ROOTNAME must not
exceed 258 characters, where Server is any
virtual server name in the cluster.
-a ACCESSBASEDENUM Sets the access-based enumeration feature to

enabled or disabled. When enabled, CIFS
users can only see files and directories for
which they have read rights. Acceptable
values for the ACCESSBASEDENUM variable
are:
• enabled
• disabled
This feature is disabled by default.

6-9
Table 6-3 : Options for the gns add root command (Continued)

controls how clients cache files for use when
working offline.
The CACHING variable describes how files
are cached on the clients. The default value
is manual. The acceptable values are:
• none - Clients do not cache files to make
them available when working offline.
• manual - Users must manually specify
any files that they want available when
working offline. To ensure proper file
always opened.
room for newer and more recently
accessed files. To ensure proper file
always opened.
room for newer and more recently
accessed files. File sharing is not
ensured.

6-10
-o CACHING (Continued) Note!

If Win2k clients are used, you should not enable
client-side caching. For additional
information,see http://support.microsoft.com/
?kbid=262845.
-c COMMENT The new comment string that will be

reported to CIFS clients when they
enumerate the shares on any virtual server.
The default value is no comment.
The COMMENT string needs to be enclosed
in double quotes, if it contains embedded
spaces.
The size of the COMMENT string is limited
to 256 bytes.
-d DOMAIN\USERGROUP: Specifies an ACL entry that should be added
RIGHTS to the deny list. These entries are users or
groups that are explicitly denied certain
access rights. It is required that the caller be
in some virtual server context if they are
going to set deny ACL entries. This is
required because we need to be able to
convert the names to ids. This option can
appear multiple times.
the user or group.
deny. The acceptable value is r for read
access.

6-11
-g DOMAIN\USERGROUP: Specifies an ACL entry that should be added

RIGHTS into the granted list. These entries are users
or groups that are explicitly granted certain
access rights. It is required that the caller be
in some virtual server context if they are
going to set grant ACL entries. This option
the user or group.
• RIGHTS - The access rights to grant. The
acceptable value is r for read access.
Example
The following example adds root pubroot, denies read rights for matrix\grouptest1 and
grants read rights for matrix\domain users.
eng53 ENG61-VS1 diag> gns add root cifs pubroot -d

"matrix\grouptest1:r" -g "matrix\domain users:r"
eng53 ENG61-VS1 diag> gns show cifs pubroot
Created : Fri Mar 23 11:39:42 2007
Comment :
Caching : manual
Security :
ACL :
Denied ACE: MATRIX\groupTest1:r
Children : None
eng53 ENG61-VS1 diag>

6-12
Related Commands
gns modify root cifs Modifies a CIFS global name space root.
GNS Delete
Synopsis
gns delete cifs ROOTNAME[\PATH] [-r]
Description
This command deletes global name space objects.
Options
Table 6-4 : Options for gns delete command
PATH The optional path within

the global name space to
be deleted.
ROOTNAME The name of the root to
delete or the parent of the
path that is to be deleted.

6-13
Table 6-4 : Options for gns delete command (Continued)
-r Specifies that all objects in

ROOTNAME\PATH should
be recursively deleted.
Deletion only occurs
within the global name
space. This option will not
delete the CIFS shares or
files to which child
junctions point. If there are
child objects, this
command will fail without
the -r option.
Example
The following example deletes maryroot3\dirtest and uses the -r recursive option.
eng53 ENG61-VS1> gns del cifs maryroot3\dirtest -r

Recursively deleting a GNS sub-tree may take awhile...
Are you sure ? [y|n] : y
/
eng53 ENG61-VS1>
Related Commands
gns add dir cifs Adds a CIFS virtual directory to the global name
space.
gns add junction cifs Adds a CIFS junction to the global name space
gns add root cifs Adds a CIFS Root to the global name space.

6-14
GNS Modify Directory
Synopsis
gns modify dir cifs ROOTNAME\PATH [-d DOMAIN\USERGROUP:RIGHTS]
[-g DOMAIN\USERGROUP:RIGHTS] [-n NEWNAME]
[-r DOMAIN\USERGROUP]
Description
This command modifies a global name space directory in every virtual server.
Options
Table 6-5 : Options for the gns modify directory command
PATH One or more directory names

delimited by a backslash (\). PATH
is case insensitive.
-n NEWNAME Renames the directory. The object
stays within the current parent
directory.

6-15
Table 6-5 : Options for the gns modify directory command (Continued)
-d DOMAIN\USERGROUP:RIGHTS Specifies an ACL entry that

should be added into the deny list.
These entries are users or groups
that are explicitly denied certain
access rights. It is required that
the caller be in some virtual server
context if they are going to set
deny ACL entries. This is
required because we need to be
able to convert the names to ids.
times.
• DOMAIN - The domain
associated with the user or
group.
• USERGROUP - The name of
the user or group to which the
ACL applies.
grant or deny. The acceptable
value is r for read access.

6-16
-g DOMAIN\USERGROUP:RIGHTS Specifies an ACL entry that

should be added into the granted
list. These entries are users or
groups that are explicitly granted
certain access rights. It is required
that the caller be in some virtual
server context if they are going to
set grant ACL entries. This is
required because we need to be
able to convert the names to ids.
times.
group.
ACL applies.
ROOTNAME The name of the root. This
variable is case insensitive.
USERGROUP The name of the user or group to
which the ACL applies.

6-17
-r DOMAIN\USERGROUP Removes the ACL entry

associated with the user or group.
group.
ACL applies.
Example
The following example renames dir1 to newDir.
eng53 ENG61-VS1> gns modify dir cifs pubroot\dir1 -n newDir

eng53 ENG61-VS1> gns show cifs pubroot\newDir
Created : Fri Mar 23 11:42:15 2007
Inode : 132
Security :
ACL :
Children : None
eng53 ENG61-VS1>
Related Commands
space.

6-18
GNS Modify Junction
Synopsis
gns modify junction cifs ROOTNAME\PATH [-n NEWNAME] [-r TARGET]
[-t TARGET]
Description
Modifies a CIFS junction in the global name space.
Options
Table 6-6 : Options for the gns modify junction command
-n NEWNAME Renames the junction. The

object stays within the
current parent directory.
backslash (\). This variable
is not case sensitive.
name cannot match any
existing root or CIFS share
name in the cluster.
ROOTNAME is case
insensitive. ROOTNAME is
limited to 255 characters.

6-19
Table 6-6 : Options for the gns modify junction command (Continued)
-r TARGET Removes the given target

path from the list of
alternates. If all paths are
removed, the junction
continues to exist, but
clients will not be able to
traverse it. This is the
target path to which DFS
clients will be redirected.
For example,
This variable is not case
sensitive. This option can
appear up to 8 times to
create multiple targets.

6-20
Table 6-6 : Options for the gns modify junction command (Continued)
-t TARGET Adds the given target path

to the list of alternatives.
Note! It is a Windows
restriction that there can
only be a single target path
when it is a domain-based
path. A domain-based DFS
path is one where the DFS
path is stored in the Active
Directory. An example of
such a path is
\\onstor.com\public.
This is the target path to
which DFS clients will be
redirected. For example,
This variable is not case
sensitive. This option can
Example
The following example adds a target.
eng61 ENG61-VS2> gns modify junction cifs maryroot5\junction1 -t

\\eng61-vs2\share1
The following example removes a target.
eng61 ENG61-VS2 diag> gns modify junction cifs maryroot5\junction1

-r \\eng61-vs2\share1

6-21
Related Commands
gns add junction cifs Adds a CIFS junction to the global name space.
GNS Modify Root
Synopsis
gns modify root cifs ROOTNAME [-a ACCESSBASEDENUM] [-c COMMENT]
[-d DOMAIN\USERGROUP:RIGHTS] [-g DOMAIN\USERGROUP:RIGHTS]
[-n NEWNAME] [-o CACHING] [-r DOMAIN\USERGROUP]
Description
This command modifies the global name space root.
Options
Table 6-7 : Options for the gns modify root command
ROOTNAME The name of the root to modify.

ROOTNAME is case insensitive.

6-22
Table 6-7 : Options for the gns modify root command (Continued)
-a ACCESSBASEDENUM Sets the access-based enumeration

feature to enabled or disabled.
When enabled, CIFS users only
see files and directories on which
they have read rights. Acceptable
values for the
ACCESSBASEDENUM variable
are:
• enabled
• disabled
This feature is disabled by default.
-c COMMENT The new comment string that will
be reported to CIFS clients when
the enumerate the shares on any
virtual server. The default value is
no comment.
The COMMENT string needs to be
enclosed in double quotes, if it
contains embedded spaces.
The size of the COMMENT string
is limited to 256 bytes.

6-23
-d DOMMAIN\USERGROUP:RIGHTS Specifies an ACL entry that

should be added to the deny list.
These entries are users or groups
that are explicitly denied certain
access rights. It is required that the
caller be in some virtual server
context if they are going to set
deny ACL entries. This option can
group.
ACL applies.

6-24
-g DOMMAIN\USERGROUP:RIGHTS Specifies an ACL entry that

should be added to the granted
list. These entries are users or
groups that are explicitly granted
certain access rights. It is required
that the caller be in some virtual
server context if they are going to
set grant ACL entries. This option
group.
ACL applies.
-n NEWNAME Renames the root. The object
stays within the current parent
directory.
Note!
Win32 applications cannot access a
path greater than 260 total bytes. If
NEWNAME is too long, then the
combined virtual server names and
NEWNAME will not be a path that
clients can use in applications like the
Explorer. In practice the length of
\\Server\NEWNAME must not exceed
258 characters, where Server is any
virtual server name in the cluster.

6-25
-o CACHING Sets the client-side caching

options. This controls how clients
cache files for use when working
offline.
This variable describes how files
are cached on the clients. The
default value is manual. The
acceptable values are:
• none - Clients should not
cache files to make them
available when working
offline.
• manual - Users must manually
specify any files they want
available when working
offline. To ensure proper file
sharing, the server version of
the file is always opened.
automatically downloaded and
made available when working
offline. Older copies are
automatically deleted to make
room for newer and more
recently accessed files. To
ensure proper file sharing, the
server version of the file is
always opened.

6-26
-o CACHING (Continued) • programs - Opened files are

automatically downloaded and
made available when working
offline. Older copies are
automatically delete to make
room for newer and more
recently accessed files. File
sharing is not ensured.
Note!
If Win2k clients are used, you should
not enable client-side caching. For
additional information, see http://
support.microsoft.com/
?kbid=262845.
-r DOMAIN\USERGROUP Removes the ACL entry

associated with the user or group.
group.
ACL applies.
Example
The following example sets the caching option to programs.
eng53 ENG61-VS1> gns modify root cifs pubroot -o programs
Related Commands

6-27

GNS Show
Synopsis
gns show cifs [all|ROOTNAME[\PATH]]
Description
This command displays information about global name space objects.
If ROOTNAME is omitted, or all is specified, the names of all the roots are displayed.
If ROOTNAME is provided and PATH is omitted the detailed information about the root,
including the comment, the ACL, and the list of child GNS objects is displayed. For
each child object the name and the object type, either virtual directory or junction, is
displayed.
If ROOTNAME and PATH are provided and they refer to a virtual directory detailed
information about the directory including the ACL and the list of child GNS objects is
displayed. For each child object the name and the object type, either virtual directory
or junction, is displayed.
If ROOTNAME and PATH are provided and they refer to a junction, the list of target
paths to which this junction points is displayed.
Note!
If the virtual server context is not set it may not be possible to convert the
security information into normal user and group names.

6-28
Options
Table 6-8 : Options for the gns show command

backslash (\). PATH is case
insensitive.
name cannot match any
existing root or CIFS share
name in the cluster.
ROOTNAME is case
insensitive. ROOTNAME is
limited to 255 characters.

6-29
Example
The following example displays the names of all the roots.
eng53 ENG61-VS1 diag> gns show cifs all

Children : Root maryroot30
: Root maryroot20
: Root maryroot27
: Root maryroot24
: Root maryroot5
: Root maryroot6
: Root maryroot7
: Root maryroot8
: Root maryroot9
: Root maryroot10
: Root maryroot11
: Root maryroot12
: Root maryroot14
: Root maryroot13
: Root maryroot15
: Root maryroot16
: Root maryroot18
: Root maryroot1
: Root maryroot19
: Root maryroot21
: Root maryroot17
: Root maryroot3
: Root maryroot4
: Root maryroot2
: Root maryroot22
: Root maryroot23
: Root maryroot25
: Root maryroot29
: Root maryroot28
: Root maryroot26
: Root maryroot31
: Root maryroot32

6-30
The following example shows detailed information about ROOTNAME maryroot31.
eng53 ENG61-VS1> gns show cifs maryroot31

Created : Mon Mar 12 10:51:16 2007
LastWriteTime : Mon Mar 12 10:51:16 2007
Comment :
Caching : manual
Security :
ACL :
Children : None
eng53 ENG61-VS1>
The following example shows detailed information about ROOTNAME maryroot5 and
PATH dir3.
eng53 ENG61-VS1> gns show cifs maryroot5\dir3

Created : Fri Mar 16 06:37:19 2007
Inode : 113
Security :
ACL :
Children : Junction junctionx
eng53 ENG61-VS1>
Related Commands
space.
gns add junction cifs Adds a CIFS junction to the global name space.

Chapter 7: Cluster Commands
This chapter documents the following cluster commands:
• “Cluster Add NAS Gateway” on page 7-2
• “Cluster Add Group” on page 7-4
• “Cluster Commit” on page 7-5
• “Cluster Delete NAS Gateway” on page 7-6
• “Cluster Delete Group” on page 7-8
• “Cluster Move NAS Gateway” on page 7-9
• “Cluster Show Cluster” on page 7-11
• “Cluster Show Group” on page 7-13
• “Cluster Show Summary” on page 7-14
• “Cluster Uncommit” on page 7-16

7-2
Cluster Add NAS Gateway
Synopsis
cluster add nasgateway NASGATEWAYNAME -a IPADDR
Description
By default, each ONStor™ NAS Gateway is its own cluster of one. In this
configuration each individual NAS Gateway is its own cluster controller and cluster
node, and each NAS Gateway maintains its own cluster database.
However, you can create a cluster of multiple NAS Gateways by adding NAS
Gateways with the cluster add nasgateway command. The cluster creation process
for multiple NAS Gateways involves configuring one NAS Gateway, then adding
other NAS Gateways to the cluster. In this configuration the following occurs:
• The cluster adopts the node name of the NAS Gateway on which you configure the
cluster.
• The cluster controller is elected after you run the cluster commit command.
• Each NAS Gateway you add to the cluster synchronizes with the cluster controller
and updates its cluster database.
With the cluster add nasgateway command, you can specify the node name of the
NAS Gateway to be added and posts its name in the cluster member list. The node
name is configured as part of the start script the first time you turn on the NAS
Gateway.
To make the NAS Gateway active in the cluster run the cluster commit command.
When this command completes, one cluster controller is elected from the nodes, and
all nodes in the cluster become active.

7-3
Options
Table 7-1 : Options for the cluster add nasgateway command
NASGATEWAYNAME The unique node name of the NAS Gateway to

be added to the cluster. The NAS Gateway’s
node name is assigned when you first start the
NAS Gateway, so to add the NAS Gateway to
a cluster, you need to specify the node name as
it was specified. To determine the NAS
Gateway’s node name, look at the command
prompt, for example, eng31>
Do not include the > when specifying the NAS
Gateway’s node name.
-a IPADDR This specifies the NAS Gateway’s IP address
instead of the NAS Gateway’s node name if
DNS name service is not active in the network.
Example
eng38> cluster add nasgateway Falcon -a 10.2.46.1

eng38>
In this example, the NAS Gateway Falcon is added to the cluster. The NAS Gateway’s
IP address is also specified to enable addition of the NAS Gateway to a cluster where
DNS is not active to resolve the node name Falcon.
Related Commands
cluster commit Commits changes made to a cluster.
cluster uncommit Uncommits changes made to a cluster.
cluster delete nasgateway Removes a NAS Gateway from a cluster.

7-4
cluster show cluster Shows cluster configuration.
Cluster Add Group
Synopsis
cluster add group GROUPNAME
Description
NAS Gateway groups are subgroups within the cluster. Each NAS Gateway group can
contain one or more NAS Gateways that are manually added to the NAS Gateway
group. A NAS Gateway group is not mandatory, but it is helpful if you want to
configure and manage some NAS Gateways in the cluster differently than others. NAS
Gateway group boundaries are strictly enforced with the exception of control
messages, such as the synchronization of the cluster database between the cluster
controller and the nodes in the cluster. Failover of virtual servers need to respect the
NAS Gateway group boundaries, so virtual servers can fail over only within their
respective NAS Gateway group. Each cluster can support a maximum of four Gateway
groups, excluding the default group. You can add NAS Gateways to a group any time
after you have configured the group.
Options
The GROUPNAME variable is the name of the NAS Gateway
group that you are adding to the cluster. Group names can have up
to 64 alphabetic characters.
Example
eng38> cluster add group birdsofprey

eng38>
In this example, the NAS Gateway group birdsofprey is added to the cluster.

7-5
Related Commands
cluster delete group Removes a NAS Gateway group from cluster.
cluster show group Shows NAS Gateway group configuration.
Cluster Commit
Synopsis
cluster commit
Description
Cluster parameters do not have to be active for you to be able to configure them. To
make cluster parameters active in the cluster database after you have configured them,
run the cluster commit command. For example, if you run the cluster add
nasgateway command, that command issues on the cluster node. However, the
command is not written to the cluster database and made active to the rest of the nodes
in the cluster until you run the cluster commit command.
Some cluster commands require the cluster commit command. The following table
shows each cluster command and whether it requires the cluster commit command.
Table 7-2 : Commands requiring cluster commit
Command Name Requires Commit?
cluster add nasgateway Yes

cluster delete nasgateway Yes
cluster add group No
cluster delete group No
cluster show cluster No
cluster show group No

7-6
Example
eng38> cluster commit

eng38>
In this example, the cluster commit command activates the cluster configuration.
Related Commands
cluster add nasgateway Adds a NAS Gateway to a cluster.
cluster delete nasgateway Removes a NAS Gateway from a cluster.
Cluster Delete NAS Gateway
Synopsis
cluster delete nasgateway NASGATEWAYNAME -a IPADDR
Description
When you delete a NAS Gateway from a cluster, it is removed from the cluster and its
node name is removed from the cluster members list. Therefore, the deleted NAS
Gateway no longer participates in the cluster. You can delete a NAS Gateway by
running the cluster delete nasgateway command.
Removing a NAS Gateway from a cluster with the cluster delete nasgateway
command causes the NAS Gateway to restart only . When the NAS Gateway restarts,
it deletes all configuration information from its cluster database, except the IP
interface configuration for the system switch and controller (SSC) ports and network
time protocol (NTP) configuration.
Note!
If the NAS gateway being deleted was servicing virtual servers, they do not
failover to another node in the cluster. They have to be moved prior to deleting
the NAS gateway

7-7
Options
Table 7-3 : Options for the cluster delete nasgateway command
Optio
Object Description
n
NASGATEWAYNAME The unique NAS Gateway node name to be

deleted from the cluster. The NAS Gateway’s
node name is assigned when you first start the
NAS Gateway, so to delete the NAS Gateway
from a cluster, specify the assigned node name.
To determine the NAS Gateway’s node name
look at the command prompt, for example,
eng31>.
Do not include the > when specifying the NAS
Gateway’s node name.
-a IPADDR This specifies the NAS Gateway’s IP address,
instead of the NAS Gateway’s node name, if
DNS name service is not active in the network.
Example
eng38> cluster delete NASGATEWAY Falcon -a 10.2.46.1

eng38>
In this example, the NAS Gateway Falcon is deleted from the cluster. In this example,
the NAS Gateway’s IP address is also being specified to enable deletion of the NAS
Gateway from a cluster where DNS is not active to resolve the node name Falcon.
Note!
To proceed with the deletion, do not forget to run cluster commit after
cluster delete nasgateway.
Related Commands

7-8
cluster add nasgateway Add a NAS Gateway to a cluster.

cluster show cluster Shows cluster configuration.
Cluster Delete Group
Synopsis
cluster delete group GROUPNAME
Description
You can delete a NAS Gateway group from a cluster by running the cluster delete
group command. You cannot delete a NAS Gateway group if it still contains NAS
Gateways. If you attempt to delete a NAS Gateway group that is not empty, the NAS
Gateway posts an error message stating that the requested operation failed because the
NAS Gateway group is not empty.
Options
The GROUPNAME variable is the name of the NAS Gateway
group that you are deleting from the cluster. Group names can
have up to 64 alphabetic characters.
Example
eng38> cluster delete group birdsofprey

eng38>
In this example, the NAS Gateway group birdsofprey is deleted from the cluster. If you
have previously deleted all NAS Gateways from the group birdsofprey with the
cluster delete nasgateway command, the NAS Gateway group birdsofprey is
deleted when the cluster delete group command completes.

7-9
Related Commands
cluster add group Creates a NAS Gateway group within cluster.
cluster show group Shows NAS Gateway group configuration.
cluster move nasgateway Moves a NAS Gateway from one NAS Gateway
group to another.
Cluster Move NAS Gateway
Synopsis
cluster move nasgateway NASGATEWAYNAME -g GROUPNAME [-a]
Description
You can move a NAS Gateway from one NAS Gateway group into another NAS
Gateway group by running the cluster move nasgateway command. Virtual servers,
except for the management virtual server, stay with the current NAS Gateway group
unless you specify that they be moved to the destination NAS Gateway group.

7-10
Options
Table 7-4 : Options for the cluster move nasgateway command
NASGATEWAYNAME The name of the NAS Gateway to be

moved to another NAS Gateway group.
-g GROUPNAME The name of the destination NAS
Gateway group to which to move the
NAS Gateway.
-a Specifies to move all virtual servers
belonging to the NAS Gateway to the
new NAS Gateway group along with the
NAS Gateway.
Example
eng38> cluster move nasgateway nasgateway1 -g nasgatewaygroup1 -a

eng38>
In this example, the NAS Gateway nasgateway1 is moved to NAS Gateway group
nasgatewaygroup1 along with all virtual servers that belong to the NAS Gateway that
is moved.
Related Commands
cluster add group Creates a NAS Gateway group within a cluster.
cluster commit Commits changes made to the cluster.
cluster delete group Removes a NAS Gateway group from a cluster.
cluster show group Displays the NAS Gateway group configuration.

7-11
Cluster Show Cluster
Synopsis
cluster show cluster
Description
You can display the cluster configuration at any time by running the cluster show
cluster command. Cluster configuration is the result of parameters you configured
and activated with the cluster commit command. If you configure cluster
parameters, but do not run the cluster commit command, the parameters do not
activate, so they do not appear in the cluster configuration.
Because each NAS Gateway in the cluster contains an identical version of the cluster
database, you can run the cluster show cluster command on any NAS Gateway in
the cluster and you will see the same information.
Example
The following example shows information for a multiple NAS Gateway cluster.
eng38> cluster show cluster

Cluster Name: eng38 Cluster State: On
NAS Gateways IP State PCC
------------------------------------------------------
eng38 10.2.13.3 UP NO
eng35 10.2.14.6 UP YES
eng38>
This example shows the cluster configuration as follows:

• Cluster Name shows the cluster’s name, in this example eng 38. By default, the
cluster inherits the name of the NAS Gateway on which you created the cluster.
• Cluster State shows the current state of the cluster. Valid values are On for a cluster
that is active, and Off for a cluster that is not active.

7-12
The cluster show cluster command also contains a table of information about the
nodes that are participating in the cluster. The table shows the following information
for the cluster’s nodes:
• NAS Gateways shows the node names of the NAS Gateways that are configured in
the cluster. Those node names are added to this display when you run the cluster
commit command.
• IP shows the IP address on which each NAS Gateway is configured. The address
shown is the SSC management port address that was assigned during the OCT, or
through the interface modify sc1 or sc2 command.
• State shows the current operational state of each NAS Gateway in the cluster. Valid
states are UP for a NAS Gateway that is online in the cluster as a cluster node, or
DOWN for a NAS Gateway that is restarting or offline as a cluster node.
• PCC shows each NAS Gateway’s state as a cluster controller in the cluster. Valid
values are NO for a NAS Gateway that has not been elected the role of cluster
controller, or YES for a NAS Gateway that has been elected the role of cluster
controller.
The following example shows information for a cluster of one NAS Gateway.
eng57> cluster show cluster

------------------------------------------------------
eng57 10.2.1.15 UP YES
eng57>
Related Commands
cluster add nasgateway Adds a NAS Gateway.
cluster delete nasgateway Deletes a NAS Gateway.

7-13
Cluster Show Group
Synopsis
cluster show group
Description
At any time, you can display the configuration of the NAS Gateway group in which
the current NAS Gateway resides. The NAS Gateway group configuration shows
information about all NAS Gateway groups that are configured in the cluster and lists
all the NAS Gateways that are configured in each NAS Gateway group. You can
display the NAS Gateway groups configured in the cluster by running the cluster
show group command. This command shows the following information:
• The name of each group that is configured on the NAS Gateway.

• The node names of the NAS Gateways that are configured within each NAS
Gateway group.
Because each NAS Gateway in the cluster contains an identical version of the cluster
database, you can run this command on any NAS Gateway in the cluster and you will
see the same information.

7-14
Example
eng58> cluster show group

GROUP default
NAS GATEWAY virtual-filer
GROUP video
NAS GATEWAY eng58
VSVR VS_MGMT_414
VSVR ENG58V2
VSVR ENG58V7
VSVR ENG58V1
VSVR ENG58V6
NAS GATEWAY virtual-filer
10.2.17.1 UP YES
eng58>
In this example, the NAS Gateway groups configured in the cluster are displayed. In
this example, the cluster contains the NAS Gateway group default. This NAS Gateway
group contains two NAS Gateways listed by name, eng57 and virtual-filer.
Related Commands
cluster add group Creates a NAS Gateway group within a cluster.
cluster delete group Removes a NAS Gateway group from a cluster.
cluster move nasgateway Moves a NAS Gateway from one NAS Gateway
group to another.
Cluster Show Summary
Synopsis
cluster show summary
Description
At any time, you can use the cluster show summary to find out the information about
the current cluster. You can use the cluster show summary command to display
the following information:
• Number of NAS Gateways in the cluster

7-15
• Number of NAS Gateway groups in the cluster

• Number of virtual servers in the cluster
• Number of volumes in the cluster
• Number of volumes online and offline
• Capacity of online volumes and percentage of use
Example
eng57> cluster show summary

------------------------------------------------------
------------------------------------------------------
eng57 10.2.1.15 UP YES
------------------------------------------------------
PCC Name : eng57
Gateway Groups : default
No of Gateway Group(s) : 1
No of Gateway(s) : 1
No of Virtual Server(s): 3
No of Volume(s) : 2
No of online Volume(s) : 2
No of offline Volume(s): 0
Online Volume capacity : 20223.9 MiB
Percent used : 0.35%
eng57>
In this example, the cluster show summary command shows the summary of the
current cluster configuration.
Related Commands
cluster show cluster Displays cluster configuration..
system show summary Displays the NAS Gateway configuration
summary.

7-16
Cluster Uncommit
Synopsis
cluster uncommit
Description
If yo have configured cluster parameters but not yet committed them to the cluster
database, you can delete the uncommitted parameters by running the cluster
uncommit command. When parameters are uncommitted, they are not active on the
node, and they are not propagated into the cluster database.
Note!
The cluster uncommit command does not remove parameters that have
already been committed to the cluster database. To change a committed cluster
database parameter, run the related cluster command, then run the cluster
commit command.
Some cluster commands require the cluster uncommit command to invalidate their
settings if they have already been committed. The following table lists each cluster
command and indicates which commands require a cluster uncommit command to
change.
Table 7-5 : Commands Requiring Cluster Uncommit
Command Name Requires Commit?
cluster add nasgateway Yes

cluster delete nasgateway Yes
cluster add group No
cluster delete group No
cluster show cluster No
cluster show group No

7-17
Example
eng38> cluster uncommit

eng38>
In this example, the cluster uncommit command inactivates and removes

parameters that have been configured but not yet committed to the cluster database.
Related Commands
cluster delete nasgateway Deletes a NAS Gateway.
cluster add nasgateway Adds a NAS Gateway.

7-18

Chapter 8: Domain Commands
This chapter documents the following domain commands:
• “Domain Add LDAP” on page 8-2
• “Domain Add NIS” on page 8-6
• “Domain Add Windows” on page 8-8
• “Domain Delete” on page 8-13
• “Domain Modify LDAP” on page 8-15
• “Domain Modify LDAP Schema” on page 8-19
• “Domain Modify NIS” on page 8-25
• “Domain Modify Windows” on page 8-27
• “Domain Show” on page 8-30
• “Domain Show LDAP Schema” on page 8-33
• “Domain Verify LDAP” on page 8-34
• “Domain Verify NIS” on page 8-37

8-2
Domain Add LDAP
Synopsis
domain add ldap DOMAINNAME SERVER_URIS DEFAULT_BASE_SCOPE
[-u LOGIN_DN] [-p PASSWORD_BASE_SCOPE][-g GROUP_BASE_SCOPE]
[-h HOST_BASE_SCOPE] [-n NETGROUP_BASE_SCOPE]
Description
You can add an LDAP domain to the NAS Gateway’s configuration by issuing the
domain add ldap command. This command also specifies the primary LDAP server
and optionally, a backup LDAP server with which the NAS Gateway will register to
become part of the domain.
Options
Table 8-1 : Options for the domain add ldap command
DOMAINNAME Specifies the name of the domain

you are adding. Enter an
alphanumeric character string of up
to 63 characters. Do not use
restricted characters such as *,~,?,
and!.

8-3
Table 8-1 : Options for the domain add ldap command (Continued)
SERVER_URIS A character string that specifies the

LDAP server hostname or IP address
and port. You can specify up to
servers by including them in
quotation marks (“) and separating
the list with commas and spaces (, ).
For example, a string specifying the
LDAP server ldap://192.168.3.1 can
be either of the following formats:
• ldap://server.example.com:345
• ldap://192.168.2.1:678
• 192.168.3.1
• server.example.com

8-4
DEFAULT_BASE_SCOPE A character string that specifies the

default base distinguished name
(DN) and scope to be used for LDAP
searches. Examples: “ou=eng,
o=company, c= us:SUB”
“ou=qa, o=company, c= us:BASE”
“ou=finance, o=company, c=
us:ONE”
• BASE specifies a search just at the
level specified in the directory.
• ONE specifies a search at the base
level plus one layer below in the
directory.
• SUB specifies a search through all
subdirectories of the tree.
Note!
When enclosing values in quotation
marks, a space between the values after
the comma is valid. A space before the
values BASE, SUB, and ONE is not
required.
Note!
If the scope is not specified or is not
BASE, ONE, or SUB, the default scope
is SUB.
-u LOGIN_DN A character string that specifies the

login DN to used for administrative
queries. Example: “cn=admin,
dc=example, dc=com”.
Note!
If you enter this argument, you are
prompted for that account’s password.

8-5
-p PASSWORD_BASE_ An optional character string that

SCOPE specifies the base DN and scope to
be used for user account-related
LDAP searches. Example:
“ou=People, o=company, c=us:
SUB”
-g GROUP_BASE_ An optional character string that
SCOPE specifies the base DN and scope to
be used for user group-related LDAP
searches. Example: “ou=Groups,
o=company, c=us: BASE”.
-h HOST_BASE_SCOPE An optional character string that
specifies the base DN and scope to
be used for LDAP searches related to
the host name and address. Example:
“dc=example,dc=com: ONE”.
-n NETGROUP_BASE_ An optional character string that
SCOPE specifies the base DN and scope for
LDAP searches related to NIS
netgroups. Example:
“dc=example,dc=com: SUB”.
Note!
Because all optional arguments are character strings, verify any values you
enter with your LDAP system administrator to ensure that they are valid.
Invalid values cause LDAP search errors and might produce unexpected
results.

8-6
Example
In the following example, the LDAP domain cmdrefexample is added to the LDAP
server 10.3.23.33.
eng31 VS1> domain add ldap cmdrefexample 10.3.23.33

dc=authdom,dc=lab:SUB -u
"cn=administrator,cn=Users,dc=authdom,dc=lab" -p
"cn=Users,dc=authdom,dc=lab" -h "cn=computers,dc=authdom,dc=lab:
SUB" -n
"cn=netgroup,cn=authdom,cn=DefaultMigrationContainer30,dc=authdom,d
c=lab: SUB"
Enter Password:
eng31 VS1>
Related Commands
domain delete ldap Deletes the LDAP domain specified.
domain modify ldap Modifies the LDAP domain configuration.
domain show ldap Shows the list of LDAP domains configured for
the NAS Gateway.
domain verify ldap Verifies the LDAP domain configuration.
Domain Add NIS
Synopsis
domain add nis DOMAINNAME IPADDR [IPADDR] [IPADDR] [IPADDR]
Description
To log on to a UNIX domain, the domain needs to exist. You can add the domain to the
ONStor™ NAS Gateway’s configuration by running the domain add nis command,
which enables the NAS Gateway to add a network information service (NIS) domain
to its configuration.
The NAS Gateway needs to have a virtual server configured and operating in the
domain that you add with the domain add command. When you configure a domain,
the virtual server in that domain checks with the NIS server to validate the domain and

8-7
user. Therefore, the virtual server needs to be part of the same domain in which the
user is configured. You can add a NAS Gateway’s virtual server to the domain with the
command, vsvr set domain.
Options
Table 8-2 : Options for the domain add nis command
nis Specifies that you are adding a NIS

domain to the NAS Gateway.
DOMAINNAME The name of the domain that you are
creating consisting of an alphanumeric
character string of up to 63 characters.
Do not use restricted characters such as
*,~,?, and !.
IPADDR The IP address of the NIS server.
Specify the IP address in dotted decimal
notation, for example 1.2.3.4. This is
typically the master NIS server.
[IPADDR] An optional argument that specifies an
IP address of a NIS server that serves the
same domain. Specify the IP address in
dotted decimal notation, for example
1.2.3.4. This is typically the slave NIS
server.

8-8
Example
eng31 PUBSTEST3> domain add nis chromatis 10.3.119.128

eng31 PUBSTEST3>
In this example, the NIS domain chromatis is added to the NAS Gateway, and the
domain controller is configured as 10.3.119.128. When this command completes, the
NAS Gateway attempts to join the domain by contacting the NIS server at
10.3.119.128.
Related Commands
domain delete nis Deletes the NIS domain specified.
domain modify nis Modifies the NIS domain configuration.
domain show Shows the list of domains configured for the
NAS Gateway.
Domain Add Windows
Synopsis
domain add windows DOMAINNAME LOGINUSER HOSTNAME [HOSTNAME]
[-NONETBIOS] [-k KRBDOMAINNAME] [-t CLOCKSKEW]
Description
To log on to a Windows domain, the domain needs to exist. You can configure the
Windows domain in the NAS Gateway’s configuration by running the domain add
windows command. This command requires a logon user name and password to allow
the NAS Gateway to join the domain. When you specify the logon user name, the
NAS Gateway prompts you for a password for that logon user name.
The NAS Gateway needs to have a virtual server configured and be operating in the
domain that you add with the domain add windows command. When you configure a
domain, the virtual server in that domain checks with the Windows domain controller

8-9
server to validate the domain and user. Therefore, the virtual server needs to be part of
the same domain in which the user is configured.
Note!
With this command, you need to also specify a password. With the Windows
domain passwords, the software imposes a minimum length of six characters.
Make sure that you specify a password of six characters or more when entering
a password on EverON™ software.
For Windows domains, if the controllers are on a different subnet than the
virtual server, you must configure the WINS server, that the NAS Gateway will
use, for name resolution by issuing the vsvr set wins command before
you issue the domain add command.
The user of the NAS Gateway/virtual server should have a minimum of
NETWORK privilege in the cluster or virtual server scope to execute this
command.
Options
Table 8-3 : Options for the domain add windows command
windows Configures a Windows domain on the

NAS Gateway. Use the Windows
identity format to log on to the NAS
Gateway through this domain, for
example, domain1\patrickh.
creating consisting of an
alphanumeric character string of up to
63 characters. Do not use restricted
characters such as *,~,?, and !. For
Windows domains, this is the
NetBIOS Windows domain name.

8-10
Table 8-3 : Options for the domain add windows command (Continued)
LOGINUSER The name of the logon user that the

NAS Gateway uses to log on with the
domain controller and participate in
the domain. With this argument you
are prompted for a password
associated with the logon user.
If you are supporting NAS Gateway
access through multiple domains, you
can also specify a fully-qualified
logon user name that has the domain
prefixed.
HOSTNAME The host name or IP address of the
Windows domain controller. In a
Windows NT domain, this is the host
name or IP address of the primary
domain controller. If your Windows
NT domain has only one domain
controller, enter its IP address for this
argument. If the
-NONETBIOS option is set,
HOSTNAME needs to be the DNS
host name.
[HOSTNAME] An optional argument that specifies
the hostname or IP address of up to 31
additional primary domain controllers
for a Windows domain. If the
HOSTNAME needs to be the DNS
host name.

8-11
Table 8-3 : Options for the domain add windows command (Continued)
[-NONETBIOS] When specifying this option, the

domain controller can only be
contacted using DNS name
resolution. Use this option when the
NetTBIOS name is not available.
When specifying this option, use the
DNS host name in the HOSTNAME
option instead of the IP address.
When specifying this option and you
have configured backup domain
server for failover, ensure that the
DNS configuration can resolve all
server names in the backup list.
-k KRBDOMAINNAME This option is used when adding a
Kerberos domain.
Note!
In order to ensure clock synchronization,
Kerberos domains must be configured for
Network Time Protocol (NTP).
-t CLOCKSKEW This option can only be specified with

the -k option. CLOCKSKEW values
range from 1 to 9999 minutes. The
default value is 5 minutes.

8-12
Example
eng31 PUBSTEST3> domain add windows domain1 user1 host1 -NONETBIOS

Enter Password:
eng31 PUBSTEST3>
In this example, the Windows domain domain1 is added to the NAS Gateway. As part
of this command. The logon user name user1 is configured to allow the NAS Gateway
to log on to the domain controller and join the domain. To do this, the user needs to
have permission to add a computer to the domain. The domain controller is configured
as host1. The -NONETBIOS option specified that the domain controller can only be
contacted through DNS resolution. When this command completes, the NAS Gateway
prompts you for a password for the logon user. Without it, the NAS Gateway is unable
to join the domain.
In the following example, a Windows domain with a fully-qualified domain name
(FQDN) is added.
g11r9 > domain add windows HELIX enguser 10.2.6.35

Enter Password:
g11r9 >
g11r9 > system dnsconfigure resolver
g11r9 > domain modify windows HELIX enguser triplehelix.helix.lab
Enter Password:
g11r9 >
In the example above, the windows domain HELIX is modified so that it now uses the
FQDN of the domain instead of its IP address.
Note!
The domain using the FQDN can be added with or without the –NONETBIOS
option.

8-13
In the following example, a Windows domain named smallpond is added with a

Kerberos domain name of smallpond.lab.
eng233> domain add windows smallpond enguser 10.3.0.6 -k

smallpond.lab
Enter Password:
eng233> domain show windows smallpond

Type Domain name Login user
Address(es)
windows SMALLPOND enguser
10.3.0.6
smallpond.lab(Kerberos)
Clock Skew : 5 min(s)
Related Commands
domain delete windows Deletes the Windows domain specified.
domain modify windows Modifies the Windows domain configuration.
NAS Gateway.
Domain Delete
Synopsis
domain delete {ldap|nis|windows} DOMAINNAME
Description
You can delete a domain at any time if no virtual servers are joined to the domain. If
virtual servers are joined to the domain, the domain needs to be cleared by using the
vsvr clear domain command in all the virtual servers.
Note!
Clearing the domain requires that the virtual server to be in a disabled state.
When you delete the domain, the NAS Gateway leaves the domain and cannot
participate in the domain’s services. You can delete a domain by running the domain
delete command. You can delete a single domain at a time.

8-14
Note!
If you want to change the domain definition on the NAS Gateway, you can
delete the domain and reconfigure it. However, a more efficient way to change
a domain definition is through the domain modify command.
Options
Table 8-4 : Options for the domain delete command
ldap|nis|window A list from which you specify the type

of domain that you are deleting.
• ldap deletes an LDAP domain.
• nis deletes an NIS domain.
• windows deletes a Windows domain.

deleting consisting of an
windows domains, this is the
NetBIOS windows domain name.
Example
In the following example, the LDAP domain domain1 is deleted.
eng31 PUBSTEST3> domain delete ldap domain1

eng31 PUBSTEST3>
In the following example, the NIS domain chromatis is deleted.
eng31 PUBSTEST3> domain delete nis chromatis

eng31 PUBSTEST3>

8-15
In the following example, the Windows domain effigy is deleted.
eng31 PUBSTEST3> domain delete windows effigy

eng31 PUBSTEST3>
Related Commands
domain add ldap Adds the LDAP domain specified.
domain add nis Adds the NIS domain specified.
domain add windows Adds the Windows domain specified.
NAS Gateway.
domain verify nis Verify the configuration of a NIS domain.
domain verify windows Verify the configuration of a Windows domain.
Domain Modify LDAP
Synopsis
domain modify ldap DOMAINNAME [-s SERVER_URIS]
[-d DEFAULT_BASE_SCOPE] [-u LOGIN_DN] [-p PASSWORD_BASE_SCOPE] [-
g GROUP_BASE_SCOPE] [-h HOST_BASE_SCOPE] [-n
NETGROUP_BASE_SCOPE]
Description
You can modify parameters of an existing domain by issuing the domain modify
ldap command.
Note!
Except for the -s SERVER_URIS and the -d DEFAULT_BASE_SCOPE options,
you can enter an empty string to clear an option, for example, -u “ “.
If the scope is not specified or is not BASE, ONE, or SUB, the default scope is
SUB.

8-16
Options
Table 8-5 : Options for the domain modify ldap command
DOMAINNAME Specifies the name of the domain

you are modifying. Enter an
alphanumeric character string of up
to 63 characters. Do not use
restricted characters such as *,~,?,
and!.
-s SERVER_URIS A character string that specifies the
LDAP server host name or IP
address and port. You can specify up
to four servers by including them in
quotation marks (“) and separating
the list with commas and spaces (, ).
For example, a string specifying the
LDAP server ldap://192.168.3.1 can
be either of the following formats:
• ldap://server.example.com:345
• ldap://192.168.2.1:678
• 192.168.3.1
• server.example.com

8-17
Table 8-5 : Options for the domain modify ldap command (Continued)
DEFAULT_BASE_SCOPE A character string that specifies the

default base distinguished name
(DN) and scope to be used for LDAP
searches.
Examples:
“ou=eng, o=company, c= us:SUB”
“ou=qa, o=company, c= us:BASE”
“ou=finance, o=company, c=
us:ONE”
• BASE specifies a search just at the
level specified in the directory.
• ONE specifies a search at the base
level plus one layer below in the
directory.
• SUB specifies a search through all
subdirectories of the tree.
Note!
When enclosing values in quotation
marks, a space between the values after
the comma is valid. A space before the
values BASE, SUB, and ONE is not
required.
Note!
If the scope is not specified or is not
BASE, ONE, or SUB, the default scope
is SUB.

8-18
Table 8-5 : Options for the domain modify ldap command (Continued)
-u LOGIN_DN A character string that specifies the

login DN to used for administrative
queries. Example: “cn=admin,
dc=example, dc=com”.
Note!
If you enter this argument, you are
prompted for that account’s password.
-p PASSWORD_BASE_SCOPE An optional character string that

be used for user account-related
LDAP searches. Example:
“ou=People, o=company, c=us:
SUB”
-g GROUP_BASE_SCOPE An optional character string that
be used for user group-relates LDAP
searches. Example: “ou=Groups,
o=company, c=us: BASE”.
-h HOST_BASE_SCOPE An optional character string that
be used for LDAP searches related to
the host name and address. Example:
“dc=example,dc=com: ONE”.
-n NETGROUP_BASE_SCOPE An optional character string that
specifies the base DN and scope for
LDAP searches related to NIS
netgroups. Example:
“cd=example,dc=com: SUB”.

8-19
Note!
Because all optional arguments are character strings, verify any values you
enter with your LDAP system administrator to ensure that they are valid.
Invalid values cause LDAP search errors and might produce unexpected
results.
Example
eng31 VS1> domain modify ldap cmdrefexample -s "ldap://10.0.0.44" -

d "dc=nags-domain,dc=com: SUB" -u "" -p "" -g "ou=Group,dc=nags-
domain,dc=com: SUB" -h "ou=Hosts,dc=nags-domain,dc=com: SUB" -n ""
eng31 VS1>
In this example, the domain cmdrefexample is modified by changing the IP address of

the LDAP server to 10.0.0.44.When this command completes, the NAS Gateway
attempts to join the domain by contacting the LDAP server at 10.0.0.44.
Related Commands
domain add ldap Adds an LDAP domain to the NAS Gateway.
domain delete ldap Deletes an LDAP domain from the NAS
Gateway.
domain modify ldap schema Modifies the schema of an LDAP domain.
domain show ldap Displays a list of LDAP domains configured for
the NAS Gateway.
domain show ldap schema Displays the schema of an LDAP domain.
Domain Modify LDAP Schema
Synopsis
domain modify ldap schema (user | group | netgroup | host)
DOMAINNAME [OPTIONS ...]

8-20
Description
You can modify the schema of a configured LDAP domain by running the domain
modify ldap schema command. With this command you can modify User, Group,
Netgroup, and Host schemas.
Options
Table 8-6 : Options for the domain modify ldap schema command
user The user schema, where you can modify

the user object class, the user name, the
user ID number, and the user password.
group The group schema, where you can
modify the object class, the group name,
the group ID number, and the group
member ID.
netgroup The netgroup schema, where you can
modify the object class, the netgroup
name, the netgroup triple (host, user,
domain), and the netgroup member ID.
host The host schema, where you can modify
the object class, the host name, and the
host’s IP address.
DOMAINNAME An alphanumeric character string that
specifies the LDAP domain name.

8-21
OPTIONS A set of optional arguments through

which you can specify object class
names and attribute names.
For the group portion of the LDAP
schema, the following options are
available:
• -o OBJECTCLASS — the object class
name for the group. The RFC2307
value is posixGroup. The default
Windows ADS value is group.
• -n GROUPNAME — the attribute name
for the group name. The RFC2307
value is cn. The default Windows ADS
value is msSFU30Name.
• -i GID — the attribute name for the
group ID. The RFC2307 value is
gidNumber. The default Windows ADS
value is msSFU30GidNumber.
• -m MEMBERNAME — the attribute
name for the group member. The
RFC2307 value is memberUid. The
default Windows ADS value is
msSFU30MemberUid.

8-22
For the host portion of the LDAP

available:
name for a host, for example, the IP
device. The RFC2307 value is ipHost.
The default Windows ADS value is
computer.
• -n HOSTNAME — the attribute name
for a host’s canonical name. The
RFC2307 value is cn. The default
Windows ADS value is msSFU30Name.
• -l HOSTALIASES — the attribute
name for a host’s alias names.The
Windows ADS value is
msSFU30Aliases.
• -a HOSTADDR — the attribute name
for a host’s IP address. The RFC2307
value is ipHostNumber. The default
msSFU30IpHostNumber.

8-23
For the netgroup portion of the LDAP

available:
name for the NIS netgroup. The
RFC2307 value is nisNetGroup. The
default Windows ADS value is
msSFU30NisNetgroup.
• -n NETGROUPNAME — the attribute
name for the netgroup name. The
Windows ADS value is msSFU30Name.
• -t NETGROUPTRIPLE — the
attribute name for the netgroup triple.
The RFC2307 value is
nisNetgroupTriple. The default Windows
ADS value is msSFU30NetgroupDetail.
• -m NETGROUPMEMBER — the
attribute name for the netgroup member.
The RFC2307 value is
memberNisNetgroup. The default
msSFU30NetgroupDetail.

8-24
For the user portion of the LDAP

available:
name for the user account. The
RFC2307 value is posixAccount. The
default Windows ADS value is user.
• -n USERNAME — The attribute name
for the user name. The RFC2307 value
is uid. The default Windows ADS value
is msSFU30Name.
• -i UID — the attribute name for the
user ID. The RFC2307 value is
uidNumber. The default Windows ADS
value is msSFU30UidNumber.
• -p PASSWORD — the attribute name
for the user password. The RFC2307
value is userPassword. The default
msSFU30Password.
Example
eng31 PUBSTEST3> domain modify ldap schema host domain1 -a

ipHostNumber1
eng31 PUBSTEST3>
Related Commands
domain delete ldap Deletes an LDAP domain from the NAS
Gateway.

8-25
domain show ldap Displays a list of LDAP domains configured for

the NAS Gateway.
domain show ldap schema Displays the schema of an LDAP domain.
Domain Modify NIS
Synopsis
domain modify nis DOMAINNAME IPADDR [IPADDR] [IPADDR] [IPADDR]
Description
You can modify an existing domain or any of its parameters by running the domain
modify command.
Options
Table 8-7 : Options for the domain modify nis command
nis Creates an NIS domain. Use the UNIX

identity format to log on to the NAS
Gateway through this domain, for
example, patrickh@domainY.
modifying consisting of an
characters such as *,~,?, and !.

8-26
Table 8-7 : Options for the domain modify nis command (Continued)
IPADDR The IP address of the NIS server.

Specify the IP address in dotted decimal
notation, for example 1.2.3.4. Typically,
this is the master NIS server.
[IPADDR] An optional argument that specifies an
IP address of an additional NIS server
that serves the same domain. Specify the
IP address in dotted decimal notation,
for example 1.2.3.4. This is typically the
slave NIS server.
Example
eng31 PUBSTEST3> domain modify nis chromatis 10.2.17.21

eng31 PUBSTEST3>
In this example, the domain chromatis is modified. In this example, the IP address of
the NIS server is changed to 10.2.17.21.When this command completes, the NAS
Gateway attempts to join the domain by contacting the domain controller at
10.2.17.21.
Related Commands
domain delete nis Delete the NIS domain specified.
NAS Gateway.

8-27
Domain Modify Windows
Synopsis
domain modify windows DOMAINNAME LOGINUSER HOSTNAME [HOSTNAME]
[-t CLOCKSKEW]
Description
You can modify an existing Windows domain or any of its parameters by running the
domain modify command.
Note!
For Windows domains, if the controllers are on a different subnet than the
virtual server, you must configure the WINS server that the NAS Gateway will
use for name resolution by issuing the vsvr set wins command before
you issue the domain add command.
This command cannot turn a pre-Windows 2000 domain (NTLMxx)
configuration into a Windows 200x domain ( Kerberos) configuration.
Options\
Table 8-8 : Options for the domain modify windows command
windows Creates a Windows domain.

modifying consisting of an
Windows domains, this is the NetBIOS
Windows domain name.

8-28
Table 8-8 : Options for the domain modify windows command (Continued)
LOGINUSER The name of the logon user that the NAS

Gateway uses to log on with the domain
controller and participate in the domain.
With this argument you are prompted for
a password associated with the logon
user.
If you are supporting NAS Gateway
access through multiple domains, you
can also specify a fully qualified logon
user name with the domain prefixed.
HOSTNAME The DNS or NetBIOS host name, or the
IP address of the Windows domain
controller. If the –NONETBIOS option
was set when the domain was added
(using the domain add command),
HOSTNAME cannot be NetBIOS host
name or IP address.
[HOSTNAME] An optional argument that specifies the
hostname or IP address of up to 31
additional primary domain controllers
for a Windows domain. If the
HOSTNAME needs to be the DNS host
name.
-t CLOCKSKEW The maximum clock skew in minutes.
This option can be specified only if the
domain was created with the -k option.
CLOCKSKEW values range from 1 to
9999 minutes. The default value is 5
minutes.

8-29
Example
In the following example, a Windows domain is modified.
eng31 PUBSTEST3> domain modify windows chromatis test1 10.2.17.21

Enter password:
eng31 PUBSTEST3>
In this example, the Windows domain chromatis is modified on the NAS Gateway.
The logon user name is configured to test1. The domain controller is also being
modified to 10.2.17.21. When this command completes, the NAS Gateway prompts
you for a password for the new logon user name. When the command completes, the
NAS Gateway attempts to join the domain by contacting the domain controller at
10.2.17.21 using the newly modified parameters.
In the following example a Windows domain with a FQDN is modified.
eng31 PUBSTEST3> domain add windows chromatis onstor 10.3.168.1

Enter password:
eng31 PUBSTEST3>
In this example, the Window domain chromatis is modified. The logon user name
onstor\tester is configured to allow the NAS Gateway to log on to the domain
controller and join the domain. The FQDN onstor is added for supporting NAS
Gateway access through multiple domains. The FQDN allows the user to access the
virtual server PUBSTEST even though the user is configured in a different domain
than PUBSTEST.
Related Commands
domain delete windows Delete the Windows domain specified.
NAS Gateway.

8-30
Domain Show
Synopsis
domain show {all|ldap|nis|windows} [DOMAINNAME]
Description
The NAS Gateway tracks all the domains it has joined in the domain list. This list is
available for each NAS Gateway. You can, however, see a domains list that shows the
domains that are available to a specific virtual server by running the vsvr domain
show command.
To view the NAS Gateway.’s domains list, run the domain show command.You can
filter the display as follows by running a keyword with the domain show command.
• You can display all domains regardless of domain type.
• You can display all LDAP domains or a specific LDAP domain by name.
• You can display all NIS domains or a specific NIS domain by name.
• You can display all Windows domains or a specific Windows domain by name.

8-31
Options
Table 8-9 : Option for the domain show command
all|ldap|nis| A list from which you specify one of the

windows] following types of domain to display:
• all shows a list of all LDAP, NIS, and
Windows domains configured on the NAS
Gateway.
• ldap shows a list of all LDAP domains
configured on the NAS Gateway.
• nis shows a list of all NIS domains
configured on the NAS Gateway.
• windows shows a list of all Windows
domains configured on the NAS Gateway.
DOMAINNAME An option you can specify to display an

LDAP, NIS, or Windows domain by domain
name.
Example
g6r9 > domain show windows SMALLPOND

Type Domain name Login user Address(es)
windows SMALLPOND enguser 10.3.0.6
Security Level : Kerberos, NTLMv2, NTLM
Clock Skew : 5 min(s)
In this example, all domains are displayed in the domain list that contains the
• The type of each domain configured, either LDAP, NIS, or Windows.
• The domain name. The logon user field lists the name of the Windows logon user
that was configured. For Windows domain names, the NAS Gateway prompts you
for a logon user name to be used to log on to the domain. The password for that

8-32
logon user, however, is not displayed for security reasons. This command also
shows FQDNs for instances where you need to access a virtual server from another
virtual server that is not in the same domain.
• The IP address of the domain controller.
The following example, shows all domain types.
eng233 > domain show all

Type Domain name Address(es)
nis onstorlab 10.3.0.4

windows MATRIX enguser 10.3.0.5
windows SMALLPOND enguser 10.3.0.6

ldap openauthdom LDAP://10.3.1.5.12
Related Commands
domain add ldap Adds a LDAP domain to the NAS Gateway.
domain delete nis Delete the NIS domain specified.
domain delete windows Delete the Windows domain specified.
domain modify windows Modifies the Windows Domain configuration.
domain verify nis Verify the configuration of a NIS domain.

8-33
Domain Show LDAP Schema
Synopsis
domain show ldap schema DOMAINNAME
Description
Use the domain show ldap schema command to view the LDAP schema information
contained in a specified LDAP domain name.
Options
The DOMAINNAME variable specifies the LDAP domain name of
the schema you want to display.
Example
The following example shows the LDAP schema is for Open LDAP domain
cmdrefexample.
eng57 VS2>domain show ldap schema cmdrefexample

Type Domain name
ldap cmdrefexample
user.objectClass : posixAccount
user.name : uid
user.id : uidNumber
user.password : userPassword
group.objectClass : posixGroup
group.name : cn
group.id : gidNumber
group.member : memberUid
netgroup.objectClass : nisNetgroup
netgroup.name : cn
netgroup.triple : nisNetgroupTriple
netgroup.member : memberNisNetgroup
host.objectClass : ipHost
host.name : cn
host.aliases : cn
host.addr : ipHostNumber

8-34
The following example shows the LDAP schema for the AD LDAP domain winad,
which is configured for the Windows environment.
eng57 VS2>domain show ldap schema winad

Type Domain name
ldap winad
user.objectClass : user
user.name : msSFU30Name
user.id : msSFU30UidNumber
user.password : msSFU30Password
group.objectClass : group
group.name : msSFU30Name
group.id : msSFU30GidNumber
group.member : msSFU30MemberUid
netgroup.objectClass : msSFU30NisNetgroup
netgroup.name : msSFU30Name
netgroup.triple : msSFU30NetgroupDetail
netgroup.member : msSFU30NetgroupDetail
host.objectClass : computer
host.name : msSFU30Name
host.aliases : msSFU30Aliases
host.addr : msSFU30IpHostNumber
Related Commands
domain show ldap Displays list of LDAP domains configured
for the NAS Gateway.
Domain Verify LDAP
Synopsis
domain verify ldap DOMAINNAME

8-35
Description
Run this command from the virtual server context to verify the LDAP domain
configuration. This command connects to the LDAP server and makes LDAP queries
using the LDAP configuration.
Options
The DOMAINNAME variable is the LDAP domain name for the
virtual server. DOMAINNAME is the domain name you
previously created in the NAS Gateway using the domain add
ldap command.

8-36
Example
eng62> vsv sh eng25-3

Virtual Server
==============
ID : 4 (protected)
NAS Gateway name : eng25
Status : Enabled
Name : ENG25-3
NetBIOS name : VS25-3
Pri. WinSrvr IP : 0.0.0.0
Sec. WinSrvr IP : 0.0.0.0
IP address 1 : 10.3.125.31/255.255.0.0
IP address 2 : --Not-Set--
Windows domain : MATRIX
Unix domain : --Not-Set--
LDAP domain : onstorlab
AutoCreate Path : --Not-Set--
AutoCreate VolID : --Not-Set--
Read responses fragmentation : default
UDP checksum enabled : yes
eng25>
eng25> vsv set eng25-3
eng25 ENG25-3>
eng25 ENG25-3> domain verify ldap onstorlab
User name lookup results : #name=59, #uid=59, #passwd=59,
#gid=59
User id lookup results : #name=59, #uid=59, #passwd=59,
#gid=59
Group name lookup results : #name=18, #gid=18
Group id lookup results : #name=18, #gid=18
User group id lookup results : #gid=11
Host name lookup results : #name=65, #alias=0, #addr=32
Host addr lookup results : #name=65, #alias=0, #addr=32
Netgroup name lookup results : #triple=294, #member=27
LDAP configuration verified successfully - virtual server Id=4.
Related Commands

8-37

domain modify ldap schema Modifies schema of an LDAP domain.
domain show ldap Displays list of LDAP domains configured
for the NAS Gateway.
Domain Verify NIS
Synopsis
domain verify nis DOMAINNAME IPADDR [IPADDR] [IPADDR] [IPADDR]
Description
Verify the configuration of a NIS domain.
Note!
This command has to be run within the context of the vsvr that is joined to the
NIS domain.
Options
Table 8-10 : Options for the domain verify nis command
DOMAINNAME The DOMAINNAME

variable is the NIS domain
name for the virtual server.
DOMAINNAME is the
domain name you
previously created in the
NAS Gateway using the
domain add nis
command.

8-38
Table 8-10 : Options for the domain verify nis command
IPADDR The IP address of the NIS

server. Specify the IP
address in dotted decimal
notation, for example
1.2.3.4. This is typically
the master NIS server.
Example
eng13 ENG13_VS4> domain verify nis onstorlab 10.3.0.4

Domain onstorlab Server 10.3.0.4 Port 962. Valid.
eng13 ENG13_VS4>
Related Commands
domain add nis Adds a NIS domain to the NAS Gateway.
domain delete Deletes the NIS domain specified.
domain show Displays a list of domains that are configured for
the NAS Gateway.

Chapter 9: Elog Commands
This chapter documents the following elog facility commands:
• “Elog Clear Log” on page 9-2
• “Elog Display Enable or Disable” on page 9-2
• “Elog Facility Level” on page 9-3
• “Elog Find” on page 9-4
• “Elog Host” on page 9-7
• “Elog Level” on page 9-8
• “Elog Show Config” on page 9-10
• “Elog Show Log” on page 9-11
• “Elog State Enable or Disable” on page 9-14

9-2
Elog Clear Log
Synopsis
elog clear log
Description
The elog clear log command deletes all entries in the event log. When you run this
command, the event log is immediately cleared, and it can begin accepting messages
whenever new system events occur.
cluster1-4> elog clear log

cluster1-4>
In this example, all messages are deleted from the current event log.
Related Commands
elog show log Shows locally stored log messages.
Elog Display Enable or Disable
Synopsis
elog display {enable|disable}
Description
Use the elog display command to activate or deactivate the display of event log
messages on the system switch and controller (SSC). Therefore, when you run this
command, you can determine whether the event log messages are allowed to scroll
across the management display. By default, the event log message display is enabled.
Options
The enable|disable commands specify whether to enable or disable
the event log message display on the ONStor™ NAS Gateway’s

9-3
SSC. If enabled, the messages are displayed on the management

terminal’s console. The default is enable.
Example
cluster1-4> elog display disable

cluster1-4>
In this example, the event log message display is disabled. When the software is
disabled, the event messages are no longer displayed on the management session.
Related Commands
elog show config Shows the current event log configuration.
elog show log Shows locally stored event log messages.
Elog Facility Level
Synopsis
elog facility
{local0|local1|local2|local3|local4|local5|local6|local7}
Description
The elog facility is a way of categorizing event log messages arriving at an event log
host from different NAS Gateways. The event log messages are named with the same
user-level facility codes that a standard UNIX syslog program uses. The facility codes
used are local0 through local7. These values are identifiers that you can apply to the
event log messages that are forwarded from specific NAS Gateways to allow a syslog
host to track which messages are coming from which NAS Gateways. Use the elog
facility command to set facility levels for filtering messages from different NAS
Gateways at a common syslog host.

9-4
Options
The local0|local1|local2|local3|local4|local5|local6|local7
facility codes are the possible user-level facility codes for
assignment to an NAS Gateway. Do not assign the same facility
code to more than one specified NAS Gateway. local0 is the
default elog facility.
Example
cluster1-4> elog facility local3

cluster1-4>
In this example, the elog facility level on the current NAS Gateway is set to local3. If
event log messages are forwarded to a syslog host, the messages from this NAS are
displayed with a local3 tag. The local3 tag indicates that the event log messages are
from the NAS Gateway cluster1-4.
Related Commands
elog state Disables or enables event log capability.
Elog Find
Synopsis
elog find KEYWORD
Description
Because the event log message log can support numerous messages, the NAS Gateway
supports a basic keyword search engine for locating text strings within the event log
message log. Use the elog find command to find specific keywords without having
to perform a line-by-line scroll through the entire log. The elog find command
returns all lines that contain the keyword you specify. The search string is case-
sensitive.

9-5
Some common ways to search the log are as follows:

• By date, if you are searching for an event that happened on a particular date or at a
particular time. For example, you could search for Oct to find events that happened
in October; you could search for 31 to find events that happened on the 31st day of
each month tracked in the log.
• By node name, if you are searching for an event that happened on a particular NAS
Gateway. For example, you could search for the node Cluster1-4.
Note!
The NAS Gateway’s event log search engine does not support Boolean
operations (for example, AND, OR, and NOT). The search engine is a text
string match.
There is a difference between the elog show log and elog find command. The
elog show log command shows current event log content only. The elog find
command finds strings in all archived event log files and the current content.
Options
The KEYWORD variable is the string that you are searching for in
the event log message log. Type an alphanumeric keyword of up
to 256 characters. Keywords can contain an asterisk (*) as a
wildcard character. Do not use the question mark (?) as a wildcard
character because that is part of the NAS Gateway’s command
completion online help.
Example
In the following example all error level events in the event log are located.
cluster1-4> elog find error

(error): [9][8, 0]: Retry I/O for volume 0x1142005b7dd6 LUN
0x1660e802ec1000.
/var/agile/messages.2.gz:Nov 7 23:55:41 cluster1-4 :
1:3:evm:ERROR: EVM server
(error): [10][9, 0]: Retry I/O for volume 0x1142005b7dd7 LUN
0x1760e802ec1000.
/var/agile/messages.2.gz:Nov 7 23:56:08 cluster1-4 :
1:3:evm:ERROR: EVM server
cluster1-4>

9-6
In this example, the NAS Gateway is searching the log for all the error level messages.
The results are displayed on the management console.
In the following example all events that occurred on the SSC are located.
cluster1-4> elog find SSC

/var/agile/messages.5.gz:Oct 12 19:20:42 cluster1-4 :
0:0:cluster:INFO: Synchronize-EVENT: SSC with NTP server
node 5175 state from CC to SSC
0:0:eventd:INFO: Process-EVENT: SSC: Mgmt Port 10.2.20.55
10.60.20.55 State Up
cluster1-4>
In this example, the NAS Gateway is searching the log for all messages about the SSC.
The results are displayed on the management console.
In the first message, the SSC is synchronizing with the NTP signal broadcast from the
NTP server. In the second message, the SSC is recognizing the network-layer
activation of a management port.
In the following example all Close messages, for example, all close requests
(CloseReq) and close responses (CloseRsp) are located.
cluster1-4> elog find Close*

Close Rsp (CloseReq): 0x20000080e5128ae7:14
0:0:sdm:NOTICE: SDM:
(CloseReq): handle: 200000, h_entry: 100b63d0
Close Req (CloseRsp): 0x20000080e5128ae7:15
(CloseRsp): handle: 200000, h_entry: 100b63d0
0:0:sdm:NOTICE: SDM: Send
Close Rsp (CloseReq): 0x20000080e5128ae7:16
(CloseReq): handle: 200000, h_entry: 100b63d0
cluster1-4>
In this example, the NAS Gateway is displaying all the messages that contain the text
string Close.

9-7
Related Commands
elog clear log Clears all locally stored log messages.
elog show log Shows locally stored log messages.
Elog Host
Synopsis
elog host IPADDR
Description
The event log host runs the syslog functionality to receive event log messages. You
can forward event log messages to syslog daemons running on the specified event log
host. The address you specify determines whether event log messages are forwarded to
a remote host or the local host as follows:
• If the host address is set to 0, all event log messages are forwarded to the local
syslog daemon and stored in /usr/local/agile/log/messages.
• If a nonzero syslog host is specified, all messages are forwarded to the specified
host using the currently configured facility code.
Note!
If you set the syslog host to a valid IP address, make sure that the remote syslog
host is configured to receive syslog messages from other hosts.
Options
The IPADDR variable is the IP address assigned to the remote syslog
host. The local syslog daemon on the NAS Gateway forwards event log
messages to the remote host with the IP address that you specify. Type
an IP address in dotted decimal notation, for example: 10.1.11.134.

9-8
Example
cluster1-4> elog host 10.11.128.169

cluster1-4>
In this example, the event log remote host is set at 10.11.128.169. The NAS Gateway’s
local syslog daemon forwards the event log messages to this IP address. Because a
valid IP address was specified for the remote event log host, the local event log
daemon does not direct the event log messages to the syslog.conf file. Instead, the local
syslog daemon forwards the event log messages to the remote host.
Related Commands
Elog Level
Synopsis
elog level {debug|info|notice|warning|error|critical|alert|emergency}
Description
The event log of the NAS Gateway provides messages about system activity of
various levels. The event log messages are governed by an event log daemon that runs
on the SSC. Elog messages are prioritized with the same priority levels used by the
standard UNIX syslog tool.
Elog forwards only those messages to the syslog daemon that are the configured
severity or greater. All messages with lower priority levels are discarded. For example,
if you configured the elog tool to handle warning-level messages, the NAS Gateway
would display system messages of the severity warning, error, critical, alert, and
emergency. The NAS Gateway would not display messages that are notice,
information, or debug level. You can choose to have the event log messages saved to a
file or forwarded to a different host as follows:
• If you choose to have event log messages saved to a file, they are automatically
saved to /var/agile and is called “messages”.

9-9
Any administrator of the event log host machine can edit and print the file.
• If you choose to have event log messages saved to a host, they are sent to an a
syslog.conf file at an IP address that you specify. Any administrator of the event
log host machine can edit and print the file.
Options
Table 9-1 : Options for elog level command
Option Severity
debug Least severe.

info More severe than debug.
notice More severe than debug and info.
warning More severe than debug, info, and notice. This is the default
level.
error More severe than debug, info, and warning.
critical More severe than debug, info, warning, and error.
alert More severe than debug, info, warning, error, and critical.
emergency More severe than debug, info, warning, error, and alert.
Example
cluster1-4> elog level critical

cluster1-4>
In this example, the command is setting the elog tool to forward messages that are
critical level and more serious whenever the elog software is enabled.
Related Commands

9-10
Elog Show Config
Synopsis
elog show config
Description
Use the elog show config command to display the current configuration of the event
log parameters. You can run this command at any time to verify the configuration or
ensure that any changes you have made actually occurred. This command shows the
following event log configuration information:
• The state of the elog software, either enabled or disabled.
• The configured event log message level. All messages equal to or greater than the
configured severity are displayed.
• The state of the event log display, either enabled or disabled.
• The current local facility for this NAS Gateway.
• The IP address of the event log local host, either an all zeroes value, or a nonzero
IP address.
Example
cluster1-4> elog show config

ELOG configuration
------------------
ELOG configuration
------------------
ELOG State: Enabled
ELOG Display: Disabled
ELOG Level: Debug
ELOG Facility: local0
ELOG Host Addr: 0.0.0.0
cluster1-4>
In this example, the current event log configuration is displayed. The event log
configuration shows the following information:

9-11
• The state of the NAS Gateway’s elog messaging software.

• The state of the event log display on the SSC. By default, this feature is disabled. If
enabled, event log messages display across the management console’s monitor as
event log events occur.
• The minimum configured level of message to display, save to file, or forward to
another host.
• The configured elog local facility.
The event log host address, which is the IP address of the device to which event log
messages are forwarded. An all zeroes value in this field indicates that event log
messages are not forwarded. Instead they are stored locally in the messages file at /usr/
local/agile/etc/syslog.conf.
Related Commands
elog show log Shows the current event log.
Elog Show Log
Synopsis
elog show log [NUMLINES]
Description
Use the elog show log command you display the event log. This log keeps a record
of the locally stored event log messages. You can display the entire log or you can
specify the number of lines in the log that you want to view. Each event log message is
one line, so the number of lines you choose to display equates to the number of event
log messages that are displayed.
Note!
The elog show log command shows current event log content, but not the
content of any older archived event log files. However, you can view the event
log strings in any archived files, including older files, by running the elog find
command.

9-12
Options
The NUMLINES variable is the number of lines to display from the
event log. Each message is one line, so the number of lines you
type equates to the number of messages that are displayed.

9-13
Example
eng46 TECHPUBSVS> elog show log 50

Feb 20 09:20:03 eng46 : 0:0:asd:INFO: Rcvd Generate report request APP:
(null)
Feb 20 09:36:43 eng46 : 2:0:scsi:INFO: 1074:
ispfc:ISPFC_CS_NSDB_CHANGE,[8015] o n port
[cb0000]
Feb 20 09:36:43 eng46 : 2:0:scsi:INFO: 1075:
[501700]
Feb 20 09:36:47 eng46 : 2:0:scsi:NOTICE: 1076: ispfc: Fibrechannel link now
enab led and up
enab led and up
Feb 20 09:37:39 eng46 : 2:0:scsi:INFO: 1078:
[cb0000]
Feb 20 09:37:39 eng46 : 2:0:scsi:INFO: 1079:
[501700]
enab led and up
Feb 20 09:37:43 eng46 : 2:0:scsi:INFO: 1081:
[cb0000]
enab led and up
Feb 20 09:37:44 eng46 : 2:0:scsi:INFO: 1083:
[501700]
enab led and up
enab led and up
Feb 20 10:20:03 eng46 : 0:0:asd:INFO: Rcvd Generate report request APP:
(null)
Feb 20 10:49:35 eng46 : 0:0:nfxsh:NOTICE: cmd[7]: localmap import passwd
ftp://u pgrade:password@10.2.0.2/home/upgrade/
onstorpasswdfile : status[11]
Feb 20 10:52:50 eng46 : 0:0:nfxsh:NOTICE: cmd[0]: vsvr show : status[0]
Feb 20 10:53:00 eng46 : 0:0:nfxsh:NOTICE: cmd[1]: vsvr set TECHPUBSVS :
status[0 ]
Feb 20 10:54:26 eng46 : 1:0:bsdrl:ERROR: 26: bsdrl_RcvPkt: 1615: if_output
failed d with error: Host is down, IP dst
10.2.0.2, vsId 3, IfIndex 1.
Feb 20 10:55:23 eng46 : 0:0:nfxsh:NOTICE: cmd[2]: localmap import group
ftp://up grade:passwd@10.2.0.2/home/upgrade/
onstorgroupgile : status[11]
eng46 TECHPUBSVS>
In this example, 50 lines of the current event log are displayed.

9-14
Related Commands
Elog State Enable or Disable
Synopsis
elog state {enable | disable}
Description
Use the elog state command to activate or deactivate the elog software feature. If
you disable the elog software, any parameters you have set remain configured for the
next time you enable the elog software. When the elog software is disabled, no event
log messages are forwarded to the syslog daemon.
Note!
Elog messages are enabled by default. You do not need to explicitly enable
them.
You can control the screen display of event log messages with the elog display
command. When event log is enabled, you can use the elog display command
to activate or deactivate the display of event log messages on the management
console.
Options
The enable|disable commands are to activate or deactivate the elog
software feature.
Example
In the following example the elog software is disabled.
cluster1-4> elog state disable

cluster1-4>

9-15
When the software is disabled, the elog feature no longer displays messages across the
management console’s display screen or forwards event log messages to their
destination file or host.
In the following example the elog software is enabled.
cluster1-4> elog state enable

cluster1-4>
When the software is enabled, the elog feature displays messages across the
management console’s display screen or forwards messages event log messages to
their destination file or host. By default, event log messages are enabled.
Related Commands

9-16

Chapter 10: Filesystem Commands
This chapter documents the following filesystem commands:
• “Filesystem Convert” on page 10-3
• “Filesystem Quota Disable” on page 10-3
• “Filesystem Quota Enable” on page 10-5
• “Filesystem Quota Group Config” on page 10-7
• “Filesystem Quota Group Set” on page 10-14
• “Filesystem Quota Group Show” on page 10-19
• “Filesystem Quota Log Clear” on page 10-23
• “Filesystem Quota Log Facility” on page 10-24
• “Filesystem Quota Log Host” on page 10-25
• “Filesystem Quota Log Show” on page 10-26
• “Filesystem Quota Log Show Config” on page 10-28
• “Filesystem Quota Tree Config” on page 10-29
• “Filesystem Quota Tree Remove” on page 10-34
• “Filesystem Quota Tree Set” on page 10-36
• “Filesystem Quota Tree Show” on page 10-40
• “Filesystem Quota User Config” on page 10-45
• “Filesystem Quota User Set” on page 10-51
• “Filesystem Quota User Show” on page 10-55
• “Filesystem Revert” on page 10-59
• “Filesystem Show Stats Cache” on page 10-59
• “Filesystem Show Stats Cache Hash” on page 10-64
• “Filesystem Show Stats Cache Verbose” on page 10-73

10-2
• “Filesystem Stats Performance” on page 10-83

• “Filesystem Show Stats Performance Daemon” on page 10-87
• “Filesystem Show Stats Performance I/O” on page 10-94
• “Filesystem Show Stats Resource” on page 10-100

10-3
Filesystem Convert
Synopsis
filesystem convert VOLNAME
Description
The filesystem convert command converts the filesystem to the latest. Any new
volume will automatically be created with the latest FS version 28. The filesystem convert is
used to convert file systems that were created prior to the upgrade to version 26. The
filesystem version id displayed by the volume show VOLNAME command output. A file
system needs to be converted to be able to support 1024 hardlinks per file. The volume
should be taken offline before executing this command.
Note!
When the filesystem convert command completes
successfully, there is no output to the console.
Options
The VOLNAME variable is the name of an existing volume.
Related Commands
filesystem revert Reverts the filesystem to an older version.
volume offline Takes the specified volume offline.
volume online Brings a volume online.
volume show Displays volume information.
Filesystem Quota Disable
Synopsis
filesystem quota disable VOLNAME [user,group,tree]

10-4
Description
You can explicitly disable or enable individual quotas. If a quota has been enabled,
you can disable it by running the filesystem quota disable command. With this
command you can simultaneously disable all quotas of any or all types on a volume.
For example, you could disable all user quotas on vol1 at the same time. Or, by using a
comma-separated list, you could disable all user and group quotas on vol1 at the same
time, or all user, group, and tree quotas on vol1 at the same time.
When a quota is disabled, it is no longer available for tracking or enforcement. When
you disable a quota, a quota rebuild occurs when you reenable the quota. The rebuild
occurs if the number of quotas being enabled is one or greater.
When quotas are disabled, they keep the usage parameters they had before they were
disabled, unless any changes were made to the quota configuration while they were
disabled. All parameter values, default and custom, are retained while a quota is
disabled. The parameter values are restored when a quota is reenabled.
You can change quota parameters while the quota is disabled. After you make the
change, the new parameters are not active until you reenable the quota, and the quota
completes a quota rebuild.
Note!
Power cycling and restarting the NAS Gateway do not change quota state. The
quota remains in the same operational state that it was in before the event that
caused the power cycle or restart to occur.
Options
Table 10-1 : Options for filesystem quota disable command
VOLNAME The name of the volume where

the quota is configured.

10-5
Table 10-1 : Options for filesystem quota disable command (Continued)
user,group,tree A list for specifying the type of

quota you are disabling on the
volume specified in
VOLNAME. You can specify
one or more quotas. If you
specify multiple quotas,
separate each quota type with a
comma, for example,
user,group or user,group,tree.
Example
eng11 PUBSTEST> filesystem quota disable techpubs user,group,tree

eng11 PUBSTEST>
In this example, all quotas (user, group, and tree) are disabled on the techpubs volume.
Related Commands
filesystem quota enable Enables quotas on a volume.
Filesystem Quota Enable
Synopsis
filesystem quota enable VOLNAME {user,group,tree}
Description
You can explicitly disable or enable individual quotas. If a quota has been disabled,
you can enable it by running the filesystem quota enable command. With this
command you can simultaneously enable all quotas of any or all types on a volume.
For example, you could enable all user quotas on vol1 at the same time. Or, by using a

10-6
comma-separated list, you could enable all user and group quotas on vol1 at the same
time, or all user, group, and tree quotas on vol1 at the same time.
Whenever a quota undergoes a state change from disabled to enabled, the quota
rebuild process occurs. During this process, the ONStor™ NAS Gateway scans the file
system to discover where quotas are configured and how they are applied, to either a
user, group, or tree. Any time you enable one or more quotas, the NAS Gateway
rebuilds the quotas.
When the quotas are enabled for the first time, they have the following default values
that you can configure with settings that are more appropriate for your network:
• track only mode, no enforcement of quota limits for the user, group, or tree. Only
tracking and recording usage occur.
• infinite default limits and warning thresholds.
• no logging of events when limits or thresholds are exceeded.
However, if quotas are reenabled, they contain the same parameters they had before
they were disabled unless any changes were made to the quota configuration while
they were disabled. In this situation, only the operational state changes.
Note!
Power cycling and restarting the NAS Gateway do not change quota state. The
quota remains in the same operational state that it was in before the event that
caused the power cycle or restart to occur.
Options
Table 10-2 : Options for filesystem quota enable command
VOLNAME The name of the volume where

the quota is configured.

10-7
Table 10-2 : Options for filesystem quota enable command (Continued)
user,group,tree A list for specifying the type of

quota you are enabling on the
volume specified in VOLNAME.
You can specify one or more
quotas. If you specify multiple
quotas, separate each quota type
with a comma, for example,
user,group or user,group,tree.
Example
eng11 PUBSTEST> filesystem quota enable techpubs user,group,tree

eng11 PUBSTEST>
In this example, all quotas (user, group, and tree) are enabled on the techpubs volume.
Related Commands
filesystem quota disable Disables quotas on a volume.
Filesystem Quota Group Config
Synopsis
filesystem quota group config VOLNAME [-d] [-e {enforce |
trackonly}] [-l LIMIT] [-L {yes | no}] [-w WARNING] [-W {yes | no}]
Description
You can configure group quotas in the filesystem as either default or specific group
quotas. With default group quotas you can configure quota conditions and behavior for
all groups that access a volume. Default group quotas are configured on a volume, and
you can apply a baseline of the same usage conditions to all members of the groups

10-8
that access the volume. Because default group quotas are applied to all groups that use
a volume, you can configure only one default group quota on each volume.
You can configure default group quotas for each volume by running the filesystem
quota group config command.
You can configure a default group quota in one of the following ways for monitoring
usage and enforcing conditions on that usage:
• Track only mode enables the NAS Gateway to track the group’s usage on the
volume without enforcing any results if the group exceeds the allocated amount of
volume space.
• Enforce mode enables the NAS Gateway to track the group’s usage on the volume
and enforce the quota.
Quotas are assigned to a volume, so you need to run the filesystem quota group
config command from the context of the same virtual server that contains the volume
where you want the quota defined. You can also use this command to change an
existing default group quota. Default group quota that already exist when you run the
command are updated with any arguments that have changed.
Options
Table 10-3 : Options for the filesystem quota group config command
VOLNAME The name of the volume where the group

quota is configured.

10-9
-d Specifying this option generates a

default configuration of the quota. The
default configuration is as follows:
Enabled: yes
Enforcement: enforced
Limit: infinite
Log Limit: yes
Warn: infinite
Log Warn: yes
-e trackonly An optional argument that causes the
NAS Gateway to track a group’s usage
on the volume without preventing
allocations of disk space to that group.
With this argument, members of a group
can continue allocations even if a usage
threshold is exceeded. -e trackonly
is enabled by default.
-e enforce An optional argument that causes the
NAS Gateway to track and enforce a
group’s usage on the volume. With this
argument, the group is prevented from
performing allocations if a usage
threshold is met or exceeded. -e
trackonly is enabled by default.

10-10
-l LIMIT An optional argument that specifies the

absolute limit in MiBs for the default
group quota. A MiB is 1048576 bytes.
Type the keyword -l followed by a
blank space, then the LIMIT value. The
default limit is infinite.
This argument interacts with the -e
enforce argument to indicate the
threshold at which quota enforcement
occurs. If this threshold is exceeded,
allocations fail.
This argument also interacts with the -L
{yes | no} argument to indicate the
threshold at which usage events are
recorded when the log limit has been
exceeded.

10-11
-L {yes | no} An optional argument that specifies

whether to log usage events for events
that exceed the value specified for the -l
LIMIT argument. If the -L {yes | no)
argument is specified, and the value
specified for -l LIMIT is exceeded, the
event is written to the quota log the first
time that usage exceeds the limit. Events
are logged once per day regardless of
how many times the log limit has been
exceeded in a 24-hour period. This
argument indicates when usage is getting
high before the hard limit is reached and
group requests might fail. The default is
no log limit.

10-12
-w WARNING An optional argument that specifies the

soft limit in MiBs for the default group
quota. A MiB is 1048576 bytes.
To specify this argument, type the
keyword -w followed by a blank space,
then the WARNING value. The default is
infinite.
This argument works with the -W {yes |
no} argument.
If the group exceeds the -w WARNING
usage limit, an event is written to the
quota log if the -W {yes | no} argument is
configured.
If the log limit has been exceeded, the
event is written to the log the first time
that usage exceeds the limit. Events are
logged once per day regardless of how
many times the log limit has been
exceeded in a 24-hour period.
-W {yes | no} An optional argument that specifies
whether to log usage events if the value
specified in
-w WARNING is met or exceeded. You
can specify either yes or no. By default
no warning events are logged.

10-13
Example
In the following example a default group quota with all default parameters is
configured.
eng11 PUBSTEST> filesystem quota group config techpubs

eng11 PUBSTEST>
In this example, the default group quota is configured on the volume techpubs.
Because no custom quota parameters are specified, the quota is configured with the
following default parameters:
• Track only mode
• Infinite log and warning values
• No log limit, which disallows generating an event for the quota log when the
absolute usage limit is met or exceeded
• No log warning, which disallows generating an event for the quota log when the
In the following example a default group quota with custom parameters is configured.
eng11 PUBSTEST> filesystem quota group config techpubs - e trackonly

-l 200 -L yes -w 150 -W yes
eng11 PUBSTEST>
In this example, a track-only default group quota is configured on the volume

techpubs. This quota is configured with the following values.
• Track only mode
• An absolute usage limit of 200 MiBs
• The ability to generate a log message when events meet or exceed the absolute
usage limit
• A warning threshold of 150 MiBs to alert you when usage on techpubs is
approaching the absolute limit
• The ability to generate a log message when usage meets or exceeds the warning
limit

10-14
In the following example an enforce mode quota is configured.
eng11 PUBSTEST> filesystem quota group config techpubs -e enforce

-l 160 -W yes
eng11 PUBSTEST>
In this example, an enforce mode default group quota is configured on the volume
techpubs. This quota is configured with the following parameters:
• Enforce mode
usage limit
Because no other parameters are specified, the omitted parameters are set to their
default values as follows:
• Infinite warning limit
• No logging of events that exceed the warning threshold
Related Commands
filesystem quota group set Sets or changes quota usage limits or warning
thresholds for a specific group.
filesystem quota group show Shows group quota configuration or group
quotas.
Filesystem Quota Group Set
Synopsis
filesystem quota group set VOLNAME GROUPNAME [-l LIMIT] [-w
WARNING] [-d]

10-15
Description
You can configure group quotas in the file system as default group quotas or specific
group quotas. With specific group quotas you can set specific usage conditions for
individual users that access the volume. These usage conditions for specific group
quotas are applied along with the default group quotas on the volume. When multiple
quotas are configured, the NAS Gateway analyzes all of them, and applies the strictest
to offer the most control over usage. Specific group quotas are optional. If no group
quotas are configured, no usage is tracked or enforced for each group.
You can configure specific group quotas with the filesystem quota group set
command. Use this command to set different limit and warning values for a specific
group. You can also use the -d argument to reset a specific group quota’s limit and
warning values to the limit and warning values configured in the default group quota.
You can configure specific quotas on the same volume as default group quotas. If a
specific and default group quota are configured on the same volume, both quotas are
processed when a disk allocation occurs, and the most restrictive usage case is
enforced.
Specific group quotas inherit the following quota parameters from the default quota
configured on a volume:
• Type (either enforce or track only)
• Log warning or no log warning
• Log limit or no log limit
Specific group quotas support specifying a group identity (GID), a network
information services (NIS) name, or a Windows name, for example:
• 99@onstor (LDAP or NIS user identity [UID] format)
• groupname@domain (LDAP or NIS group name)
• pubs@onstor (LDAP or NIS user name format)
• onstor\software (Windows group name format)
Group names need to be valid and known to the LDAP, NIS, or Windows domain
controllers. Because the NAS Gateway is multiprotocol, you can map common

10-16
Internet file services (CIFS) and network file system (NFS) users between domain
types through ID mapping. You cannot assign a specific group quota to GID 0.
Note!
It is possible to configure a 0 MiB quota. Although unusual, it is a valid
configuration in some cases. For example, assume that a group has finished a
project and no longer needs special usage conditions. You can set a 0 MiB
enforce-mode quota on the group so that no new usage can accumulate for that
group name. Or, you can set a 0 MiB track-only mode quota to allow additional
usage to accumulate and post messages to the quota log when any usage occurs
for the group.
Options
Table 10-4 : Options for the filesystem quota group set command
VOLNAME The name of the volume where the

specific group quota is configured.
GROUPNAME The name of the group to which to
assign the quota usage conditions. Group
names can be either Windows or NIS
formats, and they need to match the
group names that are configured on the
NIS or Windows domain controller.

10-17
Table 10-4 : Options for the filesystem quota group set command (Continued)

absolute limit in MiBs for the specific
group quota. A MiB is 1048576 bytes.
The default is whatever -l LIMIT value is
configured for the default group quota,
or infinite if no value is specified for
default and specific quotas.
blank space, then the value. You can set
an infinite limit by typing the keyword -
l followed by a blank space, then the
word infinite.
You can also use the keyword default
to indicate use of the default value.
soft limit in MiBs for the specific group
infinite.

10-18
Table 10-4 : Options for the filesystem quota group set command (Continued)
-d An optional argument that causes the

specific group quota to use the values
from the default group quota on the
volume. This option is useful for
resetting a specific group’s usage
conditions to the same usage conditions
that are assigned to the default group
quota. This option may not be combined
with the -l LIMIT or -w WARNING
arguments.
Example
In the following example a specific group quota is configured.
eng11 PUBSTEST> filesystem quota group set techpubs pubs@onstor

-l 400 -w 340
eng11 PUBSTEST>
In this example, a specific group quota is set on the techpubs volume. The specific
group quota is applied to pubs@onstor so that any member of this group is allowed to
access the volume techpubs with the following custom conditions:
• Absolute usage limit of 400 MiBs
• Warning limit of 340 MiBs
Related Commands
filesystem quota group config Configures default group quotas on a volume.
filesystem quota group show Shows group quota configuration or group
quotas.

10-19
Filesystem Quota Group Show
Synopsis
filesystem quota group show VOLNAME [GROUPNAME|-all][-P PAGENUMBER
[-s PAGESIZE]]
Description
You can display a group quota definition by running the filesystem quota group
show command. Use this command you display the group quota records in the
following ways:
• By volume
• By specific group name (for specific group quotas only)
• For all users on the volume
This command returns group quota information regardless of whether the quota is
enabled or disabled. The quota configuration information is displayed in any of the
following ways:
• If the quota feature is enabled and the quota configuration contains no specific
group quotas, the output of this command shows the default quotas assigned to
everyone on the volume.
• If no limit or warning has been configured, the output of this command shows
infinite warning and limit levels.
• If the quota feature is disabled, the output shows unknown (disabled) to indicate
that usage cannot currently be measured because the quota software is disabled.
• If the quota build phase is in progress, the output of this command shows unknown
(rebuilding) to indicate that usage cannot currently be measured because the quota
software is rebuilding.

10-20
Options
Table 10-5 : Options for the filesystem quota group show command

group quotas are configured.
GROUPNAME An optional argument that specifies the
name of the group for which to display
the group quota. Group names can be
either Windows or NIS formats, for
example 99@onstor, pubs@onstor, or
onstor\software. The names need to match
the group names that are configured on
the NIS or Windows domain controller.
-all An optional keyword that causes the
NAS Gateway to display all group
quotas configured on the volume
specified in VOLNAME. If the group
quotas are enabled when you run the
filesystem quota group show
command, the NAS Gateway displays
the quota records and the usage
information. If you do not specify the -
all keyword, only the default group
quota on the volume is displayed.
-P PAGENUMBER An option that specifies the number of
the page to display if the -all option has
been used.
-S PAGESIZE An option that specifies the page size in
number of records to display if the -all
option has been used.

10-21
Example
In the following example default group quota information on a volume is displayed.
eng38 ENG38VS0> filesystem quota group show techpubs

Enabled: yes
Limit: 200 MiB
Log Limit: yes
Warn: 150 MiB
Log Warn: yes
eng38 ENG38VS0>
In this example, the default group quota information for the techpubs volume is
displayed as follows:
• The state of the quota software on the volume. Valid values are either yes for
enabled, or no for disabled.
• The mode (either track only or enforce) that is configured on the quota.
• The absolute usage limit that is applied to everyone on the volume.
• The state of generating log messages for an event that meets or exceeds the
absolute limit shown in Limit. Valid values are yes for message generation, or no
for no message generation.
• The warning limit at which messages are generated to alert you when the usage is
approaching the absolute maximum.
warning limit shown in Warn. Valid values are yes for message generation, or no

10-22
In the following example information on a specific group is displayed.
eng38 ENG38VS0> filesystem quota group show techpubs pubs@onstor
Group: pubs@onstor
Limit: 400 MiB
Warn: 340 MiB
Usage: 274 MiB
eng38 ENG38VS0>
In this example, the warning, limit, and current usage for the specific group
pubs@onstor is displayed with the following information:
• The group name. If this value is a GID, the term “GID” is displayed along with the
number, for example, GID78@onstor.
• The absolute usage limit for the group pubs@onstor.
• The warning threshold for the group pubs@onstor.
• The current usage for the group pubs@onstor.
In the following example the filesystem quota group show command with the -all
keyword is run.
eng38 ENG38VS0> filesystem quota group show techpubs -all
Group: gid78@onstorlab
Limit: default
Warn: default
Usage: 500 MiB
Group: group2@onstorlab
Limit: default
Warn: default
Usage: 274 MiB
Group: software@onstorlab
Limit: default
Warn: default
Usage: 500 MiB
eng38 ENG38VS0>

10-23
In this example, all specific user quotas configured on the volume techpubs are
displayed with the following information:
• The group name. You can display a GID along with group names.
• The absolute usage limit for the group pubs@onstor.
• The warning threshold for the group pubs@onstor.
• The current usage for the group pubs@onstor.
Related Commands
filesystem quota group config Configures default group quotas on a volume.
filesystem quota group set Sets or changes quota usage limits or warning
thresholds for a specific group.
Filesystem Quota Log Clear
Synopsis
filesystem quota log clear
Description
You can clear locally stored log messages by running the filesystem quota log
clear command. Quota log messages contain information about specific usage events
that meet or exceed a warning or limit threshold. The quota log receives messages
when a quota is configured with the following parameters:
• A limit or a warning value
• A log limit value
Clearing the quota log is immediate and removes all entries.

10-24
Example
eng38 ENG38VS0 > filesystem quota log clear

eng38 ENG38VS0 >
Related Commands
filesystem quota log show Shows quota log contents.
Filesystem Quota Log Facility
Synopsis
filesystem quota log facility
{local0|local1|local2|local3|local4|local5|local6|local7}
Description
The quota log facility interfaces with the standard Syslogd capability to provide
logging of important system information at the specified level of priority. With this
facility, you can locally save, forward to a remote host, or display system messages on
the system console. Quota log messages use the same user-level facility codes as a
standard UNIX syslog program.
Options
One of the following values
local0|local1|local2|local3|local4|local5|local6|loc
al7 denotes the facility code. The default value is local6.
Example
eng38 ENG38VS0 > filesystem quota log facility local2

eng38 ENG38VS0 >
In this example, the facility code is set to local2.

10-25
Related Commands
filesystem quota log show config Shows the current log configuration.
Filesystem Quota Log Host
Synopsis
filesystem quota log host IPADDR
Description
The quota log facility interfaces with the standard syslogd capability to provide
logging of system information at the specified level of priority. With this facility, you
can locally save, forward to a remote host, or display system messages on the system
console.
You can forward quota log messages to syslog daemons running on a specified host by
running the filesystem log host command. If the host address is set to 0, all quota
log messages are forwarded to the local syslog daemon. Quota log messages for
priority less than info are not saved in the local log. If a nonzero syslog host is
specified, all messages are forwarded to the specified host using the currently
configured facility code. In this case, make sure that the remote syslog host is
configured to receive syslog messages from other hosts because some
implementations, by default, are configured to not receive syslog messages forwarded
by other hosts. Remote logging is disabled by default, so all messages are sent to the
local host.
Options
The IPADDR variable is the IP address of a remote host that runs
syslogd and is capable of receiving quota log messages from this
NAS Gateway.

10-26
Example
eng11> filesystem quota log host 192.168.172.1

eng11>
In this example, 192.168.172.1 is specified as the syslogd host for sending quota log
messages.
Related Commands
filesystem quota log show config Shows the current log configuration.
Filesystem Quota Log Show
Synopsis
filesystem quota log show [NUMLINES]
Description
You can display locally stored log messages by running the filesystem quota log
show command. Quota log messages contain information about specific usage events
that meet or exceed a warning or limit threshold. The quota log receives messages
when a quota is configured with the following parameters:
• A limit or a warning value
• A log limit value
Usage can approach a limit or a warning value, so events are logged once per day
regardless of how many times a warning or limit threshold is exceeded in a 24-hour
period.
Options
The NUMLINES variable is an optional argument that specifies the
number of lines to display. The number of lines you specify are
counted in most-recent to least-recent order to facilitate seeing the
most recent usage events. Type a 32-bit number for the

10-27
NUMLINES argument. If you do not specify a value for

NUMLINES, by default the entire quota log is displayed.
Example
eng38 ENG38VS0 > filesystem quota log show

Sat Apr 24 17:59:25 2004 Process-EVENT Quota User Disabled: vol3
(000000220000006d)
Sat Apr 24 17:59:28 2004 Process-EVENT Quota User Enabled: vol3
(000000220000006d)
(000000220000006d)
(000000220000006d)
(000000220000006d)
(000000220000006d)
(000000220000006d)
(000000220000006d)
(000000220000006d)
(000000220000006d)
(000000220000006d)
Sat Apr 24 20:46:58 2004 Process-EVENT Quota Tree Limit: vol3
(000000220000006d) (inode 0000000000000002) path: '\' - Usage: 10
MiB
eng38 ENG38VS0 >
Fields displayed in the log include the following:

• Date timestamp—weekday, month, date, hour, minute,
second, year.
• Process type.
• State—valid values are enabled and disabled.
• Volume ID followed by a field for ONStor technical support
only.

10-28
After the quota log has finished scrolling, the NAS Gateway command prompt
reappears. You can continue with other operations, or you can clear the quota log to
start a fresh recording of quota events.
Related Commands
filesystem quota log clear Clears the quota log for all volumes.
Filesystem Quota Log Show Config
Synopsis
filesystem quota log show config
Description
You can display locally quota log configuration information by running the
filesystem quota log show config command. Quota log configuration shows the
log facility and the host address.
Example
eng57> filesystem quota log show config

Filesystem quota log configuration
----------------------------------
Filesystem Quota Log Facility: local6
Filesystem Quota Log Host Addr: 0.0.0.0
This example shows the following information:

• The quota log facility code is set to local6.
• The quota log host IP address is 0.0.0.0.
Related Commands

10-29
Filesystem Quota Tree Config
Synopsis
filesystem quota tree config VOLNAME [-d] [-e {enforce | trackonly}]
[-l LIMIT] [-L {yes | no}] [-w WARNING] [-W {yes | no}]
Description
You can configure tree quotas, also called hierarchical or directory quotas, in the file
system as default or specific tree quotas. With default tree quotas you can configure
conditions and behavior for a part of the directory structure on a volume.
Default tree quotas apply to a volume, and the usage is charged to directories on the
volume, not to users or groups that access the directory. Therefore, individual users or
groups receive usage conditions and can be charged for their use of the directory even
if the users or groups do not have specific user or group quotas assigned to them.
When user or group quotas and tree quotas are assigned, all configured quotas are
applied. The most restrictive quota is enforced.
You can configure default tree quotas for each volume by running the filesystem
quota tree config command.
You can configure default tree quotas in one of the following ways for monitoring
usage and enforcing conditions on that usage, for example:
• Track only mode enables the NAS Gateway to track the usage of the tree on the
volume without enforcing any results if usage exceeds the allocated amount of
volume space.
• Enforce mode enables the NAS Gateway to track the usage of the tree on the
volume and enforce the quota.
Quotas are assigned to a volume, so you need to run the filesystem quota tree
config command from the context of the same virtual server that contains the volume
where you want the quota defined. You can also use this command to change an
existing default tree quota. Default tree quotas that already exist when you run the
command are updated with any arguments that have changed.

10-30
You can configure or modify a default tree quota regardless of its state. If a quota is
disabled when you make a change, the new arguments take effect when the quota is
reenable
Table 10-6 : Options for the filesystem quota tree config command

default tree quota is configured.
-d Specifying this option generates a
default configuration of the quota. The
default configuration is as follows:
Enabled: yes
Limit: infinite
Log Limit: yes
Warn: infinite
Log Warn: yes
-e trackonly An optional argument that causes the
NAS Gateway to track a tree’s usage on
the volume without preventing
allocations of disk space to that tree.
With this argument, a client using the
tree can continue allocations even if a
usage threshold is exceeded. -e
trackonly is enabled by default.
- e enforce An optional argument that causes the

NAS Gateway to track and enforce a
tree’s usage on the volume. With this
argument, a client using the tree is
prevented from performing a allocations
if a usage threshold is met or exceeded.
-e trackonly is enabled by default.

10-31
Table 10-6 : Options for the filesystem quota tree config command (Continued)

absolute limit in MiBs for the default
tree quota. A MiB is 1048576 bytes.
This argument interacts with the -e
enforce argument to indicate the
threshold at which quota enforcement
occurs. If this threshold is exceeded,
allocations fail.
This argument also interacts with the -L
{yes | no} argument to indicate the
threshold at which usage events are
recorded when the log limit has been
exceeded.
-L [{yes | no}] An optional argument that specifies
whether to log usage events for events
that exceed the value specified for the -l
LIMIT argument. If the -L {yes | no}
argument is specified, and the value
specified for -l LIMIT is exceeded, the
event is written to the quota log the first
time that usage exceeds the limit. Events
are logged once per day regardless of
how many times the log limit has been
exceeded in a 24-hour period. This
argument indicates when usage is
getting high before the hard limit is
reached and group requests might fail.
The default is no log limit.

10-32
Table 10-6 : Options for the filesystem quota tree config command (Continued)

soft limit in MiBs for the default tree
infinite.
This argument works with the -W {yes
| no} argument.
If the group exceeds the -w WARNING
usage limit, an event is written to the
quota log if the -W {yes | no}
argument is configured.
If the log limit has been exceeded, the
event is written to the log the first time
that usage exceeds the limit. Events are
logged once per day regardless of how
many times the log limit has been
exceeded in a 24-hour period.
-W [{yes | no}] An optional argument that specifies
whether to log usage events if the value
specified with the -w WARNING
argument is exceeded. You can specify
either yes or no. By default no warning
events are logged.
Example
In the following example a default tree quota with all default parameters is configured.
eng11 PUBSTEST> filesystem quota tree config techpubs

eng11 PUBSTEST>

10-33
In this example, the default tree quota is configured on volume techpubs. Because no
custom quota parameters are specified, the quota is configured with the following
default parameters:
• Track only mode
In the following example a default tree quota with custom parameters is configured.
eng11 PUBSTEST> filesystem quota tree config techpubs -e trackonly

-l 500 -L yes -w 450 -W yes
eng11 PUBSTEST>
In this example, a default tree quota is configured on volume techpubs. This quota is
configured with the following values.
• Track only mode
usage limit
• A warning threshold of 450 MiBs, to alert you when usage on techpubs is
approaching the absolute limit.
limit
eng11 PUBSTEST> filesystem quota tree config techpubs -e enforce

-l 460 -W yes
eng11 PUBSTEST>

10-34
In this example, an enforce mode default tree quota is configured on volume techpubs.
This quota is configured with the following parameters:
• Enforce mode
usage limit
Because no other parameters are specified, the omitted parameters are set to their
default values, which are as follows:
Related Commands
filesystem quota tree set Sets specific quotas on a directory, or changes
quota usage limits or warning thresholds.
filesystem quota tree show Shows tree quota configuration or tree quotas.
Filesystem Quota Tree Remove
Synopsis
filesystem quota tree remove VOLNAME PATHNAME
Description
The filesystem quota tree remove command removes a directory which is the
root of tree quota. All the directories and files under the quota tree will be removed
recursively.
This command is not supported on file systems which were created prior to EverOn
version 3.0.0 when the tree quota is not empty. Such file systems must be converted to
the latest layout version before issuing this command.
If the PATHNAME is not a director y or quota tree root, the command fails.

10-35
Options
Table 10-7 : Options for the filesystem quota tree remove command
PATHNAME Specifies the path name

which is the root of the
quota tree.
VOLNAME Specifies an existing
volume to which the quota
command is applied.
Example
In the following example, path name pnested/cnested is removed from volume
pcvol.
eng56 ENG56-VS1> filesystem quota tree remove pcvol pnested/cnested
eng56 ENG56-VS1>
Related Commands
filesystem convert Converts the filesystem layout to the latest
version.
filesystem quota tree config Configures default tree quotas on a volume.
filesystem quota tree show Displays tree quota configuration or tree quotas.
volume show Displays one or more volumes.

10-36
Filesystem Quota Tree Set
Synopsis
filesystem quota tree set VOLNAME PATHNAME [-l LIMIT] [-w WARNING]
[-n {yes | no} [-d]
Description
You can configure tree quotas, also called hierarchical or directory quotas, in the file
system as default tree quotas or specific tree quotas. Specific tree quotas support
tracking or enforcing usage conditions on a specific part of the directory structure.
When you configure a tree quota, any child directories in the directory tree inherit its
conditions. If the specific tree quota is nested, usage of a directory is recursively
charged up the tree to all quota tree roots until the closest simple quota is encountered
(or the root directory), whichever is first.
You can configure specific tree quotas on a directory in the file system by running the
filesystem quota tree set command. As part of running this command, you
specify the directory path to which the quota applies. You can specify the root
directory as part of the specific tree quota or a nonroot directory, but only if that
directory is empty. Any nonroot directory you specify needs to be in relation to the
root of the volume, so always include the root slash ( / ) when you specify the directory
path as shown in the following examples:
• / configures the directory as the root of whichever volume is specified when you
configure the quota.
• /dir1 configures the quota for dir1 on whichever volume is specified when you
configure the quota.
• /dir1/dir2 configures the quota for dir2, which resides as a child of dir1 on
whichever volume is specified when you configure the quota is.
If a default tree quota and a specific tree quota are on the same volume, both quotas are
enforced.

10-37
Specific tree quotas inherit the following quota parameters from the default tree quota
For specific tree quotas, you can specify directory paths in either Windows or UNIX
formats. Because the NAS Gateway is multiprotocol, it interprets the path correctly
and applies the quota. For example, you can specify /vol1/eng/publications for a
UNIX environment and \vol1\eng\publications for the same directory paths, and the
NAS Gateway applies the quotas where you configure them.
Note!
The directory path where the quota is applied needs to exist before running the
filesystem quota tree set command.
Options
Table 10-8 : Options for the filesystem quota tree set command
VOLNAME The name of the volume where the specific tree


10-38
Table 10-8 : Options for the filesystem quota tree set command (Continued)
PATHNAME The first object in the directory path where the

quota is configured. Specify the directory path
in relation to the root of the volume, for
example /dir1. Include the root slash in the path
( / ). Children of this object inherit the quota
conditions of the parent.
You can specify the root directory as part of the
specific tree quota or a nonroot directory, but
only if that directory is empty. Any nonroot
directory you specify needs to be in relation to
the root of the volume, so always include the
root slash ( / ) when you specify the directory
path.
absolute limit in MiBs for the specific tree

10-39
Table 10-8 : Options for the filesystem quota tree set command (Continued)
-w WARNING An optional argument that specifies the soft

limit in MiBs for the default tree quota. A MiB
is 1048576 bytes.
To specify this argument, type the keyword -w
followed by a blank space, then the WARNING
value. The default is infinite.
This argument works with the -W {yes | no}
argument.
If the group exceeds the -w WARNING usage
limit, an event is written to the quota log if the -
W {yes | no} argument is configured.
If the log limit has been exceeded, the event is
written to the log the first time that usage
exceeds the limit. Events are logged once per
day regardless of how many times the log limit
has been exceeded in a 24-hour period.
-n {yes | no} An optional argument that specifies the nesting
mode. If you specify -n yes, the usage of this
also tree needs to be charged against the quota
tree root of the parent directory.
The usage of the tree quota is charged only
against the object on which the quota is
configured. The default is a nonnested quota
tree.
-d An optional argument that resets the soft and
hard limit to the default values on the volume
instead of using the soft and hard limits defined
for a specific tree.

10-40
Example
In the following example a specific tree quota is configured.
eng11 PUBSTEST> filesystem quota tree set techpubs /dir1/dir2

-l 80 -w 66 -n yes
eng11 PUBSTEST>
In this example, a specific tree quota is set on the volume techpubs. The specific tree
quota is applied to /dir1/dir2 so that any user or group is allowed to access that
directory with the following custom conditions:
• Nested quota
Related Commands
filesystem quota tree show Shows the tree quota configuration or tree
quotas.
Filesystem Quota Tree Show
Synopsis
filesystem quota tree show VOLNAME [PATHNAME|-all]
Description
You can display a tree quota definition by running the filesystem quota tree show
command. Use this command to display the tree quota records in the following ways:
• By volume
• By specific path (for specific tree quotas only)

10-41
Note!
Use either the back slash ( \ ) or forward slash (/) in this command. The NAS
Gateway always represents the directory structure with back slashes.
This command returns tree quota information regardless of whether the quota is
following ways:
• If the quota feature is enabled and the quota configuration contains no specific
directory quotas, the output of this command shows the default quotas on the
volume.
infinite for the warning and limit levels. Usage shows zero MiBs until usage occurs
on the volume.
Options
Table 10-9 : Options for the filesystem quota tree show command
VOLNAME The name of the volume where the tree

quotas are configured.

10-42
Table 10-9 : Options for the filesystem quota tree show command (Continued)
PATHNAME An optional argument that specifies the

directory for which to display tree
quotas. You can specify paths in either
Windows or NIS format, and paths can
have a maximum of 1024 characters. If
you specify a path, any quota configured
on that path is displayed.
NAS Gateway to display all tree quotas
configured on the volume specified in
VOLNAME. If the tree quotas are enabled
when you run the filesystem
quota tree show command, the
NAS Gateway shows both the quota
records and the usage information. If
you do not specify the -all keyword,
only the default tree quota on the volume
is displayed.
-P PATHNAME An option that specifies the number of
the page to display.
-S PATHNAME An option that specifies the page size in
number of records to display.

10-43
Example
The following example shows default tree quota information.
eng38 ENG38VS0> filesystem quota tree show techpubs

Enabled: yes
Enforcement: track only
Limit: infinite
Log Limit: yes
Warn: infinite
Log Warn: yes
eng38 ENG38VS0>
In this example, the default tree quota information on the volume techpubs is
displayed as follows:
The following example shows a specific directory.
eng38 ENG38VS0> filesystem quota tree show techpubs \dir1
Directory: \dir1
Limit: 80 MiB
Warn: 75 MiB
Usage: 55 MiB
Nested: yes
eng38 ENG38VS0>

10-44
This example shows the warning, limit, and current usage for the directory /dir1 with
• The directory name. The directory structure is always displayed with backslashes
( \ ) regardless of whether the directory itself is actually a Windows format ( \ ) or
UNIX format ( / ).
• The absolute usage limit for the directory /dir1.
• The warning threshold for the directory /dir1.
• The current usage for the directory /dir1.
• The state of the directory /dir1 as a simple or nested directory. A value of yes in the
Nested field indicates a nested directory; a value of no indicates a simple directory.
In the following example, all specific tree quotas on a volume are displayed.
eng38 ENG38VS0> filesystem quota tree show techpubs -all
Directory: \
Limit: infinite
Warn: infinite
Usage: 1066 MiB
Nested: no
Directory: \dir1
Limit: 80 MiB
Warn: 75 MiB
Usage: 55 MiB
Nested: yes
Directory: \dir2
Limit: 33 MiB
Warn: 22 MiB
Usage: 1011 MiB
Nested: yes
eng38 ENG38VS0>
In this example, the following information of all specific tree quotas configured on the
volume techpubs are displayed:
• The directory name. The directory structure is always displayed with backslashes
( \ ) regardless of whether the directory itself is actually a Windows format ( \ ) or

10-45
UNIX format ( / ). The root directory is configured as a simple quota. By

definition, the root directory cannot be a nested quota.
Related Commands
Filesystem Quota User Config
Synopsis
filesystem quota user config VOLNAME [-d] [-e {enforce | trackonly}]
[-l LIMIT] [-L {yes|no}] [-w WARNING] [-W {yes | no}]
Description
You can configure user quota in the file system as default or specific user quotas.
Default user quotas are configured on a volume and apply to every user who accesses
the volume. With default user quotas you can configure a baseline of the same quota
conditions and behavior for all users who access a volume. Because the default user

10-46
quota on each volume applies to everyone, only one default user quota can exist on
each volume.
You can configure default user quotas in one of the following ways for managing
usage:
• Track only mode enables the NAS Gateway to track the user’s usage on the volume
without enforcing any results if the user exceeds the allocated amount of volume
space.
• Enforce mode enables the NAS Gateway to track the user’s usage on the volume
and enforce the quota.
Quotas are assigned to a volume, so run the filesystem quota user config
command from the context of the virtual server that contains the volume where you
want the quota defined. You can also use this command to change an existing default
user quota. Default user quota that already exist when you run the command are
updated with any arguments that have changed.
Note!
For this command to take effect, the virtual server needs to be enabled and the
volume needs to be online and in read-write mode. An online volume in read-
only mode cannot receive any new quota information until its is in read-write
mode.
Options
Table 10-10 : Options for the filesystem quota user config command
VOLNAME The name of the volume where the default user


10-47
-d Specifying this option generates a default

configuration of the quota. The default
configuration is as follows:
Enabled: yes
Limit: infinite
Log Limit: yes
Warn: infinite
Log Warn: yes
-e trackonly An optional argument that causes the NAS
Gateway to track a user’s usage on the volume
without preventing allocations of disk space to
that user. With this argument, the user can
continue allocations even if a usage threshold is
exceeded.
-e trackonly is enabled by default.
-e enforce An optional argument that causes the NAS
Gateway to track and enforce a user’s usage on
the volume. With this argument, the user is
prevented from performing allocations if a usage
threshold is met or exceeded. e-trackonly is
enabled by default.

10-48
-l LIMIT An optional argument that specifies the absolute

limit in MiBs for the default user quota. A MiB
is 1048576 bytes.
Type the keyword -l followed by a blank
space, then the LIMIT value. By default, the
limit is infinite.
This argument interacts with the -e enforce
argument to indicate the threshold at which
quota enforcement occurs. If this threshold is
exceeded, allocations fail.
This argument also interacts with the -L {yes |
no} argument to indicate the threshold at which
usage events are recorded when the log limit has
been exceeded.
-L {yes | no} An optional argument that specifies whether to
log usage events for events that exceed the value
specified for the -l LIMIT argument.
If the -L {yes | no) argument is specified, and the
value specified for -l LIMIT is exceeded, the
event is written to the quota log the first time that
usage exceeds the limit. Events are logged once
per day regardless of how many times the log
limit has been exceeded in a 24-hour period.
This argument indicates when usage is getting
high before the hard limit is reached and group
requests might fail. The default is no log limit.

10-49
-w WARNING An optional argument that specifies the soft limit

in MiBs for the default user quota data.
To specify this argument, type the keyword -w
followed by a blank space, then the WARNING
value. The default is infinite.
This argument works with the -W {yes | no}
argument.
If the user exceeds the -w WARNING usage limit,
an event is written to the quota log if the -W {yes
| no} argument is configured.
If the log limit has been exceeded, the event is
written to the log the first time that usage
exceeds the limit. Events are logged once per
day regardless of how many times the log limit
has been exceeded in a 24-hour period.
-W An optional argument that specifies whether to
{yes|no} log usage events if the value specified in -w
WARNING is met or exceeded. You can specify
either yes or no. By default no warning events
are logged.
Example
In the following example a default user quota with all default parameters is
configured.
eng11 PUBSTEST> filesystem quota user config techpubs

eng11 PUBSTEST>

10-50
In this example, the default user quota is configured on the volume techpubs. Because
no custom quota parameters are specified, the quota is configured with the following
default parameters:
• Track only mode
absolute usage limit is met or exceeded.
In the following example a default user quota with custom parameters is configured.
eng11 PUBSTEST> filesystem quota user config techpubs -e trackonly

-l 200 -L yes -w 150 -W yes
eng11 PUBSTEST>
In this example, a track-only default user quota is configured on the volume techpubs.
This quota is configured with the following values.
• Track only mode
usage limit
• A warning threshold of 150 MiBs, to alert you when usage on techpubs is
approaching the absolute limit.
limit.
eng11 PUBSTEST> filesystem quota user config techpubs - e enforce

-l 160 -L yes
eng11 PUBSTEST>

10-51
In this example, an enforce mode default user quota is configured on the volume
techpubs. This quota is configured with the following parameters:
• Enforce mode
usage limit
Because no other parameters are specified, the omitted parameters are set to the
following default values:
Related Commands
filesystem quota user set Sets or changes quota usage limits or warning
thresholds for a specific user.
filesystem quota user show Shows user quota configuration or user quotas.
Filesystem Quota User Set
Synopsis
filesystem quota user set VOLNAME USERNAME [-l LIMIT] [-w WARNING]
[-d]
Description
You can configure user quotas in the file system as either default user quotas or
specific user quotas. Use specific user quotas to set specific usage conditions for
individual users that access the volume. These usage conditions for specific user
quotas are applied along with the default user quotas on the volume. When multiple
quotas are configured, the NAS Gateway analyzes all of them and applies the strictest
to offer the most control over usage. Specific user quotas are optional. If no user
quotas are configured, then no usage is tracked or enforced for each user.

10-52
You can configure specific user quotas with the filesystem quota user set
command. Use this command to set different limit and warning values for a special
user. You can also use the optional argument -d to reset a specific user quota’s limit
and warning values to the limit and warning values configured in the default user
quota.
You can configure specific quotas on the same volume as default user quotas. If
specific and default user quotas are configured on the same volume, both quotas are
enforced.
Specific user quotas inherit the following quota parameters from the default quota
Specific user quotas support specifying a UID, an NIS or LDAP name, or a Windows
name, for example:
• 99@onstor (LDAP or NIS UID format)
• gary@onstor (LDAP or NIS user name format)
• onstor\gary (Windows user name format)
User names need to be valid and known to the Windows or NIS domain controllers.
Because the NAS Gateway is multiprotocol, you can map CIFS and NFS users
between domain types through ID Mapping. You cannot assign a specific user quota to
UID 0.
Note!
It is possible to configure a 0 MiB quota. Although unusual, it is a valid
configuration in some cases. For example, assume that an employee no longer
works with you. You can set a 0 MiB enforce-mode quota on the user so that no
new usage can accumulate for that user name. Or, you can set a 0 MiB track-
only mode quota to allow additional usage to accumulate and post messages to
the quota log when any usage occurs for the departed user.

10-53
Options
Table 10-11 : Options for the filesystem quota user set command

specific user quota is configured.
USERNAME The name of the user to which you are
assigning the quota usage conditions.
User names can be either Windows or
NIS formats, and they need to match the
user name that is configured on the NIS
or Windows domain controller.
absolute limit in MiBs for the specific
user quota. A MiB is 1048576 bytes.
soft limit in MiBs for the specific user
infinite.

10-54
Table 10-11 : Options for the filesystem quota user set command (Continued)
-d An optional argument that causes the

specific user quota to use the values
from the default user quota on the
volume. This option is useful for
resetting a specific user’s usage
conditions to the same usage conditions
that are assigned to the default user
quota. This option may not be combined
with the -l LIMIT or -w WARNING
arguments.
Example
In the following example a specific user quota is configured.
eng11 PUBSTEST> filesystem quota user set techpubs timg@onstor

-l 400 -w 340
eng11 PUBSTEST>
In this example, a specific user quota is set on the volume techpubs. The specific user
quota is applied to timg@onstor so that this user is allowed to access the volume
techpubs with the following custom conditions:
Related Commands
filesystem quota user config Configures default user quotas on a volume.
filesystem quota user show Shows user quota configuration or user quotas.

10-55
Filesystem Quota User Show
Synopsis
filesystem quota user show VOLNAME [USERNAME|-all][-P PAGENUMBER
[-S PAGESIZE]]
Description
You can display a user quota definition by running the filesystem quota user
show command. Use this command to display the user quota records in the following
ways:
• By volume.
• By specific user name (for specific user quotas only)
This command returns user quota information regardless of whether the quota is
following ways:
• If the quota feature is enabled and the quota configuration contains no specific user
quotas, the output of this command shows the default quotas assigned to everyone
on the volume.
infinite for the warning and limit levels. Usage shows zero MiBs until usage occurs
on the volume.

10-56
Options
Table 10-12 : Options for the filesystem quota user show command
VOLNAME The name of the volume where the user

quotas are configured.
USERNAME An optional argument that specifies the
name of the user for which you are
displaying the user quota. User names
can be either Windows or NIS formats,
for example, 99@onstor, pubs@onstor,
or onstor\software. The names need to
match the user name that is configured
on the NIS or Windows domain
controller.
NAS Gateway to display all user quotas
configured on the volume specified in
VOLNAME. If the user quotas are enabled
when you run the filesystem
quota user show command, the
NAS Gateway shows the quota records
and the usage information. If you do not
specify the -all keyword, only the
default user quota on the volume is
displayed.

10-57
Example
The following example shows default user quota information on a volume.
eng38 ENG38VS0> filesystem quota user show techpubs

Enabled: yes
Limit: 6000 MiB
Log Limit: yes
Warn: 5555 MiB
Log Warn: yes
eng38 ENG38VS0>
In this example, the following default user quota information on the volume techpubs
is displayed:
The following example shows information a specific user.
eng38 ENG38VS0> filesystem quota user show techpubs onstor\timg
User: onstor\timg
Limit: default
Warn: default
Usage: 274 MiB
eng38 ENG38VS0>

10-58
In this example, the following warning, limit, and current usage information for the
specific user onstor\timg is displayed:
• The user name. You can display a UID along with user names.
• The absolute usage limit for the user pubs@onstor.
• The warning threshold for the user pubs@onstor.
• The current usage for the user pubs@onstor.
The following example shows information about all specific users.
eng38 ENG38VS0> filesystem quota user show techpubs -all
User: UID5544@onstorlab
Limit: default
Warn: default
Usage: 500 MiB
User: rajeshk@onstorlab
Limit: 7777 MiB
Warn: 6666 MiB
Usage: 500 MiB
User: onstor\timg
Limit: default
Warn: default
Usage: 274 MiB
eng38 ENG38VS0>
This example shows all the specific users, and their limits, warning thresholds, and
current usage showing the following information:
• The user name. You can display a UID along with user names.
• The absolute usage limit for the user pubs@onstor.
• The warning threshold for the user pubs@onstor.
• The current usage for the user pubs@onstor.
Related Commands
filesystem quota user config Configures default user quotas on a volume.

10-59
filesystem quota user set Sets or changes quota usage limits or warning
thresholds for a specific user.
Filesystem Revert
Synopsis
filesystem revert VOLNAME
Description
This command reverts the filesystem to the previous version. This command should only
be used if the software needs to be reverted to a previous version where the latest filesystem
version, version 28, is not supported. Any current volume with a filesystem version greater
than 26 would have to be reverted using the filesystem revert command prior to revert
to the previous software version. The filesystem version is displayed by the volume show
VOLNAME output.The volume should be taken offline before executing this command.
Note!
When the filesystem revert command completes successfully,
there is no output to the console.
Options
The VOLNAME variable specifies an existing volume.
Related Commands
filesystem convert Converts the filesystem to the latest version.
volume offline Takes the specified volume offline.
volume show Displays volume information.
Filesystem Show Stats Cache
Synopsis
filesystem show stats cache [-n NODENAME | VOLNAME]

10-60
Description
File system cache statistics display in detail the cache usage for the file system,
including the traffic usage of I/O operations. You can display the file system cache
statistics by running the filesystem show stats cache command. This command
tracks the statistics for each NAS Gateway, so all statistics are displayed for all
volumes on the current NAS Gateway. You can specify a node or volume name to
view the cache statistics for a specific volume or a specific NAS Gateway.
Options
Table 10-13 : Options for the filesystem show stats cache command
-n NODENAME An optional argument for displaying the

file system cache statistics for a specific
NAS Gateway in the cluster.
VOLNAME An optional argument for displaying the
file system cache statistics for a specific
volume. Run the filesystem show
stats cache command with the
VOLNAME option from the virtual server
context.
Note!
Because the file system show stats cache command with the -n
NODENAME option runs from the NAS Gateway context and the command
with the VOLNAME option runs from the virtual server context, you cannot
combine both options in running the command.

10-61
Example
eng31 ENG31-VS1> filesystem show stats cache
Cachestats for all volumes:
Type Max Used Dirty Hits Misses

1/00 COW LWM HWM
------------------------------------------------------------------
-----------------------------------------
inodeBuf 42930 65 0 24 66
2750 0 42930 107367
8knondir 14310 12 0 69 8
115 2 14310 35563
1knondir 182783 0 0 0 0
0 0 182783 224309
8kdir 2862 1 0 0 1
0 0 2862 8589
1kdir 208895 1 0 1 1
1000 0 208895 418752
user 185343 0 0 0 0
0 0 185343 322103
inodes 491517 17 0 74 14
189 491517 1836266
quotas 1073 0 0 0 0
0 0 1073 1073
I/O Curr Max Meta User Log

Type Pending Pending Total Total Total
------------------------------------------------------------------
-
read 0 6 81 1 17
write 0 7 9 1 12
eng31 ENG31-VS1>

10-62
Table 10-14 shows the file system statistics that are tracked through the filesystem
show stats cache command.
Table 10-14 : Columns in the cache statistics display
Column Description
Type The type of file system metadata event that is tracked. Valid values are:
• inodebuf for the number of inode buffers cached.
• 8knondir for the number of 8K file system blocks not used in directory
functions that have been cached.
• 8kdir for the number of 8K file system blocks used for directory operations.
• 1kdir for the number of 1K file system blocks used in directory functions
that have been cached.
• user for the number of times the user data cache has been used.
• inodes for the number of times the inode cache has been used.
• quotas for the number of time the quota cache has been used.
Max The current maximum size in units of the object cached, for example, a
1k or 8k block of data. The object tracked is listed in Type. This field is a
soft limit that interoperates with the LWM and HWM fields. When Max
reaches the LWM value, the cache can grow at internally computed
increments to, but not past the value listed in the HWM field.
Used The number of times the cache has been used for the object listed in
Type.
Dirty The number of times the objects listed in Type have been modified. This
statistic indicates that an object was written to disk.
Hits The number cache uses for each type of object listed in the Type field.
The number for this field shows how many times each listed object was
found in the cache.
Misses The number of cache misses for each type of object listed in the Type
field. The number in this field shows how many times an object of this
type was not found in the cache.

10-63
Table 10-14 : Columns in the cache statistics display (Continued)
Column Description
COW The number of copy on write (COW) operations that have been used.
LWM The low watermark (LWM) for each object in the cache. This field
interoperates with the Max field to adjust the cache size. When Max
equals the LWM value, the cache is triggered to grow at internally
computed increments.
HWM The high watermark (HWM) for each object in the cache. This field
computed increments. The HWM field shows the absolute maximum to
which the cache can grow.
The second table in the display shows the file system I/O counters for various types of
read and write operations that are cached. Table 10-15 explains the columns in the I/O
section of the cache statistics display.
Table 10-15 : Columns in I/O section of cache statistics display
Column Description
I/O Type Indicates whether the statistic being tracked is a read or write
operation. The read and write operations tracked are for user
data read or write operations and metadata read or write
operations. A write operation indicates that a modified entry in
the cache was written to disk, and a read operation indicates that
an entry was read in from disk.
Current Pending The total number of read or write operations that were in
progress at the time the filesystem show stats show
cache command was run.
Max Pending The peak usage recorded for the Current Pending field.
Meta Total The total number of read or write operations for metadata.

10-64
Table 10-15 : Columns in I/O section of cache statistics display (Continued)
Column Description
User Total The total number of read or write operations for user data.
Log Total The total number of read or write operations for the transaction
journal.
Filesystem Show Stats Cache Hash
Synopsis
filesystem show stats cache hash [-n NODENAME | VOLNAME]
Description
File system information is hashed to more efficiently locate metadata in NAS Gateway
memory. The NAS Gateway’s file system cache hash statistics focus primarily on
inode and metadata usage. You can display the file system cache statistics by running
the filesystem show stats cache hash command. These statistics show
information about the following:
• Inodes
• Memory buffers
• User data
• Pages
• Disks
By default, this command tracks statistics for each NAS Gateway, so all statistics are
displayed for all volumes on the current NAS Gateway. You can specify a node name
or a volume name to view the cache hash statistics for a specific volume.

10-65
Options
Table 10-16 : Options for the filesystem show stats cache hash command

file system cache hash statistics for a
specific NAS Gateway in the cluster.
file system cache hash statistics for a
specific volume. Run the filesystem
show stats cache hash
command with the VOLNAME option
from the virtual server context.
Note!
Because the filesystem show stats cache hash command with the
-n NODENAME option runs from the NAS Gateway context and the command

10-66
Example
eng31 ENG31-VS1> filesystem show stats cache hash
Type Max Used Dirty Hits Misses 1/00

COW LWM HWM
------------------------------------------------------------------
--------
---------------------------
inodeBuf 17790 1024 0 18371 2130 115
0 17790 48315
8knondir 5930 167 0 14953 345 23
0 5930 16003
1knondir 82251 0 0 0 0 0
0 82251 100938
8kdir 1186 1 0 0 3 0
0 1186 3865
1kdir 94001 1 0 90 3 33
2 94001 188436
0 73493 144945
inodes 326963 18 0 582 45 77
326963 826312
quotas 1073 0 0 0 0
0 0 1073 1073
------------------------------------------------------------------
-
read 0 2 2465 0 45
write 0 10 73 0 32
File system statistics are displayed in three parts, which consist of two tables and a list.

10-67
Table 10-17 shows the first table of the file system cache hash statistics.
Column Description
Type The type of file system metadata event that is tracked. Valid values are:
• 8knondir for the number of 8K file system blocks not used in
directory functions that have been cached.
• 1knondir for the number of 1K file system blocks not used in
directory functions that have been cached.
• 8kdir for the number of 8k file system blocks used for directory
operations.
• 1kdir for the number of 1K file system blocks used in directory
Max The current maximum size in units of the object cached, for example, a
1k or 8k block of data. The object tracked is listed in Type. This field is
a soft limit that interoperates with the LWM and HWM fields. When
Max reaches the LWM value, the cache can grow at internally computed
increments to the value listed in the HWM field.
Used The number of times the cache has been used for the object listed in
Type.
Hits The number of cache uses for each type of object listed in the Type field.
found in the cache.

10-68
Column Description
LWM The low watermark (LWM) for the each object in the cache. This field
Table 10-18 : Columns in I/O section of cache statistics display
Column Description
operation. The read and write operations tracked are for both user
operations. A write operation indicates that a modified entry in
the cache was written to disk, and a read operation indicates that
an entry was read in from disk.

10-69
Table 10-18 : Columns in I/O section of cache statistics display (Continued)
Column Description
Current Indicates the total number of read or write operation that were in
Pending progress at the time the filesystem show stats cache
hash command was run.
Log Total the total number of read or write operations for the transaction
journal.

10-70
Example
Inode Hash Statistics

Total nbr of buckets: 4194304
Total nbr of entries 17
Total nbr of used buckets 17
Max depth 1
Avg depth 1.00
Userbuf Block Hash Statistics
Max depth 0
Avg depth 1.00
Metabuf Block Hash Statistics
Max depth 1
Avg depth 1.00
Userbuf Page Hash Statistics
Max depth 0
Metabuf Page Hash Statistics
Max depth 10
Avg depth 1.95
Userbuf Inum Hash Statistics
Max depth 0
metabuf Inum Hash Statistics
Max depth 1
Avg depth 1.00
eng31 ENG31-VS1>

10-71
This example shows the following statistics:

• Inode Hash Statistics shows the following Inode usage for the file system:
- The total number of hash buckets available for distributing the hashed
inodes
- The total number of inode entries that have been hashed
- The total number of containers that have received hashed inode
information
- The maximum depth of each of the hash containers
- The average depth of each of the hash containers
• UserBuf Block Hash Statistics shows the following user data buffer block usage
for the file system:
- The total number of hash buckets available for distributing hashed user
data buffer blocks
- The total number of user data buffer block entries that have been
hashed.
- The total number of containers that have received hashed user data
buffer block information
- The maximum depth of each of the hash container
• MetaBuf Block Hash Statistics shows the following metadata buffer block usage
for the file system:
- The total number of hash buckets available for distributing metadata
buffer blocks
- The total number of metadata buffer block entries that have been
hashed
- The total number of containers that have received hashed metadata
buffer block information

10-72

• Userbuf Page Hash Statistics shows the following user data page usage for the file
system:
data buffer pages
- The total number of user data buffer pages that have been hashed
- The total number of containers that have received hashed user buffer
page information
• MetaBuf Page Hash Statistics shows the following metadata page usage for the file
system:
- The total number of hash buckets available for distributing metadata
buffer page usage
- The total number of metadata buffer pages that have been hashed
buffer page information.
• Userbuf Inum Hash Statistics shows the following user data buffer inum usage for
the file system:
data buffer inums
- The total number of user data buffer inums that have been hashed
- The total number of containers that have received hashed user buffer
inum information
- The average depth of each of the hash containers.

10-73
• MetaBuf Inum Statistics shows the following metadata inum usage for the file
system:
- The total number of hash buckets available for distributing hashed
metadata buffer inums
- The total number of metadata buffer inums that have been hashed
buffer inum information
Related Commands
filesystem show stats cache Shows filesystem cache statistics.
filesystem show stats cache verboseShows verbose cache statistics.
vsvr set Sets the current virtual server for all future
commands.
Filesystem Show Stats Cache Verbose
Synopsis
filesystem show stats cache verbose [-n NODENAME | VOLNAME]
Description
The file system tracks verbose cache statistics for metadata. Verbose cache statistics
track the usage of the write-back cache and the write-back daemon as follows:
• The write-back cache is used whenever a user or metadata object is modified and
the cache is full, causing the user or metadata to be written to disk.
• The write-back daemon is triggered on regular intervals and when specific file
system events occur.

10-74
You can display these file system cache statistics by running the filesystem show
stats cache verbose command. By default, this command tracks statistics for each
NAS Gateway. Therefore, all statistics are displayed for all volumes on the current
NAS Gateway. You can specify a node name or a volume name to view the verbose
cache statistics for a specific NAS Gateway volume.
Options
Table 10-19 : Options for the filesystem show stats cache verbose command
Optio
Object Description
n
-n NODENAME An optional argument for displaying the verbose

cache statistics for a specific NAS Gateway in the
cluster.
VOLNAME An optional argument for displaying the verbose
cache statistics for a specific volume. Run the
filesystem show stats cache verbose
command with the VOLNAME option from the virtual
server context.
Note!
Because the filesystem show stats cache verbose command
with the -n NODENAME option runs from the NAS Gateway context and the
command with the VOLNAME option runs from the virtual server context, you
cannot combine both options in running the command.

10-75
Example
eng31 ENG31-VS1> filesystem show stats cache verbose
Type Max Used Dirty Hits Misses

1/00 COW LWM HWM
------------------------------------------------------------------
-----------------------------------------
inodeBuf 42930 65 0 24 66
2750 0 42930 107367
8knondir 14310 12 0 69 8
115 2 14310 35563
1knondir 182783 0 0 0 0
0 0 182783 224309
8kdir 2862 1 0 0 1
0 0 2862 8589
1kdir 208895 1 0 1 1
1000 0 208895 418752
user 185343 0 0 0 0
0 0 185343 322103
inodes 491517 17 0 74 14
189 491517 1836266
quotas 1073 0 0 0 0
0 0 1073 1073

------------------------------------------------------------------
-
read 0 6 81 1 17
write 0 7 9 1 12
<<display continues...>>

10-76
The file system statistics are displayed in three parts: two tables and a list. Table 10-20
shows the first table of the file system cache statistics.
Colum
Description
n
Type The type of file system metadata event that is tracked. Valid values are as
follows:
• 8kdir for the number of 8k file system blocks used for directory operations.
• 1kdir for the number of 1K file system blocks used in directory functions that
have been cached.
Max The current maximum size in units of the object cached, for example a 1k
or 8k block of data. The object tracked is listed in Type. This field is a
soft limit that interoperates with the LWM and HWM fields. When Max
reaches the LWM value, the cache can grow at internally computed
increments to the value listed in the HWM field.
Used The number cache uses for the object listed in Type.
Hits The number of cache uses for each type of object listed in the Type field.
found in the cache.

10-77
Colum
Description
n
LWM The low watermark (LWM) for the each object in the cache. This field
Table 10-21 : Columns in I/O Section of cache statistics display
Column Description
operation. The read and write operations tracked are for both user
operations. A write operation indicates that a modified entry in the
cache was written to disk, and a read operation indicates that an
entry was read in from disk.

10-78
Table 10-21 : Columns in I/O Section of cache statistics display (Continued)
Column Description
Current The total number of read or write operations that were in progress
Pending at the time the filesystem show stats cache verbose command
was run.
Log Total The total number of read or write operations for the transaction
journal.

10-79
Example
eng62 VS62L> filesystem show stats cache verbose
Ignore the VS context for global stats on local nas gateway
Type Max Used Dirty Hits Misses Hit % COW LWM HWM
------------------------------------------------------------------------------------------------
------
8knondir 5930 746 0 53420 9935 84.32 25 5930 17781
inodeBuf 17790 177 0 93573 2607 97.29 10 17790
53683
8kdir 1186 10 0 1358 59 95.84 14 1186 4294
1knondir 91391 13 0 417 13 96.98 0 91391 112154
1kdir 104447 10 0 219 48 82.02 2 104447 209375
totals 0 0 0 0 0 0.00 0 0 0
inodes 371367 217 0 1930 466 80.55 0 371367 918128
quotas 536 6 0 205 8 96.24 1 536 536
------------------------------------------------------------------
read 0 259 11897 490 355
write 0 258 4628 48 2850
Writeback buf for inode: superblock disk_writes: 154 trans_writes: 192
Writeback buf for inode: inode inode disk_writes: 1292 trans_writes: 1793
Writeback buf for inode: root inode disk_writes: 13 trans_writes: 171
Writeback buf for inode: ref count inode disk_writes: 3002 trans_writes: 8899
Writeback buf for inode: unused inode disk_writes: 13 trans_writes: 98
Writeback buf for inode: full block inode disk_writes: 7 trans_writes: 126
Writeback buf for inode: dir in inode disk_writes: 8 trans_writes: 230
Writeback buf for inode: quota inode disk_writes: 70 trans_writes: 221
Writeback buf for inode: trashcan inode disk_writes: 1 trans_writes: 3
Writeback buf for inode: snapshot dir inode disk_writes: 27 trans_writes: 207
Writeback buf for inode: system hidden disk_writes: 9 trans_writes: 67
Writeback buf for inode: cifs shares disk_writes: 16 trans_writes: 26
Writeback buf for inode: unused disk_writes: 13 trans_writes: 2760
wb wakeup counts:
eventType meta user
sync 65 0
inoSync 113 0
waiter 1139305 0
periodic 284877 284877
resched 1139337 0
quotaSync 7 0
Max per Loop 16 1
inode cleaner counts:
all 59
start 56
Max per Loop 5
eng62 VS62L>
Table 10-22 shows the write-back buffer action for inodes and explains what each

10-80
entry means.
Table 10-22 : Write-back Buffer for Inodes statistics
Write-back buf for Inode

Description
Field
bad inode disk_writes The number of bad inode disk write operations.
This statistic shows the number of times a bad
inode was written to disk.
trans_writes The number of bad inode transaction write
operations. This statistic shows the number of
transactions that modified an inode with the type
Bad.
inode inode disk_writes The number of inode disk write operations. This
statistic shows the number of times an inode with
the type Inode was written to disk.
trans_writes The number of inode transaction write operations.
This statistic shows the number of transactions that
modified an inode with the type Inode.
ref count inode disk_writes The number of reference count inode disk write
operations. This statistic shows the number of times
an inode with the type reference count was written
to disk.
trans_writes The number of reference count inode transaction
write operations. This statistic shows the number of
Ref Count.
snapshot dir inode The number of snapshot directory inode disk write
disk_writes operations. This statistics shows the number of
times an inode with the type snapshot directory was
written to disk.

10-81
Table 10-22 : Write-back Buffer for Inodes statistics (Continued)
Write-back buf for Inode

Description
Field
trans_writes The number of snapshot directory inode transaction

snapshot directory.
snapshot but inode The number of snapshot inode disk write
disk_writes operations. This statistics shows the number of
times an inode with the type snapshot was written
to disk.
trans_writes The number of snapshot directory inode transaction
snapshot.
The file system cache verbose statistics also display write-back wake up statistics in a
table. These statistics track specific events that activate the file system’s write-back
daemon, which in turn, triggers the write-back of user data or metadata from the write
back cache to disk. Table 10-23 shows the write-back wake up statistics. These
statistics are tracked for both user data buffers and metadata buffers.
Table 10-23 : Write-back Wake Up statistics
Field Description
eventtype The type of metadata and user data events that

trigger the write back daemon. When the listed
event type occurs, the modified objects in the write
back cache are written to disk.

10-82
Table 10-23 : Write-back Wake Up statistics (Continued)
Field Description
sync The number of metadata and user data

synchronization wake up events, such as a file
system unmount. When a sync event occurs, the
NAS Gateway performs a write operation to disk.
inosync The number of metadata and user data inode sync
wake up events. When this events occurs, the inode
cleaner is triggered in addition to a write back to
disk. Inode cleaner statistics are also tracked in the
file system verbose statistics display.
waiter The number of metadata and user data waiter wake
ups. This statistic indicates that one or more other
NAS Gateway processes are waiting for write back.
periodic The number of metadata and user data periodic
wake ups. This statistics indicates the number of
times the write back daemon was activated by the
expiration of a timer that periodically triggers the
write back daemon.
resched The number of metadata and user data reschedule
wake ups. This statistics indicates the number of
times that the write back daemon has rescheduled
itself for write back.
Max per loop The maximum number of metadata and user data
wake ups per loop. This statistic indicates the peak
usage of write back buffers or inodes cleaned in
each loop.
The file system cache verbose statistics also show the Inode cleaner statistics. The
inode cleaner triggers the write back of inodes to disk. These statistics monitor the

10-83
• The number of times the inode cleaner has been triggered.

• The peak usage of the inode cleaner per loop.
Related Commands
filesystem show stats cache hash Shows statistics related to hash utilization of the
cache.
filesystem show stats cache verboseShows verbose cache statistics.
commands.
Filesystem Stats Performance
Synopsis
filesystem show stats performance [-n NODENAME | VOLNAME]
Description
The file system performance statistics show information about the runtime operation
of the file system based on specific file system request types. The performance
statistics also list average response or completion times for each file system request
type. Through the completion times you can assess file system performance by noting
how quickly requests are processed. Many of the file system requests tracked resemble
NFS v3 or CIFS file system requests.
You can view performance statistics by running the filesystem show stats
performance command. By default, this command tracks statistics for each NAS
Gateway, so all statistics are displayed for all volumes on the current NAS Gateway.
You can specify a node name or a volume name to view the performance statistics for
a specific volume.

10-84
Options
Table 10-24 : Option for the filesystem show stats performance command
Optio
Object Description
n

file system statistics for a specific NAS
Gateway in the cluster.
file system performance statistics for a
show stats performance
command with the VOLNAME option
from the virtual server context.
Note!
Because the filesystem show stats performance command with
the -n NODENAME option runs from the NAS Gateway context and the

10-85
Example
eng38 ENG38-VS1> filesystem show stats performance

ReqType count cpuUsec ioUsec lockUsec admUsec elapsed
------------------------------------------------------------------
null 0 0 0 0 0 0
getAttr 2 30 0 0 26 56
setAttr 1 8278 2956 0 50 11284
lookup 3 240 0 0 29 269
readLink 0 0 0 0 0 0
read 1 196 926 0 31 1153
write 1 786 2483 0 62 3331
create 0 0 0 0 0 0
mkdir 0 0 0 0 0 0
symLink 0 0 0 0 0 0
mknod 0 0 0 0 0 0
remove 0 0 0 0 0 0
rmdir 0 0 0 0 0 0
rename 1 710 2146 0 60 2916
hardLink 0 0 0 0 0 0
readDir 0 0 0 0 0 0
readDirPlus 0 0 0 0 0 0
stat 0 0 0 0 0 0
fsinfo 1 246 0 0 37 283
pathconf 0 0 0 0 0 0
commit 0 0 0 0 0 0
readDirEnh 0 0 0 0 0 0
bulkStat 0 0 0 0 0 0
readSync 0 0 0 0 0 0
readahead 0 0 0 0 0 0
null 0 0 0 0 0 0
Total ops: 10
Average response time: 1988 usecs
Average cpu usage: 1099 usecs
Cur/Max active requests: 0/1
Max contexts: 5
Total bytes Tx over hyper channel to TXRX: 0
Total bytes Rx over hyper channel from TXRX: 11857192
eng38 ENG38-VS1>

10-86
The file system performance statistics are displayed in two sections. The first section
is a table of the completion times for each file system request. Table 10-25 shows the
columns in this display and explains what each column shows.
Table 10-25 : Columns, File System Performance Statistics Display
Column Description
ReqType The type of file system request that is tracked. The file
system requests tracked through this field support NFS
v3 and CIFS.
count The number of each type of file system request that is
tracked.
cpuUsec The average response time, in microseconds, that a
CPU has dedicated to each type of file system request.
ioUsec The average time, in microseconds, that is spent
waiting on each file system request.
lockUsec The average response time, in microseconds, that is
spent waiting for shared or exclusive locks to be
applied.
admUsec The average response time, in microseconds, that the
CPU is waiting for administrative operations to
complete.
elapsed The average elapsed time, in microseconds, for each
file system request completed.
The second section of the file system performance statistics contains the following
totals for all file system requests served:
• Total Ops shows the number of file system operations.
• Cur/Max active requests shows the current and peak number of active file system
requests.
• Max Contexts shows the number of file system contexts being tracked.

10-87
• Total bytes Tx over hyper channel to TXRX shows the number of bytes that are
transmitted to the file system transmit/receive data mover through the hyper
channel subprotocol.
• Total bytes Rx over hyper channel from TXRX shows the number of bytes that are
received from the file system transmit/receive data mover through the hyper
Related Commands
filesystem show stats performance daemonShows file system performance statistics
related to background daemons running in the
EverON™ operating system.
filesystem show stats performance ioShows file system performance statistics
related to disk input/output.
commands.
Filesystem Show Stats Performance Daemon
Synopsis
filesystem show stats performance daemon [-n NODENAME | VOLNAME]
Description
The file system daemon statistics show performance statistics of the NAS Gateway’s
daemons. These statistics list average response or completion times for each file
system request type.
You can display the file system daemon performance statistics by running the
filesystem stats show performance daemon command. By default, this
command tracks statistics for each NAS Gateway, so all statistics are displayed for all
volumes on the current NAS Gateway. You can specify a volume name to view the
daemon performance statistics either for a specific NAS Gateway or for a specific
NAS Gateway volume.

10-88
Options
Table 10-26 : Option for the filesystem show stats performance daemon
command

file system daemon performance statistics
for a specific NAS Gateway in the cluster.
file system daemon performance statistics
for a specific volume. Run the
filesystem show stats
performance daemon command with
the VOLNAME option from the virtual
server context.
Note!
Because the filesystem show stats performance daemon
command with the -n NODENAME option runs from the NAS Gateway
context and the command with the VOLNAME option runs from the virtual
server context, you cannot combine both options in running the command.

10-89
Example
eng38 ENG38-VS1> filesystem show stats performance daemon

------------------------------------------------------------------
null 0 0 0 0 0 0
getAttr 4 99 3496 0 14 3611
setAttr 411365 194 34919 46 117 35280
lookup 10760054 168 0 17 27 213
access 0 0 0 0 0 0
read 29797 125 1507 0 101 1735
write 5492983 348 13330 1079 64 14826
create 699166 12438 35980 41 94 48558
mkdir 261204 1462 39289 40 123 40918
symLink 147631 614 37660 88 80 38447
mknod 0 0 0 0 0 0
remove 719837 1969 36399 104 103 38581
rmdir 124722 939 33958 90 92 35083
rename 93829 9954 38810 51 47 48866
hardLink 87463 1847 40067 67 110 42096
readDir 0 0 0 0 0 0
stat 952257 29 0 32 75 138
fsinfo 2 104 0 0 15 120
commit 46956 182 54889 0 92 55165
readDirEnh 459397 98 0 0 69 168
readSync 796890 140 0 0 52 194
Total ops: 21083557

Max contexts: 52
In this section of the file system daemon performance commands, the average
response times are listed per file system request, and at the bottom of this display, the

10-90
totals and average of the totals are displayed. Table 10-27 shows the contents of the
file system requests, and explains what each column tracks.
Table 10-27 : Columns in the File System Performance statistics display
Column Description
v3 and CIFS.
tracked.
cpuUsec The average response time in microseconds that a CPU
has dedicated to each type of file system request.
ioUsec The average time in microseconds that is spent waiting
on each file system request.
lockUsec The average response time in microseconds that is
spent waiting for shared or exclusive locks to be
applied.
admUsec The average response time in microseconds that the
CPU is waiting for administrative operations to
complete.
elapsed The average elapsed time in microseconds for each file
system request completed.
The bottom of this section of the file system performance statistics contains the
following totals for all file system requests served:
requests.

10-91
• Average response time shows the average amount of time in microseconds that file
system operations take to complete. This number is based on the number displayed
in the Total Ops field.
• Average CPU usage shows the average amount of time in microseconds that the
CPU takes to process each file system operation. This number is based on the
number displayed in the Total Ops field.
• Max Contexts shows the number of file system contexts that are tracked.

10-92
The following statistics are displayed in the second table of the file system daemon
performance statistics.
eng38 ENG38-VS1> filesystem show stats performance daemon
Thread Statistics (total times in usec since last reset)
ReqType cpuUsec ioUsec lockUsec admUsec tape
read
tape write elapsed
-------------------------------------------------------------------
------------------------------
invalid 0 0 0 0 0
0 0
wblog 0 0 0 0 0
0 0
wbmeta 0 0 0 0 0
0 0
wbuser 0 0 0 0 0
0 0
inoclnr 0 0 0 0 0
0 0
inogrow 0 0 0 0 0
0 0
inocnt 0 0 0 0 0
0 0
refcnt 0 0 0 0 0
0 0
snap 0 0 0 0 0
0 0
freezer 0 0 0 0 0
0 0
alloc 0 0 0 0 0
0 0
buddy 0 0 0 0 0
0 0
trash 0 0 0 0 0
0 0
dump 0 0 0 0 0
0 0
max daemon 0 0 0 0 0
0 0
(null) 0 0 0 0 0
0 0
invalid 0 0 0 0 0
0 0
buf 0 0 0 0 0
0 0
eng38 ENG38-VS1>

10-93
Table 10-28 shows the columns that are tracked in this section of the file system
daemon performance statistics and explains what statistics are tracked.
Table 10-28 : Columns in the File System Performance Statistics Display
Column Description
ReqType The type of file system request that is tracked.

cpuUsec The average response time in microseconds that a CPU
has dedicated to each type of file system request.
ioUsec The average time in microseconds that is spent waiting on
each file system request.
lockUsec The average response time in microseconds that is spent
waiting for shared or exclusive locks to be applied.
admUsec The average response time in microseconds that the CPU
is waiting for administrative operations to complete.
tape read The average amount of time in microseconds that the file
system spent reading from tape.
tape writes The average amount to of time in microseconds that the
file system spent writing to tape.
Related Commands
filesystem show stats performance Shows file system performance statistics.
filesystem show stats performance ioShows file system performance statistics
related to disk input/output.
commands.

10-94
Filesystem Show Stats Performance I/O
Synopsis
filesystem show stats performance io [-n NODENAME | VOLNAME]
Description
The file system I/O performance statistics track the operation and performance of
specific user data and metadata functions. The file system I/O performance statistics
include the standard file system performance statistics for reference, but the I/O
statistics elaborate on the statistics tracked in the ioUsec column. The statistics in this
column are provided as more detailed statistics and counters for each of the supported
file system request types. Many of the file system requests tracked resemble NFS v3 or
CIFS file system requests, just like the file system performance statistics.
You can view I/O performance statistics by running the filesystem show stats
performance io command. By default, this command tracks statistics for each NAS
Gateway, so all statistics are displayed for all volumes on the current NAS Gateway.
You can view the I/O performance statistics either for a specific NAS Gateway or for a
specific NAS Gateway volume.
Options
Table 10-29 : Option for the filesystem show stats performance io command

file system I/O performance statistics for
a specific NAS Gateway in the cluster.

10-95
Table 10-29 : Option for the filesystem show stats performance io command

file system I/O performance statistics for
a specific volume. Run the
filesystem show stats
performance io command with the
VOLNAME option from the virtual server
context.
Note!
Because the filesystem show stats performance io command
with the -n NODENAME option runs from the NAS Gateway context and the

10-96
Example
eng38 ENG38-VS1> filesystem show stats performance io

------------------------------------------------------------------
null 0 0 0 0 0 0
getAttr 4 99 3496 0 14 3611
setAttr 422219 194 35006 45 119 35368
lookup 10916930 169 0 16 27 214
read 31332 123 1433 0 104 1662
write 5651157 347 13284 1078 65 14779
create 714562 12593 36027 40 95 48760
mkdir 267320 1467 39363 39 126 40999
symLink 151301 615 37743 88 81 38530
mknod 0 0 0 0 0 0
remove 736942 2003 36459 103 105 38673
rmdir 128236 948 33988 88 93 35121
rename 96185 9998 38867 50 47 48966
hardLink 89674 1849 40133 65 112 42164
readDir 0 0 0 0 0 0
stat 977138 29 0 33 76 140
fsinfo 2 104 0 0 15 120
commit 47799 182 54977 0 93 55254
readDirEnh 473037 98 0 0 69 169
readSync 821126 141 0 0 53 195
null 0 0 0 0 0 0
Table 10-31 explains what type of information each column in the output displays.
Column Description
system requests tracked through this field support NFS v3
and CIFS.

10-97
Column Description

tracked.
cpuUsec The average response time in microseconds that a CPU has
dedicated to each type of file system request.
ioUsec The average tim, in microseconds that is spent waiting on
each file system request.
lockUsec The average response tim, in microsecond, that is spent
waiting for shared or exclusive locks to be applied.
admUsec The average response time in microseconds that the CPU is
waiting for administrative operations to complete.

10-98
The following statistics are the detailed statistics from the ioUsec column of the first
section of file system I/O.
ReqType count UserRead UserWrite commit MetaRead MetaWrite Log

--------------------------------------------------------------------------
null 0 0 0 0 0 0 0
getAttr 4 0 0 0 3496 0 0
setAttr 422219 0 0 0 0 0 35006
lookup 10916930 0 0 0 0 0 0
readLink 0 0 0 0 0 0 0
read 31332 1433 0 0 0 0 0
write 5651157 0 3292 0 0 0 9992
create 714562 0 0 0 0 0 36027
mkdir 267320 0 0 0 1 0 39362
symLink 151301 0 0 0 0 0 37743
mknod 0 0 0 0 0 0 0
remove 736942 0 0 0 0 0 36459
rmdir 128236 0 0 0 0 0 33988
rename 96185 0 0 0 0 0 38867
hardLink 89674 0 0 0 0 0 40133
readDir 0 0 0 0 0 0 0
readDirPlus 0 0 0 0 0 0 0
stat 977138 0 0 0 0 0 0
fsinfo 2 0 0 0 0 0 0
pathconf 0 0 0 0 0 0 0
commit 47799 0 0 15276 0 0 39701
readDirEnh 473037 0 0 0 0 0 0
bulkStat 0 0 0 0 0 0 0
readSync 821126 0 0 0 0 0 0
null 0 0 0 0 0 0 0
Total ops: 21524964

Max contexts: 52
eng38 ENG38-VS1>

10-99
Table 10-31 shows what each column in the ioUsec column of detailed file system
statistics display contains and explains what each field means.
Table 10-31 : Detailed file system I/O statistics
Column Description
v3 and CIFS.
Count The number of each type of file system request that is
tracked.
UserRead The time in microseconds that each request type has
spent waiting for user read I/O.
UserWrite The time in microseconds that each request type has
spent waiting for user write I/O.
commit The time in microseconds that each request type has
spent waiting for an NFS commit.
MetaRead The time in microseconds that each request type has
spent waiting for metadata read I/O.
MetaWrite The time in microseconds that each request type has
spent waiting for metadata write I/O.
Log The time in microseconds that each request type has
spent waiting for transaction log I/O.
The last section of the file system performance statistics i/o example contains the
following totals for all file system requests served:
requests.

10-100
• Cur/Max log transactions shows the current and peak number of transaction
journal transactions.
• Max Contexts shows the number of file system contexts that are tracked.
Related Commands
filesystem show stats performance Shows file system performance statistics.
filesystem show stats performance daemonShows file system performance statistics
related to background daemons running in the
EverON operating system.
commands.
Filesystem Show Stats Resource
Synopsis
filesystem show stats resource [-n NODENAME | VOLNAME]
Description
Prior to running a file system request, the NAS Gateway runs a resource checking
algorithm to determine whether enough resources exist to provide a reasonable
attempt at completing the request. If resources exist, the file system request completes.
If no resources exist, the file system request is blocked and queued, while the NAS
Gateway rechecks resource availability.

10-101
The file system resource statistics show file system resource usage and availability
prior to a file system request being completed. These conditions are displayed as
counters that describe the number of successful or blocked file system requests.
You can display the file system resource performance statistics by running the
filesystem show stats resource command. By default, this command tracks
statistics for each NAS Gateway, so all statistics are displayed for all volumes on the
current NAS Gateway. You can view the resource statistics either for a specific NAS
Gateway or for a specific NAS Gateway volume.
Options
Table 10-32 : Option for the filesystem show stats resource command

file system resource statistics for a
specific NAS Gateway in the cluster.
file system resource statistics for a
show stats resource command
with the VOLNAME option from the
virtual server context.
Note!
Because the filesystem show stats resource command with the -
n NODENAME option runs from the NAS Gateway context and the command

10-102
Example
eng46> filesystem show stats resource

Resource Count
--------------------------------------
No log resource 0
No user buffer resource 0
No meta 8knondir resource 0
No meta 1knondir resource 0
No meta 8kdir resource 0
No meta 1kdir resource 0
No inode cache resource 0
No memory resource 0
No sac buffer resource 0
No ultra buffer resource 0
No vol log buffer resource 0
No thread/esm/stack 0
No edesc/buf 0
Blocked for snapshot 0
Blocked in pause state 0
No IO resource 0
Total: 0
Log/Alloc Count
--------------------------------------
Forced write due to TO 0
Ongoing Trans not decr 0
Alloc in cont space 0
No emap found in alloc 0
Rnd alloc in cont space 0
Rnd alloc over compl disk 0
Total: 0
Other Count
--------------------------------------
Memory cleaner called 0
eng46>
This display contains two sections. The first section shows resource checking counters
for individual file system operations. The counters in this section do not indicate errors
and check for the following:
• No log resource shows the number of times that the transaction journal did not
have enough resources to complete a transaction.

10-103
• No user buffer resource shows the number of times that not enough buffers were
available for user data operations to complete.
• No meta 8knondir resource shows the number of times that not enough resources
were available for 8k nondirectory metadata operations to complete.
• No meta 1knondir resource shows the number of times that not enough resources
were available for 1k non-directory metadata operations to complete.
• No meta 8kdir resource shows the number of times that not enough resources were
available for 8k directory metadata operations to complete.
• No meta 1kdir resource shows the number of times that not enough resources were
available for 1k directory metadata operations to complete.
• No inode cache resource shows the number of times that not enough resources
were available in the inode cache.
• No memory resource shows the number of times that not enough memory was
available.
• No sac buffer cache shows the number of times that no storage access control
(SAC) buffers were available in the cache.
• No ultra buffer cache shows the number of times that no ultra buffers were
available in the cache.
• No vol log buffer resource shows the number of times that no log buffers were
available for a volume.
• No thread/esm/stack resource shows the number of times that no threads, state
machines, of thread stacks were available.
• No edesc/buf shows the number of times that no E descriptors or buffers were
available.
• Blocked for snapshot shows the number of times that file system operations were
temporarily suspended for the completion of a snapshot.
• Blocked in pause state shows the number of times that file system operations were
temporarily suspended because the resource was in pause state.
• No IO resource shows the number of times that no resources were available for
processing user or metadata I/O.

10-104
The second section contains metrics that track and quantify the occurrence of specific
events in the file system. The counters in this section do not indicate errors.
• Forced write due to TO shows the number of times file system information was
written to disk due to a time-out.
• Ongoing trans not decr shows the number of currently active transaction that have
not been decremented.
• Alloc in cont space shows the number of blocks that have been allocated in a
contiguous space.
• No emap found in alloc shows the number of times the file system has not found an
Emap entry in the resource allocation.
• Rnd allocat in cont space shows the number of blocks that have been randomly
allocated in a contiguous space.
• Rnd allocat over compl disk shows the number of number of blocks that have been
randomly allocated over a complete disk.
• Memory cleaner called shows the number of times the buffer cache was cleaned up
because the NAS Gateway encountered a low memory resource condition.
Related Commands
commands.

Chapter 11: ID Mapping Commands
This chapter documents the following ID mapping commands:
• “ID Map Delete” on page 11-2
• “ID Map Edit” on page 11-4
• “ID Map Insert” on page 11-7
• “ID Map Notify Change” on page 11-11
• “ID Map Show” on page 11-13

11-2
ID Map Delete
Synopsis
idmap delete {user | group} INDEX
Description
You can delete an ID mapping at any time. When you delete an ID mapping, the user
or group for which you created the mapping can no longer be translated between a
common Internet file services (CIFS) or network file services (NFS) domain.
Therefore, that user or group can log on to their native domain only. For example, a
native Windows user or group is no longer be able to log on to an UNIX domain, and a
native UNIX user or group is no longer be able to log on to a Windows domain.
Note!
The entries in the identity list are numbered sequentially, so when you delete an
index entry, the remaining entries renumber to move up or down in the identity
list to keep a contiguous range of numbers.
Options
Table 11-1 : Options for the idmap delete command
user|group Specifies whether a user or group is

mapped between CIFS/Windows and
UNIX/NFS.
INDEX A number that controls where in the
identity list the ID mapping is deleted.
Type a number that refers to the ID
map’s position in the list.

11-3
Example
In the following example, a user is added.
eng31 PUBSTEST> idmap delete user 1

eng31 PUBSTEST>
In this example, the ID Map at index 1 is deleted. After deleting this entry, the user is
longer mapped between the domains based on the conditions applied in ID Map 1.
However, if other mappings, such as one for a group that the user is a member of, or a
default mapping for the user name, still exists, the user is able to map between CIFS
and NFS by using those rules.
In the following example, a group is deleted.
eng31 PUBSTEST> idmap delete group 1

eng31 PUBSTEST>
In this example, the ID Map at index 1 is deleted. After deleting this entry, the group is
no longer mapped between the domains based on the conditions applied in ID Map 1.
However, if other mappings, such as the default mapping for the group name, still
exists, the group is able to map between CIFS and NFS by using those rules.
Related Commands
domain add nis Adds an NIS domain to the NAS Gateway.
domain add windows Adds an Windows domain to the NAS Gateway.
idmap insert user Inserts a user identity mapping between NIS or
LDAP and Windows identities.
idmap edit user Edits a user existing identity mapping between
NIS or LDAP and Windows entities.
idmap notify user Allows the administrator to notify that an
external configuration change may have an
impact on user identity mapping.

11-4
idmap show user Shows the user identity mapping lists.
ID Map Edit
Synopsis
idmap edit {user | group} INDEX
Description
The ONStor™ NAS Gateway supports identity mapping between UNIX and Windows
domains. With identity mapping, you can specify the following translations:
• How UNIX user and group IDs (UIDs and GIDs, respectively) are translated to
Windows users and groups
• How Windows users and groups are translated to UNIX UIDs and GIDs
You can edit an ID mapping by running the idmap edit command. Editing allows you
replace an ID mapping in the identity list. As part of this command, you need to
specify an index number, which is a numeric value, that indicates which entry in the
list is to be replaced.

11-5
Options
Table 11-2 : Options for the idmap edit command
user|group Specifies whether a user or group is mapped

between CIFS/Windows and UNIX/NFS.
INDEX A number that controls where in the identity list the
ID mapping is added. Type a number that refers to
the ID map’s position in the list.
Usage
When you run the idmap edit user or idmap edit group command, you are
prompted to type the user or group mapping, which takes the form:
Enter the user mapping: windowsDomain\name ==/<=/=> name@unixDomain
(*=wildcard, name empty=no mapping)
or
Enter the group mapping: windowsDomain\name ==/<=/=> name@unixDomain
Mapping information takes three building blocks: the Windows identity, the mapping
director, and the NFS identity. The building blocks consist of the following:
• The first building block is windowsDomain\name, where name is a Windows user
or group name that is mapped to a UNIX user or group. Separate the
windowsDomain and name components with a back slash (\). Both components
support an asterisk (*) to represent “any” or a blank space to represent no mapping.
For example:
spectrum\domain admins
spectrum\*, or spectrum\
• The second building block is the mapping director. The NAS Gateway supports
unidirectional or bidirectional translation:

11-6
- == indicates bidirectional translation between the Windows domain

and the UNIX domain.
- => indicates unidirectional translation from the Windows domain to
the UNIX domain.
- <= indicates unidirectional translation from the UNIX domain to the
Windows domain.
• The final building block is name@unixDomain where name is a UNIX user or
group name that is mapped to a Windows user or group. Separate the unixDomain
and name components with an at sign (@). Both components support an asterisk
(*) to represent “any” or a blank space to represent no mapping.
Example
In the following example a user is edited. This command takes two steps.
eng31 PUBSTEST> idmap edit user 1

>spectrum\paulw==pwilson@chromatis
eng31 PUBSTEST>
In this example, the user spectrum\paulw is mapped between Windows and UNIX
domains. When the mapping is complete, Windows user spectrum\paulw can access
files in the NFS/UNIX domain chromatis and the UNIX user pwilson@chromatis can
access CIFS/Windows files in the CIFS/Windows domain spectrum.
In the following example a group is edited. This command takes two steps.
eng31 PUBSTEST> idmap edit group 1

Enter the group mapping: windowsDomain\name ==/<=/=>
name@unixDomain
>spectrum\domain admins==domains@chromatis
eng31 PUBSTEST>
In this example, the index entry 1 is edited. In this entry, the group spectrum\domain
admins is mapped between Windows and UNIX domains. When the mapping is
complete, members of the windows group domain admins can access files in the NFS/

11-7
UNIX domain as domains@chromatis and users from the NFS/UNIX domain

domains@chromatis can access files in the CIFS/Windows domain as
spectrum\domain admins.
Related Commands
ID Map Insert
Synopsis
idmap insert {user | group} INDEX
Description
You can create and insert an ID mapping by running the idmap insert command.
This command inserts a mapping rule in the identity list, which lists all Windows users
and groups. The identity list contains two sections: one for users and one for groups.
As part of the idmap insert command, you need to specify an index number, which
is a numeric value that indicates where in the list the ID mapping is added.
Note!
By default, the NAS Gateway maps the user name between domains, so you
only need to add an ID map if the user name is different. For example, if the

11-8
Windows user paulw keeps the user name paulw in the UNIX/NFS domain,
there is no need to add an ID map.
Creating an ID map is a two step process that starts with specifying the ID type, either
user or group, and an index number. After entering this portion of the command, press
Enter and at the prompt type the name mapping as the second step.
Unidirectional Mapping Consideration

By default, if an entry is mapped only one way, the NAS Gateway discovers the source
ID of the one-way mapping and attempts to create a two-way mapping by using the
same user as specified in the one-way mapping. The following example creates a one-
way mapping:
spectrum\user7077=>user7077@onstorlab
In this example, spectrum\user7077 maps to user7077@onstorlab. Because there is no
rule to map user7077@onstorlab in the other direction, the NAS Gateway defaults to
user7077 in domain spectrum, which is spectrum\user7077. Therefore, this mapping
remains a two-way mapping even though it was not specified as such.
To configure a true one-way mapping, you need to have a rule that specifies “nobody”
or a user that is not specific.
Options
Table 11-3 : Options for the idmap insert command
user|group A choice list that specifies whether a user or group is

mapped between CIFS/Windows and UNIX/NFS.
INDEX A number that controls where in the identity list the
ID mapping is added. Type a number that refers to
the ID map’s position in the list.
Usage
When you run the idmap insert user or idmap insert group command, you are
prompted to type the user or group mapping, which takes the form:

11-9

or
Enter the group mapping: windowsDomain\name ==/<=/=> name@unixDomain
Mapping information takes three building blocks: the Windows identity, the mapping
director, and the NFS identity. The building blocks consist of the following:
• The first building block is windowsDomain\name, where name is a Windows user
or group name that is mapped to a UNIX user or group. Separate the
windowsDomain and name components with a back slash (\). Both components
support an asterisk (*) to represent “any” or a blank space to represent no mapping.
For example:
spectrum\domain admins
spectrum\*, or spectrum\
• The second building block is the mapping director. The NAS Gateway supports
unidirectional or bidirectional translation:
- == indicates bidirectional translation between the Windows domain
and the UNIX domain.
- => indicates unidirectional translation from the Windows domain to
the UNIX domain.
- <= indicates unidirectional translation from the UNIX domain to the
Windows domain.
• The third building block is name@unixDomain where name is a UNIX user or
group name that is mapped to a Windows user or group. Separate the unixDomain
and name components with an at sign (@). Both components support an asterisk
(*) to represent “any” or a blank space to represent no mapping.

11-10
Example
In the following example, a user is added. This command takes two steps.
eng31 PUBSTEST> idmap insert user 1

>spectrum\paulw==paulwilson@chromatis
eng31 PUBSTEST>
In this example, the group spectrum\paulw is mapped between Windows and UNIX
domains. When the mapping is complete, Windows user spectrum\paulw can access
files in the NFS/UNIX domain chromatis and the UNIX user paulwilson@chromatis
can access CIFS/Windows files in the CIFS/Windows domain spectrum.
In the following example, a group is added. This command takes two steps.
eng31 PUBSTEST> idmap insert group 1

Enter the group mapping: windowsDomain\name ==/<=/=>
name@unixDomain
>spectrum\domain admins==admins@chromatis
eng31 PUBSTEST>
In this example, the user spectrum\domain admins is mapped between Windows and
UNIX domains. When the mapping is complete, members of the windows group
domain admins can access files in the NFS/UNIX domain chromatis and users from
the NFS/UNIX domain chromatis can access files in the CIFS/Windows domain
spectrum.
Related Commands

11-11

ID Map Notify Change
Synopsis
idmap notify change {user | group}
Description
Because the NAS Gateway is a multiprotocol device, it can serve clients in both NFS
and CIFS environments. CIFS users are mapped to NFS users and NFS users are
mapped to CIFS users through ID mapping.
Certain conditions on the Windows or NIS or LDAP domain controllers can affect
how the NAS Gateway recognizes and maps NFS and CIFS users through the ID map.
For example, if a new NIS or LDAP user name is created, it might cause a new
mapping to match to a CIFS user that did not exist before. In this situation, the NAS
Gateway needs to update some system cache information and user and group
mappings in the security file. You can affect an explicit update by running the idmap
notify change command.
The idmap notify change command is helpful for situations where you know of
changes to the Windows or NIS or LDAP configuration. For example, assume you
need to change an NIS or LDAP map on your NIS or LDAP server. When you add an
entry for the user timg to your NIS or LDAP password map, you know it will have an
impact on the NAS Gateway’s identity mapping because timg has an account in a
Windows domain. In this situation, use the idmap notify change command so that
quotas are recomputed to properly account for the charge.
Use the idmap notify change command to alert the NAS Gateway to changes in the
ID map. With this command, the NAS Gateway can reconstruct the ID map with new

11-12
quota-related information. When the new ID map is constructed, internal caches and
the user and group records in the security file are refreshed. Therefore, the relevant
entries are updated to use the most recent version of the ID map, which ensures that
the user and group entries are kept current. The idmap notify change command
invokes a quota rebuild phase.
Options
user|group specifies whether to update the ID mappings of
either users or groups.
Example
eng31 PUBSTEST> idmap notify change user

eng31 PUBSTEST>
In this example, the ID maps for users are updated.
Related Commands

11-13
ID Map Show
Synopsis
idmap show {all | user | group} [-P PAGENUMBER [-S PAGESIZE]]
Description
When you configure ID mappings, the NAS Gateway adds the user and group
mappings to the identity list. You can display the identity list by running the idmap
show command.
The identity list contains separate sections for user and group mappings. As part of this
command, you can filter the output by specifying the type of ID mapping, either user
or group, that you want the NAS Gateway to display. You also can use the all
keyword to see both sections of the identity list.
The identity list contains information about the user or group names for CIFS and
NFS, the index number for each mapping, and the direction of name mapping.

11-14
Options
Table 11-4 : Option for the idmap show command
all|user|group A choice list for displaying the contents

of the identity list:
• all shows all entries in the identity list.
Users are displayed at the top of the
identity list, then groups are displayed.
• user shows only the user entries in the
identity list.
• group shows only the group entries in
the identity list.

Example
eng31 PUBSTEST> idmap show all

Type Index
--------------------------------------------
user 1 spectrum\paulw==paulwilson@chromatis
user 2 *\johndoe=>johndoe@bentoptics
user 3 spectrum\ <=guest@*
Type Index
--------------------------------------------
group 1 spectrum\domain admins==admins@chromatis
group 2 prism\*=>*@bentoptics
group 3 *\ <=*@effigy
eng31 PUBSTEST>
In this example, all ID maps are shown. The identity list contains the user or group, the
index number associated with the user or group, and the identity map semantic, which
includes the Windows domain and user, the translation director to indicate which way

11-15
the mapping works, and the UNIX user and domain. When the identity list is
displayed, the NAS Gateway shows the users section first, and the groups section last.

11-16

Chapter 12: Interface Commands
This chapter documents the following interface commands:
• “Interface Create” on page 12-2
• “Interface Delete” on page 12-5
• “Interface Modify” on page 12-6
• “Interface Show” on page 12-10

12-2
Interface Create
Synopsis
interface create INTERFACE -l LPORT [-s (enable | disable)]
[-t VLANTAG] [-a IPADDR/MASKLEN] [,IPADDR/MASKLEN] ...]
[-p [cifs=(enable | disable)], [nfs=(enable | disable)]]
[-w PRIMARYIPADDR [,SECONDARYIPADDR]]
Description
A virtual server uses interfaces to support file system services. Interfaces are created
by using logical ports. You can associate multiple interfaces within a virtual server
with the same logical port. When creating an interface, you can also configure WINS
server IP addresses and enable or disable CIFS and NFS protocols. You can also assign
a VLAN tag to the interface enabling the NAS Gateway to process 802.1q packets

12-3
Options.
Table 12-1 : Options for interface create command
INTERFACE Specifies the name of the

interface you are creating.
-l LPORT Specifies a logical port for the
new interface.
-s enable | disable Enables or disables the interface.
By default the interface is
enabled.
-t VLANTAG Specifies a VLAN tag enabling
the NAS Gateway to process
802.1q packets. The value for
VLAN tags can be any number
between 0 and 4095. A value of
0 indicates that VLAN tagging
is disabled for that interface.
You can assign one VLAN tag
per interface.
Note!
The VLANTAG option of this
command is only available if you
are running the command from the
virtual server context.
Note!
For the virtual server, the IP
address of each interface has to be
unique. The virtual server does not
support overlapping subnets across
VLANs.

12-4
Table 12-1 : Options for interface create command (Continued)
-a IPADDR/MASKLEN Specifies a valid IP network

[,IPADDR/MASKLEN] ...] address, the mask bits associated
with the IP address. Separate the
address and mask with a forward
slash (/), for example: 1.2.3.4/
31. You can specify up to 31
additional IP address/mask
length pairs separated by
commas.
-p [cifs=(enable | disable)] Enables or disables the CIFS
[nfs=(enable | disable)] protocol.
Enables or disables the NFS
protocol. By default both are
enabled.
-w PRIMARYIPADDR Specifies at least one WINS
[,SECONDARYIPADDR] server IP address. Entering a
second WINS server IP address
is optional.
Because the WINS server can
reside in a stand-alone server or
on the domain controller, specify
either the IP address of the
stand-alone WINS server, or the
IP address of the domain
controller, whichever is
pertinent to your network
configuration. Type the IP
notation.

12-5
Example
In the following example, the interface eth0 is created using the default lport fp.1.
cluster1-4> interface create eth0 -l fp.1 -a 33.33.0.1/24

cluster1-4>
In the following example, the interface eth1 is created using the user-defined lport
mylport. The VLAN tag is set to 120.
cluster1-4> interface create eth1 -l mylport -t 120

cluster1-4>
Related Commands
interface delete Deletes an IP address from a physical interface.
route add Adds a static route to any node within a cluster.
interface modify Modifies any of the interface’s parameters. Use
this command to add or delete IP addresses.
Interface Delete
Synopsis
interface delete INTERFACE
Description
Use the interface delete command to delete an interface. When you delete an
interface, ensure that no IP addresses are associated with it. Use the interface
modify command to remove IP addresses. See “Interface Modify” on page 12-6.
Options
The INTERFACE variable specifies the interface you are deleting.

12-6
Example
cluster1-4> interface delete eth1

cluster1-4>
Related Commands
interface create Assigns an IP address to a physical interface.
interface modify Modifies any of the interface’s parameters. Use
this command to add or delete IP addresses.
Interface Modify
Synopsis
interface modify INTERFACE -l LPORT [-s (enable | disable)]
[-t VLANTAG][-a IPADDR/MASKLEN] [,IPADDR/MASKLEN] ...]
[-d IPADDR [,IPADDR]...][-p [cifs=(enable | disable)], [nfs=(enable |
disable)]] [-w PRIMARYIPADDR [,SECONDARYIPADDR]]
Description
A virtual server uses interfaces to support file system services. Interfaces are created
by using logical ports. You can associate multiple interfaces within a virtual server
with the same logical port. When creating an interface, you can also configure WINS
server IP addresses and enable or disable CIFS and NFS protocols. You can also assign
a VLAN tag to the interface enabling the NAS Gateway to process 802.1q packets.
Use the interface modify command to modify the parameters of an existing
interface.

12-7
Options.
Table 12-2 : Options for interface modify command
INTERFACE Specifies the interface you are

modifying.
-l LPORT Specifies a logical port for
associated with the interface.
-s enable | disable Enables or disables the
interface. By default the
interface is enabled.
-t VLANTAG Specifies a VLAN tag
enabling the NAS Gateway to
process 802.1q packets. The
value for VLAN tags can be
any number between 0 and
4095. A value of 0 indicates
that VLAN tagging is disabled
for that interface. You can
assign one VLAN tag per
interface.
Note!
The VLANTAG option of this
command is only available if you
are running the command from
the virtual server context.
Note!
For the virtual server, the IP
address of each interface has to
be unique. The virtual server
does not support overlapping
subnets across VLANs.

12-8
Table 12-2 : Options for interface modify command (Continued)
-a IPADDR/MASKLEN [,IPADDR/ Specifies a valid IP network

MASKLEN] ...] address, the mask bits
associated with the IP address.
Separate the address and mask
with a forward slash (/), for
example: 1.2.3.4/31. You can
specify up to 31 additional IP
address/mask length pairs
separated by commas.
-d IPADDR [,IPADDR]...] Specifies a valid IP network
address.
-p [cifs=(enable | disable)] Enables or disables the CIFS
[nfs=(enable | disable)] protocol.
Enables or disables the NFS
protocol. By default both are
enabled.

12-9
Table 12-2 : Options for interface modify command (Continued)
-w PRIMARYIPADDR Specifies at least one WINS

[,SECONDARYIPADDR] server IP address. Entering a
second WINS server IP
address is optional.
Because the WINS server can
reside in a stand-alone server
or on the domain controller,
specify either the IP address of
the stand-alone WINS server,
or the IP address of the
domain controller, whichever
is pertinent to your network
configuration. Type the IP
notation.
Note!
On the SSC, interfaces are created by default (sc1 and sc2). Only the -s, -a, and
-d options are supported on the SSC, for example, interface modify sc1 -a
100.2.3.1/16 and interface modify sc2 -d 100.5.3.1/16.
Example
cluster1-4> interface modify fp.1 -s disable

cluster1-4>
In this example, the state of the interface fp.1 is modified from enabled to disabled.
cluster1-4> interface modify fp.1 -d 10.11.12.13

cluster1-4>

12-10
In this example, the IP address of the interface fp.1 deleted.
cluster1-4> interface modify eth1 -a 10.11.12.13/16

cluster1-4>
In this example, an IP address is added to the interface eth1.
Related Commands
interface create Creates an interface on a physical interface.
interface delete Deletes an interface from a physical interface.
Interface Show
Synopsis
interface show {interface | ip} [-a SPEC] [-n NODE] (NAS Gateway
context)
interface show {interface | ip} [-a SPEC] (virtual server context)
Description
Use the interface show command to display one of two tables on the NAS Gateway:
• The IP table, which contains all IP addresses assigned to interfaces.
• The interfaces table, which contains all interfaces.
With the interface show command, you can also view a specific entry in either of
the tables.
Note!
command, the display shows information for the SSC only. If you are in the
virtual server context, the display shows only the information for that specific
virtual server.

12-11
Options
Table 12-3 : Options for the interface show command
interface | ip Specifies which table the NAS

Gateway shows. Select ip to
display the IP table. Select
interface to display the
interfaces table.
-a SPEC An optional argument that
shows only one item from the
respective table:
• If you have selected ip, SPEC
needs to be an IP address.
• If you have selected interface,
SPEC needs to be a physical
interface.

specifies a particular node. Use
this option only in the NAS
Gateway context.
Example
The following example shows the interface table in NAS Gateway context.
eng6> interface show interface

Interface Table
------------------------------------------------------------
Interface Admin. Operation Mac Address LPORT
------------------------------------------------------------
sc1 UP UP 00:07:34:00:06:00
sc2 DOWN UP 00:07:34:00:06:01
eng6>

12-12
This table lists the SSC interfaces configured on the NAS Gateway. The interfaces
table contains the following information:
• Interface shows the name of the interface. Valid values are:
- sc1 is the SSC’s 10/100 management port connection, which is the left
port as you look at the SSC faceplate.
- sc2 is the SSC’s 10/100 management port connection 2, which is the
right port as you look at the SSC faceplate.
Note!
The sc1 and sc2 interfaces are created by default. Use the interface
modify command to modify these two interfaces.
• Admin shows the state as UP when the interface is enabled and DOWN when the
interface is disabled.
• Operation shows the link state.
• Mac Address column indicates the hardware address of the device.
• LPORT shows the name of the logical port used by the interface.
The following example shows the interface table in virtual server context.
eng57 VS1> interface show interface

Interface Table
-------------------------------------------------------------------
Interface Admin. Operation Mac Address LPORT Vlan
-------------------------------------------------------------------
fp1 UP UP 00:07:34:01:c5:10 fp1.0 0
eng57 VS1>
This table lists all interfaces configured on the specified virtual server. The interface
table consists of the following information:
• Interface shows the name of each interface. Valid values are:
• Admin shows the state as UP when the interface is enabled and DOWN when the
interface is disabled.
• Operation shows the link state.
• Mac Address column indicates the hardware address of the device.

12-13
• LPORT shows the name of the logical port used by the interface.
• Vlan show the VLAN tag. A value of 0 indicates that VLAN tagging is disabled.
The following example shows the IP table in NAS Gateway context.
eng6> interface show ip

IP Table
--------------------------------------------------------------
dest mask interface
--------------------------------------------------------------
10.2.17.1 255.255.0.0 sc1
eng6>
This table lists all IP interfaces configured on the NAS Gateway. The IP table consists
of the following information:
• dest column shows the IP addresses supported on the interface.
• mask column shows the subnet masking for the IP address on the interface.
• interface column shows the interface name. Valid values are:
- lo0, which is the system data bus.
- sc1 or sc2, or both, which indicates the SSC’s 10/100 management
interfaces.
Note!
You cannot modify the IP addresses of sc1 and sc2 once the NAS Gateway is
part of a cluster of two or more.
The following example shows the IP table in virtual server context.
eng57 VS1> interface show ip

IP Table
----------------------------------------------------------------
dest mask interface vlan
----------------------------------------------------------------
10.3.57.122 255.255.0.0 fp1 disabled (0)
eng57 VS1>
This table lists all IP interfaces configured on the virtual server. The IP table consists
of the following information:

12-14
• dest column shows the IP addresses supported on the interface.

• mask column shows the subnet masking for the IP address on the interface.
• interface column shows the name of the interface.
• Vlan show the VLAN tag. A value of 0 indicates that VLAN tagging is disabled.

Chapter 13: Localmap Commands
This chapter documents the following localmap commands:
• “Localmap Edit” on page 13-2
• “Localmap Import” on page 13-3

13-2
Localmap Edit
Synopsis
localmap edit (passwd|group|netgroup) [(-g|-s)]
Description
You can create and edit local NIS password and group files for multiprotocol access by
running the localmap edit command. This command starts a vi editor where you can
modify the password and group files. You need to be in the virtual server context to
run this command. You can use this command to do the following:
• Add user names and IDs, and group names and IDs to the password and group
files.
• Delete user names and IDs, and group names and IDs from the password and
group files.
Options
Table 13-1 : Option for localmap edit command
passwd|group|netgroup Specifies whether to edit a password,

group, or netgroup file.
-g|-s -g displays the password NIS map file
content from stdout.
-s Sets the password NIS mapfile
content from stdin. After entering the
map entries, the user should specify
‘exit’ as a delimiter in a newline and and
press the Return key again.

13-3
Example
eng57 VS1> localmap edit passwd

kevinc::5033:5000:::
johns::5125:5000:::
arunt::5061:5000:::
quota1::2000:2100:::
briansm::5095:5000:::
isabellec::5045:5000:::
neerajk::5062:5000:::
deanner::5106:5000:::
joev::5112:5000:::
dbexch::5105:5000:::
sandrineb::5048:5000:::
dariusd::5032:5000:::
quota2::2001:2100:::
qetest::2005:500:::
skipe::5056:5000:::
kirans::5136:5000:::
timg::5139:5000:::
tonyw::5039:5000:::
ericc::5040:5000:::
nitinj::5068:5000:::
ianb::5082:5000:::
gilbert::5005:5000:::
debbie::5107:5000:::
/tmp/TMPE18832: unmodified: line 1
Related Commands
localmap import Imports password and group files for
multiprotocol access from an FTP server.
Localmap Import
Synopsis
localmap import {passwd|group|netgroup} LOCATION

13-4
Description
You can import the password and group files for multiprotocol file access from an FTP
server by issuing the localmap import command. You need to be in the virtual server
context to run this command.
Options
Table 13-2 : Options for localmap edit command
passwd|group|netgroup Specifies the password, group, or

netgroup file to import.
LOCATION The FTP server location of the file to be
imported.

13-5
Example
In the following example, a password is imported.
eng46 VS1> localmap import passwd ftp://upgrade:password@10.2.0.2/

home/upgrade/onstorpasswdfile
hookup: 228: Onstor src ip = 0x104a7c0
Connected to 10.2.0.2.
220 stargate.onstor.lab FTP server (Version wu-2.6.1-16) ready.
331 Password required for upgrade.
230 User upgrade logged in.
200 Type set to I.
250 CWD command successful.
Retrieving home/upgrade/onstorpasswdfile
local: /tmp/TMPEq3046/onstorpasswdfile remote: onstorpasswdfile
500 'EPSV': command not understood.
227 Entering Passive Mode (10,2,0,2,169,57)
150 Opening BINARY mode data connection for onstorpasswdfile
(312613 bytes).
100% |**************************************************| 305 KB
00:00
226 Transfer complete.
312613 bytes received in 0.44 seconds (693.77 KB/s)
221-You have transferred 312613 bytes in 1 files.
221-Total traffic for this session was 313253 bytes in 1 transfers.
221 Thank you for using the FTP service on stargate.onstor.lab.
eng46 VS1>

13-6
In the following example, a netgroup is imported.
eng46 VS1> localmap import netgroup ftp://

upgrade:password@10.2.0.2/home/upgrade/nagendras/netgroup
200 Type set to I.
Retrieving home/upgrade/nagendras/netgroup
local: /tmp/TMPmZ3046/netgroup remote: netgroup
150 Opening BINARY mode data connection for netgroup (590 bytes).
100% |**************************************************| 590
00:00
590 bytes received in 0.00 seconds (14.43 MB/s)
eng46 VS1>

13-7
In the following example, a group is imported.
eng46 VS1> localmap import group ftp://upgrade:password@10.2.0.2/

home/upgrade/onstorgroupfile
200 Type set to I.
Retrieving home/upgrade/onstorgroupfile
local: /tmp/TMPvx3046/onstorgroupfile remote: onstorgroupfile
150 Opening BINARY mode data connection for onstorgroupfile (91455
bytes).
100% |**************************************************| 91455
00:00
91455 bytes received in 0.04 seconds (2.18 MB/s)
eng46 VS1>
Related Commands
localmap edit Edits password and group files for multiprotocol
access.

13-8

Chapter 14: Logical Ports
Commands
This chapter documents the following logical port commands:
• “Lport Create” on page 14-2
• “Lport Delete” on page 14-6
• “Lport Modify” on page 14-7
• “Lport Prefer” on page 14-11
• “Lport Show” on page 14-14

14-2
Lport Create
Synopsis
lport create LPORTNAME -m {single | failover | aggregation} -a
PORTS
-s {enable | disable}
Description
Logical port names are logical constructions that enable you to group links so that they
appear as one single entity.
You can create a logical port by running the lport create command. You can assign
one of three modes of operation to the port you create: single, failover, or aggregation.
The logical port’s behavior differs depending on which one of the following modes
you assign:
• Single mode, where a single active link of the logical port carries traffic. In this
mode no provisions for failover or load balancing exist.
• Failover mode, where only one active physical port of the logical port carries
traffic. The other physical link on the logical port is available to carry traffic but
only if the active link becomes unavailable. When the active link state changes to
DOWN, the live backup link can assume operation as the new active physical link,
and continue carrying traffic after a switch over. During switchover, packet
retransmission is governed by higher layers of the IP protocol suite such as
transport control protocol (TCP) or user datagram protocol (UDP).
Note!
For each logical port, configure a preferred link or port. After setting the
preferred port, the port becomes the active port for the logical port as long as
the preferred port is UP. You can set the preferred port by running the lport
prefer command.
• Aggregation mode, where all links in the logical port are considered active and
carry traffic simultaneously. In a link-aggregated configuration, the traffic is load
balanced across all physical links that are associated with the logical port. In link-
aggregated mode, the traffic has an inherent redundancy. For example, if three
links are configured in the same logical port, and one of the links is put into the

14-3
DOWN state, the traffic continues along the other two links in a load-balanced
manner.
The lport create command needs to have at least one link but cannot have more
than four links. When you create a logical port, you can also enable or disable it.
When creating a logical port, consider the following:
• A logical port, default or user defined, that has already been associated with an
interface cannot participate in a new logical port.
• The same logical port, default or user defined, cannot participate in multiple
logical ports. For example, you cannot configure default lport fp1.0 in both logical
port 1 and logical port 2.

14-4
Options
Table 14-1 : Options for the lport create command
LPORTNAME Specifies an alphanumeric identifier for

the logical port that you are adding. For
example, lp.0.
-m single | failover | A choice list indicating one of three
aggregation modes in which the logical port should
operate:
• Selecting single causes a single active
physical port of the logical port to carry
traffic. In this mode no provisions for
failover or load balancing exist.
• Selecting failover causes the link to
operate in failover mode. By default, the
ONStor™ NAS Gateway sets the first
link you configure to the preferred link.
However, you can change the preferred
link by running the lport prefer
command.
• Selecting aggregation causes the link to
operate in link aggregation mode.

14-5
Table 14-1 : Options for the lport create command (Continued)
-a PORTS Specifies the link addresses that are

created. When you specify the links, use
the standard port numbering format–for
example, fp.0. You can specify multiple
links with this argument by comma-
separating the links, for example,
fp.0,fp.1. You need to specify at least
one physical link for the -a PORTS
argument. The maximum number of
ports that you can specify depends on
the model of ONStor 2200 NAS
Gateway you have:
• A 2220 model has two Gigabit Ethernet
ports, so the maximum number of ports
you can specify is two.
• A 2240, 2260, or 2280 model has four
Gigabit Ethernet ports, so the maximum
number of ports that you can specify is
four.
-s {enable | disable} Enables or disables the logical port at

creation.
Example
In the following example, a logical port in single mode is created.
cluster1-4> lport create lp.0 -m single -a fp.0 -s enable

cluster1-4>
In this example, the logical port lp1.0 is created, enabled, and configured to operate in
single mode with fp1.0. No provision for failover or load balance exists in this
configuration.

14-6
In the following example, a logical port in failover mode is created.
cluster1-4> lport create lp.0 -m failover -a fp.0,fp.1 -s enable

cluster1-4>
failover mode with fp1.0 and fp1.1. These two ports can act as redundant switch over
links for traffic processed on the ports.
In the following example, a logical port in aggregation mode is created.
cluster1-4> lport create lp.0 -m aggregation -a fp.0,fp.1 -s enable

cluster1-4>
aggregation mode with fp1.0 and fp1.1. All ports on the NAS Gateway process and
load balance the traffic equally.
Related Commands
lport delete Remove a logical port.
lport modify Modify a logical port.
lport prefer Set a preference port for a logical port.
lport show Show logical port configuration.
Lport Delete
Synopsis
lport delete LPORTNAME
Description
The NAS Gateway supports removing physical links from a logical port. You can
delete backup links one at a time, but you cannot delete the active link because such a
deletion would disrupt traffic on the port. You can delete physical links from the

14-7
logical port by running the lport delete command. This command is helpful for
moving physical links from one logical port to another because you need to delete the
association of a link to a logical port before assigning the link to a new logical port.
Note!
To completely delete the entire logical port, you can run the lport delete
command.
Options
The LPORTNAME variable specifies an alphanumeric identifier for
the logical port that you are adding, for example, lp.0, lp.1, lp.2,
or lp.3.
Example
cluster1-4> lport delete lp.0

cluster1-4>
The lport delete command deletes the logical port lp.0. When the physical ports
associated with the logical port are removed from the logical port, you need to
configure them with their own IP interface to support routes and traffic.
Lport Modify
Synopsis
lport modify LPORTNAME -m [single | failover | aggregation] -a
[PORTS]
-s [enable | disable]
Description
You can modify a logical port by running the lport modify command. The link can
be one of three modes of operation: single, failover, or aggregation. The logical port’s
behavior differs depending on which one of the following the modes you assign:

14-8
• Single mode, where a single active physical port of the logical port carries traffic.
In this mode no provisions for failover or load balancing exist.
• Failover mode, where only one active physical port of the logical port carries
traffic. Other physical links on the logical port are available to carry traffic but
only if the active link becomes unavailable. When the active link state changes to
DOWN, the live backup link can assume operation as the new active physical link,
and continue carrying traffic after a switchover. During switchover, packet
retransmission is governed by higher layers of the IP protocol suite such as TCP or
UDP.
Note!
For each logical port, configure a preferred port. After setting the preferred
port, the port becomes the active port for the logical port as long as the
preferred port is UP. You can set the preferred port by running the lport prefer
command.
• Aggregation mode, where all physical links in the logical port are considered
active and carry traffic simultaneously. In a link-aggregated configuration, the
traffic is load balanced across all physical links that are associated with the logical
port. In link aggregated mode, the traffic has an inherent redundancy. For example,
if three links are configured in the same logical port, and one of the links is put into
the DOWN state, the traffic continues along the other two links in a load-balanced
manner.
Note!
If a physical port is deleted from the logical port, a new single logical port is
created with the deleted physical port.
You can also enable or disable the logical port.

14-9
Options
Table 14-2 : Options for the lport modify command
LPORTNAME An alphanumeric identifier for the

logical port that you are modifying. For
example, lp.0, lp.1, lp.2, or lp.3.
-m single | failover | A choice list indicating one of three
aggregation modes in which the logical port should
operate.
• Selecting single causes a single active
physical port of the logical port to carry
traffic. In this mode no provisions for
failover or load balancing exist.
• Selecting failover causes the link to
operate in failover mode. By default, the
NAS Gateway sets the first link you
configure to the preferred link. However,
you can change the preferred link by
running the lport prefer command.
• Selecting aggregation causes the link to
operate in link aggregation mode.

14-10
Table 14-2 : Options for the lport modify command (Continued)
-a PORTS Specifies the ports assigned to the

logical port you are modifying. Use the
standard port numbering format–for
example, fp.0. You can specify multiple
links with this argument by separating
links with a comma (,) – for example,
fp.0, or fp.1. The -a PORTS argument
needs to have at least one physical link
specified. The maximum number of
ports that you can specify depends on
the model of ONStor 2200 NAS
Gateway you have:
• A 2240, 2260, or 2280 has four Gigabit
Ethernet ports, so the maximum number
of ports that you can specify is four.
-s [enable | disable] Enables or disables the logical port.
Example
In the following example, a logical port in single mode is modified.
cluster1-4> lport modify lp.0 -m single -a fp.0

cluster1-4>
In this example, the logical port lp1.0 is modified and configured to operate in single
mode with fp1.0. No provision for failover or load balance exists in this configuration.

14-11
In the following example, a logical port in failover mode is modified.
cluster1-4> lport modify lp.0 -m failover -a fp.0,fp.1

cluster1-4>
In this example, the logical port lp1.0 is modified and configured to operate in failover
mode with fp1.0 and fp1.1. These two ports can act as redundant switch over links for
traffic processed on the ports.
In the following example, a logical port in aggregation mode is modified.
cluster1-4> lport modify lp.0 -m aggregation -a fp.0,fp.1,fp.2,fp.3

cluster1-4>
In this example, the logical port lp1.0 is modified and configured to operate in
aggregation mode with fp1.0, fp1.1, fp1.2, and fp1.3 All ports on the NAS Gateway
would process and load balance the traffic equally.
In the following example, a logical port is disabled.
cluster1-4> lport modify lp.0 -s disabled.

cluster1-4>
Related Commands
Lport Prefer
Synopsis
lport prefer LPORTNAME -a PORTS

14-12
Description
The NAS Gateway supports a preferred link in situations where multiple links exist on
the logical port. When two or more ports exist on the logical port, the preference value
you assign determines which one is the active link that carries traffic. You can set the
preferred link by running the lport prefer command.

14-13
Options
Table 14-3 : Options for the lport prefer command

logical port that you are adding, for
-a PORTS The port address of the link that you are
setting as the preferred link. When you
specify links, use the standard interface
numbering format, for example, fp.0.
You can specify multiple links with this
argument. If you do, use commas to
separate the links, for example, fp.0,fp.1.
You need to specify at least one physical
link for this argument The maximum
number of ports you can specify depends
on the model of ONStor 2200 NAS
Gateway you have:
• A 2240, 2260, or 2280 has four Gigabit
Ethernet ports, so the maximum number
of ports you can specify is four.
Example
cluster1-4> lport prefer lp.0 -a fp.1

cluster1-4>
In this example, the logical port lp1.0 has been created already with fp1.0 and fp1.1.
By default, the first port added to the logical port, is the preferred port. However,
because the lport prefer command is run, the specified port becomes the preferred

14-14
link. In this example, the port fp1.1 is configured as the preferred port for the logical
port pubstest. As the preferred link, port fp1.1 is the active link.
Related Commands
Lport Show
Synopsis
lport show [LPORTNAME] [-n NODE]
Description
The NAS Gateway keeps a list of all the logical ports and their associated physical
links in the logical ports table. The logical ports table contains each logical port and
provides information about how the logical port is configured and operating. You can
display the logical ports table by running the lport show command. Use this
command to display all logical ports or one specific logical port.

14-15
Options
Table 14-4 : Options for the lport show command

logical port that you are displaying, for
-n NODE An optional argument that specifies the
name of a NAS Gateway. If you do not
specify a node, the command runs on the
current NAS Gateway.
Example
eng11> lport show

Logical Port Table
------------------------------------------------------------------
--------
Name Admin Operation Mode IPCnt PrefPort ActPort
Ports
------------------------------------------------------------------
--------
fp.0 UP UP single 1 N/A fp.0 fp.0
lport1 UP DOWN failover 0 fp.1 fp.1
fp.1 fp.3
fp.2 UP DOWN single 0 N/A fp.2 fp.2
eng11>
In this example, the logical ports table shows all logical ports with the following
information:
• Name indicates the name of the logical port.
• Admin shows the logical port’s state that was explicitly set through the -s
enable|disable argument of the lport create or lport modify command.
• Operation shows the state that the port actually is in.

14-16
• Mode indicates the operational mode that is configured for the logical port. Valid
values are single, aggregation or failover.
• IPCnt indicates the number of IP interfaces that are assigned to the logical port.
This field contains a numeric value that is at least one, and at most one less than
the total amount of ports configured in the logical port. There is no minimum and
maximum number for IPCnt.
• PrefPort indicates the port that has been assigned as the preferred port. The
preferred port is considered the active port, and the preferred port is the first port
configured in the logical port unless you have assigned a different preferred port
by running the lport prefer command.
• ActPort shows the names of the ports in the logical port that are actively
supporting traffic.
• Ports indicates the number of ports configured in the logical port. This field needs
to contain at least one port, but cannot contain more than four ports.
Related Commands
lport create Create a logical port.

Chapter 15: LUN Commands
This chapter documents the following LUN commands:
• “LUN Label” on page 15-2
• “LUN Rescan” on page 15-4
• “LUN Show” on page 15-5
• “LUN Show All” on page 15-8
• “LUN Show Device” on page 15-11
• “LUN Show Disk” on page 15-14
• “LUN Show Port” on page 15-18
• “LUN Show Tape” on page 15-21
• “LUN Topology” on page 15-23
• “LUN Unlabel” on page 15-24

15-2
LUN Label
Synopsis
lun label DEVICENAME [-f] [-r RAIDLEVEL] [-c CLUSTERNAME]
Description
The ONStor™ NAS Gateway sees LUNs in the following ways:
• Logical volume LUNs that have been assigned to logical volume space of a file
system.
• Free LUNs that are available, but have not been used for logical volume space.
• Foreign LUNs that are not available to the NAS Gateway.
• Out-of-cluster LUNS that have been labeled by another NAS Gateway on the same
SAN.
Initially when the system discovers a LUN, the NAS Gateway reads the label on the
LUN. If the LUN does not own an ONStor label, the LUN is marked as a foreign
LUN. If the LUN owns an ONStor label, but the label belongs to a different NAS
Gateway, the LUN is marked as an out-of-cluster LUN.
Use the lun label command to manually apply an ONStor label to a LUN that is
either a foreign or out-of-cluster LUN. After the LUN has been labeled, the NAS
Gateway views it as a free LUN, thus, the LUN can be claimed for use in a volume or
for automatic growth of the file system.
Note!
• This command is valid only for devices marked FREE, FOREIGN, and
OUTCLUSTER.
• You can remove a LUN label, by running the lun unlabel command.
Warning!
Before labeling a LUN that shows as outCluster, make sure that
the LUN does not belong to a volume on the other cluster. Use the
lun show disk command output to verify this after running the
lun rescan command.

15-3
Options
Table 15-1 : Options for the lun label command
-f This option skips the sanity check for a device

before writing the label.
The -f option is required when labeling a LUN
that is part of a volume.
Note!
Use this option with caution, because if not
checked, the device might be part of a volume
owned by another NAS Gateway or cluster. If you
write a label to a device that is part of another NAS
Gateway or cluster, the data and the volume is lost.
This option does not guarantee the device state
consistency among other NAS Gateways and
clusters.
DEVICENAME The device name and of the particular LUN

that you want to label. You can view the device
name by first running the lun show all
command.
-r RAIDLEVEL Assigns a RAID level to the device.
You can view the RAID levels assigned by
running the lun show all command. If the
RAID level shows None, no RAID level is a
assigned to the device, and you need to assign
one by using this option. Valid RAID levels are
RAID-0, RAID-01, RAID-1, RAID-3, RAID-
5, and Plain.
-c CLUSTERNAME An optional argument that specifies the name
of a cluster in which to label individual LUNs
or all LUNs.

15-4
Example
cluster1-4> lun label MYLEX_20000080e5125e6e_31 -r Raid-0 -c eng38

Are you sure? [Y/N]: y
cluster1-4>
In this example, the NAS Gateway is labeling the MYLEX_20000080e5125e6e_31

LUN with a RAID level of Raid-0 and a cluster name of eng38. The NAS Gateway
prompts you for confirmation before actually performing the labeling transaction.
Type Y to accept and perform the LUN labeling. Type N to cancel the LUN labeling.
LUN Rescan
Synopsis
lun rescan {all | DEVICE_NAME} [NODE]
Description
The lun rescan command rescans the list of devices and controllers that are
accessible to the NAS Gateway. This command can be run from every gateway.
Note!
You need to run this command before importing a volume.

15-5
Options
Table 15-2 : Options for the lun rescan command
all Specifies the list of all devices

accessible by the NAS Gateway.
DEVICE_NAME Specifies the device name for the rescan.
NODE Specifies the node name to rescan the
devices in a particular node.
Example
In the following example, all devices accessible to NAS Gateway eng 46 are
rescanned.
eng46> lun rescan all eng46

/
eng46>
Related Commands
lun show Lists all devices and controllers in the cluster.
LUN Show
Synopsis
lun show
Description
After the Fibre Channel (FC) discovery phase, the NAS Gateway has a view of the
entire storage network. From this perspective, the NAS Gateway creates the storage
availability report, which is a listing of all the devices that have registered in the FC
topology. The storage availability report organizes all devices by controller, device

15-6
type, and RAID level. The report shows size and the following usage information for
LUNs:
• Size, in megabytes, of used LUN space in each device.
• Size, in megabytes, of free LUN space in each device.
• Size, in megabytes, of the out-of-cluster LUN in each device.
• Size, in megabytes, of the foreign LUN space in each device.
You can display the storage availability report by running the lun show command.
The output of this command can span multiple pages. To navigate the LUN display,
you can use the following standard UNIX conventions:
• Press Enter to page forward through the display one page at a time, or you can hold
down the Enter key to rapidly page to the end of the display.
• Press q to cancel the display.
Note!
Zoning is a common practice in storage area networks (SANs). The NAS
Gateway cannot discover or display devices that have been zoned away from it.

15-7
Example
eng11> lun show
Storage availability report.

============================
Controller Type Raid Used (MB)

Free
(MB) Out Cluster (MB) Foreign (MB)
-------------------------------------------------------------------
-------------
-------------------------------------------
IBM_KPZ0M982 Disk None 0.00
0.00
0.00 17501.69
IBM_KPZ0N306 Disk Raid-0 0.00
0.00
17501.69 0.00
IBM_5EG7P173 Disk Raid-0 0.00
0.00
16383.94 0.00
IBM_5EG7P737 Disk Raid-0 0.00
0.00
16383.94 0.00
IBM_5EG7Q222 Disk Raid-0 0.00
0.00
16383.94 0.00
IBM_5EG7Q244 Disk Raid-0 0.00
0.00
16383.94 0.00
IBM_KPZ0P932 Disk Raid-0 0.00
0.00
17501.69 0.00
QUANTUM_PMB47P2770 Tape - -
-
- -
cluster1-4>
This example shows the storage availability report with the following information:
• Controller indicates the name of the storage device, for example the RAID
controller, that is governing the individual LUN.
• Type shows the physical device to which the LUN is assigned. Typical values are:
- Tape, for tape drive or library.

15-8
- Disk, for LUNs that are configured on a disk device, such as a JBOD or
a RAID.
- Stacker, for a tape library’s head or robot arm.
• Raid indicates the level of RAID that a particular LUN is configured to support.
• Used(MB) shows the amount of used LUN space on the listed device.
• Free (MB) shows the amount of free LUN space on the listed device.
• Out Cluster (MB) shows the amount of LUN space that is assigned to a different
cluster on the listed device.
• Foreign (MB) shows the amount of LUN space that is assigned to an unknown
device.
LUN Show All
Synopsis
lun show all [-n NODE][-P PAGENUMBER [-S PAGESIZE]]
Description
The NAS Gateway sees LUNs as being in one of the following states:
• Used, assigned to a NAS Gateway
• Free, unassigned and available for use
• Foreign LUNs, discovered but not available to the NAS Gateway.
• Out of Cluster state
When LUNs are displayed, the NAS Gateway shows the LUNs regardless of whether
they are assigned to single tape or disk, a tape controller, or a RAID.
The lun show all command displays all LUNs that the NAS Gateway has
discovered. The display shows LUNs and their configuration parameters.

15-9
Note!
The lun show all command can span multiple pages. To navigate the LUN
display, press Enter to page forward through the display. To stop viewing the
display, press Q then Enter.
Options
Table 15-3 : Options for the lun show all command
-all An optional argument for displaying all

LUNS that the NAS Gateway has
discovered.
-n NODE An optional argument for displaying the
LUN list available on the specified node.

15-10
Example
eng46> lun show all
All devices known to PCC.

=========================
Device Name Model

Raid Size (MB) State Cluster Volume
-------------------------------------------------------------------
-------
3PARdata_0255_000410255
Disk Raid-0 10239.94 free eng46
3PARdata_0255_0003E0255 Disk
Raid-0 10239.94 used eng46 techpubsvol
IBM_0000013021452000_1
Stacker - - - -
NEXSAN_500040200eec040f_64D73FCC
Disk Raid-5 23841.75 outCluster eng49 vol7fromeng53
NEXSAN_500040200eec040f_64D73F3B
Disk Raid-5 23841.75 outCluster eng49 Vol2
NEXSAN_500040200eec040f_64D73F9F
Disk Raid-5 23841.75 outCluster eng49 Vol2
NEXSAN_500040200eec040f_64D73C54
Disk Raid-5 23841.75 outCluster eng49 eng49-1
NEXSAN_500040200eec040f_652D6923
Disk Raid-5 28610.12 outCluster eng49 eng53vs1
NEXSAN_500040200eec040f_652D6903
Disk Raid-5 28610.12 outCluster eng15 vol_core_38
neg46>
This example shows the LUN list with the following information:
• Device Name indicates the name of the storage device, for example the RAID
• Model shows the physical device to which the LUN is assigned. Typical values are
as follows:
- Tape, for all LUNs that are configured on a tape device, such as a tape
drive or a tape library.
a RAID.

15-11
• Size indicates the maximum amount of storage space in megabytes for which the
LUN has been configured. This field shows only the configured maximum storage
space on the LUN; this field does not show the amount used or the amount that
remains free.
• State shows the availability of the LUN. The LUN can be in any one of the
following states:
- Used
- Free
- OutCluster
- Foreign
• Cluster shows whether the LUN has been assigned to a cluster. The values appear
as follows:
- n/a indicates that the LUN is not part of a cluster.
- Any value that is not n/a indicates the name of the cluster to which the
LUN belongs.
• Volume shows the name of the volume to which the LUN has been assigned.
LUN Show Device
Synopsis
lun show device DEVICENAME [-n NODE]
Description
Use the lun show device command to display detailed information about a particular
LUN. The NAS Gateway sees LUNs as being in one of the following states:
• Foreign, discovered but not available to the NAS Gateway

15-12
• Out of cluster
After the FC discovery phase, the NAS Gateway has a view of the entire storage
network topology. This view includes LUNs that are owned by different devices, for
example, LUNs owned by disk and tape devices.
Options
Table 15-4 : Options for the lun show device command
DEVICENAME An alphanumeric character string that

specifies the LUN for which you want to
display detailed information.
node name by which to filter the output.
Only the devices that are accessible on
that node are displayed. The default
value is local.

15-13
Example
cluster1-4> lun show device HITACHI_60432_24
Device detail from PCC.

=======================
Name : HITACHI_60432_24
Model : HDS9910
Type : Disk
Size (MB) : 2346.94
Raid Level : Raid-5
State : Foreign
Nodes : cluster1-4 cluster2-4
Active path :
Path list : Port WWN LUN
sp.1 0x500060e802ec1012 64
sp.0 0x500060e802ec1011 64
cluster1-4>
• Name indicates the name of the individual LUN.
• Model indicates the model number of the device on which the LUN is configured.
• Type indicates the type of physical device, disk or tape, on which the LUN has
been configured.
• Size (MB) indicates the maximum amount of storage space in megabytes for which
the LUN has been configured.This field shows only the configured maximum
storage space on the LUN; not the amount used or the amount that remains free.
• Raid Level indicates the level of RAID that a particular LUN is configured to
support.
following four states:
- Used
- Free
- OutCluster

15-14
- Foreign
• Nodes shows which nodes in the cluster can access the LUN.
• Active Path indicates what path is currently being used to support access to the
LUN.
• Path List shows the connectivity to the LUN. This field shows the following:
- The NAS Gateway port on which you can access the LUN.
- The world wide name (WWN) of the controller governing the LUN.
- The LUN ID number for the particular LUN.
LUN Show Disk
Synopsis
lun show disk [-c CONTROLLER] [-r RAID_LEVEL] [-t STATE] [-n NODE][-P
PAGENUMBER [-S PAGESIZE]]
Description
The NAS Gateway sees LUNs as being in one of four states:
• Out of cluster
example, the LUNs owned by disk and tape devices. You can view all LUNs that have
been configured on disk devices by running the lun show disk command.

15-15
Options
Table 15-5 : Options for the lun show disk command
-c CONTROLLER An optional argument for filtering the

LUN list by controller ID.
-r RAIDLEVEL An optional argument for filtering the
LUN list by RAID level. Possible RAID
values are RAID-0, RAID-1, RAID-3,
RAID-5, Plain, or Any.
-t STATE An optional argument for filtering the
LUN list by the state of the devices.
Possible values are: all, used, free,
foreign, and outCluster.
-n NODE An optional argument for filtering the
LUN list by node name. Only devices
that are accessible on the specified node
are displayed. The Default is local.

15-16
Example
In the following example, all disk LUNs are displayed.
eng46> lun show disk
Disk devices known to PCC.

==========================
Device Name
Model Raid Size (MB) State Cluster Volume
-------------------------------------------------------------------
-------------------------------------------------------------------
--------------
3PARdata_0255_000410255
INSERV Raid-0 10239.94 free eng46
3PARdata_0255_0003E0255
INSERV Raid-0 10239.94 used eng46
techpubsvol
NEXSAN_500040200eec040f_64D73FCC
SATABlade Raid-5 23841.75 outCluster eng49
vol7fromeng53
NEXSAN_500040200eec040f_64D73F3B
SATABlade Raid-5 23841.75 outCluster eng49 Vol2
NEXSAN_500040200eec040f_64D73F9F
SATABlade Raid-5 23841.75 outCluster eng49 Vol2
NEXSAN_500040200eec040f_64D73C54
SATABlade Raid-5 23841.75 outCluster eng49 eng49-
1
NEXSAN_500040200eec040f_652D6923
SATABlade Raid-5 28610.12 outCluster eng49
eng53vs1
NEXSAN_500040200eec040f_652D6903
SATABlade Raid-5 28610.12
eng46>
• Model shows the model number of the disk that is supporting LUNs.

15-17
• Size indicates the maximum amount of storage space, in megabytes, for which the
LUN has been configured.This field shows only the configured maximum storage
space on the LUN; not the amount used or the amount that remains free.
following states:
- Used
- Free
- Foreign
• OutCluster shows whether the LUN has been assigned to a cluster. Values are as
follows:
LUN belongs.
• Volume shows the name of the volume to which the LUN is assigned.
In the following example, the disk LUNs for a specific controller are displayed.
cluster1-4> lun show disk -c IBM_KPZ0N698_0
Disk devices known to PCC.

==========================
Device Name
Model
Raid Size (MB) State Cluster
-------------------------------------------------------------------
-------------
-------------------------------------------------------
IBM_KPZ0N698_0
IC35L018
F2D210-0 Raid-0 17501.69 free Andrew'sCluster
Done.
cluster1-4>
In this example, the controller ID is specified as part of the command, so the LUNs
associated with only that controller are displayed. The display contains the same fields
that are documented in the previous example.

15-18
LUN Show Port
Synopsis
lun show port PORT [-n NODE][-P PAGENUMBER [-S PAGESIZE]]
Description
The NAS Gateway sees LUNs as being in one of four states:
• Out of cluster
network topology. As part of LUN discovery, the NAS Gateway notes which storage
port a LUN is accessible through. You can view LUNs on each storage port, by
running the lun show port command.

15-19
Options
Table 15-6 : Options for the lun show port command
PORT An alphanumeric character string that

indicates the storage port on which you
are displaying the configured LUNs, for
example, sp.0 for the LUNs that are
accessible through FC port 0.
node. Only devices that are accessible on
the specified node are displayed.

15-20
Example
eng46> lun show port sp.1

Devices detail from PCC on port sp.1
====================================
Device Name
Model Raid Size (MB) State Cluster Volume
-------------------------------------------------------------------
-------------------------------------------------------------------
--------------
NEXSAN_5000402002e80be0_6B6BFF8F
Disk Raid-5 1716705.19 outCluster eng49
NEXSAN_5000402002e80be0_6B6BFEB8
NEXSAN_5000402002e80be0_6B6BFFE5
NEXSAN_5000402002e80be0_69073C37
NEXSAN_5000402002e80be0_69073C08
NEXSAN_5000402002e80be0_69073C61
NEXSAN_5000402002e80be0_6B6BFEA1
Disk Raid-5 1716705.19 outClust
eng46>
• Model shows the physical device to which the LUN is assigned. Typical values are
as follows:
a RAID

15-21
• Size indicates the maximum amount of storage space in megabytes for which the
LUN has been configured. This field shows only the configured maximum storage
space on the LUN; not the amount used or the amount that remains free.
following states:
- Used
- Free
- Foreign
- Out of cluster
• Cluster shows whether the LUN has been assigned to a cluster. The values are as
follows:
LUN belongs.
• Volume shows the name of the volume to which the LUN is assigned.
LUN Show Tape
Synopsis
lun show tape [-c CONTROLLER] [-n NODE][-P PAGENUMBER [-S PAGESIZE]]
Description
example, the LUNs owned by tape devices. You can view all LUNs that have been
configured on tape devices by running the lun show tape command.

15-22
Options
Table 15-7 : Options for the lun show tape command
-c CONTROLLER An optional argument for filtering the

LUN list by a specific controller ID
number. If you do not specify the
controller ID, the entire LUN list is
displayed.
-n NODE An optional argument for displaying the
LUN list on a particular node.
Example
eng46> lun show tape
Tape devices known to PCC.

==========================
Device Name Model Type

-------------------------------------------------------------------
-------
IBM_0000013021452000_1 ULT3582-TL Stacker
IBM_1110018463_0 ULT3580-TD2 Tape
eng46>
This example shows the LUN List with the following information:
• Device Name indicates the name of the tape drive or tape library.
• Model shows the model number of the tape drive or tape library.

15-23
• Type shows the value Tape for a tape drive or Stacker for a media changer or tape
library.
LUN Topology
Synopsis
lun topology
Description
After LUN discovery, you can view the LUN topology by running the lun topology
command. This command shows the storage topology report, which provides the
following basic information about the discovered storage devices:
• All the discovered controllers, by name
• The type of physical device each controller governs, tape or disk
• The controller’s presence in or absence from a cluster, and the nodes in the cluster

15-24
Example
cluster1-4> lun topology
Storage topology report.

========================
Controllers Type Nodes

-------------------------------------------------------------------
----
IBM_KPZ0B663 Disk cluster1-4
HITACHI_60432 Disk ccluster2-4
MYLEX_20000080e5128ae7 Disk cluster2-4
IBM_KPZ0R095 Disk cluster2-4
IBM_KPZ0N698 Disk cluster2-4
IBM_KPZ0M398 Disk cluster2-4
cluster1-4>
This example shows the storage topology report with the following information:
• Controllers indicates the names of all the controllers discovered in the SAN.
• Type shows the physical device to which the LUN is assigned. Typical values are:
a RAID.
• Nodes shows all the node names in the cluster of the NAS Gateways that have
access to the LUNs.
LUN Unlabel
Synopsis
lun unlabel DEVICENAME

15-25
Description
The lun unlabel command removes the label from a previously labeled LUN. When
you unlabel a LUN, it is no longer part of the storage pool. After the label is removed,
the LUN returns to the foreign LUN status, where it can be used by other entities, or
reassigned by adding another label. You can unlabel one LUN at a time, and you can
run this command only on free LUNs.
Note!
This command is useful for correcting labeling mistakes made when running
the lun label command.
Options
The DEVICENAME variable is the device name of the labeled
LUN that you want to unlabel. You can view a list of LUNs by
running the lun show all command.
Example
cluster1-4> lun unlabel MYLEX_20000080e5125e6e_31

Are you sure ? [Y/N] : y
cluster1-4>
In this example, the NAS Gateway is unlabeling a specific LUN. The NAS Gateway
prompts you for confirmation before actually performing the unlabeling transaction.
Type Y to accept and perform the unlabeling of the specified LUN. Type N to cancel
the labeling of the specified LUN.

15-26

Chapter 16: Mirror Commands
This chapter documents the following mirror commands:
• “Mirror Create” on page 16-2
• “Mirror Delete” on page 16-8
• “Mirror Demote” on page 16-9
• “Mirror Disable” on page 16-10
• “Mirror Enable” on page 16-11
• “Mirror Kill” on page 16-12
• “Mirror Modify” on page 16-13
• “Mirror Pause” on page 16-16
• “Mirror Promote” on page 16-18
• “Mirror Resume” on page 16-19
• “Mirror Reverse” on page 16-20
• “Mirror Schedule” on page 16-21
• “Mirror Show” on page 16-25
• “Mirror Start” on page 16-27
• “Mirror Testconnect” on page 16-29

16-2
Mirror Create
Synopsis
mirror create MIRRORNAME SRC-VOL TGT-VOL [-R TARGETDEVICE] [-S
STATE] [-m MINUTE] [-h HOUR] [-d DATE] [-M MONTH] [-D DAY][-
l{low|med|high}]
Description
You can create mirrors by running the mirror create command. A mirror consists of
the following elements:
• A name for the mirror
• The source volume that is mirrored onto the target volume
• The target volume that receives the source volume’s file system data
• The target device that houses the mirror volume
When these parameters have been set, the mirror target is configured with a file system
structure and is ready to accept live data from the mirror source whenever a mirror
session becomes active.
Use the mirror create command also to setup a mirror schedule that automatically
starts a mirror session. The mirror schedule contains parameters that govern when a
mirror session starts. The time variables that you can specify with this command
operate on an interval basis. For example, if you set the mirror schedule to activate a
session every hour, the interval is every 60 minutes. However, in some situations, the
actual mirror session might take longer than the configured interval. In such situations,
the ONStor™ data mirror software skips enough intervals to resynchronize the
sessions with the configured session times. For example, if the interval was configured
for every minute, and the mirror session took 1.25 minutes, the first session would
occur at exactly the top of the minute, and would be available again at 2.25 minutes.
However, that time does not occur at the top of the minute, so the schedule would skip
the interval at 2 minutes, and synchronize again at the next valid interval, which is
minute 3.

16-3
When mirror schedule parameters have been set, the cron daemon governs the starting
of mirror sessions. You can configure a mirror schedule with or without the optional
time variables for a session as follows:
• If you do not configure the time variables, you need to manually start an on-
demand mirror session by running the mirror start command. This command
starts a mirror session for the volume names and target locations you configured
with the mirror create command.
• If you do configure the time variables, the cron daemon automatically starts a
mirror session. If the mirror schedule is configured, you can still manually invoke
a mirror session by running the mirror start command. But, only one mirror
session can be active at a time. Therefore, when a mirror session is active and
another mirror start request is sent, the ONStor™ NAS Gateway rejects the second
request.
Note!
If a mirror is already created without a mirror schedule, and you want to add a
mirror schedule to it, you can use the mirror schedule command. You can also
use this command to change mirror schedule time parameters.
The source and target volume must be of the same RAIDlevel.
The mirror create command in Data Mirror over IP can be run from the virtual
server associated with source volume but not from the virtual server associated with
target volume.

16-4
Options
Table 16-1 : Options for the mirror create command
MIRRORNAME An alphanumeric character string of up

to 15 characters. Avoid using special
characters such as *, ?, ~, and / in the
mirror name. The name you specify is
important because all other mirror
commands refer to it.
SRC-VOL The name of the source volume to be
mirrored. The name string can be upto
255 characters.
TGT-VOL The name of the target volume to receive
the file system data from the source disk.
The target volume does not need to exist
on the mirror device. The target volume
is created as part of the mirror session.
The name string can be up to 255
characters. To specify the target in a
remote mirror, append
“@<ip_address_of_target_vsvr>” after
the volume name.
-R TGTDEVICE The name of the device controller for the
target disk. Type the name of the array
controller. You cannot mirror a file
system volume across multiple arrays.
The name string can be up to 127
characters. This optional parameter
becomes required if the target volume
does not yet exist.

16-5
Table 16-1 : Options for the mirror create command (Continued)
-S STATE An optional argument that sets the

operational state of the mirror schedule
when you configure it. Specify either
enable or disable.
If you specify enable, the mirror
schedule is immediately active when
you complete configuring it. This state is
the default.
If you specify disable, the mirror
schedule is not active when you
complete configuring it.
-m MINUTE An optional argument that specifies the
minutes of the hour at which to initiate a
mirror session. Type a value from 0 to 59
where 0 is the top of the hour and 59 is
the 59th minute of the hour.
-h HOUR An optional argument that specifies the
hour of the day at which to initiate a
mirror session. This parameter accepts
24-hour time, so type a value from 0 to
23 where 0 is midnight and 23 is 11:00
p.m.
If you do not specify a minutes value,
the session occurs at the top of the hour
that you specify.
If you specify a minutes value, the
session occurs at the number of minutes
in the hour you specify.

16-6
-D DATE An optional argument that specifies the

date in a month on which to initiate a
where 1 is the first of the month and 31
is the last day of the month.
-M MONTH Specifies an optional month of the year
in which to initiate a mirror session.
Type a value from 1 to 12 where 1 is
January and 12 is December.
If you do not specify a month value, the
mirror session occurs every month based
on the time values configured with the
other time parameters.
If you specify a month value, the mirror
session occurs at that month within the
year. For example, if you specify 6, the
mirror session occurs in June of each
year.
-d DAY An optional argument that specifies the
day on which to initiate a mirror session.
Sunday and 6 is Saturday.
If you do not specify a day of the week
value, the session occurs as configured
by the other parameters.
If you specify a day of the week value,
the session occurs on the day that you
specify.

16-7
-l low|med|high It’s the option for setting the mirror load

either low, medium or high. You select
the mirror load that is put on the NAS
Gateway and disk arrays during a mirror
session. Type these keywords in
lowercase.
Example
In the following example, an on-demand mirror is created.
eng31 PUBSTEST> mirror create techpubs pubstest pubsMirror -R IBM_KZSCDFD

Mirror: techpubs created successfully
eng31 PUBSTEST>
In this example, the mirror is configured as an on-demand mirror. In this command,

the mirror techpubs is created. The mirror’s source is the volume pubstest and the
mirror’s target volume is pubsMirror on RAID IBM_KZSCDFD.
In the following example, a mirror schedule is created.
eng31 PUBSTEST> mirror create techpubs pubstest pubsMirror -R IBM_KZSCDFD -m 30 -h 0,12 -D 1,4,6
Mirror: techpubs created successfully
eng31 PUBSTEST>
In this example, the mirror is configured with a scheduled mirror. In this command, the
mirror techpubs is created. The mirror’s source is the volume pubstest and the mirror’s
target volume is pubsMirror on RAID IBM_KZSCDFD. The mirror synchronizes data
from the source to the target on the 30th minute of midnight and noon on Monday,
Thursday, and Saturday of every week.
Related Commands
mirror delete Deletes a mirror.
mirror modify Modifies a mirror.

16-8
mirror schedule Schedules a mirror.

mirror start Initiates a mirror session.
Mirror Delete
Synopsis
mirror delete MIRRRONAME
Description
You can delete a mirror by name. When you delete a mirror, all its configured
parameters are deleted. The file system data associated with the mirror is not deleted
from the mirror array. If the target mirror is not already promoted, deleting the mirror
will trigger a promote of the target volume to change its type to Standard and make it
available for RW. This can only happen when the target volume is offline. Put it offline
by using the volume offline command.
The mirror delete command can be run from the virtual server associated with
source volume as well as the virtual server associated with target volume.
Options
The MIRRORNAME variable is an alphanumeric character string of
up to 15 characters.
Example
eng31 PUBSTEST> mirror delete techpubs

Are you sure? [y/n] y
Mirror: techpubs deleted.
eng31 PUBSTEST>
In this example, the mirror techpubs is deleted.

16-9
Related Commands
mirror create Creates a mirror.
Mirror Demote
Synopsis
mirror demote VOLNAME
Description
The mirror demote command converts the standard volume into a mirror volume. If
the volume is a target of a mirror, the mirror state will be changed from "promoted" to
"enabled". The schedule associated with the mirror will be enabled if it exists. If the
volume does not currently have a mirror configured, it must have previously been a
source or a target of a mirror.
Note!
For a remote mirror, this command should be run in the context of the virtual
server associated with the remote mirror's target volume.
Options
The VOLNAME variable specifies the name of the volume to
demote. The length of the volume name string can be up to 255
characters.
Example
In the following example, newvol1-m had been a promoted target volume and is now
demoted to a mirror volume.
eng123 ENG123V1> mirror demote newvol1-m

Mirror[remote] demoted.
eng123 ENG123V1>
Related Commands
mirror promote Promotes an existing mirror.

16-10
mirror create Creates a mirror.

mirror reverse Reverses the roles of source and target volumes
in a mirror.
Mirror Disable
Synopsis
mirror disable MIRRORNAME
Description
You can disable mirrors. Typically, you disable a mirror when the disk array that
houses the mirror requires repair or upgrade. A mirror needs to be disabled when the
disk array housing the mirror requires repair or upgrade. When you disable the mirror,
you deactivate the NAS Gateway's mirroring capability for the specified mirror.
Therefore, the NAS Gateway would not perform further mirror function for this mirror
automatically through the mirror schedule or manually through the mirror start
command. When a mirror is disabled, configured parameters in the mirror schedule
are not deleted. Instead, they remain as configured but suspended until the mirror is
enabled.
You need to explicitly disable each mirror by name. When you disable the mirror, the
live file system remains on the mirror array in the state it had before the mirror was
disabled. The source array cannot transmit subsequent updates to the mirror array until
the mirror schedule is re-enabled.
The mirror disable command in Data Mirror over IP can be run from the virtual
target volume.
Options

16-11
Example
eng31 PUBSTEST> mirror disable techpubs

eng31 PUBSTEST>
In this example, the mirror techpubs is disabled.
Related Commands
mirror enable Enables a mirror.
Mirror Enable
Synopsis
mirror enable MIRRORNAME
Description
Mirrors are automatically enabled when they are created. However, for mirrors that
have been manually disabled, you need to explicitly enable each mirror by name, to
reactivate its mirroring capability. When you enable the mirror, one of two situations
occurs:
• The NAS Gateway begins mirroring based on the mirror schedule’s time
parameters that you have previously configured. This situation occurs if the NAS
Gateway is configured for scheduled mirroring. Subsequent updates are sent from
the source array to the target mirror array depending on the parameters that you set
with the mirror create command or the mirror schedule command.
• The mirror schedule is not initialized and the NAS Gateway waits for you to
manually invoke a mirror session through the mirror start command.
Options

16-12
Example
eng31 PUBSTEST> mirror enable techpubs

eng31 PUBSTEST>
In this example, the mirror techpubs is enabled on the NAS Gateway.
Related Commands
mirror disable Disables a mirror.
Mirror Kill
Synopsis
mirror kill MIRRORNAME
Description
You can stop a mirror session by name by running the mirror kill command. When
you stop the mirror session, any in-progress mirror sessions are halted regardless of
whether they are on-demand or scheduled. If a scheduled mirror session is stopped,
only the current session is halted. The next mirror session occurs at its regularly
scheduled time. If an on-demand mirror session is stopped, you can start a new mirror
session through the mirror start command.
The mirror kill command in Data Mirror over IP can be run from the virtual server
associated with source volume as well as the virtual server associated with target
volume.
Options

16-13
Example
eng31 PUBSTEST> mirror kill techpubs

Mirror: techpubs killed.
eng31 PUBSTEST>
In this example, the techpubs mirror session is stopped.
Related Commands
mirror start Initiates a mirror session.
Mirror Modify
Synopsis
mirror modify MIRRORNAME [-s SRCFSYS][-t TGTFSYS][-l{low|med|high}]
Description
The NAS Gateway’s asynchronous mirroring causes intervals of traffic between the
source volume and the mirror. While data is mirrored, the Fibre Channel link is
supporting traffic. The NAS Gateway supports setting a relative load on the NAS
Gateway and storage arrays so that you can loosely control how much bandwidth is
used for the mirror session.
By default, the NAS Gateway is configured with the mirror load set to medium.
However, you can control the mirror load by running the mirror modify command.
Use this command to set the mirror load to any of the following values:
• low
• med (the default value)
• high
Note!
Setting a lower value for mirror load can increase the amount of time that the
mirror session takes.

16-14
The mirror modify command in Data Mirror over IP can be run from the virtual
server associated with the source volume, but not from the virtual server associated
with the target volume.
The mirror modify command also allows you to modify the following by using the
-t option.
• The name of the source volume in case it has been renamed.

• The name of the target volume in case it has been renamed.
• The IP address of the target virtual server for DMIP.
• The hostname of the target virtual server.
For more information on the -t option, see “Options for the mirror modify command”
on page 16-15.

16-15
Options
Table 16-2 : Options for the mirror modify command

to 15 characters. Type the name of the
mirror on which you want to set the
mirror load.
-l low|med|high It’s the option for setting the mirror load
either low, medium or high. You select
the mirror load that is put on the NAS
Gateway and disk arrays during a mirror
session. Type these keywords in
lowercase.
-s SRCFSYS The new name of the source volume.
-t TGTFSYS The new name of the target volume. For
example, if the IP address of the
hostname of the target virtual server in
DMIP has been changed, use this option
to update the volume with the new
value.
Example
eng42 ENG42_VS1> mir modify m1 -l low

eng42 ENG42_VS1>
In this example, the mirror load for the virtual server pubstest is modified to low from
its default setting of high. The default setting of medium is applied when you create the

16-16
mirror.
g10r9 G10V2 > mirror modify remote -t target@10.3.115.21

Mirror[remote] modified.
g10r9 G10V2 > mirror show
Mirror Name AdminState Oper State Transferred Source

Volume Target Volume VirtualServer
---------------- ---------- ----------- ----------- -----------
----------- ---------------------- -------------
remote Enabled Idle 0%
source target@10.3.115.21 G10V2
g10r9 G10V2 >
In the previous example, the IP address of the remote virtual server that owns the
target volume is being changed from 10.3.115.20 to 10.3.115.21.
Related Commands
mirror schedule Adds or modifies a mirror session schedule.
Mirror Pause
Synopsis
mirror pause MIRRORNAME
Description
In addition to completely stopping and closing a mirror session, you can pause a
mirror session that is in progress. By pausing the mirror session, you stop the open
disk-to-disk connection of the mirror without stopping the session or deleting the
mirror disk’s copy of the file system. The paused mirror session retains the configured
mirror schedule and all other configured mirror parameters, but the file system and
snapshot updates are suspended while the mirror session is paused.
Note!
While the mirror is paused, the live file system can change without the
mirror reflecting the changes.

16-17
When a mirror is paused, the mirror state is indicated to be paused on the source
virtual server only. You can manually resume a paused mirror session by running the
mirror resume command. Paused mirror sessions do not time out or restart. When a
mirror session is paused, it remains paused indefinitely.
Note!
If the virtual server associated with the source or target volume is moved or
fails over due to a NAS Gateway failure or reboot while the mirror is paused,
the mirror cannot be resumed. A new mirror session will have to be initiated
through the schedule or mirror start command.
The mirror pause command for Data Mirror over IP can be run from the virtual
target volume.
Options
The MIRRORNAME variable is an optional alphanumeric character
string of up to 15 characters.
Example
eng31 PUBSTEST> mirror pause techpubs

Mirror: techpubs paused.
eng31 PUBSTEST>
In this example, the mirror volume techpubs is paused on the NAS Gateway. This
command causes any inprogress mirror session to halt, and remain halted indefinitely.
Paused mirror sessions do not timeout. You can resume the paused mirror session by
running the mirror resume command, or you can stop the paused mirror session by
running the mirror kill command.
Related Commands
mirror resume Resumes a paused mirror session.
mirror kill Stops a mirror session.

16-18
Mirror Promote
Synopsis
mirror promote MIRRORNAME
Description
You can activate an idle, target mirror file system to be a live file system. Making a
mirror file system into a live file system is called promoting a mirror. Prior to
promoting the mirror, its target volume must be made offline. After successful
promotion, the newly promoted file system is no longer read-only. It contains the
same data as the source volume as of the last mirror session that was run prior to the
promotion.
You can promote a mirror to the role of live file system by running the mirror
promote command.
The mirror promote command for Data Mirror over IP cannot be run from the virtual
server associated with source volume but it can be run from the virtual server
associated with target volume.
Note!
The mirror promote command does not delete the mirror. The mirror will
show the promoted state once the target volume promotion is complete.
Options
Example
eng123 ENG123V1> mirror promote remote

Mirror[remote] promoted
eng123 ENG123V1
In this example, the mirror is promoted on the NAS Gateway. After the promotion, the
read-only mirror volume becomes a read-writable file system volume.

16-19
mirror demote Demotes a standard volume to a mirror volume.
Mirror Resume
Synopsis
mirror resume MIRRORNAME
Description
You can restart a paused mirror session by running the mirror resume command.
When a mirror session is paused, it retains all its configured parameters, but changes
to the live file system are not reflected on the mirror file system. When you resume the
mirror session, the configured schedule and mirror parameters are still available, and
the live file system and mirror file system complete the synchronization from where it
was at the time the mirror was paused. You can resume a paused mirror session by
running the mirror resume command.
The mirror resume command for Data Mirror over IP can be run from the virtual
target volume.
Options
Example
eng31 PUBSTEST> mirror resume techpubs

Mirror: techpubs resumed.
eng31 PUBSTEST>
In this example, the mirror techpubs is resumed on the NAS Gateway. This command
causes any paused mirror sessions to start wherever they were last paused.

16-20
Related Commands
mirror pause Pauses an in-progress mirror session.
Mirror Reverse
Synopsis
mirror reverse [MIRRORNAME]
Description
This command reverses the roles of source and target volumes in a mirror. The reverse
operation can be used during disaster recovery, for copying data modifications made
on a promoted target volume back to the source volume.
Prior to running this command, the current target volume must be promoted using the
mirror promote command.
This command must be run from the virtual server context of the mirror source. Upon
successful completion of this command, the mirror source will be demoted to a mirror
volume, and the source volume will be put offline.
Options
Table 16-3 : Option for the mirror show command
MIRRORNAME Name of the mirror on which the role

reversal is to take place

16-21
Example
eng42 ENG42-VS1> mir show
Mirror Name AdminState Oper State Transferred Source Volume Target Volume
VirtualServer
---------------- ---------- ----------- ----------- ---------------------- ----------------
------ -------------
m8 Enabled Idle 0% vol1 vol2
ENG42-VS1
eng42 ENG42-VS1> vol offline vol2
/
Done.
eng42 ENG42-VS1> mir promote m8
Mirror[m8] promoted.
eng42 ENG42-VS1> mir reverse m8
Mirror[m8] reversed.
eng42 ENG42-VS1> mir show
Mirror Name AdminState Oper State Transferred Source Volume Target Volume
VirtualServer
---------------- ---------- ----------- ----------- ---------------------- ----------------
------ -------------
m8 Enabled Idle 0% vol2 vol1
ENG42-VS1
eng42 ENG42-VS1>
Related Commands
mirror promote Promotes a mirror.
mirror demote Demotes a promoted volume to a mirror target.
Mirror Schedule
Synopsis
mirror schedule MIRRORNAME [-m MINUTE] [-h HOUR] [-D DOW][-M
MONTH][-d DOM]
Description
You can modify or remove a mirror schedule at any time. When you modify the mirror
schedule, the modified parameters become active immediately, but they will not take
effect until the next scheduled update of the mirror. You can perform the following
tasks with the mirror schedule command:
• You can modify the mirror schedule by running the mirror schedule command.

16-22
• If no mirror schedule exists yet, you can use this command to configure one.
• You can remove the mirror schedule by running the mirror schedule command,
providing only the mirror name, but no schedule values, such as day, time, or
month.
The mirror schedule command for Data Mirror over IP can be run from the virtual
target volume.

16-23
Options
Table 16-4 : Options for the mirror schedule command

to 15 characters.
-m MINUTE An optional argument that specifies the
minutes of the hour at which to initiate a
where 0 is the top of the hour and 59 is
the 59th minute of the hour.
-h HOUR An optional argument that specifies the
hour of the day at which to initiate a
mirror session. This parameter accepts
24-hour time, so type a value from 0 to
23 where 0 is midnight and 23 is 11:00
p.m.
If you do not specify a minutes value,
the session occurs at the top of the hour
that you specify.
If you specify a minutes value, the
session occurs at the number of minutes
in the hour you specify.

16-24
Table 16-4 : Options for the mirror schedule command (Continued)
-D DOW An optional argument that specifies the

day on which to initiate a mirror session.
Sunday and 6 is Saturday.
If you do not specify a day of the week
value, the session occurs as configured
by the other parameters.
If you specify a day of the week value,
the session occurs on the day that you
specify.
-M MONTH Specifies an optional month of the year
in which to initiate a mirror session.
January and 12 is December.
If you do not specify a month value, the
mirror session occurs every month based
on the time values configured with the
other time parameters.
If you specify a month value, the mirror
session occurs at that month within the
year. For example, if you specify 6, the
mirror session occurs in June of each
year.
-d DOM An optional argument that specifies the
date in a month on which to initiate a
where 1 is the first of the month and 31
is the 31st day of the month.

16-25
Example
eng31 PUBSTEST> mirror schedule techpubs -h 0 -D 1,2,3,4,5,6,7

eng31 PUBSTEST>
In this example, the mirror techpubs is modified. The new mirror schedule
synchronizes the source and target file systems at midnight of every day of the week.
eng31 PUBSTEST> mirror schedule techpubs

eng31 PUBSTEST>
In this example, the mirror techpubs is modified. No arguments were specified, so the
mirror schedule techpubs is now disabled. The mirror is now an ondemand mirror and
a new session can be started with the mirror start command, until the schedule is
modified with new parameters.
Related Commands
mirror modify Adjusts the relative load that a mirroring session
places on the NAS Gateway.
Mirror Show
Synopsis
mirror show [MIRRORNAME] | [-v SRCVOLNAME]
Description
You can display mirror session information by running the mirror show command.
Use this command to display mirror information in one of two ways:
• General information about all mirror sessions
• Detailed information about a specified mirror session.

16-26
The mirror show command for Data Mirror over IP can be run from the virtual server
associated with source volume as well as the virtual server associated with target
volume.
Options
Table 16-5 : Option for the mirror show command
MIRRORNAME An optional alphanumeric character

string of up to 15 characters. Type the
name of the mirror that you want to
display. If you specify a name, only that
mirror is displayed. If you specify no
name, all configured mirrors are
displayed.
-v SRCVOLNAME An optional alphanumeric character
string of up to 255 characters that
identifies the source volume of the
mirror session to be shown. The mirror
which contains the specified source
volume will be displayed. This optional
parameter is mutually exclusive with the
MIRROR name parameter.
Example
eng31 PUBSTEST> mirror show
Mirror Name AdminState OperState Transferred SrcVol TgtVol VirtualServer

------------ ---------- -------- ----------- ------ ------ --------
techpubs Enabled Idle 100% pubs3 pubsM3 pubstest
eng31 PUBSTEST>
In this example, the NAS Gateway is displaying information about the mirror
“techpubs.” The mirror show command displays the following information:

16-27
• Name shows the name given to the mirror when it was created.
• AdminState shows the administrative state of the mirror. Valid values are Enabled
(the mirror is operating) or Disabled (the mirror is not operating).
• Oper State shows the state the mirror actually is in. Valid values include IDLE
(mirror is not replicating), In-Progress (mirror is middle of replicating data), and
Paused (mirror is middle of replication but paused).
• Transferred shows the percentage of data on the source volume that has been
replicated on to the target volume
• Source Vol shows the name of the source volume. The source volume is the name
of the live volume that has its data mirrored to the target volume.
• Target Vol shows the name of the target volume. The target volume is the name of
the read-only mirror volume that is mirroring the live data from the volume
specified in Source Vol. In the case of a DIMP mirror, the IP address or hostname
of the virtual server that is hosting the target volume is displayed.
• Virtual Server is the name of the virtual server in which the source volume, target
volume, and mirror have been created.
Related Commands
mirror create Creates a mirror of a source volume.
mirror modify Modifies a mirror.
Mirror Start
Synopsis
mirror start MIRRORNAME
Description
The data mirror software supports on-demand mirror sessions. In an on-demand mirror
session you manually start the mirror session. You can start a mirror by running the
mirror start command.

16-28
When you run the mirror start command, the NAS Gateway reads the file system
information on the source volume, creates a snapshot, and transmits it as either a
baseline transfer or an incremental transfer to the target volume and array. You can
invoke an on-demand mirror session at any time after a mirror has been created and
enabled. On-demand mirror sessions do not interfere with any automatic mirroring
through a mirror schedule, so you can run the mirror start command on a volume
even if that volume has a configured mirror schedule for automatic mirroring.
Note!
You can pause or stop an in-progress on-demand mirror session by running the
mirror pause or mirror kill command.
The mirror start command for Data Mirror over IP can be run from the virtual
target volume.
Options
Example
eng31 PUBSTEST> mirror start techpubs

eng31 PUBSTEST>
In this example, the mirror techpubs is started on the NAS Gateway eng31.
Related Commands
mirror kill Stops a mirror session.
mirror pause Pauses a mirror session.
mirror resume Resumes a mirror session.

16-29
Mirror Testconnect
Synopsis
mirror testconnect {HOSTNAME|IPADDR}
Description
Firewalls might block the sanm ports used for data mirroring over IP. To check these
ports for accessibility mirror testconnect is run from the source virtual server
context:
Note!
For Data Mirror over IP to work, the following ports must be accessible:
• 48502, the port on which the sanm agent on the target FP port listens.
• 36035, the port used by the sanmd daemon on the SSC.
Options
The HOSTNAME|IPADDR variables specify either a DNS, NIS,
LDAP host name or an IP address of the location to check for port
accessibility across firewalls.
Example
eng31 PUBSTEST> mirror testconnect 10.2.1.15

Testing mirror connection 10.2.1.15
IP: 10.2.1.15,TCP port: 48502 connected

IP: 10.2.1.15,UDP port: 36035 connected
eng31 PUBSTEST>
In this example, the ports are checked for accessibility.

16-30

Chapter 17: NDMP Commands
This chapter documents the following NDMP commands:
• “NDMP Delete Session” on page 17-2
• “NDMP Disable” on page 17-4
• “NDMP Enable” on page 17-5
• “NDMP Reset” on page 17-5
• “NDMP Set Alternative Tape Model” on page 17-7
• “NDMP Set DMA” on page 17-9
• “NDMP Set Port” on page 17-10
• “NDMP Set Tape Block Size” on page 17-11
• “NDMP Set Version” on page 17-15
• “NDMP Show Configuration” on page 17-16
• “NDMP Show Detail” on page 17-17
• “NDMP Show Log” on page 17-25
• “NDMP Show Status” on page 17-27
• “NDMP Show Trace” on page 17-37

17-2
NDMP Delete Session
Synopsis
ndmp delete session {-a|-s SESSIONID}
Description
You can delete all NDMP sessions in a virtual server by running the ndmp delete
session command. This command is useful when the TCP/IP session is not closed
completely. Running this command deletes all the current NDMP sessions in the
current virtual server and forces the TCP/IP session to close completely. This
command affects only the current sessions, it does not prevent subsequent sessions
from occurring.
Use this command only if you think the session is hung. To find out whether a session
is hung when a backup session fails, do the following:
1. Query the data management application (DMA) for active
sessions.
• If the DMA responds that no sessions are active, check the
ONStor™ NAS Gateway by running the ndmp show status
-a command.
• If the NAS Gateway shows a session, run the ndmp show

status -s command, check for the DMA’s IP address.
2. Check the tape device for an active session. For information
about checking the tape device, consult the documentation
that accompanied your tape device or media changer.

17-3
Options
Table 17-1 : Options for the ndmp delete session command
-a Stops all active NDMP

sessions.
-s SESSIONID Specifies a particular
NDMP session ID that
you want to stop. If you
specify this argument,
only the specified session
is deleted. All other active
NDMP sessions remain in
progress.
Example
In the following example, all active NDMP sessions are deleted.
eng43 PUBSTEST> ndmp delete session -a

All current active sessions deleted. New sessions will take effect.
eng43 PUBSTEST>
In this example, all NDMP sessions are deleted. All inprogress backup or restore data
streams are halted.
In the following example, a specific NDMP session is deleted.
eng43 PUBSTEST> ndmp delete session -s 178912

Session deleted. New sessions will take effect.
eng43 PUBSTEST>
In this example, only NDMP session number 178912 is deleted. The NAS Gateway
severs contact with the NDMP client for only this NDMP session. All other inprogress
backup or restore data streams remain active.

17-4
Related Commands
ndmp show detail Shows detailed information of NDMP sessions.
ndmp show status Shows status of the active NDMP sessions.
NDMP Disable
Synopsis
ndmp disable
Description
When NDMP is disabled, a virtual server does not listen for requests from the NDMP
client. You can disable the NDMP software on each virtual server by running the ndmp
disable command. When you run this command, any inprogress NDMP sessions are
allowed to complete, but all subsequent sessions are prevented from starting.
Use this command cautiously. Many DMAs use multiple sessions to perform a backup
or restore operation. In some cases, if you run this command while a session is active,
you might error out the entire operation. For example, if multiple sessions comprise a
single backup operation, and you run this command while one session in the operation
is active, the entire backup operation error out. Therefore, verify that all sessions in the
virtual server are closed before running the ndmp disable command. You can verify
that all sessions in the current virtual server are closed by running the ndmp show
status -v VSVRNAME command. If you run this command and no sessions are listed,
no sessions are active, and you can safely run the ndmp disable command.
Example
eng43 PUBSTEST> ndmp disable

Ndmp is now disabled.
eng43 PUBSTEST>
In this example, the NDMP software is disabled on the virtual server pubstest. When
the NDMP software is disabled, the configured NDMP parameters remain intact.
However, the current virtual server does not support any NDMP functionality.

17-5
Related Commands
ndmp enable Enables the NDMP feature.
NDMP Enable
Synopsis
ndmp enable
Description
NDMP needs to be enabled on a virtual server for successful backup and restore
operations. When NDMP is enabled, the virtual server is able to respond to NDMP
client requests. You can enable NDMP by running the ndmp enable command. By
default, NDMP is enabled.
Example
eng43 PUBSTEST> ndmp enable

Ndmp is now enabled.
eng43 PUBSTEST>
In this example, the NDMP software is enabled on the virtual server pubstest. After
enabling the software, the virtual server can begin serving NDMP backup or restore
functions if the remaining NDMP parameters have been set.
Related Commands
ndmp disable Disables the NDMP feature.
NDMP Reset
Synopsis
ndmp reset

17-6
Description
If you have configured a virtual server with custom NDMP settings, you can return the
NDMP feature to default state by running the ndmp reset command. Because the
NDMP commands are run from within the context of a virtual server, this command
sets the NDMP parameters to their defaults for the current virtual server. When you
run this command, the NDMP parameters are set to the following defaults:
• NDMP state: Enabled
• NDMP version: 4
• TCP port for NDMP services: 10000
• Tape block size: 0 (variable block mode)
• Tape Alternate Model: false
Note!
You can view the current state of the NDMP software by running the ndmp
show config command.
Example
eng43 PUBSTEST> ndmp reset

NDMP configuration is now set to default values.
eng43 PUBSTEST>
In this example, the NDMP configuration for the virtual server pubstest is reset to its
default configuration.
Related Commands
ndmp set port Sets the NDMP port variable in the NDMP
server.
ndmp set tape Sets the NDMP tape model and block size.
ndmp set version Sets the NDMP version.

17-7
NDMP Set Alternative Tape Model
Synopsis
ndmp set tape altmodel (true|false)
Description
You can configure each virtual server to use a specified tape model within an NDMP
v3 environment. The configured tape model determines the behavior of the tape driver
as follows:
• The v4 tape model causes the tape drive to halt at a file mark and not position the
tape at the beginning of the next file mark.
• The standard tape model used in a v3 environment causes the tape driver to
consume the file mark and position the tape at the beginning of the next file mark.
This setting supports compatibility with Veritas Net Backup.
By default, the alternative tape model feature is set to false, which causes the v4 tape
model to be used in an NDMP v3 environment. When set to true, the virtual server
supports the default tape driver functionality within a negotiated NDMP v3
environment.
You can configure the alternative tape model by running the ndmp set tape
altmodel command. This command enables the NAS Gateway to conform to other
vendors’ backup implementations. For information about which version of tape driver
model to set, consult the documentation that accompanied your NDMP backup
solution. Then, set the NAS Gateway to comply with that implementation.

17-8
Options
Table 17-2 : Options for the ndmp set tape altmodel command
true Causes the NAS Gateway to

support the standard tape model
for an NDMP v3 environment.
false Enables the NAS Gateway to
support alternative mode which
allows the NDMP v4 tape
model to operate in an NDMP
v3 environment. This setting is
the default.
Example
eng43 PUBSTEST> ndmp set tape altmodel true

NDMP tape alternative model flag is now set to true.
eng43 PUBSTEST>
In this example, the virtual server pubstest is configured to use the Veritas tape model
in the negotiated NDMP v3 environment.
Related Commands
ndmp show config Shows NDMP configuration information.

17-9
NDMP Set DMA
Synopsis
ndmp set dma
{generic|bakbone|ca|commvault|legato|oracle|tivoli|veritas}
Description
The ndmp set dma command sets the DMA to be used to communicate with the
NDMP server. Setting a specific DMA might provide workarounds to NDMP protocol
conformance issues present in the DMA. Not all DMAs have conformance issues. For
details on which versions of these DMAs are supported, contact the ONStor technical
support department and request the latest run of the Compatibility Matrix.

17-10
Options
Table 17-3 : Options for the ndmp set dma command
generic Unspecified DMA. Set by default.

bakbone BakBone NetVault
ca Computer Associates BrightStor
commvault CommVault Galaxy
legato Legato NetWorker
oracle Oracle
tivoli Tivoli Storage Manager
veritas Veritas NetBackup
Example
eng46 TECHPUBS> ndmp set dma tivoli

NDMP DMA is now set to tivoli.
eng46 TECHPUBS>
In this example, the DMA is set to Tivoli Storage Manager.
Related Commands
NDMP Set Port
Synopsis
ndmp set port PORT

17-11
Description
By default, the NAS Gateway listens for services on TCP port 10,000. However, you
can set a different TCP port for NDMP by running the ndmp set port command. If
you set the port to a different value, you disallow any other functionality that is
supported on that port. For example, if you set the port to 80, you will use NDMP on
that port, but disallow world wide web HTTP support, which uses that TCP port by
default.
Options
The PORT variable is the TCP port number on which you want to
configure the NDMP services. By default, port 10,000 is used.
Example
eng43 PUBSTEST> ndmp set port 10100

NDMP port is now set to 10100.
eng43 PUBSTEST>
In this example, the TCP port that is supporting NDMP services on the virtual server
pubstest is set to 10100.
Related Commands
NDMP Set Tape Block Size
Synopsis
ndmp set tape blksize <-1|0|SIZE>
Description
You can configure the NAS Gateway to support one of the following tape block
modes:

17-12
• The default of the tape device

• Fixed block mode
• Variable block mode
The NAS Gateway supports either mode through the ndmp set tape blksize
command. Use this command to specify the actual tape block size to be used if fixed
block mode is configured. ONStor recommends using variable block mode unless
otherwise explicitly required by the NDMP client.
Note!
If you are specifying the tape block size, specify a multiple of 512-bytes. If you
do not specify a tape block size that is a multiple of 512-bytes, you might
experience I/O errors.
Some backup solutions require a specific tape block mode. Consult the documentation
that accompanied your backup solution to find out which mode is supported. Then, set
the NAS Gateway to comply with that mode.
Note!
Setting this parameter can change the tape device’s read and write speed.
If a mismatch occurs between the tape block mode configured on the NAS
Gateway and the tape block mode configured on the DMA, you will experience
I/O errors. For example, if the NAS Gateway is configured for fixed block
mode, and the DMA is configured with variable mode, the NDMP session will
not start and I/O errors will occur.

17-13
Options
Table 17-4 : Options for the ndmp set tape blksize command
-1 Causes the virtual server to use

the default tape block mode and
size that are in use on the tape
device.
0 Sets the virtual server to
support variable block mode.
This setting is the default.
SIZE Sets the size, in tape blocks, for
the virtual server to support
fixed block mode. For example,
2048 would set a virtual server
to support fixed block mode in
which each tape block is 2048
bytes.
Example
eng43 PUBSTEST> ndmp set tape blksize 2048

NDMP tape block size is now set to 2048.
eng43 PUBSTEST>
In this example, the virtual server pubstest is configured to use 2048 byte tape blocks.
Related Commands

17-14
NDMP Set Trace
Synopsis
ndmp set trace {0|1|2}
Description
The ndmp set trace {0|1|2} command sets the trace level for all NDMP messages
for active NDMP sessions. You use the trace level to activate or deactivate tracing of
NDMP messages. The default value is 0 (tracing deactivated). Level 0 deactivates
traces for NDMP. Level 1 or 2 activates traces.
Options
Table 17-5 : Options for the ndmp set tape blksize command
0 This option turns tracing off.

1 This option turns tracing on and
provides tracing information.
2 This option turns tracing on and
provides more detailed tracing
info than 1
Example
eng13 ENG13_VS0> ndmp set trace 2
In this example, there is no current active session, so new sessions will take effect. The
trace message is now set to 2 for all active & new sessions.

17-15
Related Commands
ndmp show trace Shows current NDMP log trace level
NDMP Set Version
Synopsis
ndmp set version NUM
Description
Presently, each virtual server supports NDMP v3 and v4. You can select which version
of NDMP that a virtual server can use by running the ndmp set version command.
Options
The NUM variable is a list of version numbers on which the
NDMP client and server agree before sending NDMP messages
or beginning NDMP backup or restore transactions.
Example
eng43 PUBSTEST> ndmp set version 3

NDMP version supported is now set to 3.
eng43 PUBSTEST>
In this example, the virtual server pubstest is configured to use NDMP protocol
version 3.
Related Commands

17-16
NDMP Show Configuration
Synopsis
ndmp show config [VIRTUALSERVER]
Description
You can use the ndmp show config command to display current NDMP
configuration information for a specific virtual server. NDMP configuration
information includes the following:
• Whether NDMP is enabled or disabled.
• The NDMP version that the virtual server supports.
• Port number on which NDMP services are configured. By default, port 10,000 is
used.
• The tape block size.
• The tape alternative model flag.
Options
The optional VIRTUALSERVER variable is a specified virtual server
for which to look up NDMP configuration.

17-17
Example
g10r9 diag> ndmp show config
Virtual Server State Version Port Block Size Alt Model DMA
-------------------------------------------------------------------------------------------------------------
VS_MGMT_512 ENABLED 4 10000 0 false Generic
G10V1 ENABLED 4 10000 0 false Generic
In this example, the virtual server pubstest is configured to use NDMP protocol
version 3, and NDMP is enabled. The tape block size is 2048, and the port number is
10100. The tape alternative model flag is set to true.
NDMP Show Detail
Synopsis
ndmp show detail {-a | -v VIRTUALSERVER | -s SESSIONID}
Description
You can display detailed information for NDMP sessions by running the ndmp show
detail command. By default, this command executes in the current virtual server.

17-18
Options
Table 17-6 : Options for the ndmp show detail command
-a Shows all active NDMP sessions.

-v VIRTUALSERVER The name of the virtual server for which
you want to display the detailed NDMP
session information. Without this
optional argument, all NDMP sessions
are displayed for the current virtual
server.
-s SESSIONID Shows in detail a specified active
NDMP session. Type an active session
ID number.

17-19
Example
The following example shows an example of output from the ndmp show detail
command for a local NDMP session.
eng42 ENG42_VS1> ndmp show detail

---------------------------------------------------
Session Detail Info:
===================
Session Id: 1177961898
Virtual server: ENG42_VS1
Connection Status: Active
Authorized: Yes
Version: 4
Auth Type: MD5
Client Address: 10.0.0.104
Time Start: (1177963033) Mon Apr 30 12:57:13 2007
Tape state: Open
alias: NRNU9hc
phys name: 0000000d7663d86b_NR_NU_default-density-
compressed
mode: Read/Write
Media Changer state: Closed
alias: NA
phys name: NA
Mover state: Halted
mode: Read
pause reason: NA
halt reason: Connection closed
recsiz: 65536
recnum: 4
data written: 0 MB
seek position: 0
bytes left to read: 0
window offset: 0
window len: -1
addr type: Local
addr(s): Local
Data state: Halted
operation: Backup
halt reason: Successful
bytes processed: 0 MB
read offset: 0
read len: 0
addr type: Local
addr(s): Local
---------------------------------------------------

17-20
The following shows an example output of the ndmp show detail command for a
remote NDMP session.
eng70 ENG70_VS1> ndmp show detail

---------------------------------------------------
Session Detail Info:
===================
Session Id: 1177954593
Virtual server: ENG70_VS1
Connection Status: Active
Authorized: Yes
Version: 4
Auth Type: MD5
Client Address: 10.0.0.104
Time Start: (1177954884) Mon Apr 30 10:41:24 2007
Tape state: Closed
alias: NA
phys name: NA
mode: Read Only
Media Changer state: Closed
alias: NA
phys name: NA
Mover state: Idle
mode: NA
pause reason: NA
halt reason: NA
recsiz: 0
recnum: 0
data written: 0 MB
seek position: 0
bytes left to read: 0
window offset: 0
window len: 0
addr type: NA
addr(s): NA
Data state: Halted
operation: Backup
halt reason: Successful
bytes processed: 62 MB
read offset: 0
read len: 0
addr type: Tcp
addr(s): 10.3.42.2:6588
---------------------------------------------------

17-21
The output of the ndmp show detail command provides the following information:
Status Item Description Valid Value

Session Id The unique ID assigned to the session. Numeric string
Virtual server The name of the virtual server associated Alphanumeric string
with this NDMP session.
Connection status The status of the NDMP control connec- Active or Closing
tion between the DMA (NDMP client)
and the NDMP server running on the
NAS Gateway.
Authorized Indicates whether the NDMP client Yes and No
has authenticated itself to the server.
Version The negotiated version of NDMP in use. Number
Auth Type The authentication type used for client None, Text, and MD5.
and server authorization. The NAS Gate-
way supports MD5 hash, and text
authentication.
None is listed if the client has not yet
performed authentication.
Client Address The IP address of the NDMP client of Dotted numeric string
this session.
Time Start The time at which this NDMP session Date and time
started.
Tape state the state of the tape drive supporting the open, or closed
NDMP session.
Tape alias A character string that substitutes for the Character string
actual physical name of the tape drive in
use.
Tape phys name A character string that represents the Character string
physical name of the tape drive in use.

17-22

Tape mode The current mode used to open the tape Read/Write, Read, or
drive. RAW
Media Changer state Indicates whether the media changer is open or closed
active or inactive.
Media Changer alias A character string that substitutes for the Character string
actual physical name of the media
changer in use.
Media Changer phys A character string that represents the Character string
name physical name of the media changer in
use.
Mover state The current state of the NDMP server’s Idle, Listen,
mover state machine. Active, Paused, or
Halted
Mover mode The direction of data transfer relative to NA, Read, or Write.
the data connection.
NA indicates that the mover is not
active. Read indicates that data is
read from the data connection and
written to the tape device. Write
indicates that data is read from the
tape device and written to the data
connection.
Mover pause reason The reason for any pause in the NA, End of media,
mover if the value in Mover Mode is End of file, Seek,
paused. Media error, or End
of mover window
Mover halt reason The reason for any stoppage in the NA, Connection
mover if the value in Mover Mode is closed, Aborted,
halted. Internal error, or
Connection error.

17-23

Mover recsize The record size, in bytes, used by the Number of bytes
mover when reading or writing to the
tape device.
Mover recnum The record number of the last record Numeric string
processed by the mover.
Mover data written The cumulative number of data stream Number of bytes
bytes read from or written to the data
stream.
Mover seek position The data stream offset of the first byte A range of unsigned 64-
that the DMA requested the mover to bit integers
transfer to the data connection during a
read operation.
Mover bytes left to The number of bytes remaining to be Number of bytes
read read to satisfy the current read request.
Mover window offset The absolute offset of the first byte of A range of unsigned 64-
the mover window within the data bit integers
stream.
Mover window len The length of the current mover window Number of bytes
in bytes.
Mover addr type The type of data connection used to con- local, TCP, and NA.
nect the mover to the data server.
local indicates that the mover and data
servers are collocated for the purpose of
performing a local backup and restore.
TCP indicates that the mover is con-
nected via a TCP/IP network connection
to a remote data server. NA indicates that
the mover is in idle state.

17-24

Mover addr(s) The address to which the mover server is NA, local, or up to four
either connected or on which it is listen- IP addresses separated
ing. by spaces.
NA indicates that the mover server is in
idle state. local indicates that the mover
server is connected or listening locally.
IP addresses indicates that the mover is
connected to or listening on a remote
device.
Data State The current state of the NDMP server’s Idle, Active,
data state machine. Halted, Listen or
Connected
Data operation The current data server operation. None, Backup, or
Restore
Data halt reason The event that caused the data server NA, Successful,
state machine to enter the Halted Aborted, Internal
state. error, or Connec-
tion error.
Data bytes processed The cumulative number of bytes trans- Number of bytes
ferred during the current data operation.
Data read offset The data steam offset specified in the A range of unsigned 64-
last data read request sent to the DMA. bit integers
Data read len The length specified in the last data read A range of unsigned 64-
request sent to the DMA. bit integers

17-25

Data addr type The type of data connection used to con- local, TCP, and NA.
nect the data server to the mover. local indicates that the
mover and data servers
are collocated for the
purpose of performing a
local backup and restore
operation TCP indicates
that the data server is
connected via a TCP/IP
network connection to a
remote mover. NA indi-
cates that the data server
is in idle state.
Data addr(s) The address to which the data server is NA, local, or up to four
either connected or on which it is listen- IP addresses separated
ing. by spaces.
NA indicates that the data server is in
idle state. local indicates that the data
server is connected or listening locally.
IP addresses indicate that the data server
is connected or listening remotely.
NDMP Show Log
Synopsis
ndmp show log [NUMLINES]
Description
The ndmp show log command shows the locally stored NDMP protocol log
messages.

17-26
Options
The NUMLINES variable is an optional argument that specifies the
number of lines that you want to display. The number of lines you
specify are counted in most-recent to least-recent order to
facilitate seeing the most recent usage events. Type a 32-bit
number for NUMLINES. By default, the entire NDMP log is
displayed if you do not specify a value for NUMLINES.
Example
In the following example, all locally stored NDMP protocol log messages are
displayed.
eng46 TECHPUBS> ndmp show log
Tue Mar 22 18:21:18 2005 (1111544478): ndmp_cfgd started; pid:5722
Wed Mar 23 23:10:15 2005 (1111648215): ndmp_cfgd started; pid:30003
Thu Mar 24 11:34:29 2005 (1111692869): ndmp_cfgd started; pid:24409
Thu Mar 24 11:57:40 2005 (1111694260): ndmp_cfgd started; pid:32561
Thu Mar 24 12:00:23 2005 (1111694423): New session: id:1111694260

pid:27656 vs:2
ip:10.3.46.50 DMA:10.3.19.11
Thu Mar 24 12:00:23 2005 (1111694423): Transmitted to 10.3.19.11;

Session:111169
4260 vs:2
Message : 0x502 (NDMP_NOTIFY_CONNECTED)
Timestamp : 1111694423
XSequence : 1
RSequence : 0
Error : 0 (NDMP_NO_ERR)
Reason : 0 (CONNECTED)
Proto Version : 4
Text :
Thu Mar 24 12:00:23 2005 (1111694423): Received from 10.3.19.11;

Session:111169

17-27
In the following example, the two most recently locally stored NDMP protocol log
messages are displayed.
eng46 TECHPUBS> ndmp show log 2

Fri Jun 3 23:25:28 2005 (1117866328): ndmp_cfgd started; pid:1573
Fri Sep 23 08:47:54 2005 (1127490474): ndmp_cfgd started; pid:11046

eng46 TECHPUBS>
NDMP Show Status
Synopsis
ndmp show status {-a | -v VIRTUALSERVER | -s SESSIONID}
Description
You can display a list of the NDMP sessions and see information about their operation
or performance status by running the ndmp show status command. By default, this
command affects the current virtual server.

17-28
Options
Table 17-7 : Options for the ndmp show status command
-a The status for all active sessions

in the current virtual server.
-v VIRTUALSERVER The virtual server for which you
want to display all active NDMP
sessions. Without this optional
argument, all NDMP sessions are
displayed for the current virtual
server.
-s SESSIONID A specified NDMP session ID
that you want to display.

17-29
Example
The following example shows the status of a specific session ID in the active virtual
server.
filer1> ndmp show status -s 129459

---------------------------------------------------
Session Status:
==============
SessId: 129559
======================
Virtual Server Ver Client Address Start Time Elapsed
Time
---------------- --- --------------- ----------------- -------

---------
VS1 4 10.0.0.147 11:04:20 11-05-04 00 days
00:00:36
Device Mode
Mover State
---------------------------------------------------- ----------
-----------
NRNU15hc Read/Write Active
Operation Status Data State Transferred(MB)

Throughput(MB/s)
--------- ------------ ---------- --------------- ------------
----
BACKUP Active Active 0 0
Size(MB) Level Est Time Remain Completed(%)

--------------- ----- --------------- ------------
0 0 00:54:59 0.00
Path
--------------------------------------
/vol1/big_backup2/Build.orig
This example shows the status information for NDMP session 129459.

17-30
The following example shows the status of a local backup NDMP session.
filer1> ndmp show status -a

---------------------------------------------------
Session Status:
==============
SessId: 1100911384
======================
Virtual Server Ver Client Address Start Time Elapsed Time
------------------ --- --------------- ----------------- -
---------------
VS-ENG5-1 4 10.0.0.147 16:44:43 11-19-04 00
days 00:01:14
Device Mode
---------------------------------------------------- ----------
NRNU24hc Read/Write
Mover State Data State Transferred(MB) Throughput(MB/s)

----------- ---------- --------------- ----------------
Active Active 16200 30
Operation Status Est Size(MB) Level Est Time Remain

Completed(%)
--------- --------- --------------- ----- --------------- ---
---------
BACKUP Active 32400 0 00:09:00 50
Path
--------------------------------------
/vol1/

17-31
The following shows an example output of the ndmp show status command for a
local restore NDMP session.

---------------------------------------------------
Session Status:
==============
SessId: 1100911385
======================
------------------ --- --------------- ----------------- -
---------------
VS-ENG5-1 4 10.0.0.147 16:51:43 11-19-04 00
days 00:01:07
Device Mode
---------------------------------------------------- ----------
NRNU24hc Read/Write

----------- ---------- --------------- ----------------
Active Active 0 0
Operation Status
--------- ---------
RESTORE Active
Source Volume Destination Volume

-------------------------------------- --------------------------
-----------
/vol1 /vol1

17-32
remote backup NDMP session from the mover server view.

---------------------------------------------------
Session Status:
==============
SessId: 1098320402
======================
------------------ --- --------------- ----------------- ---
-------------
VS_MGMT_257 4 10.0.0.147 18:12:40 10-20-04 00
days 00:05:52
Device Mode
---------------------------------------------------- ----------
NRNU23hc Read/Write

----------- ---------- --------------- ----------------
Active Idle 543 30
Data Connection Address(es)

------------------------------------------------------------------
-----------
10.3.1.148:6332

17-33
remote backup NDMP session from the data server view.
Session Status:
==============
SessId: 1100911386
======================
------------------ --- --------------- ----------------- --
--------------
VS-ENG5-1 4 10.0.0.147 16:55:20 11-19-04 00
days 00:06:09

----------- ---------- --------------- ----------------
Idle Active 518 29.4
Operation Status Est Size(MB) Level Est Time Remain

Completed(%)
--------- --------- --------------- ----- --------------- ---
---------
BACKUP Active 1368 0 00:00:29 37.87
Path
--------------------------------------
/vol2/

------------------------------------------------------------------
-----------
10.3.107.20:6332

17-34
remote restore NDMP session from the mover server view.
Session Status:
==============
SessId: 1098322524
======================
------------------ --- --------------- ----------------- --
--------------
VS_MGMT_257 4 10.0.0.147 18:37:38 10-20-04 00
days 00:00:11
Device Mode
---------------------------------------------------- ----------
NRNU23hc Read/Write

----------- ---------- --------------- ----------------
Active Idle 0 0

------------------------------------------------------------------
-----------
10.3.1.148:7100

17-35
remote restore NDMP session from the data server view.
Session Status:
==============
SessId: 1100913521
======================
------------------ --- --------------- ----------------- --
--------------
VS-ENG5-1 4 10.0.0.147 17:20:11 11-19-04 00
days 00:00:43

----------- ---------- --------------- ----------------
Idle Active 0 0
Operation Status
--------- ---------
RESTORE Active
Source Volume Destination Volume

-------------------------------------- --------------------------
-----------
/vol1 /vol1

------------------------------------------------------------------
-----------
10.3.107.20:6844
Example Output Description

The preceding examples show the status of a local and a remote NDMP session on the
current NAS Gateway filer1:
Table 17-8 : Output Description of ndmp show status
Status Item Description Valid Values

SessionId The unique ID assigned to this session. Numeric string
Virtual Server The name of the virtual server Alphanumeric
associated with this NDMP session. string

17-36
Table 17-8 : Output Description of ndmp show status (Continued)

Ver The NDMP version. Number
Client Address The IP address of the NDMP client in Dotted numeric
this session. string
Start Time The date and time at which this NDMP Date and time
session started.
Elapsed Time The amount of time that has elapsed Number of days,
since the NDMP client started the hours, minutes, and
session. seconds
Device The name of the tape device. Alphanumeric
string
Mode The current mode used to open the Read, Read/
device. write, or RAW
Mover State The current state of the NDMP server's Idle, Listen,
mover state machine. Active, Paused,
or Halted
Operation The type of operation being performed. BACKUP,
RESTORE, None
Status The status of the operation being Active, Idle,
performed. Completed,
Aborted, Internal
Err, Connect Err
Data State The current state of the NDMP server's Idle, Active,
data state machine. Halted, Listen,
Connected
Transferred (MB) The amount of data in megabytes that Number of
has been transferred. megabytes

17-37
Table 17-8 : Output Description of ndmp show status (Continued)

Throughput (MB/s) The data transfer rate in megabytes per Number of
second. megabytes per
second
Data Connection The IP addresses corresponding to a Dotted numeric
Address(es) remote NDMP session. If the session is string
connected, the address to which the
session is connected is displayed. If the
session is listening, one or more
addresses on which the session is
listening are displayed.
The Data Connection Address(es) output

only prints for remote NDMP sessions.
Path The path to which the data is backed Path
up.
NDMP Show Trace
Synopsis
ndmp show trace
Description
You can use the ndmp show trace command to display current NDMP log trace
level.

17-38
Example
eng57> ndmp show trace

The current NDMP trace message level is 0.
Related Commands
ndmp set trace Sets NDMP log trace level.

Chapter 18: NFS Commands
This chapter documents the following NFS commands:
• “NFS Cache Delete Mounts” on page 18-2
• “NFS Cache Show Mounts” on page 18-4
• “NFS Share Add” on page 18-6
• “NFS Share Delete” on page 18-18
• “NFS Share Disable” on page 18-19
• “NFS Share Enable” on page 18-21
• “NFS Share Modify” on page 18-23
• “NFS Show” on page 18-35

18-2
NFS Cache Delete Mounts
Synopsis
nfs cache delete mounts [-s SHARE] [-v VOLNAME]
Description
This command is used to force all NFS clients to go through the NFS mount
processing again by deleting their cached mount entries. When a client next accesses
the affected virtual server, volume, or share, their mount access rights are re-evaluated.
This command is typically used when an external change has been made that would
affect the access rights of one or more clients to shares. Examples include a change to
the membership of an NIS NetGroup or DNS name change.
Note!
Note that you cannot specify both -s and -v. options. If both are omitted, all
shares for the current virtual server are affected.

18-3
Options
Table 18-1 : Options for the nfs cache delete mounts command
-s SHARE When specified, all mount

entries for the given share
are deleted. A share is of
the form:
/VOLNAME/PATH
-v VOLNAME When specified, all mount

entries for the given
volume are deleted.
Example
The following example uses the -v option to delete volume g10-vs1-vol1.
g10r9 G10-VS1> nfs cache delete mounts -v g10-vs1-vol1
g10r9 G10-VS1>
The following example deletes all mounts.
g10r9 G10-VS1> nfs cache delete mounts
g10r9 G10-VS1> nfs cache show mounts
No Mount information.
g10r9 G10-VS1>
Related Commands
nfs cache show mounts Display the NFS mount entries.
nfs show Display the list of exported NFS filesystems.

18-4
NFS Cache Show Mounts
Synopsis
nfs cache show mounts [-s SHARE] [-v VOLNAME]
Description
This command is used to display the cached NFS client mount entry information.
Note!
Note that you cannot specify both -s and -v. options. If both are omitted, all
shares for the current virtual server are affected.

18-5
Options
Table 18-2 : Options for the nfs cache show mounts command
-s SHARE When specified, all mount

entries for the given share
are deleted. A share is of
the form:
/VOLNAME/PATH
-v VOLNAME When specified, all mount

entries for the given
volume are deleted.
Example
The following example shows the output of the command without any options.
g10r9 G10-VS1> nfs cache show mounts

Client IP: 10.3.12.27 Share path: /g10-vs1-vol2
The following example used the -s option.
g10r9 G10-VS1> nfs cache show mounts -s /g10-vs1-vol1

18-6
The following example used the -v option.
g10r9 G10-VS1> nfs cache show mounts -v g10-vs1-vol1
Related Commands
nfs cache delete mounts Delete the NFS mount entries, forcing clients to
refresh their NFS mount options.
nfs show Display the list of exported NFS filesystems.
NFS Share Add
Synopsis
nfs share add PATHNAME [-o OPTIONS]
Description
During runtime operation, you can configure file system-related characteristics on
volume space where the file system resides. You need to configure file system
functions directly related to NFS. You can configure an NFS share by running the nfs
share add command.
The ONStor™ NAS Gateway’s NFS shares contain two main components: the options
list and the clients list. The client list is specified in the -o OPTIONS parameter and
takes the following format:
-o OPTIONLIST=CLIENTLIST[;OPTIONLIST=CLIENTLIST]
Options List
In the options list you specify mount permissions for clients. The NAS Gateway
supports the following mount options:
• ro (read-only)
• rw (read-write)

18-7
• no root squash
• root squash
• all squash
• secure lock (for requiring network lock manager [NLM] requests)
• no submounts
• secure port
• no set-user-ID bits
• synchronization (for stable writes)
• anonymous user identities (UIDs)
• anonymous group identities (GIDs)
Syntax rules apply when you are specifying multiple options as part of the options list
section of the share. To specify multiple options in the options list, follow these rules
to configure the share configured properly, and enable the NAS Gateway to parse the
share correctly for display when you run the nfs show command:
• Options lists are case sensitive. Specify them in lowercase.
• Always specify -o to indicate that one or more options follow in the options list.
• The default configuration for a share is read-only, root_squash access unless you
configure different options through the -o argument. If you want different mount
permissions, you need to explicitly configure them.
• Comma-separate multiple entries in the options list, for example,
-o ro,no_root_squash,no_suid.
• Use an equal sign (=) to separate the options list from the clients list, for example:
-o ro=192.168.15.21/16.
• The comma is used to create a list of options before the equal sign to assign them
to one or more clients. Here is an example of using commas:
-o rw,no_root_squash,nosub=10.1.2.3.
In this example, the multiple options list of read and write (rw), no root squashing
(no_root_squash), and no access to submounts through the share (no_sub), all apply

18-8
to the 10.1.2.3 client. The commas allow EverON™ software to correctly parse the
multiple mount options assigned to a single client.
• The semicolon is used as a delimiter to type another set of exports. Continuing
with the previous example, to keep the share above and add another one, you
would specify the share as follows:
-o rw,no_root_squash,nosub=10.1.2.3;ro,root_squash=10.9.9.9
In this example, the multiple options list is retained for the 10.1.2.3 client, but another
complete export is added for the 10.9.9.9 client. In the share for the 10.9.9.9 client, the
semicolon separates the share lists for each client, and allows EverON software to treat
them as two independent export conditions, one for each client.
Clients List
Use the client list to specify one or more clients that are permitted to access the share.
The client list supports single clients, domains, network groups, or all clients.
Consider the following:
• To specify the clients list for a single client, type the client’s network address and
mask bits, for example: 192.168.15.21/16. By default, if you do not want to
specify the mask bits, the client address defaults to /32 (the same as
255.255.255.255) for the node address of that specific client.
• To specify the clients list for a domain, type the domain name, for example,
onstor.com. In this example, any client in the domain onstor.com can mount the
share unless a specific exclusion is noted in the share.
• To specify the clients list for a network group within a domain, type an “at ” ( @ )
sign followed by the network group name, for example, @pubs. In this example,
any client in the network group @pubs can mount the share unless an exclusion is
noted for the share.
• You can use the asterisk ( * ) character as a wildcard to indicate “all” for all clients
that request to mount the share unless a specific exclusion is configured on the
share.
Note!
The maximum number of clients per client list is 16, and the maximum client
string size is 255 characters.

18-9
The client list has syntax rules that ensure a correct configuration and that allow the
NAS Gateway to parse it for display when you un the nfs show command. When you
are configuring the clients list in the NFS share, follow these guidelines:
• Use an equal sign ( = ) to separate the clients list from the options list, for example,
-o ro=192.168.3.4.
• Use a colon to separate multiple entries in the client list, for example,
-o ro=192.168.3.4:192.168.3.19:192.168.3.128.
• Use a hyphen to exclude clients from a share, for example,
-o ro=-192.168.3.128:192.168.3.4:192.168.3.19.
• A client needs to be explicitly configured with read-only or read-write access to be
able to mount the share, for example,
-o ro=192.168.3.128 or -o rw=192.168.3.128.
• If a client is not listed in the read-write or read-only parameter, the client has no
permission to use the share.
• If a client is not listed in the no_root_squash parameter, the client has root_squash
capability.
Exclusions to the Share’s Client List
You can configure a share to all but a few clients. The share’s client list supports
exclusions for this purpose. An exclusion is one or more clients that are not allowed to
access the share that you are configuring to a group of clients. For example, you might
have a subnet where all clients are granted read-write access except one. In this
situation, you can configure the one client as an exclusion within the share that all
other clients use. The excluded client gets no access through the share, and because a
new share to a volume overwrites any existing share, you cannot configure a separate
share just for the excluded client if you wanted to give that client a separate set of
conditions. You can create an exclusion to the client list by doing the following:
• Indicate the excluded clients with a hyphen (-).
• In the clients list, always list excluded clients before the domain or network group
to which they belong, or before the asterisk ( * ). The NAS Gateway scans shares
in a left-to-right order and stops at the first match. For example, -o ro=-
192.168.22.24:* is different than -o ro=*:-192.168.22.24 because the excluded client
will not gain read-only access to the share. If the excluded client appeared after the

18-10
asterisk, it would gain read-only access to the share. Therefore, when you are
configuring an exclusion, consider the importance of the exclusion’s position.
For example if you ran the command:
nfs share add /vol1 -o rw,nosub=-192.168.22.24 :192.168.0.0/24 you would
configure read-write access to /vol1 with the no submount operation to any members
of the 192.168.0.0 subnet except for 192.168.22.24, which has been excluded from
using this share. You can configure client 192.168.22.24 with different share
conditions on a different share. If a conflict in mount options exists, the NAS Gateway
chooses the most restrictive option.
Client Authentication Level
Each share can support a file level authentication value that is a range from 0 to 1,
which equates to AUTH_NONE to AUTH_SYS, respectively. AUTH_SYS level is
the same as AUTH_UNIX.
The authentication level is specified as a comma-separated pair of numbers from 0 to 1
that are enclosed in parenthesis, for example (0,0).The authentication levels indicate
what authentication level is supported for clients that mount the share. The following
list shows the supported file authentication levels and explains what each level allows:
• (0,0) means that a client needs to have AUTH_NONE to use the share.
• (0,1) means that a client can have AUTH_NONE or AUTH_SYS to use the share.
This level is the default.
• (1,1) means that a client needs to have AUTH_SYS to use the share.
Note!
Auth level (1,0) is not valid.
If you want the authentication level set to a custom value, append it to the end of a
client in the client options list. For example, if you ran the command:
nfs share add /vol1 -o rw,nosub=192.168.22.24 :192.168.0.0/24(1,1)
you would allow read-write access to /vol1 with the no submount operation to any
members of the 192.168.0.0 subnet. These clients are required to have AUTH_SYS
level to use the share except for client 192.168.22.24 which uses the default
authentication (0,1) because no custom value was specified for it.

18-11
Options
Table 18-3 : Options for the nfs share add command
PATHNAME The file-system mount point

you are sharing with one or
more clients. Include the root
slash in the pathname, for
example,
/pubstest.
-o ro Indicates whether the clients
configured on the share can
mount the file system with
read access. Configure either
read-only or read-write access.
Otherwise, there is no access
on the share. Read-write and
root squash access is the
default configuration for an
NFS share.
-o rw Indicates whether the clients
read-write access. Configure
either read-only or read-write
otherwise, there is no access
on the share. If you configure a
share through nfs share
add and do not specify an
options list, the share defaults
to read-write and root-squash
access.

18-12
Table 18-3 : Options for the nfs share add command (Continued)
-o no_root_squash Indicates that clients are

excluded from root squashing
on the share. By default, the
share supports root squash for
the clients, so clients that
access the share through the
root ID (0) are disallowed
from using that ID. Instead,
clients using ID 0 are forced to
use either of the following
IDs:
• The default root squash ID,
which is 65534 (the “nobody”
user)
• The configured anon_UID if
the anon_UID option is
configured for the share that
is mounted.
If no_root-squash is specified,
clients who use the share are
not allowed to root on the
share.
If no_root-squash is omitted,
allowed to root on the share.
-o root_squash Indicates that any client that
attempts to access the share as
root is squashed to either the
default ID (65534) or the
configured anon-UID or anon-
GID.

18-13
-o all_squash Indicates that all clients are

allowed to access the share
after being squashed to either
the default ID (65534) or the
configured anon-UID or anon-
GID.
-o secure_lock Controls whether the NFS
server requires NLM lock
requests on the share. By
default, the NAS Gateway
does not require NLM requests
on the share, but you can
configure the NAS Gateway to
require NLM requests for any
user that accesses a file
through the share. If the
secure_lock option is specified
on the share, NLM requires
that any client needs to send an
NLM request when accessing
the share.
-o nosub Indicates that clients are not
allowed to access submounts
in the share. By default, clients
are allowed to mount the share
at any directory point in the
share. However, if the nosub
option is specified on the
share, clients can mount the
file system only at specified
directory points.

18-14
-o non_secure_port Indicates whether the share

uses a nonsecure server port.
By default, the share uses a
secure NFS port, but you can
set it to use a nonsecure port.
Note!
If you want to access the NFS
share from a Mac OS X client,
add this option to the share.
-o no_suid Indicates that the share needs

to disallow support for the set-
user-identifier bits. By default,
the share enables the set-user-
identifier bits, but with the
no_suid option, the share does
not allow the bits to be set.

18-15
-o anon_uid=xxx Controls the way that

anonymous UID is used. By
default, an anonymous UID is
interpreted as the UID
“nobody” (UID 65534). With
the anon_uid=xxx option, the
xxx is a anonymous UID
number that is a 16-bit number
specified by you. The UID
number you specify represents
the anonymous UID. If this
option is specified, anonymous
UIDs on the share use the UID
number assigned. If root
squash is configured on the
share, and the uid parameter is
specified, root users on the
share are squashed to the uid
value while accessing the
share.

18-16
-o anon_gid=xxx Controls the way that

anonymous GID is used. By
default, an anonymous GID is
interpreted as the GID
“nobody” (GID 65534). With
the anon_gid=xxx option, the
xxx is a anonymous GID
specified by you. The GID
the anonymous GID. If this
GIDs on the share use the GID
share, and the anon_gid
parameter is specified, then
root users on the share are
squashed to the anon_gid
share.

18-17
clientslist Specifies the client that is

allowed to use the share. You
can specify clients by IP
address, name, or network
group. You can also specify
that all clients are allowed to
access the share by using the *
as a wildcard character. You
can also specify an exclusion
to the clients list by prefixing a
minus sign (-) to the client. For
more information about the
clients list, see “Clients List”.
You need to separate the
options list and the clients list
by specifying an equals sign
(=), for example, -o
ro=1.2.3.4.
Example
The following are examples adding NFS shares.
eng38 PUBSTEST> nfs share add /vol1 -o rw,nosub=-192.168.22.24

:192.168.0.0/24
eng38 PUBSTEST>
In this example, a share is configured that allows read-write access to /vol1 with the no
submount operation to any members of the 192.168.0.0 subnet except for
192.168.22.24, which has been excluded from using this share. Multiple options are
comma-separated. Multiple clients are colon-separated. Client 192.168.22.24 has been

18-18
excluded by placing it before the allowed clients, and indicating that its an exclusion by
adding the minus sign ( - ).
eng38 PUBSTEST> nfs share add /vol1 -o ro=-192.168.22.24:*

eng38 PUBSTEST>
In this example, the NFS share is allowing read-only access to /vol1 to all clients
except for 192.168.22.24 which has been excluded from using this share. You can
configure client 192.168.22.24 with different share conditions on a different share. If a
conflict in mount options exists, the NAS Gateway chooses the most restrictive option.
Related Commands
nfs share delete Deletes a specified share or path of NFS users.
nfs share disable Disables a specified share or path.
nfs share enable Enables a specified share or path.
nfs share modify Modifies a specified share or path for NFS users.
nfs show Shows the list of exported NFS file systems.
NFS Share Delete
Synopsis
nfs share delete PATHNAME
Description
Use the nfs share delete command you remove a share definition from the NAS
Gateway. When you run this command, the NAS Gateway stops exporting a specific
directory or resource to a specific client. With the nfs share delete command you
can delete hosts from the share, all hosts from the share, delete the path, or delete all
paths.

18-19
Options
The PATHNAME variable is the path, for example, /vol1/test/dir,
that you want to make unavailable.
Example
In the following example, an NFS share is removed from a specific volume.
cluster1-4> nfs share delete /vol1/test

cluster1-4
Related Commands
nfs share add Adds a specified share or path for NFS users.
nfs share modify Modifies a specified share or path for NFS users.
NFS Share Disable
Synopsis
nfs share disable {all | PATHNAME}
Description
Use the nfs share disable command to deactivate a share definition on the NAS
Gateway. When you run this command, the NAS Gateway leaves the specified share
definition configured and intact on the NAS Gateway. The share becomes inactive.

18-20
Options
Table 18-4 : Option for the nfs share disable command
PATHNAME Specifies the client whose share

is disabled, and the full path from
the root to the directory or
resource that is exported. The
client and path are colon-
separated, for example,
MadMax:/vol1/test/dir1.
This parameter also specifies the
path without the client name, for
example, /vol1/test/dir1, if you
want to make this resource
unavailable to all clients that can
access the local node.
You can also use the keyword
all to disable all configured
NFS shares.
all This option adds the ability to
disable all enabled NFS shares.
Example
In the following example, all shares on the NAS Gateway are disabled.
cluster1-4> nfs share disable all

cluster1-4>

18-21
In the following example shares for the path /pubstest on the current NAS Gateway are
disabled.
cluster1-4> nfs share disable /pubstest

cluster1-4>
Related Commands
nfs share add Adds a specified share or path of NFS users.
nfs share modify Modifies a specified share or path of NFS users.
NFS Share Enable
Synopsis
nfs share enable {all | PATHNAME}
Description
Use the nfs share enable command to activate a configured, disabled share on the
NAS Gateway.

18-22
Options
Table 18-5 : Option for the nfs share enable command
PATHNAME Specifies the client whose share is enabled,

and the full path from the root to the
directory or resource that is exported. The
client and path are colon-separated, for
example, MadMax:/vol1/test/dir1.
This parameter also specifies the path
without the client name, for example, /vol1/
test/dir1 if you want to make this resource
available to all clients that can access the
local node.
You can also use the keyword all to
enable all configured NFS shares. If you
use the all keyword, you can enable all
shares on the current NAS Gateway.
all This option adds the ability to disable all
enabled NFS shares.
Example
In the following example NFS share pubstest is enabled.
cluster1-4> nfs share enable pubstest

cluster1-4>
Related Commands

18-23

NFS Share Modify
Synopsis
nfs share modify PATHNAME
Description
During runtime operation, you can modify file system-related characteristics on
volume space where the file system resides. You can modify an NFS share by running
the nfs share modify command. This command launches a vi editor, which you can
use to make modifications to the NFS share.
The NAS Gateway’s NFS shares contain two main components: the options list and
the clients list.
Options List
In the options list, you specify mount permissions for clients. The NAS Gateway
supports the following mount options:
• ro (read-only)
• rw (read-write)
• no root squash
• root squash
• all squash
• secure lock (for requiring NLM requests)
• no submounts
• secure port
• no set-user-ID bits
• synchronization (for stable write operations)

18-24
• anonymous UIDs
• anonymous GIDs
Syntax rules apply when you are specifying multiple options as part of the options list
section of the share. To specify multiple options in the options list, follow these rules
to configure the share properly, and enable the NAS Gateway to parse the share
correctly for display when you run the nfs share modify command:
• Options lists are case sensitive. Specify them in lowercase.
• The default configuration for a share is to read-only, root_squash access unless you
configure different options. If you want different mount permissions, you need to
explicitly configure them.
• Commas-separate multiple entries in the options list, for example,
ro,no_root_squash,no_suid.
• Use an equal sign (=) to separate the options list from the clients list, for example:
ro=192.168.15.21/16.
• The comma is used to create a list of options before the equal sign to assign them
to one or more clients. Here is an example of using commas:
rw,no_root_squash,nosub=10.1.2.3.
In this example, the multiple options list of read and write (rw), no root squashing
(no_root_squash), and no access to submounts through the share (no_sub), all apply
to the 10.1.2.3 client. The commas allow EverON software to correctly parse the
multiple mount options assigned to a single client.
• The semicolon is used as a delimiter to type another set of exports. Continuing
with the previous example, to keep the share above and add another one, you
would specify the share as follows:
rw,no_root_squash,nosub=10.1.2.3;ro,root_squash=10.9.9.9
In this example, the multiple options list is retained for the 10.1.2.3 client, but another
complete export is added for the 10.9.9.9 client. In the share for the 10.9.9.9 client, the
semicolon separates the share lists for each client, and allows EverON software to treat
them as two independent export conditions, one for each client.

18-25
Clients List
Use the client list to specify one or more clients that are permitted to access the share.
The client list supports single clients, domains, network groups, or all clients.
Consider the following:
• To specify the clients list for a single client, type the client’s network address and
mask bits, for example: 192.168.15.21/16. By default, if you do not want to
specify the mask bits, the client address defaults to /32 (the same as
255.255.255.255) for the node address of that specific client.
• To specify the clients list for a domain, type the domain name, for example,
onstor.com. In this example, any client in the domain onstor.com can mount the
share unless a specific exclusion is noted in the share.
• To specify the clients list for a network group within a domain, type an “at” ( @ )
sign followed by the network group name, for example, @pubs. In this example,
any client in the network group @pubs can mount the share unless an exclusion is
noted for the share.
• You can use the asterisk ( * ) character as a wildcard to indicate “all” for all clients
that request to mount the share unless a specific exclusion is configured on the
share.
Note!
The maximum number of clients per client list is 16, and the maximum client
string size is 255 characters.
The client list has syntax rules for correct configuration and for allowing the NAS
Gateway to parse it for display when you run the nfs modify command. When you
are configuring the clients list in the NFS share, follow these guidelines:
• Use an equal sign ( = ) to separate the clients list from the options list, for example,
ro=192.168.3.4.
• Use a colon to separate multiple entries in the client list, for example,
ro=192.168.3.4:192.168.3.19:192.168.3.128.
• Use a hyphen to exclude clients from a share, for example,
ro=-192.168.3.128:192.168.3.4:192.168.3.19.

18-26
• A client needs to be explicitly configured with read-only or read-write access to be

able to mount the share, for example,
ro=192.168.3.128 or rw=192.168.3.128.
• If a client is not listed in the read-write or read-only parameter, the client has no
permission to use the share.
• If a client is not listed in the no_root-squash parameter, the client has root_squash
capability.
Exclusions to the Share’s Client List
You can configure a share to all but a few clients. The share’s client list supports
exclusions for this purpose. An exclusion is one or more clients that are not allowed to
access the share that you are configuring to a group of clients. For example, you might
have a subnet where all clients are granted read-write access except one. In this
situation, you can configure the one client as an exclusion within the share that all
other clients use. The excluded client gets no access through the share, and because a
new share to a volume overwrites any existing share, you cannot configure a separate
share just for the excluded client if you wanted to give that client a separate set of
conditions. You can create an exclusion to the client list by doing the following:
• Indicate the excluded clients with a hyphen (-).
• In the clients list, always list excluded clients before the domain or network group
they belong to, or before the asterisk ( * ). The NAS Gateway scans shares in a
left-to-right order and stops at the first match. For example, ro=-192.168.22.24:*
is different than ro=*:-192.168.22.24 because the excluded client in the second
example will not gain read-only access to the share. If the excluded client appeared
after the asterisk, it would gain read-only access to the share. Therefore, when you
are configuring an exclusion, consider the importance of the exclusion’s position.
Client Authentication Level
Each share can support a file level authentication value that is a range from 0 to 1,
which equates to AUTH_NONE to AUTH_SYS, respectively. AUTH_SYS level is the
same as AUTH_UNIX.
The authentication level is specified as a comma-separated pair of numbers from 0 to 1
that are enclosed in parenthesis, for example (0,0).The authentication levels indicate
what authentication level is supported for clients that mount the share. The following
list shows the supported file authentication levels and explains what each level allows:

18-27
• (0,0) means that a client needs to have AUTH_NONE to use the share.
• (0,1) means that a client can have AUTH_NONE or AUTH_SYS to use the share.
This level is the default.
• (1,1) means that a client needs to have AUTH_SYS to use the share.
Note!
Authentication level (1,0) is not valid.
If you want the authentication level set to a custom value, append it to the end of a
client in the client options list.
Table 18-6 : Options for the nfs share modify command
PATHNAME The file-system mount point

you are sharing with one or
more clients. Include the root
slash in the path, for example,
/pubstest.
ro Indicates whether the clients
read access. Configure either
read-only or read-write access.
Otherwise, there is no access
on the share. Read-write and
root squash access is the
default configuration for an
NFS share.

18-28
Table 18-6 : Options for the nfs share modify command (Continued)
rw Indicates whether the clients

read-write access. Configure
either read-only or read-write
access. Otherwise, there is no
access on the share. If you
configure a share through nfs
share modify and do not
specify an options list, the
share defaults to read-write
and root_squash access.

18-29
no_root_squash Indicates that clients are

excluded from root squashing
on the share. By default, the
share supports root squash for
the clients, so clients that
access the share through the
root ID (0) are disallowed
from using that ID. Instead,
clients using ID 0 are forced to
use either of the following
IDs:
• The default root squash ID,
which is 65534 (the “nobody”
user).
• The configured anon_uid if
the anon_uid option is
configured for the share that
is mounted.
If no_root_squash is specified,
not allowed to root on the
share. If no_root_squash is
omitted, clients who use the
share are allowed to root on
the share.
root_squash Indicates that any client that
attempts to access the share as
root is squashed to either the
default ID (65534) or the
configured anon_uid and
anon_gid.

18-30
all_squash Indicates that all clients are

allowed to access the share
after being squashed to either
the default ID (65534) or the
configured anon_uid and
anon_gid.
secure_lock Controls whether the NFS
server requires NLM lock
requests on the share. By
default, the NAS Gateway
does not require NLM requests
on the share, but you can
configure the NAS Gateway to
require NLM requests for any
user that accesses a file
through the share. If the
secure_lock option is specified
on the share, NLM requires
that any client needs to send an
NLM request when accessing
the share.
nosub Indicates that clients are not
allowed to access submounts
in the share. By default, clients
are allowed to mount the share
at any directory point in the
share. However, if the nosub
option is specified on the
share, clients can mount the
file system only at specific
directory points.

18-31
non_secure_port Indicates whether the share

allows a client to use a
nonsecure server port (that is,
a source port over 1023). By
default, the share uses a secure
NFS port, but you can set it to
use a nonsecure port.
no_suid Indicates that the share needs
to disallow support for the set-
user-identifier bits. By default,
the share enables the set-user-
identifier bits, but with the
no_suid option, the share does
not allow the user to set the
bits. If the set-user-identifier
has already been set on any
files, it will be suppressed.
sync Enforces stable writes
operations on the share. The
sync argument causes data in
an NFS write operation to be
synchronized with the disk
before sending an ACK to the
NFS request. By default, NFS
shares support unstable write
operations which allows an
ACK to the NFS write request
before synchronizing the data
to disk.

18-32
anon_uid=xxx Controls the way that

anonymous UID is used. By
default, an anonymous UID is
interpreted as the UID
“nobody” (UID 65534). With
the anon_uid=xxx option, the
xxx is a anonymous UID
specified by you. The UID
the anonymous UID. If this
UIDs on the share use the UID
share, and the anon_uid
parameter is specified, root
users on the share are
squashed to the anon_uid
share.

18-33
anon_gid=xxx Controls the way that anonymous

GID is used. By default, an anon-
ymous GID is interpreted as the
GID “nobody” (GID 65534).
With the anon_gid=xxx option,
the xxx is a anonymous GID num-
ber that is a 16-bit number speci-
fied by you. The GID number
you specify represents the anony-
mous GID. If this option is speci-
fied, anonymous GIDs on the
share use the GID number
assigned. If root squash is config-
ured on the share, and the
anon_gid parameter is specified,
root users on the share are
squashed to the anon_gid value
while accessing the share.

18-34
clientslist The client that is allowed to

use the share. You can specify
clients by IP address, name, or
network group. You can also
specify that all clients are
allowed to access the share by
using the * as a wildcard
character. You can also specify
an exclusion to the clients list
by prefixing a minus sign (-) to
the client. For more
information about the clients
list, see “Clients List”.
Separate the options list and
the clients list by specifying an
equals sign (=), for example,
ro=1.2.3.4.
Example
The following are examples of modifying NFS shares.
eng38 PUBSTEST> nfs share modify /vol1 rw,nosub=-192.168.22.24

:192.168.0.0/24
eng38 PUBSTEST>
In this example, a share is modified that allows read-write access to /vol1 with the no
submount operation to any members of the 192.168.0.0 subnet except for
192.168.22.24, which has been excluded from using this share. Multiple options are
comma-separated. Multiple clients are colon-separated. Client 192.168.22.24 has been

18-35
excluded by placing it before the allowed clients, and indicating that its an exclusion by
adding the minus sign ( - ).
eng38 PUBSTEST> nfs share modify /vol1 ro=-192.168.22.24:*

eng38 PUBSTEST>
In this example, the NFS share is allowing read-only access to /vol1 to all clients
except for 192.168.22.24 which has been excluded from using this share. You can
configure client 192.168.22.24 with different share conditions with a different share (if
needed). If a conflict in mount options exists, the NAS Gateway chooses the most
restrictive option.
Related Commands
NFS Show
Synopsis
nfs show ([PATHNAME]|[all]|[-v VOLNAME [-P PAGENUMBER] [-S PAGESIZE]]])
Description
The nfs show command displays a list of exported share pathnames along with status
(enabled or disabled) which exists on the current virtual server.

18-36
Options
Table 18-7 : Options for the nfs show command
PATHNAME An optional name for the

path to the volume whose
share definitions you
want to view. If you do
not specify a path the
shares for all volumes are
displayed.
all The shares for all
volumes.
-v VOLNAME displays all NFS shares
on a volume
-P PAGENUMBER An option that specifies
the number of the page to
display.
-S PAGESIZE An option that specifies
the page size in number of
records to display.
Example
In the following example, the all option is used..
eng93 KERBEROS> nfs show all

State: Enabled Share path: /krb-vol
Option: rw, client list:
* auth(0,1)
Option: no_root_squash, client list:
* auth(0,1)

18-37
In the following example, the -v option is used to display the shares on volume
krb-vol..
eng93 KERBEROS> nfs show -v krb-vol

State: Enabled Share path: /krb-vol


18-38

Chapter 19: Port Commands
This chapter documents the following port commands which affect physical Gigabit
Ethernet (GE) ports and physical Fibre Channel (FC) ports:
• “Port Autonegotiation” on page 19-2
• “Port Disable” on page 19-4
• “Port Enable” on page 19-6
• “Port Modify” on page 19-7
• “Port Reset” on page 19-8
• “Port Show All” on page 19-10
• “Port Show Detail” on page 19-11
• “Port Show Loadstats” on page 19-14
• “Port Show Stats” on page 19-15
The commands in this chapter do not affect logical ports.

19-2
Port Autonegotiation
Synopsis
port autoneg PORT on|off
Description
You can set one of the ONStor™ NAS Gateway’s physical GE ports to support
autonegotiation with the peer device at the far end of the interface by running the port
autoneg command. This command enables the NAS Gateway to receive or initiate
link speed negotiation messages whenever the port becomes active at the network
layer.
The port autonegotiation state needs to be congruent with the peer device. If a port on
the NAS Gateway changes to the DOWN state, it does not transition to the UP state
unless the state of autonegotiation on the NAS Gateway matches the state of
autonegotiation on the peer device on the link. For example, if a port goes offline, and
the port’s autonegotiation state is set to OFF when the peer device on the other end of
the link has autonegotiation set to ON, the NAS Gateway’s port does not come back
online because of this mismatch.
Ensure that the port and peer device are both set to the same autonegotiation state,
either both are set to OFF, or both are set to ON.

19-3
Options
Table 19-1 : Options for the port autoneg command
PORT The physical GE port on which you are

setting the autonegotiation. The name of
file processing ports that you can specify
depends on the model of ONStor 2200
NAS Gateway you have:
• A 2200 model has two GE ports, so the
name you can specify is fp1.0 or fp1.1.
• A 2240, 2260, or 2280 model has four
GE ports, so the name you can specify
is either fp1.0, fp1.1, fp1.2, or fp1.3.
on|off A choice list for controlling the state of

the automatic link speed negotiation on
the port.
Specifying on allows the NAS Gateway
to negotiate link speed with the peer
device at the far end of the link
whenever the link becomes active.
Specifying off prevents the NAS
Gateway and its peer device from
negotiating. Instead, the link stays at a
configured default link speed.
By default, the NAS Gateway’s Ethernet
port are enabled for autonegotiation.
Example
In the following example, the autonegotiation capability is disabled on file processing

19-4
port 1.
cluster1-4> port autoneg fp.1 off

cluster1-4>
In the following example, link speed autonegotiation is enabled.
cluster1-4> port autoneg fp.1 on

cluster1-4>
In this example, the autonegotiation capability is disabled on GE port 1’s interface. If

the autonegotiation has been disabled on the port, but is later reenabled, the
autonegotiation feature becomes immediately active, but the configured link speed
remains. The now-enabled autonegotiation does not occur until the next time the port
state cycles from down to up.
Port Disable
Synopsis
port disable PORT
Description
You can disable any enabled port by running the port disable command. This
command deactivates the storage port (FC) or the file processing port (GE). When the
port is disabled, it is in the DOWN state, so it cannot support a physical-layer link, and
in turn, cannot carry traffic if a network-layer connection exists.
• A disabled storage port remains connected to the shared storage, but cannot carry
read or write operations to the shared storage.
• A disabled GE port remains connected to the network, but is unable to carry traffic.
This command is helpful for attachment point changes of the shared storage or for
attachment point changes in the IP network. For example, run this command before
disconnecting the FC link to a RAID, or before upgrading the storage with higher
density devices.

19-5
Options
The PORT variable is the alphanumeric character string that
identifies the physical port you want to disable. For example,
specifying sp.0 disables the storage processing port 0, or
specifying fp1.0 disables file processing port 0. The maximum
number of file processing ports that you can specify depends on
the model of ONStor 2200 NAS Gateway you have:
• A 2200 model has two GE ports, so the maximum number of
ports you can specify is two.
• A 2240, 2260, or 2280 model has four GE ports, so the
maximum number of ports that you can specify is four.
The maximum number of storage processing ports that you can
specify is two, either sp.0 or sp.1.
Example
In the following example storage processing port 1 is disabled. You cannot use the
storage port while it is disabled.
cluster1-4> port disable sp.1

cluster1-4>
In the following example file processing port 0 is disabled. You cannot use the file
processing port while it is disabled.
cluster1-4> port disable fp.0

cluster1-4>
Related Commands
port enable Enables a port or all ports.

19-6
Port Enable
Synopsis
port enable PORT
Description
You can enable any disabled storage port or file processing port by running the port
enable command. This command activates the physical storage port or file processing
port. When the port is enabled, it is in the UP state, so it can support a physical-layer
link, and in turn, can carry traffic if a network-layer connection exists.
• When you enable a storage port, the small computer system interface (SCSI)
drivers perform storage area network (SAN) discovery to rediscover the SAN’s
topology in case any attachment points changes. Changes might include that the
upgrade or insertion of a new RAID have not occurred in the FC loop.
• When you enable a file processing port, the GE drivers reestablish network-layer
connectivity with the collision domain.
Options
identifies the physical port you want to enable. For example,
specifying sp.0 enables storage processing port 0, or fp.0 enables
file processing port 0. The maximum number of file processing
ports that you can specify depends on the model of ONStor 2200
NAS Gateway you have:
The maximum number of storage processing ports you can

19-7
Example
In the following example a storage port is enabled. You cannot use the storage port
unless it is enabled.
cluster1-4> port enable sp.1

cluster1-4>
In the following example a file processing port is enabled. You cannot use the file
processing port unless it is enabled.
cluster1-4> port enable fp.0

cluster1-4>
Related Commands
port disable Disables a port or all ports.
Port Modify
Synopsis
port modify PORT [-m MTU]
Description
By default, the maximum transmission unit (MTU) size for the NAS Gateway’s file
processing ports is 1500 bytes. However, the NAS Gateway supports different sizes of
MTU on the each port. You can set the MTU on a file processing port by issuing the
port modify command. This command configures the largest unfragmented packet
size for packets transmitted on the port. Packets that are larger than the MTU size are
fragmented and sent in multiple packets, then subsequently reassembled at their
destination.

19-8
Options
Table 19-2 : Options for the port modify command
Option Object Result
-m MTU A numerical value, in bytes, that sets the

MTU size for unfragmented packets on the
port. Specify an MTU size between 1500
and 16384 bytes. The default MTU size is
1500 bytes. You can set different MTU sizes
on different ports.
PORT The physical port on which you are setting
the MTU size.
Example
Here is an example of the port modify command.
cluster1-4> port modify fp1.1 -m 2048

cluster1-4>
In this example, the interface MTU size is being set to 2048 bytes on the file port 1.
Related Commands
port show all Displays general information about storage and
file processing ports.
Port Reset
Synopsis
port reset PORT

19-9
Description
You can reset a storage port by running the port reset command. This command
performs a complete restart of the target port. The port is deactivated, then reactivated
as if you ran the port disable and port enable command in succession.
Note!
You cannot reset a file processing port with this command.
When the port is reset, it is put in the DOWN state, then transitions to the UP state.
When you reset a storage port, the SCSI drivers perform SAN discovery to relearn the
SAN’s topology in case any attachment points changes, for example, the upgrade or
insertion of a new RAID, have occurred in the FC loop. The port cannot support SAN
traffic until it has reached the UP state.
Options
identifies the physical port you want to reset. For example,
specifying sp.0 resets storage processing port 0. Specify either
sp.0 or sp.1.
Example
cluster1-4> port reset sp.1

cluster1-4>
In this command, storage processing port 1 is reset. You cannot use the storage port
until it is enabled and in the UP state.
Related Commands
port disable Disables a port or all ports.
port enable Enables a port or all ports.

19-10
Port Show All
Synopsis
port show all
Description
The NAS Gateway tracks general and detailed performance and operation statistics for
each port. The resulting data is contained in the port statistics table. To show general
information about all storage ports and file processing ports on a NAS Gateway, run
the port show all command. You can also view detailed information about the
performance and operation statistics for all ports in the port statistics table. For
detailed statistics that track the performance and usage of traffic on the ports to a much
finer level than general port statistics, run the port show stats command.
Example
eng10> port show all

Port Show All
Link Link Interface Frame
Port State Speed Type Size WWN
===================================================================
==
sp2.0 UP 2 Gbit F_PORT 2048 5000734000000a20
sp2.1 UP 2 Gbit F_PORT 2048 5000734000000a21
sp2.2 DOWN 0 Gbit N/A 2048 5000734000000a22
sp2.3 DOWN 0 Gbit N/A 2048 5000734000000a23
fp1.0 UP 1 Gbit GE_ETH 1500 00:07:34:00:0a:10
fp1.1 UP 1 Gbit GE_ETH 1500 00:07:34:00:0a:11
fp1.2 UP 1 Gbit GE_ETH 1500 00:07:34:00:0a:12
fp1.3 UP 1 Gbit GE_ETH 9196 00:07:34:00:0a:13
The information displayed consists of the following:

• port is the port specifier that indicates the ports type and location.
- sp.y indicates storage processing ports (FC).
- fp.y indicates file processing ports (GE).

19-11
• link state is the operational state of the link. Valid values are UP when the link is
active and operating correctly, or DOWN when the link is inactive or not operating
correctly.
• link speed is the operational speed of the link.
• interface type is the interface type supported on the adapter.
• frame size is the largest frame the port can receive or transmit.
• WWN is the world wide name for the particular port:
- For storage ports, this value shows the port WWN.
- For file processing ports, this value shows the MAC address of the port.
Related Commands
port show detail Shows detailed information about a port.
port show stats Shows statistical information about a port.
Port Show Detail
Synopsis
port show detail PORT
Description
The NAS Gateway tracks general and detailed performance and operation statistics for
each port for storage ports and file processing ports. The resulting data appears in the
port statistics table. To show detailed information about all storage ports and file
processing ports on a NAS Gateway, run the port show detail command.You can
view detailed information about the performance and operation statistics for any port
in the port statistics table. Detailed statistics track the performance and usage of traffic
on the port to a more granular level than general port statistics.
Options

19-12
identifies the physical port that you want to enable. For example,
specifying sp.0 shows storage processing port 0, or specifying
fp.0 shows a file processing port. The maximum number of file
processing ports that you can specify depends on the model of
ONStor 2200 NAS Gateway that you have.
The maximum number of storage processing ports you can
Example
In the following example, details of a storage processing port are displayed.
cluster1-4> port show detail sp.1

adapter name : QLogic 2300
firmware revision : 34.1.1
hardware revision : 0
interface type : F_PORT
link state : UP
link speed : 1 Gbit
Max. SCSI tags per device : 5
Fibrechannel nodename : 5001000734143721
Max. Fibrechannel frame size : 2048
SRAM parity available : YES
cluster1-4>
In this example, storage processing port 1 is displayed. The detailed information

displayed consists of the following:
• adapter name shows the manufacturer and model number of the HBA in the port.
• firmware revision shows the revision level of the firmware running on the adapter.
• hardware revision shows the revision level of the hardware supporting the adapter.
• interface type shows the type of interface that is supported on the adapter. F_Port
indicates that an FC port connects into the SAN.

19-13
• link state shows the operational state of the FC logical layer. Valid values are UP
when the link is active and operating correctly, or DOWN when the link is inactive
or not operating correctly.
• link speed shows the operational speed of the link.
• Max. SCSI tags per device shows the maximum number of SCSI tags that the
interface can support for each device accessible through the storage port.
• Fibre Channel frame size shows the largest FC frame the storage port can receive
or transmit.
• SRAM parity available shows whether the port supports static random access
memory (SRAM) parity bits. Valid values are Yes, parity bits are available, or No,
parity bits are not available.
The following example shows details of a file processing port.
g10r9 G10V5 diag> port show detail fp1.1

Port identifier : fp1.1
Admin State : ENABLED
Operational State : DOWN
Auto negotiation : ENABLED
Frame size : 1500
MAC address : 00:07:34:02:00:11
In this example, file processing port 0 is displayed. The detailed information displayed
consists of the following:
• Port Identifier is file processing port name for which details are displayed.
• Admin State shows the state of the port, which can be Enabled or Disabled.
• Operational State shows the operational state of the port. Valid values are UP
when the link is active and operating correctly, or DOWN when the link is inactive
or not operating correctly.
• Frame Size shows the largest frame the file processing port can receive or transmit.
• MAC Address is the hardware address of the device associated with the port.

19-14
Related Commands
port show all Shows information about all ports.
Port Show Loadstats
Synopsis
port show loadstats [-i SECONDS]
Description
With the port show loadstats command you can view the amount of traffic that occurs
on all file processing ports. This command applies to the file processing ports only and
gathers the following statistics:
• The speed, measured in packets per second, of transmitted and received traffic.
This statistic uses either K (1024 bytes) or M (1024 ^2 bytes) to indicate a large
value of packets per second.
• The throughput, measured in bytes per second, of transmitted and received traffic.
This statistic uses either K (1024 bytes) or M (1024 ^2 bytes) to indicate a large
value of bytes per second.
The port show loadstats command is run in the NAS Gateway context. The command
tracks the file processing port usage on a port-by-port basis, and displays the output
iteratively for each port. By default, the command runs once per second for 5 seconds,
but with an optional argument you can set the length of the statistics-gathering
interval. While the command is running, you can stop gathering statistics by pressing
Ctrl + Z.
Options
-i SECONDS is an optional argument for specifying the time
interval at which statistics are displayed. During the interval,
statistics are displayed once per second. Type a value from 1 to
1000. The default interval is 5 seconds.

19-15
Example
eng40> port show loadstats -i 4

------------------------------------------------------
| Port | IN | OUT |
------------------------------------------------------
| | Pkts/s | Bytes/s | Pkts/s | Bytes/s |
------------------------------------------------------
| fp1.0 | 0 | 0 | 0 | 0 |
| fp1.1 | 0 | 0 | 0 | 0 |
| fp1.2 | 10 | 591 | 0 | 0 |
| fp1.3 | 10 | 591 | 0 | 0 |
-----------------------------------------------------|
| fp1.0 | 0 | 0 | 0 | 0 |
| fp1.1 | 0 | 0 | 0 | 0 |
| fp1.2 | 11 | 627 | 0 | 0 |
| fp1.3 | 11 | 627 | 0 | 0 |
-----------------------------------------------------|
| fp1.0 | 0 | 0 | 0 | 0 |
| fp1.1 | 0 | 0 | 0 | 0 |
| fp1.2 | 14 | 1.70K | 0 | 0 |
| fp1.3 | 14 | 1.70K | 0 | 0 |
------------------------------------------------------
| fp1.0 | 0 | 0 | 0 | 0 |
| fp1.1 | 0 | 0 | 0 | 0 |
| fp1.2 | 12 | 2.15K | 0 | 0 |
| fp1.3 | 12 | 2.15K | 0 | 0 |
In this example, the file processing port load statistics are displayed once per second
for a total of 4 seconds. The output shows all file processing port usage in packets per
second and bytes per second for ingress and egress traffic on the port.
Related Commands
Port Show Stats
Synopsis
port show stats PORT

19-16
Description
As storage ports and file processing ports become active, the NAS Gateway tracks the
performance and operation statistics for each port. Each port’s statistics are entered
into the port statistics table. To view port statistics, run the port show stats
command. The port statistics table contains general statistics about the port and traffic
on it.
Options
identifies the physical port that you want to enable. For example,
specifying sp.0 shows statistics for storage processing port 0, or
specifying fp.0 shows file processing port 0. The number of file
processing ports that you can enter depends on the model of
ONStor 2200 NAS Gateway that you have:
The maximum number of storage processing ports you can enter
is two. Type either sp.0 or sp.1.

19-17
Example
In the following example, statistics for storage processing port sp.1 are displayed.
cluster1-4> port show stats sp.1

link failure cnt : 0
loss-of-sync cnt : 1
loss-of-signal cnt : 1
invalid xmit word cnt : 0
invalid frame CRC cnt : 0
frames out cnt : 128

frames in cnt : 256
transport error cnt : 0
data underrun cnt : 98
SCSI read 6 cnt : 0

SCSI read 10 cnt : 30
SCSI write 6 cnt : 0
SCSI write 10 cnt : 0
SCSI other cnt : 98
SCSI reads : 30
SCSI writes : 0
SCSI reads bytes : 61440
SCSI writes bytes : 0
SCSI Avg tot Read Time : 10983
SCSI Avg FC Read Time : 10952
cluster1-4>
This part of the display contains the following link, frame, and SCSI counters for
operational statistics:
• link failure cnt shows how many link failures have occurred on the link supported
by the port.
• loss-of-sync cnt shows how many loss-of-synchronization failures have occurred
on the link supported by the port.
• loss-of-signal cnt shows the number of loss-of-signal errors that have occurred on
the link supported by the port.
• invalid xmit word cnt shows the number of invalid word errors that have occurred
during transmission on the link supported by the port.

19-18
• invalid frame CRC cnt shows the number of invalid CRC errors that have occurred
on the link supported by the port.
• frames out cnt shows the total number of frames transmitted from the port.
• frames in cnt shows the total number of frames received on the port.
• transport error cnt shows the total number of errors that occurred at the link’s
transport layer.
• data underrun cnt shows the number of data underrun errors on the link.
• SCSI read 6 shows the number of SCSI read 6 errors on the storage port.
• SCSI read 10 shows the number of SCSI read 10 errors on the storage port.
• SCSI write 6 shows the number of SCSI write 6 errors on the storage port.
• SCSI write 10 shows the number of SCSI write 10 errors on the storage port.
• SCSI other cnt shows the number of SCSI errors that are not counted in the other
SCSI error counters.
• SCSI reads shows the total number of read operations involving the SCSI layer on
the storage port.
• SCSI writes shows the total number of write operations involving the SCSI layer
on the storage port.
• SCSI read bytes shows the total number of bytes written to the SCSI layer on the
storage port.
• SCSI write bytes shows the total number of bytes read from the SCSI layer on the
storage port.
• SCSI Avg FC Read Time shows the average time of all read operations from the
time the command is taken from the file processor request, as seen at the Fibre
Channel location, to the time the data is sent back to the requester at the file
processing level.
• SCSI Avg FC Read Time shows the average time of all read operations from the
time the command is dispatched from the Fibre Channel location to the time it is
considered as completed by the Fibre Channel location.

19-19
Note!
Deducting SCSI Avg FC Read Time from SCSI Avg tot Read Time results in the
average Fibre Channel processing time.
cluster1-4 PUBSTEST> port show stats sp.1
FC response time (in usec):

more than 100000 300000 400000 900000
1350000 3200000
maxTime avgTime
-------------------------------------------------------------------
----------------
-----------------------
Read tot...... 0 0 0 0 0
0
17736 2670
Read FC ...... 0 0 0 0 0
0
17692 2625
Write tot..... 0 0 0 0 0
0
1024 848
Write FC...... 0 0 0 0 0
0
971 791
cluster1-4 PUBSTEST>
In this part of the port statistics table, the NAS Gateway tracks the performance of
operations on the storage port. The performance statistics show the response time, at
different microseconds, for read and write operations on the FC port.
• Read tot shows the following:
- The number of read operations that took longer than 100000, 300000,
400000, 900000, 1350000, and 3200000 microseconds.
- The maximum time a read operation has taken to complete.
- The average amount of time read operations have taken.
• Read FC shows the following:

19-20
- The number of Fibre Channel layer read operations that took longer
than 100000, 300000, 400000, 900000, 1350000, and 3200000
microseconds.
- The maximum time a FC read operation has taken to complete.
- The average amount of time FC read operations have taken.
• Write tot shows the following:
- The number of write operations that took longer than 100000, 300000,
400000, 900000, 1350000, and 3200000 microseconds.
- The maximum time a write operation has taken to complete.
- The average amount of time write operations have taken.
• Write FC shows the following:
- The number of FC layer write operations that took longer than 100000,
300000, 400000, 900000, 1350000, and 3200000 microseconds.
- The maximum time a FC write operation has taken to complete.
- The average amount of time FC write operations have taken.

19-21
The following example shows statistics for file processing port 0.
cluster1-4 PUBSTEST> port show stats fp.0

Receive side stats
==================
No packet desc : 0
No buffer : 0
Bad packet desc : 0
Multicast count : 0
Packet count : 5
Byte count : 210
Slow path count : 0
Fast path count : 0
Packet verify errors : 0
Port down errors : 0
No LPort errors : 0
H/W Bad IP ver : 0
H/W Bad IP csum : 0
H/W Bad TCP/UDP csum : 0
H/W Bad IP header len : 0
H/W Bad TCP header len : 0
H/W Unrecognized error : 0
H/W Bad classification : 0
H/W Bad reasembly csum : 0
H/W Bad packet length: 0
H/W Bad header offsets: 0
This part of the display shows the following receive-side statistics for file processing
port 0:
• No packet desc shows the number of packets received that did not contain packet
descriptors.
• No buffer shows the number of packets dropped due to lack of buffer resource.
• Bad packet desc shows the number of packets with of malformed or corrupted
packet descriptors.
• Multicast count shows the number of multicast bits set in the destination address
header of the packet.
• Packet count shows the number of packets received.
• Byte count shows the number of bytes received.

19-22
• Slow path count shows the number of packets sent through full transmission
control (TCP/IP) stack.
• Fast path count shows the number of packets sent through user datagram protocol
(UDP) and bypassed full TCP/IP stack.
• Packet verify errors shows the number of packets that failed verification on
receipt.
• Port down errors shows the number of times a packet arrived for that port, while
the port was down.
• No LPort errors shows the number of times a packet arrived when the logical port
was not yet configured.
• Packet across CODs shows the number of packets across CODs.
• H/W Bad IP ver shows the number of bad H/W IP versions.
• H/W Bad IP csum shows the number of bad H/W IP checksums.
• H/W Bad TCP/UDP csum shows the number of bad H/W TCP/UDP checksums.
• H/W Bad IP header len shows the number of H/W packets with corrupted IP
header length.
• H/W Bad TCP header len shows the number of H/W packets with corrupted TCP
header length.
• H/W Unrecognized error shows the number of H/W unrecognized (undefined)
errors on receipt.
• H/W Bad classification shows the number of packets not recognized by field
programmable gate-array (FPGA).
• H/W Bad reassembly csum shows the number of bad H/W reassembly checksums.
• H/W Bad packet length shows the number of times a packet of inappropriate
length, for example too short or too long is received.
• H/W Bad header offsets shows the number of times a badly composed IP/TCP/
UDP header from the hardware is received.

19-23
cluster1-4 PUBSTEST> port show stats fp.0

<<display continued...>>
Transmit side stats
===================
No packet desc : 0
No buffer : 0
Bad packet desc : 0
Multicast count : 0
Packet count : 4
Byte count : 328
Slow path count : 0
Fast path count : 0
Packet verify errors : 0
Port down errors : 0
No LPort errors : 0
H/W Bad IP ver : 0
H/W Bad IP csum : 0
H/W Bad TCP/UDP csum : 0
H/W Bad IP header len : 0
H/W Bad TCP header len : 0
H/W Unrecognized error : 0
H/W Bad classification : 0
H/W Bad reasembly csum : 0
This part of the display shows the following transmit-side statistics for file processing
port 0:
• No packet desc shows the number of packets not transmitted.
• No buffer shows the number of packets dropped due to lack of buffer resource.
• Bad packet desc shows the number of malformed or corrupted packets.
• Multicast count shows the number of multicast bits set in the destination address
header.
• Packet count shows the number of packets received.
• Byte count shows the number of bytes received.
• Slow path count shows the number of packets sent through full TCP/IP stack.
• Fast path count shows the number of packets sent through UDP and bypassed full
TCP/IP stack.

19-24
• Packet verify errors shows the number of packets that failed verification on
transmit.
• Port down errors shows the number of times a packet arrived for that port, while
the port was down.
• No LPort errors shows the number of times a packet arrived when the logical port
was not yet configured.
• H/W Bad IP ver shows the number of bad H/W IP versions.
• H/W Bad IP csum shows the number of bad H/W IP checksums.
• H/W Bad TCP/UDP csum shows the number of bad H/W TCP/UDP checksums.
• H/W Bad IP header len shows the number of H/W packets with corrupted IP
header length.
• H/W Bad TCP header len shows the number of H/W packets with corrupted TCP
header length.
• H/W Unrecognized error shows the number of H/W unrecognized (undefined)
errors on receive.
• H/W Bad classification shows the number of packets not recognized by FPGA.
• H/W Bad reassembly csum shows the number of H/W bad reassembly checksums.
Related Commands
port show detail Shows detailed information about a port.

Chapter 20: Privilege Commands
This chapter documents the following privileges commands:
• “Priv Add Allow” on page 20-2
• “Priv Add Deny” on page 20-8
• “Priv Delete Allow” on page 20-12
• “Priv Delete Deny” on page 20-15
• “Priv Show” on page 20-18

20-2
Priv Add Allow
Synopsis
priv add allow {user|group} IDENTITY PRIVILEGES cluster | vsvr
[VIRTUALSERVER]
Description
Administrative users and privileges are created by associating the administrator levels
shown in Table 20-1 with an existing user or group name. Administrative users
administer the ONStor™ NAS Gateway
Table 20-1 : Admin privileges for NAS Gateway management
Admin Privilege Scope Allowed Operations
Cluster Cluster Everything, access to cluster

and files, add NAS Gateways
to or delete them from a
cluster
Security Cluster, virtual server Privileges management, audit
managements, identity
mappings
Volume Cluster, virtual server Volume management (adding,
deleting, and setting
AutoGrow™ parameters),
mirror management, snapshot
management.
Storage Cluster Logical unit number (LUN),
RAID, and Tape management.

20-3
Table 20-1 : Admin privileges for NAS Gateway management (Continued)
Admin Privilege Scope Allowed Operations
Network Cluster, virtual server Domain management, virtual

server creation and
management, IP addresses,
common Internet file services
(CIFS) and network file
services (NFS) shares, and
network management
NDMP Cluster, virtual server Network data management
protocol (NDMP)
management and scheduling.
Quota Cluster, virtual server Management of tree, user, and
group quotas.
Login Cluster Logging on to a cluster, and
any node within it. With the
Login privilege, you can run
show commands to display
(but not change) information.
When you create the administrative user privilege, you can set it to allow or deny
operations in the file system. You are explicitly setting the privilege that allows an
administrative user to perform operations at a certain scope on the NAS Gateway.
You can create an administrative user and set allow privileges with the priv add
allow command. This command sets the parameters for an administrative user’s
allowed operations at a specific level of control.

20-4
In addition to the administrative roles in Table 20-2, you can configure end users with
specific file-level execution permissions with the priv add allow command.
Table 20-2 shows the file permissions that you can assign.
Table 20-2 : Exec privileges for file operations
Privilege Scope Allowed Operation
Security Cluster, virtual server Enabling or disabling file-

level audit management,
manipulating system
access control lists
(SACLs)
Backup Cluster, virtual server File-level backup
execution, read any file or
directory
Restore Cluster, virtual server File-level restore
execution, read, write, or
delete any file or
directory.
Take ownership Cluster, virtual server Take ownership of a file,
change owner of any file
or directory
Traverse Cluster, virtual server Traverse directory,
request change
notification
These permissions mirror Windows-based privileges. These privileges apply to a

user’s rights to change objects in the file system.
When you create the user privilege, you can set it to allow or deny operations in the
file system. When you create an allow privilege, you are explicitly setting the privilege
that allows a user to perform operations at a certain scope in the file system.

20-5
You can create a user and set allow privileges with the priv add allow command.
This command sets the parameters for a user’s allowed operations at a specific level of
control.
Note!
If you want to start the ONStor VirusScan applet from any user account, you
need to configure that user account with BACKUP and RESTORE privileges
because the VirusScan applet needs to access files in read/write mode in the
virtual server. The scope of the privilege can be either VIRTUAL SERVER or
CLUSTER.

20-6
Options
Table 20-3 : Options for the priv add allow command
user|group A choice list that interacts with the IDENTITY

argument to specify the name of the user or
group. For example, if you specify user, the
IDENTITY argument names the user, and if you
specify group, the IDENTITY argument names
the group.
IDENTITY An alphanumeric character string that
specifies the name of the user or group for
which you are adding a privilege definition.
The maximum identity string size needs to be
congruent with the string size supported
through the domain. For example, 15
characters for a NetBIOS name or 64 for a
Windows domain.
This argument works in combination with the
user|group argument to specify the name of a
user or group. Type the identity as one of the
following:
• WindowsDomainName\UserName, for a
Windows user or group, for example,
spectrum\paulw.
• UserName@UNIXDomainName for a UNIX
user or group, for example,
paulw@spectrum.
• UserName@LDAPDomainName for an LDAP
ldap1@ldapdomain1
• A local user account, which you can configure
through the useraccount commands.

20-7
Table 20-3 : Options for the priv add allow command (Continued)
PRIVILEGES One or more privileges that are assigned to the

user or group that you specified with the
previous two arguments. Type any single
privilege, or a comma-separated list of
multiple privileges assigned to the same user
or group. The following are valid privileges:
• cluster (administrative user privilege)
• security (administrative user privilege)
• backup (file-level user privilege)
• restore (file-level user privilege)
• take-ownership (file-level user privilege)
• traverse (file-level user privilege)
• login (administrative user privilege)
• volume (administrative user privilege)
• storage (administrative user privilege)
• network (administrative user privilege)
• quota (administrative user privilege)
• ndmp (administrative user privilege)
cluster | Specifies whether the privileges apply to the

vsvr cluster or to a virtual server. If you specify
[VIRTUALSERVER cluster, privileges apply to all virtual servers
] within that cluster. If you specify vsvr,
privileges apply to the virtual server. You can
specify the name of a virtual server to which
to apply privileges. If you don’t specify a
virtual server name, privileges apply to the
current virtual server.

20-8
Example
The following are examples of adding allow privileges
cluster1-4> priv add allow group "spectrum\domain admins" cluster

cluster
cluster1-4>
In this example, the group spectrum\domain admins is configured with cluster

administrator roles, and the scope of their authority is cluster wide.
cluster1-4> priv add allow user "spectrum\paulw"

backup,restore,traverse,takeownership vsvr “techpubs”
cluster1-4>
In this example, the user spectrum\paulw is configured with the file-level user rights
backup, restore, traverse, and take-ownership, and the scope of the user’s authority is
the virtual server techpubs. Therefore, the user paulw can work on any file on the
virtual server techpubs for any of the listed purposes.
Priv Add Deny
Synopsis
priv add deny {user|group} IDENTITY PRIVILEGE cluster | vsvr
[VIRTUALSERVER]
Description
Deny privileges are added to the NAS Gateway to enforce a limit on what an
administrative user can do. Deny privileges allow a restrictive scope of authority. For
example, through the use of the deny privilege, you can configure an administrator
who would have access to cluster-level operations, but not have access to a virtual
server.
When the NAS Gateway checks for privileges, it tests for deny rules before checking
for allow rules. If multiple arguments are specified for the same user or group, the
denial is checked first, and the denial is enforced first. Consequently, the NAS

20-9
Gateway disallows any listed deny privileges, even if a subsequent allow rule for the
same user or group allows the privileges. Through this sequence, you can configure
control over users, for example by denying privileges for a specific user who belongs
to a group that is allowed the privileges.

20-10
Options
Table 20-4 : Options for the priv add deny command

IDENTITY argument names the user, and if
you specify group, the IDENTITY argument
names the group.
which you are adding a privilege definition.
through the domain. For example, 15
Windows domain.
following:
• WindowsDomainName\UserName, for a
spectrum\paulw.
user or group., for example,
paulw@spectrum.
ldap1@ldapdomain1

20-11
Table 20-4 : Options for the priv add deny command (Continued)
PRIVILEGES One or more privileges that are assigned to the

privilege, or a comma-separated list for
cluster | Specifies whether the privileges apply to the

vsvr cluster or to a virtual server. If you specify
[VIRTUALSERVER cluster, privileges apply to all virtual servers
] within that cluster. If you specify vsvr,

20-12
Example
cluster1-4> priv add deny user "spectrum\paulw" backup, restore,

traverse, takeownership vsvr “techpubs”
cluster1-4>
In this example, the user spectrum\paulw is denied the file execution rights backup,
restore, traverse, and take-ownership, on the virtual server techpubs. Therefore, user
paulw cannot work on any file on the virtual server techpubs for any of the listed
purposes. If user paulw was configured as part of a group of administrators, this entry
would in combination with the group entry to define what paulw could do. For
example, if paulw is a member of domain admins and domain admins had cluster-wide
authority, with the entry listed above, paulw would have cluster-wide authority, but not
on the virtual server techpubs where user paulw would be disallowed to perform
admin tasks.
Priv Delete Allow
Synopsis
priv delete allow {user|group} IDENTITY PRIVILEGES cluster | vsvr
[VIRTUALSERVER]
Description
After an allow privilege is configured, you can delete it at any time by running the
priv delete allow command. This command allows you to delete any allow
privileges from a specified user or group. By deleting the allow privilege, the user or
group cannot use the allow privilege that you configured. However, if other rules
allow access, those rules are still in effect. For example, deleting a user’s allow vsvr
admin privilege removes the allow privileges for the user specifically. However, if the
user is configured as part of a group that also has the allow vsvr admin privilege, the
user can still perform virtual server tasks as part of the group.

20-13
Options
Table 20-5 : Options for the priv delete allow command

IDENTITY argument names the user, and if
you specify group, the IDENTITY argument
names the group.
which you are deleting a privilege definition.
through the domain., for example, 15
Windows domain.
following:
• WindowsDomainName\UserName for a
spectrum\paulw.
user or group, for example, paulw@spectrum.
ldap1@ldapdomain1

20-14
Table 20-5 : Options for the priv delete allow command (Continued)
PRIVILEGES One or more privileges that are deleted from

the user or group that you specified with the
privilege, or a comma-separated list for
cluster | vsvr Specifies whether the privileges apply to the

[VIRTUALSERVE cluster or to a virtual server. If you specify
R] cluster, privileges apply to all virtual server
within that cluster. If you specify vsvr,

20-15
Example
cluster1-4> priv delete allow user "spectrum\paulw" backup,

restore, traverse, takeownership vsvr “techpubs”
cluster1-4>
In this example, the user spectrum\paulw is denied the file execution rights backup,
restore, traverse, and take-ownership, on the virtual server techpubs. Therefore, user
paulw cannot work on any file on the virtual server techpubs for any of the listed
purposes. If user paulw was configured as part of a group of administrators, this entry
would in combination with the group entry to define what paulw could do. For
example, if paulw is a member of domain admins and domain admins had cluster-wide
authority, with the entry listed above, paulw would have cluster-wide authority, but not
on the virtual server techpubs where paulw would be disallowed to perform admin
tasks.
Priv Delete Deny
Synopsis
priv delete deny {user|group} IDENTITY PRIVILEGES cluster | vsvr
[VIRTUALSERVER]
Description
After a deny privilege is configured, you can delete it at any time by running the priv
delete deny command. This command allows you to delete the deny privilege from a
specified user or group. By deleting the deny privilege, the user or group cannot use
the deny privilege that you configured. However, if other rules deny access, those rules
are still in effect. For example, deleting a user’s deny vsvr admin privilege removes the
deny privileges for the user specifically. However, if the user is configured as part of a
group that also has the deny vsvr admin privilege, the user is still denied from
performing virtual server tasks as part of the group.

20-16
Options
Table 20-6 : Options for the priv delete deny command

IDENTITY argument names the user, and if you
specify group, the IDENTITY argument names the
group.
IDENTITY An alphanumeric character string that specifies
the name of the user or group for which you are
adding a privilege definition. The maximum
identity string size needs to be congruent with
the string size supported through the domain.
For example, 15 characters for a NetBIOS name
and 64 for a Windows domain.
following:
• WindowsDomainName\UserName for a
spectrum\paulw.
• UserName@UNIXDomainName for a UNIX user
or group, for example, paulw@spectrum.
ldap1@ldapdomain1

20-17
Table 20-6 : Options for the priv delete deny command (Continued)
PRIVILEGE One or more privileges that are deleted from the

privilege, or a comma-separated list for multiple
privileges assigned to the same user or group.
The following are valid privileges:
cluster | vsvr Specifies whether the privileges apply to the

[VIRTUALSERVER] cluster or to a virtual server. If you specify
cluster, privileges apply to all virtual server
within that cluster. If you specify vsvr, privileges
apply to the virtual server. You can specify the
name of a virtual server to which to apply
privileges. If you don’t specify a virtual server
name, privileges apply to the current virtual
server.

20-18
Example.
cluster1-4> priv delete deny user "spectrum\paulw" backup vsvr

“techpubs”
cluster1-4>
In this example, the user spectrum\paulw is deleted as a backup administrator on the

virtual server techpubs. Therefore, the user paulw is no longer denied performing
backup administration tasks on the virtual server techpubs. However, paulw could still
be denied backup administration tasks on techpubs if he is configured as part of a
group, such as domain admins or vsvr admins, or on other virtual servers if paulw is
configured with administrator or user rights on a different virtual server.
Priv Show
Synopsis
priv show cluster [-P Page Number PAGESIZE ]] Page Size
priv show v Page Size svr [VSVR_NAME] Page Number [-S]
Description
When allow and deny privileges are configured, they are listed in the privileges table.
This table contains the configured privileges and lists information about privileges for
either all virtual servers in the cluster or a specific virtual server.
You can filter the privileges table output by specifying the scope in which you want to
view the configured privileges. For example, you can include a virtual server name
when you specify the priv show command, and you will see all the privileges that are
configured on that virtual server. You can display the contents of the privileges table
by running the priv show command.

20-19
Options
Table 20-7 : Option for the priv show command
cluster | Specifies whether to display privileges

vsvr for all virtual servers in the cluster or for
[VIRTUALSERVER a specific virtual server. If you specify
] cluster, privileges for all virtual server
within that cluster display. If you specify
vsvr, privileges for the virtual server
display. You can specify the name of a
virtual server for which to display
privileges. If you don’t specify a virtual
server name, privileges for the current
virtual server display.
Page Size Page Size specifies to display the current
page by page size only.
Example
cluster1-4 PUBSTEST3> priv show

Identity Privileges Scope
paulw cluster cluster
tiamat volume volume pubstest
domain admins cluster cluster
In this example, the configured administrative users are displayed for the cluster that
contains the virtual server pubstest.
• Identity lists the user or group name that is configured as an administrator.
• Privileges lists the type of privilege the administrator has.
• Scope shows where the administrator has authority to run commands.

20-20

Chapter 21: Route Commands
This chapter documents the following route commands:
• “Route Add” on page 21-2
• “Route Delete” on page 21-4
• “Route Show” on page 21-7

21-2
Route Add
Synopsis
route add {net|default} [-a IPADDR/MASKLEN] -g IPADDR [-n NODE]
Description
Use the route add command to add static routes to the route table. Static routes are
manually configured so you need to specifically create and delete them. The ONStor™
NAS Gateway does not automatically age static routes out of the route table.
The route add command supports two different types of routes: network and default.
A network route leads to a specific network destination, such as a subnet. A default
route leads to a nonspecific network destination, and usually traverses a network to a
gateway router which, in turn, forwards the route to its next hop.

21-3
Options
Table 21-1 : Options for the route add command
net|default The type of static route

that you are adding: net
indicates a specific route,
and default indicates a
default route to a gateway.
-a IPADDR/MASKLEN If you are adding a
network route, specifies
the optional IP address
and mask bits of the
network to which you are
adding a static route. Type
the IP address in dotted
decimal notation, and
separate the mask bits
from the network address
with a forward slash (/),
for example,
120.148.11.191/24.
-g IPADDR The node address of the
gateway router. Type the
IP address in dotted
decimal notation, for
example, 12.128.129.101.
The gateway address is
required for network and
default routes.

21-4
Table 21-1 : Options for the route add command (Continued)

specifies the name of the
local node on which the
route is created. If you do
not supply a local node
name, the command runs
on the current NAS
Gateway.
Example
In the following example a default route is added.
cluster1-4> route add default -g 10.1.1.1

cluster1-4>
This route appears in the NAS Gateway’s route table as either 0.0.0.0/0 or default. The
gateway for the default route is added as 10.1.1.1.
In the following example a specific network route is added.
cluster1-4> route add net -g 10.1.1.32 -a 224.57.0.0/16

cluster1-4>
The specific route’s gateway is configured as 10.1.1.32, and the specific route that is
added is for 224.57.0.0 with a 16-bit subnet mask.
Route Delete
Synopsis
route delete {net|default} [-a IPADDR/MASKLEN] -g IPADDR [-n NODE]

21-5
Description
Use the route delete command to remove previously created static routes. Static
routes are manually configured, so you need to manually delete them. The NAS
Gateway does not automatically age static routes out of the route table.
The route delete command supports two different types of routes: network and
default. A network route leads to a specific network destination, such as a subnet. A
default route is a route that leads through a network to a gateway router which, in turn,
forwards the route to its next hop. You can delete both types of route with the route
delete command.

21-6
Options
Table 21-2 : Options for the route delete command
net|default Specifies the type of static

route that you are
deleting: net indicates a
specific route, and default
indicates a default route
to a gateway.
-a IPADDR/MASKLEN If you are deleting a
network route, this
argument specifies the
optional IP address and
mask bits of the route that
you are deleting. Type the
IP address in dotted
for example,
120.148.11.191/24.
-g IP The network address of
the gateway router. Type
decimal notation, for
example, 12.128.129.101.
The gateway address is
required for default
routes.

21-7
Table 21-2 : Options for the route delete command (Continued)

local node on which the
route is deleted.
Example
In the following example a default route is deleted from the NAS Gateway’s local
node.
cluster1-4> route delete default -g 10.1.1.32

cluster1-4>
When the default route is deleted, the local node can no longer route to unknown
destination by forwarding to a default gateway. A specific route to a specific
destination needs to exist in the route table.
In the following example a specific network route is deleted.
cluster1-4> route delete net -g 10.1.1.32 -a 224.57.0.0/16

cluster1-4>
In this example, the route to the 224.57.0.0 network is deleted along with the route’s
16-bit mask. The route is deleted from the NAS Gateway’s local node, and the
10.1.1.32 gateway is also being deleted.
Route Show
Synopsis
route show [-a IPADDR/MASKLEN] [-n NODE]

21-8
Description
Use the route show command to display the route table for a particular NAS Gateway
or for a virtual server. The route table is the central listing of all static routes
configured on the NAS Gateway or virtual server. With this command you can display
the entire route table, for a particular virtual server, or a single route by destination.
The route table contains two types of routes: network and default. A network route
leads to a specific network destination, such as a subnet or node address. A default
route leads through a network to a gateway router that, in turn, forwards the route to its
next hop.
command, the display shows information for the whole NAS Gateway. If you
are in the virtual server context, the display shows only the information for that
specific virtual server.

21-9
Options
Table 21-3 : Options for the route show command
-a IPADDR/MASKLEN An optional argument that

specifies the IP address
and mask bits of the route
you want to display. Type
for example,
120.148.11.191/24.
If you do not specify this
argument, all IP addresses
on the current node are
displayed.
local node on which to
display routes.

21-10
Example
The following example shows the entire route table for the NAS Gateway.
eng11> route show

route table
-------------------------------------------------------------
dest mask nexthop interface
-------------------------------------------------------------
0.0.0.0 0.0.0.0 10.2.0.1 sc1
10.2.0.0 255.255.0.0 0.0.0.0 sc1
eng11>
The following example shows the entire route table in a virtual server context.
g10r9 G10V5> route show

Route Table
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
0.0.0.0 0.0.0.0 10.3.0.1 eth0
10.3.0.0 255.255.0.0 0.0.0.0 eth0
10.3.0.1 255.255.255.255 0.0.0.0 eth0
10.3.0.253 255.255.255.255 0.0.0.0 eth0
10.3.2.76 255.255.255.255 0.0.0.0 eth0
10.3.5.20 255.255.255.255 0.0.0.0 eth0
10.3.15.10 255.255.255.255 0.0.0.0 eth0
10.3.15.13 255.255.255.255 0.0.0.0 eth0
10.3.15.15 255.255.255.255 0.0.0.0 eth0
10.3.15.33 255.255.255.255 0.0.0.0 eth0
10.3.28.51 255.255.255.255 0.0.0.0 eth0
10.3.28.52 255.255.255.255 0.0.0.0 eth0
10.3.28.54 255.255.255.255 0.0.0.0 eth0
10.3.34.1 255.255.255.255 0.0.0.0 eth0
10.3.34.17 255.255.255.255 0.0.0.0 eth0

21-11
The route table contains information about the known routes on the NAS Gateway. In
this example, the route table shows the following information:
• dest indicates the destination address to which routes exist.
• mask is the subnet mask for the destination route.
• nexthop indicates a gateway or route that is one hop away from the current NAS
Gateway and the next network entity that processes traffic on the route. A next hop
of 0.0.0.0 indicates that the next hop is the default route.
• interface indicates the name of the interface on which the route is supported.
The following example shows a specific route in the route table.
eng11> route show 192.168.192.0/24

route table
-------------------------------------------------------------
-------------------------------------------------------------
192.168.192.0 255.255.255.0 0.0.0.0 sc1
eng11>
In this example, the route table is displaying the information for a specific route. The
information displayed is the same as listing the entire route table. However, listing one
specific route facilitates viewing the route’s information because you do not need to
scan the entire table.
Related Commands
route delete Deletes a static route from any node within a
cluster.

21-12

Chapter 22: SCSI Commands
This chapter documents the following SCSI commands:
• “SCSI Discover Device” on page 22-2
• “SCSI Discover LUN” on page 22-4
• “SCSI Failback” on page 22-5
• “SCSI Move” on page 22-8
• “SCSI Release Tape” on page 22-10
• “SCSI Show All” on page 22-11
• “SCSI Show Arraywwn” on page 22-14
• “SCSI Show Configuration” on page 22-16
• “SCSI Show Detail” on page 22-17
• “SCSI Show Stats” on page 22-21

22-2
SCSI Discover Device
Synopsis
scsi discover device {all|sp.0|sp.1}
Description
Each storage processing port on the ONStor™ NAS Gateway is its own Fibre Channel
(FC) slice, so each port sees the storage area network (SAN) from a unique
perspective. Although the NAS Gateway automatically starts small computer system
interface (SCSI) functionality when the NAS Gateway’s storage processing controller
is started, you can manually invoke the SAN discovery routine on each port by
running the scsi discover device command. This command causes the storage port
to remain active while the SCSI drivers are restarted. The result is a rediscovery of the
logical unit numbers (LUNs) on the port. The neighbor devices on the NAS Gateway’s
port, and any devices attached to the NAS Gateway’s neighbor’s port are discovered
when discovery completes and the LUNs are reported to the NAS Gateway by its
neighbor (typically an FC switch).
You can use the all option to discover all ports and devices associated with the NAS
Gateway.
Note!
This command does not do a discovery for LUNs on devices that have not
changed state.
Use this command with caution because the discovery will halt I/O for a short
period of time.
Because each of the storage ports is its own FC slice, run the scsi discover
device command for each port on which you want to invoke the SCSI
discovery routine.

22-3
Options
Table 22-1 : Options for the scsi discover device command
all Discovers all ports and devices

associated with the NAS Gateway.
sp.0|sp.1 A choice list that indicates the storage
port on which you want to start the SCSI
discovery routine. Type one of the
following:
• sp.0 to discover the SAN topology on
the first FC storage port.
• sp.1 to discover the SAN topology on
the second FC storage port.
Example
cluster1-4> scsi discover device sp.1

cluster1-4>
In this example, the SAN topology is discovered on storage processing port 1.

Discovery can take some time. When the topology has been discovered, you can view
it by running the port show topology command on the storage processing port on
which you just invoked a discovery.
Related Commands
scsi show Shows a list of discovered devices.
scsi show detail Shows detailed information about the device.
scsi show stats Shows SCSI device statistics.

22-4
SCSI Discover LUN
Synopsis
scsi discover lun {all|WWN}
Description
Each storage port on the NAS Gateway is its own FC slice, so each port sees the SAN
from a unique perspective. Although the NAS Gateway automatically starts SCSI
functionality when the NAS Gateway is started, you can manually invoke the SAN
discovery routine on each port by running the scsi discover lun command. This
command causes the storage port to remain active while the SCSI drivers are restarted.
The result is a rediscovery of the LUNs on the port. The neighbor devices on the NAS
Gateway’s storage processing port, and any devices attached to the NAS Gateway’s
neighbor’s port are discovered when discovery completes and the LUNs are reported
to the NAS Gateway by its neighbor (typically an FC switch).
You can use the all option to discover all ports and devices associated with the NAS
Gateway. You can use the WWN option to discover LUNs on the specified device.
Note!
This command does not do a discovery for LUNs on devices that have not
changed state.
Use this command with caution because the discovery halts I/O for a short
period of time.

22-5
Options
Table 22-2 : Options for the scsi discover lun command
all Discovers all ports and devices

associated with the NAS Gateway.
WWN Discovers LUNs on the device with the
specified world wide name (WWN).
Example
cluster1-4> scsi discover lun all

cluster1-4>
In this example, the LUNs for all devices associated with the NAS Gateway are
discovered. Discovery can take some time. When the topology has been discovered,
you can view it by running the lun topology command on the storage processing
port on which you just invoked a discovery.
Related Commands
scsi show detail Shows detailed information about the device.
SCSI Failback
Synopsis
scsi failback {enable|disable}

22-6
Description
The NAS Gateway supports device path failback. You can set up any storage device, a
disk volume, or a tape, with multiple paths to the NAS Gateway to enable device path
failback. This feature is useful when a path failure occurs, and it helps to maintain load
balancing across the storage ports managed by the NAS Gateway.
When a device is opened for use, the storage device manager (SDM) selects a primary
path from a list of paths created during the device discovery process. The SDM
automatically saves the primary path to the device’s database record. The primary path
is selected based on port load balancing and array preferences that have been
configured by the array manufacturer.
Note!
You can manually override the automatic primary path selected with the scsi
move command.
If the primary path fails, the SDM automatically selects a new path from a list of
alternate paths and directs device I/O to that path. When the SDM moves the device
I/O to the new path, it attempts to maintain load balancing across the available NAS
Gateway ports.
When the primary path is available again, the SDM automatically detects the restored
primary path and reverts the device back to it. You also can move the device back to
the primary path manually by running the scsi move command.
Note!
Primary and alternate path configurations are lost during restarting of a device.
You can enable or disable the device path failback feature with the scsi failback
enable|disable command. This command enables or disables the device path
failback feature for all devices connected to a single NAS Gateway.

22-7
Options
Table 22-3 : Options for the scsi failback command
enable Enables the device path failback feature

for all devices connected to a single
NAS Gateway. By default, the device
path failback feature is enabled in the
NAS Gateway.
disable Disables the device path failback feature
for all devices connected to a single
NAS Gateway.
Example
In the following example, device failback is disabled.
eng11> scsi failback disable

Success. Path failback mode set to: DISABLE
eng11>
In the following example, device failback is enabled.
eng11> scsi failback enable

Success. Path failback mode set to: ENABLE
eng11>
Related Commands
scsi discover device Refresh the list of devices that can be discovered
to the storage services engine.
scsi discover lun Refresh the list of LUNs on a known device to
the storage services engine.

22-8
SCSI Move
Synopsis
scsi move DEVNANE {sp.0|sp.1}
Description
Use the scsi move command to move devices to specified storage ports. The NAS
Gateway supports the following operations with this command:
• Path failback in situations such as a link failure and recovery, or an array controller
failure and recovery. For example, assume the NAS Gateway has redundant
connections to a RAID through storage ports sp.0 and sp.1. In the event that the
link on sp.1 should fail, all the I/O would be supported on sp.0 until the error is
cleared. When the error condition is cleared, you can use the scsi move command
to rebalance the I/O among storage ports by explicitly assigning some devices
back to sp.1.
• Manual load balancing of device I/O across multiple ports. For example, if I/O for
configured LUNs is occurring through one storage port (for example, sp.0) you
can run the scsi move command to assign some of the LUNs to a different port
(for example, sp.1) to equalize the load across multiple ports so that the load is
balanced.
Note!
The port setting you assign through the scsi move command is not persistent,
so the port usage situation that you set is affected by a restart.

22-9
Options
Table 22-4 : Options for the scsi move command
DEVNAME The device name of the SAN device that

you want to move.
sp.0|sp.1 A choice list that indicates the storage
port to which you want to move the
device in DEVNAME. Type one of the
following:
• sp.0 to discover the SAN topology
on the first FC storage port.
• sp.1 to discover the SAN topology
on the second FC storage port.
Example.
cluster1-4> scsi move IBM_1110018463_0 sp.1

Move successful
cluster1-4>
In this example, the SAN device IBM_1110018463_0 is moved to the storage

processing port sp.1 on the NAS Gateway.
Related Commands
scsi discover device Refreshes the list of devices that can be
discovered to the storage services engine.
scsi show detail Shows detailed information about a device.

22-10
SCSI Release Tape
Synopsis
scsi release WWN LUN
Description
The NAS Gateway and other storage devices can reserve a tape device. When a
reservation occurs, the tape device becomes unavailable until the reservation is
cleared. One way to clear the reservation is through a release operation. Although
reservations and releases can occur automatically, the NAS Gateway supports a
manual release operation through software. You can use the manual release whenever
a tape drive becomes hung. You can force a release by running the scsi release
command if you are a cluster administrator.
Note!
You can obtain a device’s WWN and LUN ID by running the scsi show detail
command on a device name, for example: scsi show detail
IBM_ECV3HM0B_0. At the bottom of the resulting output, you will see the
WWN and LUN ID field. Use those values.

22-11
Options
Table 22-5 : Options for the scsi release command
WWN The world wide name of the storage

device that you want to release. Type the
device’s WWN.
LUN The LUN ID of the storage device that
you want to release. Type the device’s
LUN ID.
Example
eng31> scsi release 0x50050767190197b9 0

Release completed
eng31>
In this example, the reserved tape with WWN 0x50050767190197b9 LUN ID 0 is

released. After this command completes, the tape device becomes active and available
for read and write operations.
Related Commands
SCSI Show All
Synopsis
scsi show {all|disk|tape} [-P PAGENUMBER [-S PAGESIZE]]

22-12
Description
The scsi show command gives the list of devices discovered and initialized by the
storage services engine. The output of this command will give the following
information about each device:
• Device name
• Device type
• Model number
• Raid level (if available)
Additionally, the state of the device will be displayed indicating whether the device is
OPEN or CLOSED. If the device is in the OPEN state then the storage services engine
port currently being used to access the device is displayed.
Options
Table 22-6 : Option for the scsi show arraywwn command
all|disk|tape A choice list for filtering the command’s output by

one of the following options:
• all shows all discovered devices. This option
shows the entire storage devices list, including disk
and tape devices.
• disk shows the discovered disk devices only.
• tape shows the discovered tape devices only.
-P Specifies the page number to display.

-S specifies the number of SCSI devices to display.

22-13
Example
DEV DEV NAME TYPE MODEL
PORT STATE RAID
---- ------------------------------------------------------- --------- ------
---------- ---- --------- ----
1 ADIC_SG00169000_0 CHANGER Scalar
-24 - CLOSED 0
2 IBM_SG00169001_1 TAPE ULTRIU
M-TD3 - CLOSED 0
M-TD3 - CLOSED 0
4 STK_SG00169003_3 CHANGER L180
- CLOSED 0
M-TD2 - CLOSED 0
M-TD2 - CLOSED 0
7 STK_SG00169006_6 CHANGER L180
- CLOSED 0
This example shows the storage devices list. This storage devices list contains
information for all the SCSI-compliant disk devices that the NAS Gateway has
discovered.
• Dev shows the device ID number which is a numeric identifier for each device in
the list.
• Device Name lists the device name (WWN plus LUN ID) for each device that has
been masked. If a device has not been masked, this field contains the value N/A. If
a device has been masked, this field contains the device name of the device.
• Type shows the type of device that has been discovered. Valid values are DISK or
TAPE.
• Model shows the manufacturer model number for each device.
• Port shows the port number on which the device was discovered. If the device is in
the CLOSED state, no value is displayed. If the device is in the OPEN state, the
port number is displayed.
• State shows the operational state of the device. Valid values are CLOSED or
OPEN.
• RAID shows the configured RAID level for the device. If the device is in the
CLOSED state, no RAID level is displayed. If the device is in the OPEN state, the
configured RAID level is displayed. Valid values are 0, 1, 0+1, 3, and 5.

22-14
Related Commands
scsi show stats Shows SCSI device statistics
SCSI Show Arraywwn
Synopsis
scsi show arraywwn [-P PAGENUMBER [-S PAGESIZE]]
Description
The scsi show arraywwn [-P PAGENUMBER [-S PAGESIZE]] command
is used to display list of SCSI devices and Controller port WWN through which these
SCSI device was discovered by NAS Gateway.
Options
Table 22-7 : Option for the scsi show arraywwn command
-P specifies the page

-S specifies the page size in number of records to
display.

22-15
Example
eng57> scsi show arraywwn
DEV DEV NAME WWN

---- ------------------------------------------------------- ----
---------------------
1 MYLEX_20000080e5125d4b_0
21000cc002004abd
2 MYLEX_20000080e5125d4b_1
21000cc002004abd
3 MYLEX_20000080e5125d4b_2
21000cc002004abd
4 MYLEX_20000080e5125d4b_3
21000cc002004abd
5 MYLEX_20000080e5125d4b_4
21000cc002004abd
6 MYLEX_20000080e5125d4b_5
21000cc002004abd
7 MYLEX_20000080e5125d4b_6
21000cc002004abd
8 MYLEX_20000080e5125d4b_7
21000cc002004abd
9 MYLEX_20000080e5125d4b_8
21000cc002004abd
10 MYLEX_20000080e5125d4b_9
21000cc002004abd
11 MYLEX_20000080e5125d4b_10
21000cc002004abd
12 MYLEX_20000080e5125d4b_11
21000cc002004abd
13 LSI_E4600A_R46_eng57_core
200200a0b80f52cc 200300a0b80f52cc
14 LSI_E4600A_R46_eng57_mgmt
200200a0b80f52cc 200300a0b80f52cc
15 MYLEX_20000080e5125d4b_12
21000cc002004abd
16 MYLEX_20000080e5125d4b_13
21000cc002004abd
17 MYLEX_20000080e5125d4b_14
21000cc002004abd
18 MYLEX_20000080e5125d4b_15
21000cc002004abd
19 MYLEX_20000080e5125d4b_16
21000cc002004abd
[Enter or q-Quit]:

22-16
Related Commands
scsi show Displays list of scsi devices.
scsi show configuration Shows SCSI configuration
scsi show stats Shows SCSI device statistics
SCSI Show Configuration
Synopsis
scsi show config
Description
You can use the scsi show config command to display the current configuration for
the SCSI layer attributes. The display also shows open and discovered devices and
failback mode.
Example
eng11> scsi show config
SCSI Configuration and Status Information

-----------------------------------------
Path Fail-back Mode : DISABLED
Device Counts
-------------
Devices opened on port sp.0 : 0
Devices opened on port sp.1 : 0
Total number of devices discovered : 85
eng11>
The SCSI configuration output shows information about the status and open devices
accessible through the NAS Gateway’s FC ports:

22-17
• In the SCSI Configuration and Status Information section, the Path Fail-back
Mode field indicates the state of the device path failback feature. This setting is
controlled by the scsi failback command. Although the default is enabled, this
example shows the Path Fail-back Mode as being in disabled state.
• The Device Counts section shows the devices opened on the enumerated ports and
the total number of devices discovered.
Related Commands
scsi discover lun Refreshes the list of LUNs on a known device to
the storage services engine.
scsi show Shows a list of SCSI devices.
scsi show arraywwn Shows SCSI arraywwn information
scsi show detail Shows detailed information about a SCSI
device.
SCSI Show Detail
Synopsis
scsi show detail DEVNAME
Description
The NAS Gateway supports displaying details about the tape or disk devices it has
discovered. You display device details through the NAS Gateway’s SCSI protocol by
running the scsi show detail command. The detailed display shows product
information about the device, physical device information, and logical device
information.

22-18
Options
The DEVNAME variable is the name of the storage device for
which to display detailed information.
Example
In the following example, details of a disk LUN are displayed.
eng46> scsi show detail 3PARdata_0255_0003E0255
NAME : 3PARdata_0255_0003E0255
VENDOR : 3PARdata
MODEL : INSERV
PRODUCT ID : VV
TYPE : DISK
BLOCK CNT : 20971520
BLOCK SIZE : 512
CAPACITY : 10.737 GB
COMMAND QUEUE : 10
STATE : OPEN
PATH COUNT : 1
PATH LIST : PORT STATE PATH-ID TYPE WWN LUN
0 OPEN 0x80000004 Standard
0x23510002ac000255 0
PREFERRED PORT : sp.0

OPEN HANDLE COUNT : 1
OPEN HANDLE LIST : 0x01200000
eng46>
In this example, the scsi show detail command shows the following information:
• The disk’s device ID.
• The vendor’s name.
• The disk’s model name.
• The disk’s product ID.
• The type of product, which can be a disk, media changer, or tape.
• The LUN’s block count.
• The block size.

22-19
• The total capacity.

• Command queue is the maximum number of outstanding commands that the NAS
Gateway will issue to this LUN at any one time.
• The disk’s state, which is typically Open or Closed, but you can change it with
NAS Gateway command-line interface (CLI) commands.
• The path count, which is the number of open handles.
• The storage topology path list, which shows the NAS Gateway port, port state, and
path ID, and the WWN and LUN ID of the disk.
• Preferred Port show the preferred port configured for this LUN.
• Open handle count is a counter for open handles.
• Open handle list references the open paths to a LUN.
In the following example, details of a media changer are displayed.
eng31> scsi show detail STK_LLC02205345_0
NAME : STK_LLC02205345_0
VENDOR : STK
MODEL : L40
PRODUCT ID : L40
TYPE : CHANGER
STATE : CLOSED
PATH COUNT : 1
PATH LIST : PORT STATE PATH-ID WWN LUN
0 CLOSED 0x80000052 0x100000e0020204f7 0

OPEN HANDLE LIST :
eng31>
• The media changer’s device ID.
• The media changer’s manufacturer.
• The media changer’s model number.
• The media changer’s product ID number.

22-20
• The type of product.

• The media changer’s state, which you can change with NAS Gateway CLI
commands.
• The path count.
path ID, and the WWN and LUN ID of the media changer.
• The number of open handles.
• The list of handles that have been opened.
In the following example, details of a tape device are displayed.
eng31> scsi show detail SEAGATE_HM004Z6_1
NAME : SEAGATE_HM004Z6_1
VENDOR : SEAGATE
MODEL : ULTRIUM06242-XXX
PRODUCT ID : ULTRIUM06242-XXX
TYPE : TAPE
POSITION : blockno 0, fileno 0
STATE : CLOSED
PATH COUNT : 1
PATH LIST : PORT STATE PATH-ID WWN LUN
0 CLOSED 0x80001058 0x100000e0020204f7 1

OPEN HANDLE LIST :
eng31>
• The tape’s device ID.
• The tape’s manufacturer.
• The tape’s model number.
• The tape’s product ID number.
• The type of product.
• The current file, record, and block location of the tape head.

22-21
• The tape’s state, which you can change with NAS Gateway CLI commands.
• The path count.
path ID, and the WWN and LUN ID of the tape.
• The number of open handles.
• The list of handles that have been opened.
Related Commands
SCSI Show Stats
Synopsis
scsi show stats DEVNAME
Description
The NAS Gateway tracks the SCSI statistics for each identified SCSI device. The
statistics are counted in the SCSI statistics summary. The SCSI statistics summary
shows port-level frame information, and packet-level and operation-level information
about packets and read and write transactions.
Options
The DEVNAME variable is the device name (the WWN plus LUN
ID) of the device or device controller for which you want to
display SCSI performance statistics.

22-22
Example
cluster1-4> scsi show stats HITACHI_60432_23
Read Cur Rd Max Rd Write Cur Wr

Max Wr Gen IO Q HiPriO Q Other Q
PORT WWN/LUN Ops Op/Sec Op/Sec Ops Op/Sec
Op/Sec De
pth Depth Depth
---- ---------------------- ------ ------ ------ ------ ------
------ ----
----- -------- --------
0 0x500060e802ec1011:069 1 2 2 0 0
0
0 0 0
1 0x500060e802ec1012:069 0 0 0 0 0
0
0 0 0
Read Cur Rd Max Rd Write

Cur Wr Max Wr
PORT WWN/LUN Bytes Byte/Sec Byte/Sec Bytes
Byte/Sec Byte/Sec
---- ---------------------- ----------- -------- --------
-------------
--- -------- --------
0 0x500060e802ec1011:069 2048 4096 4096
0 0 0
1 0x500060e802ec1012:069 0 0 0
0 0 0
cluster1-4>
In this example, the SCSI statistics for a Hitachi disk array are displayed. The top half
of the SCSI statistics table shows the following information about read-write
operations and the I/O queue sizes:
• The Port ID on which transactions are read or written.
• The WWN/LUN ID to which the operations are reading or writing.
• The number of read operations completed for the device listed in WWN/LUN.
• The number of current read operations per second for the device listed in WWN/
LUN.

22-23
• The maximum number of read operations per second for the device listed in
WWN/LUN.
• The number of current write operations per second for the device listed in WWN/
LUN.
• The maximum number of write operations per second for the device listed in
WWN/LUN.
• The depth of the general I/O queue for the WWN/LUN.
Related Commands
scsi show detail Shows detailed information about a SCSI
device.

22-24

Chapter 23: Snapshot Commands
This chapter documents the following snapshot commands:
• “Snapshot Create” on page 23-2
• “Snapshot Delete” on page 23-4
• “Snapshot Disable” on page 23-6
• “Snapshot Enable” on page 23-7
• “Snapshot Pin” on page 23-8
• “Snapshot Rename” on page 23-10
• “Snapshot Revert” on page 23-13
• “Snapshot Schedule” on page 23-15
• “Snapshot Show” on page 23-18
• “Snapshot Unpin” on page 23-22

23-2
Snapshot Create
Synopsis
snapshot create VOLNAME SNAPNAME [-m]
Description
Use the snapshot create command to take snapshots of the file system at any time.
Unscheduled snapshots are called on-demand snapshots, and you can take them and
store them simultaneously with any scheduled snapshots on the ONStor™ NAS
Gateway. On-demand snapshots reside in the /.snapshots directory along with the
scheduled snapshots. When you take an on-demand snapshot, do not name the
snapshot any of the following names, which are reserved for scheduled snapshots:
• Monthly.x
• Weekly.x
• Hourly.x
• Daily.x

23-3
Options
Table 23-1 : Options for the snapshot create command
VOLNAME The name of the volume on which to take the

on-demand snapshots.
SNAPNAME The name of the on-demand snapshot that
you are taking. Snapshot names can have up
to 31 alphanumeric characters. When naming
on-demand snapshots, always use the .ss
suffix to identify which files are snapshot
files.
-m This option creates the snapshot with the
name reserved for mirror snapshots. This
command should be used if the volume is
going to be replicated by array replication
and subsequently used as the source volume
for ONStor mirroring. The created snapshot
will be used as the mirror baseline.
Example
cluster1-4> snapshot create pubstest tester1.ss

cluster1-4>
In this example, an on-demand snapshot is taken on volume pubstest. The on-demand

snapshot is given a unique name that does not conflict with any scheduled snapshot
names. Although not required, the on-demand snapshot is given the .ss extension so
that it can be identified as a snapshot file.

23-4
Related Commands
snapshot show Shows a snapshot schedule or the usage of a
volume.
Snapshot Delete
Synopsis
snapshot delete VOLNAME SNAPNAME
Description
Use the snapshot delete command to remove any type of snapshot, either on-
demand or scheduled. When you delete a snapshot, the snapshot file is removed from
the /.snapshots directory. The NAS Gateway supports a maximum of 48 snapshots.
Scheduled snapshot files are numbered sequentially in a cycle from 0 to 47. When the
cycle completes, snapshot numbering starts again at 0. Therefore, if you delete a
snapshot file with a specified snapshot number, for example 21, from one cycle, the
next cycle will contain a snapshot 21, although the content of the snapshot might not
be the same as the content of snapshot 21 you deleted from the previous cycle.

23-5
Options
Table 23-2 : Options for the snapshot delete command
VOLNAME The name of the volume on which to remove snapshot.

SNAPNAME The name of the snapshot to delete. Snapshot names can have
up to 31 alphanumeric characters. Scheduled snapshot names
are typically:
• monthly.number.ss
• weekly.number.ss
• daily.number.ss
• hourly.number.ss
You can name on-demand snapshots anything you like.
Before deleting any snapshots, you can display the snapshots
directory,
/.snapshots, to verify which snapshot file you want to delete.
Example
cluster1-4> snapshot delete pubstest tester1.ss

cluster1-4>
In this example, the on-demand snapshot tester1.ss is deleted for volume pubstest.
Related Commands
snapshot show Shows a snapshot schedule or the usage of a
volume.
snapshot unpin Unpins the snapshot so that it can be deleted.

23-6
Snapshot Disable
Synopsis
snapshot disable VOLNAME
Description
By default, the snapshot scheduler is active, so when you configure a volume’s
snapshot schedule, the snapshots occur at the configured times. However, you can
disable the snapshot scheduler by running the snapshot disable command. When
the snapshot scheduler is disabled, the configured snapshot schedule remains intact. If
you reenable the snapshot scheduler for a volume, any configured snapshot schedule
becomes active again.
Note!
This command affects scheduled snapshots only. On-demand snapshots are not
affected by this command.
You can check the status of the snapshot scheduler by running the snapshot
show schedule command. If the snapshot scheduler is disabled, the output of
this command shows the following message:
**snapshot scheduling currently disabled for this volume**
If you attempt to modify the current snapshot schedule while the snapshot
scheduler is disabled, the following error message appears:
snapshot operation not allowed
Options
are disabling the configured snapshot schedule.

23-7
Example
cluster1-4> snapshot disable pubstest

cluster1-4>
In this example, the snapshot scheduler is disabled on the volume pubstest. While the
scheduler is disabled, you can still take on-demand snapshots. When the snapshot
scheduler is disabled the snapshot schedule for pubstest remains configured.
Therefore, when the snapshot scheduler is reenabled, the previously configured
snapshot schedule becomes active.
Related Commands
snapshot enable Enables the snapshot scheduling feature for a
volume.
Snapshot Enable
Synopsis
snapshot enable VOLNAME
Description
If you create a snapshot schedule the NAS Gateway adds the schedule to the
configuration file, but the schedule does not operate unless the snapshot scheduler has
been enabled. By default, the snapshot scheduler is enabled, so if you create a schedule
the snapshots automatically occur at the configured date and time. However, if the
snapshot scheduler becomes disabled, you can enable the scheduler by running the
snapshot enable command.

23-8
Note!
This command affects scheduled snapshots only. On-demand snapshots are not
affected by this command.
You can check the status of the snapshot scheduler by running the snapshot
show schedule command. If the snapshot scheduler is disabled, the output of
this command shows the following message:
**snapshot scheduling currently disabled for this volume**
If you attempt to modify the current snapshot schedule while the snapshot
scheduler is disabled, the following error message appears:
snapshot operation not allowed
Options
are enabling the configured snapshot schedule.
Example
cluster1-4> snapshot enable pubstest

cluster1-4>
In this example, the snapshot scheduler is enabled on the volume pubstest.
Related Commands
snapshot disable Disables the snapshot scheduling feature for a
volume.
Snapshot Pin
Synopsis
snapshot pin VOLNAME SNAPNAME

23-9
Description
Some applications on the NAS Gateway can cause deletion and cleanup of snapshots.
In addition, you might want to designate a snapshot that cannot be deleted. To specify
that a snapshot cannot be removed, the NAS Gateway supports pinning the snapshot.
When a snapshot is pinned, you cannot deleted it until you unpin it. You can pin a
snapshot by running the snapshot pin command.
You can pin snapshots regardless of whether they are on-demand or scheduled.
Snapshots are pinned by name. Some scheduled snapshots have reserved names. For
example, any snapshot named hourly, daily, or weekly is using a reserved name. You
cannot pin snapshots that use reserved names, unless you rename it.

23-10
Options
Table 23-3 : Options for the snapshot pin command
VOLNAME The name of the volume

on which you are pinning
the snapshot.
SNAPNAME The name of the snapshot
to pin. You cannot pin a
snapshot with a reserved
name which is any
snapshot name that starts
with hourly, daily, or
weekly.
Example
cluster1-4> snapshot pin techpubs bootup.ss

cluster1-4>
In this example, the snapshot bootup.ss is pinned on the volume techpubs. When the
snapshot pin command completes, you can not delete the snapshot bootup.ss until it
is manually unpinned.
Related Commands
Snapshot Rename
Synopsis
snapshot rename VOLNAME OLDNAME NEWNAME

23-11
Description
At any time, you can rename a snapshot regardless of whether it is an on-demand
snapshot or a scheduled snapshot by running the snapshot rename command. When
you rename the snapshot, no copy of that snapshot is created with a new name.
Instead, the existing snapshot is given a new name.
Note!
The NAS Gateway uses reserved names for some of its snapshots. If you are
renaming a snapshot, you cannot use any of the following names or you
command failure:
• hourly.x.ss, where x is a number.
• daily.y.ss, where y is a number.
• weekly.z.ss, where z is a number.

23-12
Options
Table 23-4 : Options for the snapshot rename command
VOLNAME The volume name where

the snapshot that you are
renaming is located.
OLDNAME The current name of the
snapshot. Type the name
of the existing snapshot
that you want to rename.
NEWNAME Specifies the new name of
the snapshot.
Example
cluster1-4> snapshot rename pubstest bootup.ss oldboot.ss

cluster1-4>
In this example, the snapshot bootup.ss is renamed to oldboot.ss on the volume

pubstest.
Related Commands
snapshot pin Pins a snapshot so that it cannot be removed.
snapshot show Shows a snapshot schedule or usage of a
volume.

23-13
Snapshot Revert
Synopsis
snapshot revert VOLNAME [-n SNAPNAME]
Description
Use the snapshot revert command to restore the live file system to a specified
snapshot. This command supports reverting the live file system to either a scheduled
snapshot or an on-demand snapshot. For reverting to scheduled snapshots, the
snapshot revert feature supports incremental and complete snapshots.
This command can be helpful for instances when the live file system is no longer
available or is beyond repair. For example, you could use this command if one of the
following occurs:
• Someone accidently deleted the entire live file system.
• Someone damaged the live file system, or an event corrupted the file system so
that even eek or fsck operations cannot fix the live file system.
The snapshot revert command is similar to restoring from network data
management protocol (NDMP). However, in some circumstances, the last NDMP
backup might have occurred so long ago that restore would be of little help. In such
circumstances, the snapshot revert command could be beneficial because the
interval between the file system damage and the last snapshot would be much less than
the difference between the last NDMP backup and the time of the file system damage.
For example, if the NDMP backup schedule causes a backup every other day, and the
snapshot schedule is set to occur every 4 hours, using the snapshot revert
command would reclaim hours of data that would otherwise be lost.
Note!
After the snapshot has been restored as the live file system, the NAS Gateway
retains the target snapshot as a standard snapshot. The snapshot is not deleted
when it has been restored as the new file system, and the NAS Gateway does
not take a duplicate snapshot of the new file system. Snapshots occur as
scheduled after a new file system has been created from a snapshot.

23-14
Options
Table 23-5 : Options for the snapshot revert command

that you are reverting to a
snapshot.
-n SNAPNAME An optional argument that
snapshot to be reverted to
the file system. If you
specify no SNAPNAME,
the NAS Gateway uses
the most recent snapshot
as the file system.
Example
cluster1-4> snapshot revert pubstest -n Hourly.ss

cluster1-4>
In this example, the snapshot hourly.ss is restored as the new file system on the
volume pubstest. The snapshot hourly.ss still exists as a snapshot in addition to
becoming the file system, and the NAS Gateway continues to take snapshots whenever
the configured snapshot schedule requires.
Related Commands
volume.

23-15
Snapshot Schedule
Synopsis
snapshot schedule VOLNAME [-w MAX_WEEKLY] [-d MAXDAILY][-h
MAXHOURLY][-l HOURS]
Description
Use the snapshot schedule command to schedule automatic creation and deletion of
snapshots for a volume. Weekly snapshots are taken Sunday at midnight. Daily
snapshots are taken at midnight. Total number of snapshots for a volume is limited to
48.
Note!
You must first enable snapshots before you can change the snapshot schedule.

23-16
Options
Table 23-6 : Options for the snapshot schedule command
VOLNAME The name of the volume on which

you are creating a snapshot schedule.
-w MAXWEEKLY The maximum number of weekly
snapshots to be retained. Any
nonzero number indicates that
weekly snapshots are scheduled.
-d MAXDAILY The maximum number of daily
nonzero number indicates that daily
snapshots are scheduled.
-h MAXHOURLY The maximum number of hourly
nonzero number indicates that
hourly snapshots are scheduled.
-l HOURS An optional list of hours to do the
hourly snapshots, separated with a
comma (,). If you do not specify this
argument, and you have configured
hourly snapshots with a nonzero
value, the hourly snapshots are taken
at the default schedule. Valid range is
1 to 24, where 1 is 1 a.m., and 24 is
midnight, and 12 is mid day.
At least one optional arguments should be provided.

Specify 0 to disable snapshot creation during that interval. The default snapshot
schedule is as follows:

23-17
snapshot schedule -w 0 -d 2 -h 8 -l 8,12,16,20

This means, schedule no weekly snapshots, schedule nightly snapshots keep up to 2 of
these, schedule hourly snapshots and keep up to 8 of these and schedule them for 8:00
am, noon, 4:00 pm and 8:00 pm.
Scheduled snapshots are created with default names as follows:
• weekly.n where n is an integer from 0 to MAXWEEKLY minus 1
• nightly.n where n is an integer from 0 to MAXDAILY minus 1
• hourly.n where n is an integer from 0 to MAXHOURLY minus 1
• n = 0 is the most recent snapshot. Snapshots will be renamed from n to
• n plus 1 when a new snapshot is created. The higher n value is, older the snapshot.
Example.
cluster1-4> snapshot schedule pubstest -w 6 -d 12 -h 12

-l 4,12,16,20
cluster1-4>
In this example, a snapshot schedule is configured for volume pubstest. The snapshot
schedule is for:
• A maximum of 6 weekly snapshots to be retained.
• A maximum of 12 daily snapshots to be retained.
• A maximum of 12 hourly snapshots to be retained.
• Hourly snapshots are schedule to occur at the listed times: 4 a.m., 12 p.m., 4 p.m.,
and 8 p.m.
Related Commands
snapshot enable Enables the snapshot scheduling feature for a
volume.
volume.

23-18
Snapshot Show
Synopsis
snapshot show VOLNAME {schedule|list|usage}
Description
Use the snapshot show command to display all the snapshots that have been taken for
a specific volume and the disk usage of snapshots. Through the disk usage, you can
determine whether the snapshot schedule is too frequent by the amount of disk space
that is consumed.

23-19
Options
Table 23-7 : Options for the snapshot show command
VOLNAME The name of the volume on

which you are displaying the
snapshot schedule or disk usage.
schedule The currently configured
snapshot schedule for the
specified volume.
list The list of snapshots for the
specified volume, including the
snapshot names, creation times,
and snapshot IDs.
Note!
A snapshot name prefixed by **
indicates a pinned snapshot. You
cannot delete pinned snapshots
unless you unpin them first with the
snapshot unpin command.
usage The type of snapshot information

you want to view. Specifying
usage shows the current disk
usage of snapshots.
Example
The following example shows the current snapshot schedule.
cluster1-4> snapshot show vol1 schedule

schedule
========
0 2 4 @8 12 16 20
cluster1-4>

23-20
This example shows the snapshot schedule for the volume vol1. If the snapshot
software is disabled for a volume, a message indicates that snapshot scheduling is
disabled. If no message appears, the snapshot software is enabled and the snapshot
schedule is active.
The snapshot schedule shows the following information:
• 0 (no) weekly snapshots are retained.
• 2 daily snapshots are retained.
• 4 hourly snapshots are retained.
• Snapshots are scheduled to be taken a the listed hours: 8 a.m., 12 p.m., 4 p.m., and
8 p.m.
The following example shows the disk usage consumed by snapshots.
cluster1-4> snapshot show vol1 usage

snapshot create time Id
======== =========== ==
hourly.0 Mon Jan 23 08:00:06 2006 10 / 2
Snap usage 9% 11079 MiB
Freed 6% 8001 MiB
Reclaimable 2% 3078 MiB
daily.0 Mon Jan 23 00:00:07 2006 9 / 2
Freed 6% 8001 MiB
hourly.1 Sun Jan 22 20:00:06 2006 8 / 2
Freed 5% 7001 MiB
hourly.2 Sun Jan 22 16:00:04 2006 17 / 1
Freed 5% 6615 MiB
hourly.3 Sun Jan 22 12:00:04 2006 16 / 1
Freed 4% 5666 MiB
Total size ...... 119871 Mib

In use ............ 24403 Mib
Available ......... 95468 Mib
cluster1-4>

23-21
The snapshot show command shows the following information for the volume vol1:
• snapshot is the list of every snapshot that is on the volume.
• % (percentage) is equal to the value in the snapshot field multiplied by 100%, then
divided by (this snapshot + file system space).
• Snap usage is the number of disk blocks in Mib used only by this snapshot. This
value does not include the blocks that are also used by other snapshots or by the
file system.
• Freed is the number of disk blocks in Mib that have been made available by the
snapshot.
• Reclaimable is the number of disk blocks in Mib that can be reclaimed for other
usage.
• create time is the date and time stamp of when the snapshot was taken.
Note!
In this display you can determine which snapshots are scheduled and which
snapshots are on-demand:
• The scheduled snapshots use their default names, for example, hourly.0
(the most recent snapshot) or hourly.1 (the next most recent snapshot).
• The on-demand snapshots do not have a default name, and use the .ss
extension. Use the .ss extension to indicate on-demand snapshot files.
• Total Blocks shows the aggregate number of 8k file system blocks in the file
system.
• Blocks Used shows the number of 8k file system blocks in the file system used for
snapshots.
• Available shows the number of 8k file system blocks in the file system that are
available for snapshots.
• The NOTES: section provides details about the statistics and calculations used in
the display.

23-22
The following example shows a list of snapshots for the specified volume.
cluster1-4> snapshot show vol1 list

snapshot create time Id
======== =========== ==
hourly.0 Mon Jan 23 08:00:06 2006 10 / 2
daily.0 Mon Jan 23 00:00:07 2006 9 / 2
hourly.1 Sun Jan 22 20:00:06 2006 8 / 2
hourly.2 Sun Jan 22 16:00:04 2006 17 / 1
hourly.3 Sun Jan 22 12:00:04 2006 16 / 1
Total size ...... 119871 Mib

In use ............ 24403 Mib
Available ......... 95468 Mibcluster1-4>
• snapshot is the list of every snapshot that is on the volume.

• create time is the date and time stamp of when the snapshot was taken.
• Id is the internal ID number of the snapshot.
Related Commands
volume show Shows volume information.
Snapshot Unpin
Synopsis
snapshot unpin VOLNAME SNAPNAME
Description
When a snapshot has been pinned, it is no longer eligible for deletion. You can unpin a
snapshot by running the snapshot unpin command. This command removes the pin
from a snapshot and allows you to delete it. You need to explicitly unpin a snapshot
before deleting it.

23-23
Options
Table 23-8 : Options for the snapshot unpin command

on which you are
unpinning the snapshot.
SNAPNAME The name of the snapshot
that you are unpinning.
You can unpin any
snapshot that has
previously been pinned.
You need to unpin a
pinned snapshot before
deleting it.
Example
cluster1-4> snapshot unpin techpubs bootup.ss

cluster1-4>
In this example, the snapshot bootup.ss is unpinned on the volume techpubs. When the
snapshot unpin command completes, you can delete the snapshot bootup.ss.
Related Commands
snapshot pin Pins a snapshot so that it cannot be removed.

23-24

Chapter 24: SNMP Commands
This chapter documents the following simple network management protocol (SNMP)
commands:
• “SNMP Add Community” on page 24-2
• “SNMP Add Trap” on page 24-3
• “SNMP Add Trapspec” on page 24-5
• “SNMP Delete All” on page 24-9
• “SNMP Delete Community” on page 24-10
• “SNMP Delete Trap” on page 24-10
• “SNMP Delete Trapspec” on page 24-12
• “SNMP Modify System Location or System Contact” on page 24-13
• “SNMP Show Configuration” on page 24-15

24-2
SNMP Add Community
Synopsis
snmp add cluster|VIRTUALSERVER community COMMUNITYSTRING [-w]
Description
Adds a read-only or read-write community string to the SNMP configuration of the
cluster entity or a virtual server. Community strings are utilized for SNMPv1 and
SNMPv2c protocols. Each configuration supports a maximum of 10 community
strings per string type. The community string type is assumed to be read-only unless
the -w option is specified making it read-write. Once a community string is added, the
configuration change becomes effective immediately. By default, SNMP service is
disabled since no community strings are initially defined.
Options
Table 24-1 : Options for the snmp add community command
COMMUNITYSTRING Specifies the community

string. It is a printable non-
white space character
string from 1 to 31
characters in length.
-w This option configures the
community string as read-
write. If this option is not
used, the community string
is assumed to be read-only.

24-3
Example
The following example adds the read-only community string teststring.
eng59> snmp add cluster community teststring

Community string (teststring) added
eng59>
The following example adds the read-write community string writestring.
eng59> snmp add cluster community writestring -w

Community string (writestring) added
eng59>
Related Commands
snmp delete community Deletes an SNMP community string.
SNMP Add Trap
Synopsis
snmp add cluster|VIRTUALSERVER trap HOST[:PORT] [-s SEVERITY] [-c
COMMUNITYSTRING] [-t TRAPSPEC]
Description
Adds a trap host recipient to the SNMP configuration of the cluster entity or a virtual
server. The trap host defines a client that is notified when an event (trap) of interest
occurs within the cluster or virtual server. Each configuration supports a maximum of
10 trap host recipients. If no trap specification is referenced, only generic and elog
system event traps of a severity that is equal to or greater than the severity threshold
level are sent to the trap host recipient. When one is referenced, it identifies specific
traps of interest to be sent by type rather than severity. Once a trap is added, the
configuration change becomes effective immediately.

24-4
Options
Table 24-2 : Options for the snmp add trap command
HOST Specifies the name of a host, or IP

address, that receives SNMP traps. It is
a printable non-white space character
string from 1 to 31 characters in length.
PORT Specifies the destination UDP port to
receive the traps. (default = 162)
-s SEVERITY Specifies the minimum severity level of
an elog event that is required to
generate a trap.(default = warning).
Severity levels:
info, notice, warning, error, critical,
alert, emergency
-c COMMUNITYSTRING Specifies the community string to
include when generating a trap.It is a
printable non-white space character
string from 1 to 31 characters in length.
(default = public)
-t TRAPSPEC Specifies the name of a trap
specification that defines specific traps
of interest that might be sent to a trap
recipient.

24-5
Example
The following example adds a trap for host 10.2.1.15 with the severity set to error and
a community string value of errorstring.
eng59> snmp add cluster trap 10.2.1.15 -s error -c errorstring

Trap Host Recipient (10.2.1.15:162) added
eng59>
Related Commands
elog level Sets the priority level of messages to be
processed.
snmp add trapspec Adds a trap specification for trap recipient.
snmp delete trap Deletes a trap host recipient.
SNMP Add Trapspec
Synopsis
snmp add cluster|VIRTUALSERVER trapspec TRAPSPEC TSLIST
Description
Adds a trap specification to the SNMP configuration of the cluster entity or a virtual
server. The trap specification defines specific traps of interest by type that may be sent
to a trap recipient. It consists of a list of trap numbers or range of trap numbers. The
traps may also be referenced by keywords that map to a group of traps related by
function. When a trap spec by the same name is already defined, the new trap spec
entries are appended to the existing list.
Each trap message includes various object parameters which provide additional
information for the trap event. The defined traps are listed in Table 24-5 on page 24-7
with their corresponding trap group and trap number.

24-6
Options
Table 24-3 : Options for snmp add trapspec command
TRAPSPEC Name of the trap specification. It is a

printable non-white space character string
from 1 to 31 characters in length.
TSLIST Specifies a list of trap numbers that might be
sent to the trap recipient. The list is comma
delimited and each entry is a trap number (0
- 32), trap range, or trap group keyword.
For virtual server and volume related traps, a
list of names may also be included to limit
the trap to virtual servers and volumes of
interest. The name list is comma delimited
and volume names may also be qualified by
the virtual server that manages it.
For example:
• 0, 2-9
• gen, env, node, port
• 13 (ge_vsvr), 16-17 (ons_vsvr)
• node, 29 (testvol1), 30
• gen, vsvr (gvsvr,ons_vsvr),
vol (gvsvr:vol1, vol2)
For acceptable values, see Table 24-4.

24-7
Table 24-4 : Trap Groups and Trap Numbers
Trap Groups Description Trap Numbers
gen Generic 0
elog Elog 1
env Environmental 2-7
node Node 8-9
port Port 10-11
vsvr Virtual Server 12-17
vol Volume 18-24
Table 24-5 : Trap Definitions
Trap Group/
Trap Name Trap Object Parameters
Number
Elog String (Format: elog/1

slot:cpu:appName:severity:eventDesc)
Power Supply OK (number=1.2) env/2
Power Supply Error (number=1,2) env/3
Fan OK (number=1,2 description) env/4
Fan Error (number=1,2 description) env/5
Temperature OK (tempValue, desc) - Temperature below env/6
maximum threshold

24-8
Table 24-5 : Trap Definitions
Trap Group/
Trap Name Trap Object Parameters
Number
Temperature Error (tempValue, desc) - Temperature env/7

exceeds maximum threshold
Node Up (nodeName) node/8
Node Down (nodeName) node/9
Port Up (portName=sp2.0-sp2.1, fp1.0-fp1.3) port/10
Port Down (portName=sp2.0-sp2.1, fp1.0-fp1.3) port/11
Virtual Server IP (vsvrName, ipAddress) vsvr/12
Interface Added
Virtual Server IP (vsvrName, ipAddress) vsvr/13
Interface Removed
Virtual Server Fail Over (vsvrName) vsvr/14
Virtual Server Disabled (vsvrName) vsvr/15
Virtual Server Up (vsvrName) vsvr/16
Virtual Server Down (vsvrName) vsvr/17
Volume Created (volName, vsvrName) vol/18
Volume Deleted (volName, vsvrName) vol/19
Volume Online (volName, vsvrName) vol/20
Volume Offline (volName, vsvrName) vol/21
Volume Modify (volName, vsvrName) vol/22
Volume Broken (volName, vsvrName) vol/23
Volume FsysAbort (volName, vsvrName) vol/24

24-9
Example
The following example adds trap spec txsp for trap groups vsvr and vol.
eng57> snmp add cluster trapspec txsp vsvr,vol

Trap Spec (txsp) added
eng57>
Related Commands
snmp add trap Adds a trap recipient.
snmp delete trapspec Deletes a trap spec for a trap recipient.
SNMP Delete All
Synopsis
snmp delete cluster|VIRTUALSERVER all
Description
Deletes the entire SNMP configuration for the cluster entity or a virtual server. Once
the SNMP configuration is deleted, the configuration change becomes effective
immediately.
Example
The following example deletes the entire SNMP configuration for the cluster.
eng57> snmp delete cluster all

Cluster SNMP Configuration deleted
eng57>
Related Commands
snmp delete community Deletes and SNMP community string.
snmp delete trap Deletes a trap host recipient.

24-10
snmp delete trapspec Deletes a trap specification or a specific entry

within a trap specification for a trap recipient.
SNMP Delete Community
Synopsis
snmp delete cluster|VIRTUALSERVER community COMMUNITYSTRING
Description
Deletes a community string from the SNMP configuration for the cluster entity or a
virtual server. Once a community string is deleted, the configuration change becomes
effective immediately.
Options
The COMMUNITYSTRING variable specifies a community string.
It is a printable non-white space character string from 1 to 31
Example
The following example deletes the community string teststring.
eng59> snmp delete cluster community teststring

Community string (teststring) deleted
eng59>
Related Commands
snmp add community Adds an SNMP community string.
SNMP Delete Trap
Synopsis
snmp delete cluster|VIRTUALSERVER trap HOST[:PORT]

24-11
Description
Deletes a trap host recipient from the SNMP configuration of the cluster entity or a
virtual server. Once a trap host is deleted, the configuration change becomes effective
immediately.
Options
Table 24-6 : Options for the snmp delete trap command
HOST Specifies the name of a

host or IP address that
receives SNMP traps from
the cluster. It is a printable
non-white space character
string from 1 to 31
PORT Specifies the destination
UDP port to receive the
SNMP traps. (default =
162)
Example
The following example deletes the trap recipient for IP address 10.2.1.15.
eng59> snmp delete cluster trap 10.2.1.15

Trap Recipient (10.2.1.15:162) deleted
eng59>
Related Commands
snmp add trap Adds a trap host recipient.

24-12
SNMP Delete Trapspec
Synopsis
snmp delete cluster|VIRTUALSERVER trapspec TRAPSPEC [TSLIST]
Description
Deletes a trap specification or specified entries within a trap specification from the
SNMP configuration for the cluster entity or a virtual server.
Options
Table 24-7 : Options for the snmp delete trapspec command
TRAPSPEC Name of the trap

specification. It is a
printable non-white space
character string from 1 to
31 characters in length.
TSLIST Trap specification list. A
comma-delimited list of
trap types. For example:
• 1
• env
• 14-15
• 29(testvol1)
• vsvr(gevsvr, ons_vsvr)

24-13
Example
In the following example, trap specification txsp is deleted.
eng57> snmp delete cluster trapspec txsp

Trap Spec (txsp) deleted
eng57>
Related Commands
snmp add trapspec Adds a trap specfication for a trap recipient.
snmp delete trap Deletes a trap recipient.
SNMP Modify System Location or System

Contact
Synopsis
snmp modify cluster|VIRTUALSERVER syslocation|syscontact STRING
Description
Changes the system contact or system location information that is reported by the
cluster entity or a virtual server when the corresponding MIB-II object is retrieved.
The NAS Gateway supports writing two specific variables, the system contact and
system location information, by setting the following MIB objects:
sysContact The name, email, or other contact
information for the administrator of
the NAS Gateway
sysLocation The physical location of the NAS
Gateway
By default, the sysContact object is set to support@onstor, and the sysLocation
object is set to ONStor for the cluster entity. However, through the snmp modify
command, you can set a more appropriate value for either object.

24-14
Note!
The default values are set for the cluster, not the virtual servers.
Options
Table 24-8 : Options for the snmp modify system command
syscontact | A choice list for the MIB

syslocation object that you’re setting
on the NAS Gateway’s
SNMP agent. You can
configure one MIB object
at a time.
STRING Specifies the string value
to report as the system
contact or location.
STRING may be from 1 to
63 characters in length.
If STRING contains
embedded space, STRING
must be enclosed in double
quotes.
Example
In the following example, the system location MIB object is updated.
eng57> snmp modify cluster syslocation "San Francisco"

MIB object (syslocation) value updated.
eng57>

24-15
In the following example, the system contact MIB object is updated.
eng57> snmp modify cluster syscontact support@onstor.com

MIB object (syscontact) value updated.
eng57>
Related Commands
snmp add community Adds an SNMP community string.
SNMP Show Configuration
Synopsis
snmp show cluster|VIRTUALSERVER
Description
Displays the SNMP configuration for the cluster entity or a virtual server. It includes
the read-only and read-write community strings used for SNMPv1 and SNMPv2c, trap
host recipients, trap specifications, and configurable MIB objects syscontact and
syslocation.
You can display the current SNMP configuration at any time by running the snmp
show command.

24-16
Example
eng57> snmp show cluster
SNMP Configuration: cluster
Read-Only community string:

public
Read-Write community string:

TechPubs
Trap Host Recipients:

Host Severity Community TrapSpec
10.2.1.1:162 warning public --None--
No Trap Specs defined.
Configurable MIB objects:

syscontact : support@onstor.com
syslocation: San Francisco
This example shows the current SNMP configuration for the cluster with the following
information:
• The name of the SNMP read-only community string
• The name of the SNMP read-write community string
• The trap host recipients
• The trap specifications
• The NAS Gateway’s system contact information.
• The NAS Gateway’s physical location.

Chapter 25: Stats Show Ldavg
Command
This chapter documents the stats show ldavg command.

25-2
Stats Show Ldavg
Synopsis
stats show ldavg
Description
Use the stats show ldavg command to see the amount of load on each CPU in the
main data path. The stats show ldavg command tracks information for the amount of
load on each of the following processors:
• The NCPU, which processes transport traffic
• The ACPU, which processes most of the CIFS and NFS traffic
• The FP1 and FP2 CPUs, which process file system traffic
• The FC CPU, which processes SCSI traffic
Note!
The SSC is not in the main data path, so the load on SSC CPUs is not
displayed.
For these processors, the load average displays a value between zero (0) and one (1)
that indicates how much loaded is on each processor. Zero indicates that the processors
has no load; one indicates that the processor is at full load; and a decimal value
between 0 and 1 indicates the percentage of load on the processors. For example, a
value of .60 indicates a 60% load.
The stats show ldavg command gathers the processor loads by using a polling model.
Each polling interval is approximately 1 to 2 seconds long. The stats show ldavg
command is useful for determining which CPUs are more busy or less busy for any
given user load.

25-3
Example
eng60> stats show ldavg

NCPU ACPU FP1 FP2 FC
0.100 0.331 0.292 0.304 0.121
eng60>
In this example, the CPU loads are as follows:

• The NCPU is at 10% load.
• The ACPU is at 33.1% load.
• The FP1 is at 29.2% load.
• The FP2 is at 30.4% load.
• The FC is at 12.1% load.

25-4

Chapter 26: Symbolic Link
Commands
This chapter documents the following symbolic link commands:
• “Symbolic Link Add” on page 26-2
• “Symbolic Link Delete” on page 26-5
• “Symbolic Link Show” on page 26-7

26-2
Symbolic Link Add
Synopsis
symlink add VOLUME REDIRECTEDPATH LINKTARGETTEXT
Description
Symbolic links can facilitate file access. A symbolic link is a mapping between a
representative path and an actual path to a volume or directory. For example, a
symbolic link for /pubs/projects/users/paulw/filter could be created as /filter.
However, in a mixed common Internet file services (CIFS) and network file services
(NFS) environment, problems can arise because NFS can process a file system path
that uses an absolute symbolic link, but CIFS cannot.
Note!
Symbolic link mappings are configured per volume, and the target of the
symbolic link always needs to lead to the same volume. You cannot create a
symbolic link whose target is on a different volume.
To allow CIFS clients to process absolute symbolic links, create a rule for mapping an
absolute symbolic link so that every CIFS client’s access request for that target can be
processed. When the client follows the symbolic link, security settings are applied to
the directory and target in the symbolic link as if the client was following a standard
path.
EverON™ software supports wide links on CIFS shares. This feature allows CIFS
clients access to shares on multiple volumes on multiple virtual servers or NAS
Gateways. The wide link feature operates similar to Microsoft’s distributed file system
(DFS). For more information regarding DFS, see www.microsoft.com. Wide links
combine multiple CIFS file systems into a single share across NAS Gateways and
virtual servers. By default, wide links are enabled.
Note!
Before you can use the wide link feature, you need to set up domain trusts. For
information on how to setup domain trusts, see www.microsoft.com. Wide
links can allow clients to follow shares to different domains only if the
domains are trusted.

26-3
The ONStor™ NAS Gateway does not support absolute symbolic links without a
symbolic link mapping. The mapping allows a CIFS client to follow a symbolic link to
a target that is supported on the same share only. Without a symbolic link mapping, a
target volume or directory is still available through the actual path.
If a symbolic link is configured to a target, the NAS Gateway always follows that link.
However, based on permissions, a user might not be able to open or change the target
of the symbolic link. In such cases, the NAS Gateway allows the client to traverse the
directory, but shows an empty directory if the permissions disallow the manipulation
of the object at the target of the symbolic link.
If multiple links are configured, the NAS Gateway matches to the longest path. By
default, a symbolic link is active when it is added to the NAS Gateway. The NAS
Gateway can support a total of 32 symbolic links in one path.
Note!
The symlink add command creates a symbolic link mapping rule for absolute
symbolic links only. Symbolic links are always available through NFS, and you
can create them through NFS without using this command. However, NFS-
created symbolic links might not be accessible through CIFS unless you map
the symbolic link with the symlink add command.

26-4
Options
Table 26-1 : Options for the symlink add command
VOLUME The volume on which the mapping

rule applies.
REDIRECTEDPATH The path the CIFS client should
follow when it encounters an
absolute symbolic link whose target
text starts with the text in the
LINKTARGETTEXT argument. The
REDIRECTPATH can be either of the
following:
• A path within the same volume of
the form /dir1/dir2/dir3/... This
form redirects the CIFS client to
a specific directory within the
same volume as the symbolic
link.
• A CIFS share path of the form
\\server\share\dir1\dir2\dir3\....
This form redirects the CIFS
client using Microsoft DFS to
any other CIFS server and share.
LINKTARGETTEXT An NFS-style path of the form /dir1/
dir2/... When a CIFS client
encounters a symbolic link whose
target text starts with
LINKTARGETTEXT, the client is
redirected to the path
REDIRECTEDPATH. The longest
matching rule is applied.

26-5
Example
eng49-1> symlink add \\apoc\data\linktest /mnt/apoc/linktest

eng49-1>
In this example, a wide link is being created from /mnt/apoc/linktest to

\\apoc\data\linktest. This rule redirects clients that request access to mnt/apoc/linktest
to the CIFS target \\apoc\data\linktest.
Related Commands
symlink delete Removes a symbolic link mapping rule from a
volume.
symlink show Shows the symbolic link mapping rules on a
volume.
Symbolic Link Delete
Synopsis
symlink delete VOLUME LINKTARGETTEXT
Description
You can remove a symbolic link mapping rule any time by running the symlink
delete command. This command deletes a mapping rule for CIFS when it accesses
an absolute NFS symbolic link. The rule to delete is identified by the symbolic link
target text.
When you remove a symbolic link mapping rule, the mapping and rule is deleted from
a specified volume. You need to remove symbolic link mapping rules individually.
Therefore, you need to run the symlink delete command once for each symbolic
link mapping rule you want to remove, and once on each volume. After a symbolic
link mapping rule is removed, you can still access the previously linked volume or
directory by navigating through the actual path.

26-6
EverON software supports wide links on CIFS shares. This feature allows CIFS clients
access to shares on multiple volumes on multiple virtual servers or NAS Gateways.
The wide link feature operates similar to Microsoft’s distributed file system (DFS).
For more information regarding DFS, see www.microsoft.com. Wide links combine
multiple CIFS file systems into a single share across NAS Gateways and virtual
servers. By default, wide links are enabled.
Note!
Options
Table 26-2 : Options for the symlink delete command
VOLUME the volume on which the mapping rule

applies.
LINKTARGETTEXT The symbolic link that you are deleting,
which is an NFS-style path of the form
/dir1/dir2/...
Example
eng31 PUBSTEST> symlink delete techpubs /vol1/docs/engineering/software

eng31 PUBSTEST>
In this example, the symbolic link is deleted from the volume techpubs.
Related Commands
symlink add Removes a symbolic link mapping rule from a
volume.

26-7
symlink show Shows the symbolic link mapping rules on a

volume.
Symbolic Link Show
Synopsis
symlink show VOLNAME
Description
You can display the symbolic link mappings configured on a volume by running the
symlink show command. This command shows the mapping rules for CIFS when it
accesses an absolute NFS symbolic link on a volume. This command displays
symbolic link information for each volume, so run this command on each volume if
you want to see all symbolic links configured.
EverON software supports wide links on CIFS shares. This feature allows CIFS clients
access to shares on multiple volumes on multiple virtual servers or NAS Gateways.
The wide link feature operates similar to Microsoft’s distributed file system (DFS).
For more information regarding DFS, see www.microsoft.com. Wide links combine
multiple CIFS file systems into a single share across NAS Gateways and virtual
servers. By default, wide links are enabled.
Note!
Options
VOLUME is the name of the volume on which the symbolic link
mapping rule applies.

26-8
Example
enng49-1> symlink show eng49-1

Link : /mnt/apoc/linktest
Target : \\apoc\data\linktest
engg49-1>
Related Commands
symlink add Adds a symbolic link mapping rule on a volume.
symlink delete Removes a symbolic link mapping rule from a
volume.

Chapter 27: System Commands
This chapter documents the following system commands:
• “System Compare” on page 27-3
• “System Config Copy” on page 27-5
• “System Config Reset” on page 27-6
• “System Config Restore” on page 27-8
• “System Copy All” on page 27-9
• “System Copy Init” on page 27-10
• “System Create Core Volume” on page 27-11
• “System Create Management Volume” on page 27-13
• “System Delete Core Volume” on page 27-19
• “System Disable Readahead” on page 27-21
• “System DNSconfigure Hosts” on page 27-22
• “System DNSconfigure Resolver” on page 27-23
• “System DNSconfigure Show” on page 27-26
• “System Enable Readahead” on page 27-27
• “System Get All” on page 27-28
• “System Get Config” on page 27-34
• “System Get Logs” on page 27-39
• “System Get Stats” on page 27-42
• “System Get TSE” on page 27-48
• “System Halt” on page 27-53
• “System Modify Core Dump Max Saved Files” on page 27-54
• “System Modify Core Dump Off” on page 27-55

27-2
• “System Modify Core Dump On” on page 27-56

• “System Modify Volumeexceptiondump” on page 27-57
• “System Ping” on page 27-60
• “System Reboot” on page 27-62
• “System Show Chassis” on page 27-64
• “System Show Core Dump” on page 27-66
• “System Show Node Name” on page 27-67
• “System Show Read Ahead Performance” on page 27-68
• “System Show Read Ahead State” on page 27-69
• “System Show Summary” on page 27-70
• “System Show Uptime” on page 27-73
• “System Show Username” on page 27-73
• “System Show Version” on page 27-74
• “System Time NTP Disable” on page 27-77
• “System Time NTP Server” on page 27-78
• “System Time Set” on page 27-80
• “System Time Show” on page 27-82
• “System Time Zone” on page 27-85
• “System Traceroute” on page 27-88
• “System Upgrade” on page 27-89
• “System Version” on page 27-93

27-3
System Compare
Synopsis
system compare LOCATION [-s]
Description
With the system compare command, you can compare the contents of the current
system software on the ONStor™ NAS Gateway’s active compact flash module to the
system software that resides on another location, for example a network file services
(NFS) or file transfer protocol (FTP) download server.

27-4
Options
Table 27-1 : Options for the system compare command
LOCATION The location of the distribution software.

For upgrading from an NFS or FTP
server, type the IP address of the server
and the download directory location
separated by a colon (:). For example, to
specify the new distribution software in
the directory /home/upgrade/R1.2.5-
081505.tar.gz on an FTP server with IP
address 168.192.3.4, you would run the
command as follows:
system compare ftp://
user:password@168.192.3.4/home/
upgrade/R1.2.5-081505.tar.gz.
-s An optional argument that specifies the
standby compact flash module that
contains the system software that you
want to compare to the software on the
NFS or FTP server.

27-5
Example
eng46> system compare ftp://upgrade:password@10.2.0.2/home/upgrade/

R1.3.0.OBC-0
92105.tar.gz
Downloading external system software distribution.
200 Type set to I.
Retrieving home/upgrade/R1.3.0.OBC-092105.tar.gz
remote: R1.3.0.OBC-092105.tar.gz
550 R1.3.0.OBC-092105.tar.gz: No such file or directory.
System Config Copy
Synopsis
system config copy
Description
At any time, you can copy the ONStor NAS Gateway’s existing configuration which
resides in the cluster database. Use the system config copy command to make a
backup copy of the cluster database.
The NAS Gateway supports the cluster database on one of two compact flash modules.
When you run the system config copy command, the cluster database is copied
from the presently active compact flash to the presently standby compact flash. The
cluster database copy has a unique name so that the copy is not mistaken for the
original.

27-6
Note!
This command is closely associated with the system config restore command,
which you use to restore the secondary system configuration that has been
saved through the system config copy command.
Example
cluster1-4> system config copy

Done.
cluster1-4>
In this example, the current configuration supported in the NAS Gateway’s cluster
database is copied to the NAS Gateway’s standby compact flash.
Related Commands
system config reset Loads the default system configuration
parameters for the NAS Gateway.
system config restore Loads the configuration from the secondary disk
that was most recently saved.
system copy all Makes a backup copy of all the current file
systems.
system copy init Initializes the secondary compact flash and
duplicates the file system from the primary to
the secondary compact flash.
System Config Reset
Synopsis
system config reset

27-7
Description
You can reset the NAS Gateway’s system configuration to an initial configuration by
running the system config reset. This command removes the existing cluster
database from compact flash so that you can reconfigure the NAS Gateway.
Note!
To reconfigure the NAS Gateway after deleting the cluster database, restart the
NAS Gateway. When the NAS Gateway restarts, it proceeds through the start
script as if it is configured for the first time. To configure the NAS Gateway,
follow the start script. It prompts you for required information. When you
finish the start script, the NAS Gateway is online and operating with a default
configuration that you can customize to your needs. You access this menu from
the ssc_console.
Warning!
You cannot change the node name of a NAS Gateway during
runtime. If you need to change the node name, you can run the
system config reset command to return to the start script where
you can reset or change the node name. This clears all
configuration and delete the cluster database.
Example
cluster1-4> system config reset

Done.
cluster1-4>
In this example, the NAS Gateway is reset to the default system configuration. When
this command completes, the current cluster database is deleted. After the NAS
Gateway restarts, you can configure the NAS Gateway as if this was the initial
configuration. Following the start script facilitates the configuration of the NAS
Gateway.
Related Commands
system config copy Copies the entire system configuration from the
primary disk to the secondary disk.

27-8
systems.
duplicates the file system from the primary to
the secondary compact flash.
System Config Restore
Synopsis
system config restore
Description
If you have a backup copy of the NAS Gateway’s system configuration, you can load
it into runtime by running the system config restore command. Use this command
from the secondary flash to restore the NAS Gateway from the most recently saved
cluster database.
After you restore the configuration, you can modify the active configuration to your
needs without affecting the saved backup copy of the system configuration.When you
restore the configuration, you do not delete the secondary copy of the cluster database.
It still resides on compact flash.
Note!
This command is closely associated with the system config copy command,
which you use to create a backup copy of the system configuration that can
then be restored through the system config restore command.

27-9
Example
cluster1-4> system config restore

Done.
cluster1-4>
In this example, the last saved configuration is restored on the NAS Gateway. When
this command completes, any backup copy of the cluster database on the standby
compact flash is copied to the active compact flash.
Related Commands
systems.
duplicates the file system from primary to
secondary compact flash.
System Copy All
Synopsis
system copy all [-i]
Description
The NAS Gateway contains all the runtime, configuration, and ROM files it needs on
the compact flash module that is installed on the system switch and controller (SSC).
The NAS Gateway supports copying all files, including the default configuration file
and custom configuration files on the NAS Gateway’s compact flash. You can copy all
configuration files to the standby compact flash by running the system copy all

27-10
command. You might experience a slight delay as the files are copied, but the system
remains online and serves read and write requests during any delay from the copying.
Options
-i is the option that initializes the secondary compact flash before
copying the contents of the primary compact flash to the
Example
cluster1-4> system copy all -i

cluster1-4>
In this example, all files on the NAS Gateway’s compact flash are copied.
Related Commands
duplicates the file system from primary to
System Copy Init
Synopsis
system copy init

27-11
Description
Use the system copy init command to initialize the secondary compact flash to
prepare it for duplicating the file system from the primary compact flash onto the
secondary disk. Initializing the standby compact flash module is analogous to
formatting a disk. It clears the compact flash of any contents and formats the disk with
file system structure.
Example
cluster1-4> system copy init

cluster1-4>
In this example, the standby compact flash module is initialized and file system
structure is added.
Related Commands
primary disk to the secondary disk
systems.
System Create Core Volume
Synopsis
system create corevolume VOLNAME [LUN]

27-12
Description
The core volume is the administrator-assigned space on disk for the NAS Gateway
memory core. If the NAS Gateway encounters an error, the core memory can be
flushed to the core volume. You can create a core volume by running the system
create corevolume command.
Note!
You can create only one corevolume per NAS Gateway and it must be created
under the management virtual server.
Options
Table 27-2 : Options for the system create corevolume command
VOLNAME The volume name that you are

designating as the core volume.
LUN An option for specifying a free LUN on
which to create the core volume. If you
don't specify a LUN, the NAS Gateway
takes the first available LUN. You can
view a list of available LUNs by running
the lun show disk command.
Example
cluster1-4> system create corevolume pubstest

cluster1-4>
In this example, the logical volume pubstest is created as the core volume.

27-13
Related Commands
system delete corevolume Deletes the coredump volume of the NAS
Gateway.
system show coredump Shows the core dump's configuration.
lun show disk Shows the list of devices in the cluster.
System Create Management Volume
Synopsis
system create mgmtVolume [-q HARDQUOTA][-s SOFTQUOTA][-g
MINAUTOGROW]
[-h HIGHWATERMARK][-l MINLUNSIZE][-u MAXLUNSIZE][-r RAIDLEVEL]
[-L LANGUAGE]
Description
The management volume exists in the management virtual server, which manages
specific NAS Gateway operations.
The management volume operates like any other volume, it can contain user data, and
is subject to volume-level usage conditions for volume AutoGrow™. You can create
the management volume through the system create mgmtVolume command.
When creating the management volume, consider the following:
• You need to configure the management volume within the context of the
management virtual server.
• The management volume always has the name string vol_mgmt_XXXX where XXXX
is the same numerical identifier as the management virtual server in which it is
configured. For example, in management virtual server vs_mgmt_4353, you would
expect to see management volume vol_mgmt_4353.
• You need to configure the management volume on an array, and you can configure
it with volume AutoGrow parameters at creation time.

27-14
• After you have created the management volume, you can modify it and its
AutoGrow parameters through the volume modify command. The management
volume operates like any other volume with regard to AutoGrow and usage
parameters, but it contains management data for the NAS Gateway as well as user
data.

27-15
Options
Table 27-3 : Options for the system create mgmtVolume command
ARRAY or The name of a RAID array from which

DEVICE the volume obtains LUNs, or a specific
device name. Through this argument you
can target a specific array or device
name for using LUNs to build the
volume based on whether you type an
array name or a device name:
• An array name is a string that
consists of a make and serial
number, for example, IBM_60432.
You can also use an asterisk as a
wildcard in the array name, for
example, I* to select all IBM arrays,
IBM_6* to select all IBM arrays
with a serial number that starts with
6, or IBM_60432_* to select any
LUN in the specific array
IBM_60432_.
• A device name is a string that
consists of make, serial number, and
LUN ID, for example,
IBM_60432_255.
-q HARDQUOTA An optional argument that specifies the
hard quota, which is a maximum size of
the volume. Type the volume’s absolute
maximum size in 1 megabytes blocks.
Set this argument to 0 (the default) if
you want unlimited growth for the
volume.

27-16
-s SOFTQUOTA An optional argument that specifies a

value in percentage of the
HARDQUOTA. The SOFTQUOTA
value is the threshold for automatic
volume space growth, so when the
specified SOFTQUOTA percentage is
met or exceeded, the volume space is
automatically grown. When the
SOFTQUOTA is met, the NAS Gateway
administrator is notified that allocated
disk space as a percentage of the hard
quota has reached this limit.
Specify the SOFTQUOTA value as a
percentage. The percentage you specify
is automatically calculated in actual disk
space. Specify a percentage between 1
and 100. If you specify zero (0), the soft
quota is disabled.
Default value: 0. Don’t monitor the soft
quota.
If the HARDQUOTA is 0, the
SOFTQUOTA will also be set to 0.

27-17
-g MINAUTOGROW An optional argument that specifies the

minimum growth size specified for the
volume. This parameter sets the smallest
amount of disk space to be added to the
volume if the automatic volume growth
feature is triggered and the NAS
Gateway determines that the volume
needs more disk space. This value is also
used as the default size of the volume
when it is initially created.
Type the value in megabytes. If you set
this value to zero (0), the NAS Gateway
gets the first available LUN and disk
space, regardless of size.
Default value: 500. The NAS Gateway
gets any amount of disk size larger than
500 megabytes.
-h HIGHWATERMARK An optional argument that specifies the
trigger that causes the volume space to
grow by the amount specified in the
MINAUTOGROW argument. Type the
value as a percentage of the total amount
of used space. The NAS Gateway uses
the percentage of total used space to
calculate the actual amount of disk space
required. Set the high watermark to a
value between 25% and 100%. If you set
the value to zero (0), automatic volume
space growth is disabled.
Default value: 0. No threshold is set for
automatic volume space growth.

27-18
-l MINLUNSIZE An optional argument that specifies the

smallest logical disk to be used in the
volume. A volume can comprise several
logical disks. This parameter sets the
smallest single disk to be used for
creating or resizing a volume. Type the
value in megabytes. If you set the value
to zero (0), the first available disk,
regardless of size, is used.
Default value: 0 (minimum disk size
limits are not enforced for LUN creation
or resizing).
-u MAXLUNSIZE An optional argument that specifies the
largest logical disk to be used in the
logical disks. This parameter sets the
largest single disk that to be used for
creating or resizing a volume. Type the
value in megabytes. If you set the value
to zero (0), any size of disk can be used.
Default value: 0 (minimum disk size
limits are not enforced for LUN creation
or resizing).
-r RAIDLEVEL An optional argument that specifies the
RAID level of the disks to be used while
creating the volume. If you leave this
argument blank, the NAS Gateway
ignores the RAID level, and uses
whichever LUN is available regardless
of its RAID level.

27-19
-L LANGUAGE An optional argument that defines the

valid characters in file names stored on
this volume. File names with characters
outside the valid list are not created and
permission is denied. The default value
is en_us. For a complete list of
supported language codes, run the help
volume create -L command.
Example
In the following example, a management volume is created with default values on the
virtual server..
eng93 VS_MGMT_520> system create mgmtVolume

LSI_E4600A_R46_eng93_mgmt
\
Done.
eng93 VS_MGMT_520>
Related Commands
volume create Creates a new volume in the current virtual
server.
volume show Shows one or more volumes.
volume delete Deletes a volume from a virtual server.
System Delete Core Volume
Synopsis
system delete corevolume VOLNAME [force]

27-20
Description
The core volume is the administrator-assigned space on disk for the NAS Gateway
memory core. You can delete the core volume from file system space by running the
system delete corevolume command.
Note!
While the core volume is deleted, the NAS Gateway cannot write core dump
information to disk.
Options
Table 27-4 : Options for the system delete corevolume command
VOLNAME The core volume that you are deleting.

When the core volume is deleted, the
NAS Gateway’s core dump is not
written to disk.
force An optional argument that removes the
entry of the core volume you are
deleting from the cluster database.
Example
cluster1-4> system delete corevolume pubstest

cluster1-4>
In this example, the core volume for the logical volume pubstest is deleted. When the
core volume is deleted, all core dumps that have been written to that volume are
deleted, and the disk space that was owned by the core volume is reclaimed for use by
the logical volume manager or the file system.

27-21
Related Commands
system create corevolume Creates a core dump volume for the NAS
Gateway.
System Disable Readahead
Synopsis
system disable readahead
Description
When read ahead caching is enabled, it can optimize the read ahead of data blocks into
the NAS Gateway data cache if the NAS Gateway is reading from an application that
uses sequential file reads. However, some applications perform random file reads, and
if the NAS Gateway’s read ahead caching is enabled, data cache thrashing can occur.
If read ahead caching has been enabled on the NAS Gateway, you can disable it by
running the system disable readahead command. By default, read ahead caching is
disabled.
Note!
You can determine whether read ahead caching needs to be enabled or disabled
by running the system show readahead state performance command. If an
excessive amount of cache misses is occurring, you can try enabling read ahead
caching for more optimized use of the cache. If the amount of cache misses is
acceptable, you can leave read ahead caching in its present state.
Example
cluster1-4> system disable readahead

cluster1-4>
In this example, the readahead caching for the NAS Gateway’s user data cache is
disabled.

27-22
Related Commands
system enable readahead Enables the data cache read ahead policy.
system show readahead performanceShows read ahead performance statistics.
system show readahead state Shows the current read ahead policy.
System DNSconfigure Hosts
Synopsis
system dnsconfigure hosts
Description
The NAS Gateway supports domain name service (DNS) name resolution for virtual
servers through a hosts database specific to each virtual server. You can configure a
mapping of IP addresses to symbolic device names by running the system
dnsconfigure hosts command.
DNS is configured on individual virtual servers. Therefore, wherever DNS is needed,

you need to configure it for each virtual server, including the management virtual
server. For example, for autosupport to work, you need to configure DNS for the
management virtual server. When you run this command from within the context of
the virtual server, it configures the hosts file for that virtual server. When you run this
command from outside the context of a virtual server, it configures the hosts file of the
NAS Gateway.
This command starts a text editor and allows you to enter one or more mappings for IP
addresses. When the text editor is closed, the mapping you created is saved and name
resolution can begin for the devices you added to the DNS hosts database.
The hosts file contains information regarding the known hosts on the network. For
each host, a single line is present with the following information:
• Internet address
• Official host name
• Aliases

27-23
Items in each line are separated by any number of blanks or tab characters. A hash
mark (#) indicates the beginning of a comment. In comment text, characters up to the
end of the line are not interpreted. Lines are limited to 1024 characters. Lines that
exceed the 1024 character limit are ignored.
Network addresses are specified in the dotted decimal notation. Host names may
contain any printable character other than a field delimiter, new line, or comment
character.
Example
eng31> system dnsconfigure hosts
192.168.192.34 PUBSTEST3 SAMOA
eng31>
Related Commands
system dnsconfigure resolver Configures the host name resolver.
vsvr set Sets the current virtual server context for all
future commands.
vsvr clear Clears the current virtual server context for all
future commands.
System DNSconfigure Resolver
Synopsis
system dnsconfigure resolver
Description
The NAS Gateway supports a DNS resolver configuration file that allows you to
configure different types of DNS-supported information. You can edit the resolver
configuration file for the DNS-supported information with the system dnsconfigure
resolver command. When you run this command from within the context of the

27-24
virtual server, it applies to the resolver configuration file of that virtual server. When
you run this command from outside the context of the virtual server, it applies to the
resolver configuration file of the NAS Gateway.
The system dnsconfigure resolver command starts a text editor and allows you
to type one or more mappings. When the text editor is closed, the mapping you created
is saved.
The resolver configuration file contains a list of keyword/value pairs that provides
various types of resolver information. Valid keywords for editing the resolver
configuration file are:
• nameserver — Specifies the IP address, in dotted decimal notation, of a name
server for the resolver to query. When the name server is found, the IP address of
that name server is displayed.
You can specify up to three name servers, one per keyword. The resolver queries them
in the order listed. If a query times out, the query algorithm continues to query each
subsequent name server until the list of specified name servers is completed. The
query algorithm then repeats the query of the name servers on the list for a maximum
number of times.
• domain — Specifies the local domain name. Most queries for names within the
domain accept short names relative to the local domain.
• lookup — Specifies which database to search and in which order to search. Valid
keywords are: bind and file.
- If you specify bind only, the resolver search uses the domain server to
search IP address-to-DNS name bindings.
- If you specify file only, the resolver searches the hosts database.
Note!
When you are resolving a host name within a virtual server context, the NAS
Gateway always checks the network information services ( NIS) domain for
that virtual server first. This is done automatically; you do not have to
explicitly specify this in your query.
If you specify neither the bind nor the file keyword with the lookup keyword, the
resolver searches both databases, first the bind database, then the hosts database.

27-25
• search — Specifies a search list for host-name lookup. The search list contains a
domain search path following the search keyword with spaces or tabs separating
the names. The search list function supports a maximum of six domains and a total
of 1024 characters. Most resolver queries search each component of the search
path in turn until a match is found.
Note!
The search process can take some time if the servers for the listed domains are
not local. Queries time out if no server is available for one of the domains.
You can use the system ping command with a host name to check whether you
configured the resolver correctly. When given a host name, the ping tool attempts to
resolve the name and prints the IP address of the host in dotted decimal notation if the
resolution is successful.
Example
eng11> system dnsconfigure resolver
nameserver 192.168.192.34
domain PUBSTEST3
lookup file bind
search SAMOA BALI FIJI
eng11>
Related Commands
system dnsconfigure hosts Configures the host name database.
future commands.
future commands.

27-26
System DNSconfigure Show
Synopsis
system dnsconfigure show
Description
When executed inside a virtual server context, the system dnsconfigure show
command displays the hosts file and resolver for that virtual server. When executed
outside a virtual server context, it displays the hosts file and resolver of the NAS
Gateway.
Example
eng93 VS99> system dnsconfigure show

Hosts configuration for virtual server: VS99
---------------------------------------
10.3.106.22 vs22
127.0.0.1 localhost.localdomain localhost
10.2.15.12 c12r15-rhel4.onstor.lab c12r15-rhel4 loghost
10.3.15.12 c12r15-rhel4-ge.onstor.lab c12r15-rhel4-ge
Name resolution configuration for virtual server: VS99
-------------------------------------------------
nameserver 10.2.0.7
nameserver 10.0.0.36
domain onstor.lab
search onstor.lab onstor.net agile.lab
eng93 VS99>
The previous example displays the hosts file and resolver for virtual server VS99.
Related Commands
system dnsconfigure hosts Configures the host name database.
system dnsconfigure resolver Configures the host name resolver.
future commands.

27-27
future commands.
System Enable Readahead
Synopsis
system enable readahead
Description
You can enable or disable read ahead data caching. Enabling read ahead data caching
increases the NAS Gateway’s read ahead throughput of data blocks for applications
that require sequential file readings. By default, the NAS Gateway’s read ahead
caching is disabled. You can enable it by running the system enable readahead
command.
Note!
You can determine whether read ahead caching needs to be enabled or disabled
by running the system show readahead state performance command. If an
excessive amount of cache misses is occurring, you can try enabling read ahead
caching for more optimized use of the cache. If the amount of cache misses is
acceptable, you can leave read ahead caching in its current state.
Example
cluster1-4> system enable readahead

cluster1-4>
In this example, the readahead caching for the NAS Gateway’s user data cache is
enabled.
Related Commands
system disable readahead Disables the data cache readahead policy.
system show readahead state Shows the current readahead policy.
system show readahead performanceShows readahead performance statistics.

27-28
System Get All
Synopsis
system get all [-n NUMBER] [-i INTERVAL] [-a] [-V VSVRNAME]
[-v VOLNAME] [-d DIRECTORY] [-c CASENUM]
Description
You can gather all system health information and log files into one file through the
system get all command. The system information gathered includes the following:
• All log files

• Pertinent system statistics
• The cluster database
• Current system configuration information
This information is placed into a directory on the target location. By default, the target
location is the management volume, but you can specify any other volume in the file
system. Regardless of the target location, you need to create the directory to which to
write the information. If the directory does not exist on the volume, the information
cannot be written to it. No requirement exists to keep the system health and user data
in separate directories, so the system health information can exist in the same directory
as user data.
If multiple copies of the information exist for the same date, a number is appended to
the end of the new file name to prevent overwriting of the existing file. For example, if
system_get_all already exists, and a new iteration of system_get_all occurs on the
same date, the new file is named system_get_all.1.
When the system get all command stops, a symbolic link is created to the most
recent system_get_all information. The symbolic link always points to the latest
iteration of the system_get_all information. Therefore, no matter how many iterations
of system_get_all exist in the target directory, you can always find the most recent
information by following the symbolic link. The symbolic link takes the format of
TYPE_NASGATEWAY, where TYPE is the type of system get command that was run,
and NASGATEWAY is the name of the NAS Gateway on which the command was run.

27-29
For example, all_ONStor1 indicates a symbolic link to the most recent instance of the
system get all information on the NAS Gateway ONStor1.

27-30
Options
Table 27-5 : Options for the system get all command
-n NUMBER An optional argument that specifies the

number of iterations in which the
command needs to gather all system
health information.
By default the current statistics are
gathered into the sfinfo.xml file. You
need the NUMBER and INTERVAL
arguments only if you want to gather
statistics at a certain interval over time.
For gathering statistics at a certain
interval over time, set the NUMBER
argument to at least 2.
-i INTERVAL An optional argument that specifies the
interval, in number of minutes, between
statistics gathering iterations. The
default value is 0 minutes, which causes
no wait between iterations. Type a
number greater than 0 to specify the
interval. For example, 60 for hourly
statistics gathering or 1440 for daily
statistics gathering.
-a An optional argument for gathering
statistics for all volumes on the current
NAS Gateway.
Note!
Because additional processing is required to
gather data from all volumes, this option
takes additional time for the command to
complete.

27-31
Table 27-5 : Options for the system get all command (Continued)
-V VSVRNAME An optional argument that specifies the

name of the target virtual server where
the information is saved. By default, the
information is written to the
management virtual server, but you can
specify a different virtual server with
this argument.
Note!
The target virtual server needs to exist and
be enabled for this command to run.
-v VOLNAME An optional argument that specifies the

name of the target volume where the
information is saved. By default, the
management volume, but you can
specify a different volume with this
argument.
Note!
If the target volume does not exist or is
offline, the command fails.
-d DIRECTORY An optional argument that specifies the

name of the target directory where the
information is saved. The default
directory is the root directory ( / ), but
you can specify a different directory
with this argument.
Note!
If the target directory does not exist or is

27-32
Table 27-5 : Options for the system get all command (Continued)
-c CASENUM An optional argument for uploading the

collected information to an ONStor
server via SSL, under a specific case
number. This argument specifies an
existing case number in the system.

27-33
Example
eng38> system get all

Copied /var/cron/tabs/root to vol_mgmt_34:/system_get_all,eng38,06-
01-04 /cron/tabs/root
Created directory 'vol_mgmt_34:/system_get_all,eng38,06-01-04/
crash'
Copying crash files..
Copied /var/crash/1.2 to vol_mgmt_34:/
system_get_all,eng38,06-01-04/cras h/1.2
Copied /var/crash/2.0.0.gz to vol_mgmt_34:/
system_get_all,eng38,06-01-04 /crash/2.0.0.gz
Copied /var/crash/locks to vol_mgmt_34:/
system_get_all,eng38,06-01-04/cr ash/locks
Copied /var/crash/locks.0.gz to vol_mgmt_34:/
system_get_all,eng38,06-01- 04/crash/locks.0.gz
Copied /var/crash/minfree to vol_mgmt_34:/
system_get_all,eng38,06-01-04/ crash/minfree
Created directory 'vol_mgmt_34:/system_get_all,eng38,06-01-04/
cores'
Copying core files..
Copying cluster DB..
Copied /usr/local/agile/conf/cluster.db.DB0 to vol_mgmt_34:/
system_get_all,eng38,06-01-04/cluster.db.DB0
eng38>
In this example the system information is copied to the vol_mgmt_34:/

system_get_all,eng38,06-01-04/cores directory on the management volume. To view
the system information open the log file.
Related Commands
system get config Gets configuration and basic statistics for this
NAS Gateway, an sfinfo.xml file that you can
print to the screen.

27-34
system get logs Collects and saves log files. This is a subset of
the information generated by the system get
tse command.
system get stats Collects and saves system and volume statistics
that you can print to the screen.
system get tse Gathers log and crash files that ONStor
Technical Support may need to diagnose a
problem. This is a subset of the information
generated by the system get all command.
System Get Config
Synopsis
system get config [-s | [-V VSVRNAME] [-v VOLNAME] [-d DIRECTORY]
[-c CASENUM]]
Description
You can gather system configuration information with the system get config
command. The output of this command is an XML file that is sent to a directory on a
target location, which can be either the management volume or a volume that you
specify through the command’s arguments. You need to create the target directory
before any information can be written to it.
Note!
Gathering configuration information from the entire NAS Gateway can take
some time.
No limit exists for how many copies of the system get config output you can keep.
As long as the directory has available space to write the output, the system get
config command posts output to the directory.
The NAS Gateway creates unique names so that you can keep all iterations of the
system get config commands. If multiple copies of the information exist for the
same date, a number is appended to the end of the new file name to prevent
overwriting of the existing file. For example, if system_get_config already exists, and a

27-35
new iteration of system_get_config occurs on the same date, the new file is named
system_get_config.1.
When the system get config command completes, a symbolic link is created to the
most recent system_get_config information. This symbolic link always points to the
latest iteration of configuration information. Therefore, no matter how many iterations
of configuration information exist in the target directory, you can always find the most
recent information by following the symbolic link. The symbolic link takes the format
of TYPE_NASGATEWAY, where TYPE is the type of system get command that was run,
For example, config_ONStor1 indicates a symbolic link to the most recent instance of
the system get config information on the ONStor1 NAS Gateway.

27-36
Options
Table 27-6 : Options for the system get config command
-s An optional argument that shows the

output on the management console. If
you do not display the output on the
management console, the system
configuration information is displayed
on either the management volume or the
location specified by the VSVRNAME,
VOLNAME, and DIRECTORY
arguments.
this argument.
Note!
be enabled for this command to complete.

name of the target volume to which to
save the information. By default, the
argument.
Note!

27-37
Table 27-6 : Options for the system get config command (Continued)

name of the target directory to which to
save the information. The default
with this argument.
Note!


27-38
Example
eng93 VS99> system get config

Looking for virtual servers and volumes..
Virtual server 'VS_MGMT_520' found, and it is Enabled.
Created directory 'vol_mgmt_520:/system_get_config,eng93,2007-01-
14'
Updating 'config_eng93' symlink to: '/config_eng93 ->
system_get_config,eng93,2007-01-14'
Querying the system
...................................................................
...................................................................
...................................................................
...................................................................
...................................... OK
Copying file sfinfo.xml.gz.. OK
eng93 VS99>
In this example the configuration information was written to an XML file in the
directory /tmp/sfinfo.xml to vol_mgmt_520:/system_get_config,eng93, 2007-01-14/
sfinfo.xml on the management volume. To view the information open the XML file.
Related Commands
system get all Gets all health, configuration, and statistical
information for this NAS Gateway, an sfinfo.xml
file that you can print to the screen.
tse command.
system get stats Collects and saves system and volume statistics
system get tse Gathers log and crash files that ONStor
Technical Support may need to diagnose a
problem. This is a subset of the information
generated by the system get all command.

27-39
System Get Logs
Synopsis
system get logs [-V VSVRNAME] [-v VOLNAME] [-d DIRECTORY] [-c
CASENUM]
Description
You can get NAS Gateway log files by running the system get logs command. These
log files contain system messages or error messages, which help to analyze
performance issues or debugging problems. The log files are gathered and made
available through a target directory, which can be either the management volume
default location or through a specified volume. You need to create the target directory
before any information can be written to it
No limit exists for how many copies of the system get logs output you can keep. As
long as the directory has available space to write the output, the system get logs
command will post output to the directory.
system get logs commands. If multiple copies of the information exist for the same
date, a number is appended to the end of the new file name to prevent overwriting of
the existing file. For example, if system_get_logs already exists, and a new iteration of
system_get_logs occurs on the same date, the new file is named system_get_logs.1.
When the system get logs command completes, a symbolic link is created to the
most recent system_get_logs information. This symbolic link always points to the latest
iteration of logs. Therefore, no matter how many iterations of logs exist in the target
directory, you can always find the most recent information by following the symbolic
link. The symbolic link takes the format of TYPE_NASGATEWAY, where TYPE is the
type of system get command that was run, and NASGATEWAY is the name of the NAS
Gateway on which the command was run. For example, logs_ONStor1 indicates a
symbolic link to the most recent instance of the system get logs information on the
ONStor1 NAS Gateway.

27-40
Options
Table 27-7 : Options for the system get logs command

this argument.
Note!

argument.
Note!

with this argument.
Note!

27-41
Table 27-7 : Options for the system get logs command (Continued)

Example
eng38> system get logs

Created directory 'vol_mgmt_34:/system_get_logs,eng38,06-01-04/
vscan'
Copying vscan log files..
Copied /var/log/vscan to vol_mgmt_34:/
system_get_logs,eng38,06-01-04/vscan/vscan
Created directory 'vol_mgmt_34:/system_get_logs,eng38,06-01-04/
cron'
Copying cron log files..
Copied /var/cron/log to vol_mgmt_34:/
system_get_logs,eng38,06-01-04/cron/log
Copied /var/cron/log.0.gz to vol_mgmt_34:/
system_get_logs,eng38,06-01-04/cron/log.0.gz
eng38>
In this example directories for the system logs were created on the management
volume. Open the logs to view the information.
Related Commands
system get all Get all health, configuration, and statistical

27-42
system get config Get configuration and basic statistical

system get stats Collect and save system and volume statistics
system get tse Gather log and crash files that ONStor Technical
Support may need to diagnose a problem. This is
a subset of the information generated by the
system get tse command.
System Get Stats
Synopsis
system get stats [-k] [-n NUMBER] [-i INTERVAL] [-a]
[-s | [-V VSVRNAME] [-v VOLNAME] [-d DIRECTORY] [-c CASENUM]]
Description
You can gather and save system and volume statistics by running the system get
stats command. This command gathers statistics for one or all volumes on a NAS
Gateway. The statistics are posted to a target directory, which can be the management
volume default location or a specified volume in the file system. You need to create
the target directory before information can be written to it.
No limit exists for how many copies of the system get stats output you can keep. As
long as the directory has available space to write the output, the system get stats
system get stats commands. If multiple copies of the information exist for the same
date, a number is appended to the end of the new file name to prevent the existing file
from being overwritten. For example, if system_get_stats already exists, and a new
iteration of system_get_stats occurs on the same date, the new system_get_stats file is
named system_get_stats.1.

27-43
When the system get stats iteration stops, a symbolic link is created to the most
recent system_get_stats information. This symbolic link always points to the latest
iteration of statistics. Therefore, no matter how many iterations of statistics exist in the
target directory, you can always find the most recent information by following the
symbolic link. The symbolic link takes the format of TYPE_NASGATEWAY, where TYPE
is the type of system get command that was run, and NASGATEWAY is the name of the
NAS Gateway on which the command was run. For example, stats_ONStor1 indicates a
symbolic link to the most recent instance of the system get stats information on the
ONStor1 NAS Gateway.
You can stop statistics gathering intervals in either of the following ways:
• If the previously configured statistics gathering interval is in progress, you can
stop it by running the system get stats command. For example, if you configure
statistics to run every hour, and an hourly interval is running, it stops when you run
the system get stats command again.
• If the current statistics gathering interval is in progress, you can stop it by using the
optional -k argument. This option is useful if you have started the statistics
gathering interval, but need to stop it before it completes. Each interval of statistics
is gathered into one file and put in the target location or displayed on the
management console. If you stop an iteration early, the system health information
already gathered has associated files in the target location, but those files contain
only the information that was gathered before the iteration was stopped. No
additional files are put in the target location after the iteration is stopped.

27-44
Options
Table 27-8 : Options for the system get stats command
-k An optional argument that stops any

inprogress statistics gathering
operations.
-n NUMBER An optional argument that specifies the
number of iterations in which the
command needs to gather the statistics
information. Use the NUMBER and
INTERVAL arguments only if you are
gathering statistics at a certain time
interval as follows:
• If you want to gather statistics once,
leave the NUMBER and INTERVAL
arguments blank.
• If you want to gather statistics
repeatedly over time, set NUMBER
to at least 2.
-i INTERVAL An optional argument that specifies the
interval, in number of minutes, between
statistics gathering iterations. The
default value is 0 minutes, which causes
no wait between iterations. Type a
number greater than 0 to specify the
interval. For example, 60 for hourly
statistics gathering or 1440 for daily
statistics gathering.

27-45
Table 27-8 : Options for the system get stats command (Continued)
-a An optional argument for gathering

statistics for all volumes on the current
NAS Gateway.
Note!
Because additional processing is required to
gather data from all volumes, this option
takes some time for the command to
complete.
-s An optional argument that shows the

output on the management console. If
you do not display the output on the
management console, the system
configuration information is displayed
on either the management volume or the
location specified by the VSVRNAME,
VOLNAME, and DIRECTORY
arguments.
this argument.
Note!

27-46
Table 27-8 : Options for the system get stats command (Continued)

argument.
Note!

with this argument.
Note!


27-47
Example
eng38> system get stats
Looking for virtual servers and volumes..

Virtual server 'VS_MGMT_34' found, and it is Enabled.
Created directory 'vol_mgmt_34:/system_get_stats,eng38,06-01-
04'
Updating 'stats_eng38' symlink to: '/stats_eng38 ->
system_get_stats,eng38,06-01-04'
Stats are now being gathered in the background to 'vol_mgmt_34:/

system_get_stats,eng38,06-01-04'
Use 'system get stats -k' to prematurely end the gathering of stats
in the background.
eng38>
In this example statistical information is gathered and written to a directory on the

management volume.
Related Commands
information for this NAS Gateway, sfinfo.xml
system get tse Gather log and crash files that technical support
may need to diagnose a problem. This is a subset
of the information generated by the system get
tse command.

27-48
System Get TSE
Synopsis
system get tse [-V VSVRNAME] [-v VOLNAME] [-d DIRECTORY] [-c
CASENUM]
Description
With the system get tse command you can gather of a subset of technical support
information that ONStor Technical Support engineers can use for troubleshooting. The
technical support engineering (TSE) information helps ONStor staff to gather
information on demand, without having to wait for an information gathering interval
to complete.
Note!
You need this command only if significant parts of the NAS Gateway are not
operating and you cannot run the system get config or system get
all commands.
The system get tse command obtains system information and places it in a directory
on the target location, which can be the management volume default location or a
specified volume in the file system. You need to create the directory before any
information can be written to it.
No limit exists for how many copies of the system get tse output you can keep. As
long as the directory has available space to write the output, the system get tse
system get tse commands. If multiple copies of the information exist for the same
date, a number is appended to the end of the new file name to prevent the existing file
from being overwritten. For example, if system_get_tse already exists, and a new
iteration of system_get_tse occurs on the same date, the new file is named
system_get_tse.1.
When the system get tse iteration stops, a symbolic link is created to the most recent
system_get_tse information. This symbolic link always points to the latest iteration of
the TSE information. Therefore, no matter how many iterations of TSE information

27-49
exist in the target directory, you can always find the most recent information by
following the symbolic link. The symbolic link takes the format of
TYPE_NASGATEWAY, where TYPE is the type of system get command that was run,
For example, tse_ONStor1 indicates a symbolic link to the most recent instance of the
system get tse information on the ONStor1 NAS Gateway.

27-50
Options
Table 27-9 : Options for the system get tse command

this argument.
Note!

argument.
Note!

with this argument.
Note!

27-51
Table 27-9 : Options for the system get tse command (Continued)


27-52
Example
eng38> system get tse

/root
Created directory 'vol_mgmt_34:/system_get_tse,eng38,06-01-04/
crash'
Copying crash files..
system_get_tse,eng38,06-01-04/crash/1.2
Copied /var/crash/2.0.0.gz to vol_mgmt_34:/
system_get_tse,eng38,06-01-04/crash/2.0.0.gz
Copied /var/crash/locks to vol_mgmt_34:/
system_get_tse,eng38,06-01-04/crash/locks
system_get_tse,eng38,06-01-04/crash/locks.0.gz
Copied /var/crash/minfree to vol_mgmt_34:/
system_get_tse,eng38,06-01-04/crash/minfree
Created directory 'vol_mgmt_34:/system_get_tse,eng38,06-01-04/
cores'
Copying core files..
Copying cluster DB..
Copied /usr/local/agile/conf/cluster.db.DB0 to vol_mgmt_34:/
system_get_tse,eng38,06-01-04/cluster.db.DB0
eng38>
In this example TSE information was gathered and written to a directory on the
management volume.
Related Commands
information for this NAS Gateway, sfinfo.xml

27-53
tse command.
system get stats Collect and save system and volume statistics
System Halt
Synopsis
system halt
Description
Use the system halt command to stop all active internal processes on the NAS
Gateway without having to power cycle the system or initiate a restart. When you halt
the system, you can expect the following occurrences:
• All user transactions stop.
• All internal processes halt, with the exception of a few management functions.
• The system remains online, but inactive.
• The system remains powered on.
• The configuration file does not change.
To reactivate the NAS Gateway, you need to power cycle or restart.
Example
cluster1-4> system halt

Connection to 10.2.4.64 closed by remote host.
Connection to 10.2.4.64 closed.
cluster1-4>
In this example, the NAS Gateway is halted. When the system is halted, the running
configuration is not saved or changed, no new disk read or write transactions can

27-54
occur, and the modules remain in the state they were in before the system was halted.
The system halt stops the active processes without restarting the NAS Gateway.
Related Commands
system reboot Restarts the NAS Gateway from the specified
compact flash module.
System Modify Core Dump Max Saved Files
Synopsis
system modify coredumpmaxsavedfiles MAX
Description
By default, the NAS Gateway saves one core dump file on the management volume.
However, you can set the maximum number of core dump files to save on the
management volume by running the system modify coredumpmaxsavedfiles
command.
Options
The MAX variable is the maximum number of files to be saved.
The default value of MAX is 8. The values can be between 0-99.
Example.
eng11 PUBSTEST> system modify coredumpmaxsavedfiles 5

eng11 PUBSTEST>
In this example, the number of core dumps saved to the management virtual server is
set to 5.

27-55
System Modify Core Dump Off
Synopsis
system modify coredump off
Description
The NAS Gateway supports an automatic core dumping feature that flushes the NAS
Gateway’s memory core to disk whenever the NAS Gateway encounters a system
event that causes it to reset. By default, the core dump feature is enabled. However,
you can disable automatic core dumping at any time by running the system modify
coredump off command. This command disables the automatic core dump feature so
that the memory core is not written to disk if the NAS Gateway fails.
Example
cluster1-4> system modify coredump off

cluster1-4>
In this example, the automatic core dump feature is disabled. Therefore, if the NAS
Gateway encounters a system event that causes it to reset, the NAS Gateway’s
memory core is not sent to disk.
Related Commands
Gateway.
system modify coremaxsavedfiles Specifies the maximum number of core files.

27-56
System Modify Core Dump On
Synopsis
system modify coredump on
Description
The NAS Gateway core dump is a global memory core at the time of a serious system
event. The NAS Gateway’s core dump contains much of the data from the file
processing controller and the storage device manager (SDM).
The NAS Gateway supports an automatic core dumping feature flushes the memory
core to disk if the NAS Gateway encounters a system event that causes it to reset.
However, if the core dumping feature is disabled, you can enable the feature at any
time by running the system modify coredump on command. The core dump feature
is enabled by default.
Example
cluster1-4> system modify coredump on

cluster1-4>
In this example, the automatic core dump feature is enabled. Therefore, if the NAS
Gateway encounters a system event that causes it to reset, the NAS Gateway’s
memory core is written to the core volume on the management virtual server if it has
been created.
Related Commands
Gateway.

27-57
System Modify Volumeexceptiondump
Synopsis
system modify volumeexceptiondump [-m on|off] [-a DATATYPE]
[-d DATATYPE] [-r]
Description
This command modifies the volume exception dump state when a volume goes offline.
When the volume exception dump is enabled, the subset of memory and program state
relevant to the volume that went offline is saved to a file on the management volume.
The file name takes the following format:
volume-name.uniqueID
You can include the following data types in the volume exception type:
Table 27-10 : Data Types
Data Type Description
FS The file system structure.

SUPERBLOCK The core copy of the super block.
THREADSTACKS The stacks and registers of the threads currently
running.
CONTEXTS The context structure of the running threads.
LOCKS The locks obtained by the running threads.
REQUESTS The file system requests executed by the running
threads.
INODESMRU The most recently used inodes, including inodes that
have been modified and have not been written to disk
yet.

27-58
Table 27-10 : Data Types (Continued)
Data Type Description
BUFFERSMRU The most recently used buffers, including buffers that

have been modified and have not been written to disk
yet.
INODES All inodes that were cached at the time of the
exception. Enabling this option can substantially
increase the size of the volume exception dump.
BUFFERS All buffers that were cached at the time of the
exception. Enabling this option can substantially
increase the size of the volume exception dump.

27-59
Options
Table 27-11 : Options for the system modify volumeexceptiondump command
-m on|off Turns the volume exception dump on or

off. By default this feature is turned off.
-a DATATYPE Adds the data type to the volume
exception dump.
-d DATATYPE Removes the data type from the volume
exception dump.
-r Resets the set of the data types to the
default. The following data types are
enabled by default:
• FS
• SUPERBLOCK
• THREADSTACKS
• CONTEXTS
• LOCKS
• REQUESTS
Example
In the following example the volume exception core dump is turned on.
eng11 VS_MGMT_1537> system modify volumeexceptiondump -m on
In the following example the volume exception core dump is turned off.
eng11 VS_MGMT_1537> system modify volumeexceptiondump -m off

27-60
In the following example the CONTEXTS data type is deleted from the volume
exception core dump.
eng11 VS_MGMT_1537> system modify volumeexceptiondump -d CONTEXTS
To display the configuration of the volume exception core dump feature run the
system show coredump command.
Related Commands
System Ping
Synopsis
system ping [HOSTNAME | IPADDR] [-n COUNT]
Description
Use the system ping command to test network-layer connectivity to devices through
the use of standard ping packets. This command uses the Internet control message
protocol’s (ICMP) mandatory ECHO_REQUEST datagram to elicit an ICMP
ECHO_REPLY from a network-connected host or gateway. The NAS Gateway
supports pings to IP address or hosts or gateways. To resolve a ping by host name, you
need to have name resolution services, either NIS or DNS, configured on the NAS
Gateway.
Note!
The NAS Gateway’s ping function continues until you manually stop it by
typing CTRL + C.
For a host name to be resolved you need to have previously configured NIS or
DNS name resolution services in the network.

27-61
Options
Table 27-12 : Options for the system ping command
HOSTNAME The device that you are pinging. If you are

pinging a host name or gateway name, the name
needs to be a DNS or NIS resolvable name.
IPADDR The device that you pinging. If you are pinging
an IP address, type the IP address in dotted
decimal format.
-n COUNT The -n COUNT option is used to specify the
number of responses to display.
Example
In the following example, a host is pinged by IP address.
cluster1-4> system ping 10.1.1.189

PING 10.1.1.189 (10.1.1.189): 56 data bytes
64 bytes from 10.1.1.189: icmp_seq=0 ttl=255 time=10.010 ms
cluster1-4>
In this example, the system ping command is used to test network connectivity to the
device whose IP address is 10.1.1.189. Because the NAS Gateway received a response
and no time out occurred, this device is reachable.

27-62
In the following example, a host is pinged by device name.
cluster1-4> system ping test1

PING test1 (10.1.1.189): 56 data bytes
64 bytes from test1: icmp_seq=0 ttl=255 time=10.010 ms
cluster1-4>
In this example, the system ping is run to the device test1. This device name can be
resolved due to name resolution services, in this case NIS, being enabled on the NAS
Gateway. Because the ping function succeeded, the device is reachable.
Related Commands
int add Assigns an IP address to an interface.
int show Shows the interface table for the virtual server.
system traceroute Allows the printing of an Internet route to
another system or gateway.
System Reboot
Synopsis
system reboot [-f] [-s] [-y]
Description
Use the system reboot command to perform a soft restart. A soft restart provides the
NAS Gateway with turn off notification so that its component parts and any active
software processes can perform a graceful turn off. During some software procedures,
you might be required to start from the standby compact flash module first. If you are
required to start from the standby compact flash module before the active compact
flash, accompanying documentation explicitly mentions that requirement.

27-63
Options
Table 27-13 : Option for the system reboot command
Optio
Object Description
n
-f This option reboots the NAS gateway without taking the

volumes offline.
-s An optional argument for restarting the NAS Gateway using the
contents of the secondary compact flash module.
If you specify the -s option, the NAS Gateway switches to the
compact flash that it was not running from prior to the
command, and restarts from that compact flash.
If you do not specify the -s option, the NAS Gateway restarts
from the same compact flash it is currently running from.
-y This option reboots the NAS gateway without prompting for
confirmation of the action.
Example
In the following example the NAS Gateway is restarted.
eng93> system reboot

Taking vsvr VS99 volume 99dmip offline

-
Taking vsvr VS99 volume 99local offline
-
Taking vsvr VS_MGMT_520 volume vol_mgmt_520 offline
-
The command causes the graceful turn off and restart of the system. The system
restarts with the last saved configuration.

27-64
In the following example the NAS Gateway is restarted with the -s option.
eng93> system reboot -s

Taking vsvr VS99 volume 99dmip offline

-
Taking vsvr VS99 volume 99local offline
-
Taking vsvr VS_MGMT_520 volume vol_mgmt_520 offline
-
The command causes the graceful turn off and restart of the system but with the other
compact flash module’s contents. The system restarts with the last saved configuration
on the compact flash module that was not used last to start the NAS Gateway.
Related Commands
system halt Halts the NAS Gateway.
System Show Chassis
Synopsis
system show chassis
Description
Use the system show chassis command to display information about the hardware
that is installed in the NAS Gateway. This command lists the following information:
• The functional elements that the runtime software recognizes.
• Each type of functional element in the unit.
• The type of control processor governing the operation of the each functional
element.

27-65
• The operational state of the listed processor. Valid states are as follows:
- UP for components that have successfully started and are operating
correctly.
- DOWN for components that have not started.
- UNKNOWN for components that have an undetermined operational
state.
- PROM for components that are in programmable read-only memory
(PROM) mode.
Example
bobcat-pl> system show chassis
module cpu state

---------------------------------------
SSC SSC UP
NFP TXRX0 UP
TXRX1 UP
FP0 UP
FP1 UP
FC FC0 UP
----------------------------------------------
bobcat-pl>
In this example, the chassis configuration shows the following information.

• The module field shows the functional element of the NAS Gateway. Valid values
are:
- SSC which is the system switch and controller for controlling the
management ports and the console connection.
- NFP (network file processor), which contains a TXRX0 and TXRX1
controller and an FP0 and FP1 controller, which combine to control the
Gigabit Ethernet (GE) ports and connectivity into the IP client network.
- FC (Fibre Channel), which indicates the SCSI and Fibre Channel
controller for the NAS Gateway.

27-66
• The cpu field indicates the processors that control the listed element of the NAS
Gateway:
- SSC indicates the processor that controls and coordinates the operation
of the entire NAS Gateway.
- TXRX0 and TXRX1 indicate the processors that control the file
processing functionality, and FP0 and FP1 indicate file processing
cores associated with the Gigabit Ethernet functionality.
- FC0 indicates the processor that controls the NAS Gateway’s Fibre
Channel and SCSI functionality.
• The state field indicates whether each listed processor component is either UP
(started and operating), or DOWN (not started).
Related Commands
show temperature Shows the temperature of the NAS Gateway.
System Show Core Dump
Synopsis
system show coredump
Description
During runtime, you can check the state of the automatic core dump feature by running
the system show coredump command. This command shows the following
information:
• The current state, either ON or OFF, of the NAS Gateway’s automatic core dump
feature. By default automatic core dump is enabled.
• The maximum number of saved coredump files.
• The configuration status of the core dump volume.
• The volume exception core dump status.

27-67
Example
eng93 VS_MGMT_520> system show coredump

Automatic core dump is: on
Max number of saved coredump files: 8
Automatic core dump compression is: on
Core dump volume is: vol_core_520
Volume exception core dump is: on
Volume exception data types: FS SUPERBLOCK THREADSTACKS CONTEXTS
LOCKS REQUESTS OWNERBLOCK LIVEBLOCK
eng93 VS_MGMT_520>
In this example, the NAS Gateway’s automatic core dump feature is enabled. One
saved coredump file exists. The core dump volume is vol_core_520. The volume
exception core dump feature is on.
Related Commands
Gateway.
system delete corevolume Deletes the core dump volume.
system modify coredump Specifies the core dump state.
System Show Node Name
Synopsis
system show nodename
Use the system show nodename command to view the unique node name assigned to
each NAS Gateway at start time. The node name is used to uniquely identify each
NAS Gateway.

27-68
Example
skywalker-ssc> system show nodename

Node name is: skywalker-ssc
skywalker-ssc>
In this example, the NAS Gateway’s node name is skywalker-ssc. You can run this
command on any local node to view the node’s name.
Related Commands
system show chassis Shows information about the hardware installed
on the NAS Gateway.
System Show Read Ahead Performance
Synopsis
system show readahead performance
Description
You can view the statistics for read ahead caching at any time by running the system
show readahead performance command. Read ahead cache performance statistics
include:
• The number of read ahead requests the NAS Gateway has received
• The number of data blocks read
• The percentage of read ahead hits in the NAS Gateway’s data cache
• The percentage of read ahead misses in the NAS Gateway’s data cache
Through this command you can see how effectively read ahead caching is operating
with user data applications. If cache thrashing is occurring, you can change the state of
the read ahead caching to improve the usage of the NAS Gateway’s data cache.

27-69
Example
eng11> system show readahead performance

Readahead Requests = 5894
Num Blocks Read = 5245
Readahead Cache Hit = 89 %
Readahead Cache Miss = 11 %
eng11>
In this example, the read ahead cache performance is displayed. The cache-hit-to-miss
ratio is 89/11, which indicates an efficient usage of the cache. If the hit-to-miss ratio
was excessive, for example, a hit-to-miss ratio approaching 50/50, you could change
the state of the read ahead feature, in attempt to reduce cache thrashing.
Related Commands
system enable readahead Enables data cache read ahead policy.
system disable readahead Disables data cache read ahead policy.
System Show Read Ahead State
Synopsis
system show readahead state
Description
You can display the state of read ahead caching at any time by running the system
show readahead command. By default, this feature is enabled.

27-70
Example
eng11> system show readahead state

Data Cache Readahead Enabled
eng11>
In this example, the current state of readahead caching for the NAS Gateway’s user
data cache is enabled.
Related Commands
system enable readahead Enables data cache read ahead policy.
system disable readahead Disables data cache read ahead policy.
System Show Summary
Synopsis
system show summary
Description
Use the system show summary command to view summary information about
the current NAS Gateway, such as gateway name, current date & time, timezone,
system uptime, system temperature, primary flash software version, chassis
information, NTP configuration, sc1 & sc2 ip addresses and total number of virtual
servers.

27-71
Example
eng57> system show summary
Name: eng57
Date & Time : Tue Nov 7 16:58:03 2006
Time zone : US/Pacific
System Uptime : 01:01:46
System temperature (celsius): 40
Software Version: 2.1.0.0
chassis
--------
Model number: ONS-SYS-2240
System revision: A2
System serial number: 0508040006
MAC addr: 00:07:34:01:C5:00
BMFPGA : Version 4
Board revision: A1
Board serial number: 0506010562
Boot Dev: wd1a (cf2)
SSC
PROM_R9000 : prom-2.0.3 : Thu Apr 13 16:44:49 2006
LUC revision: 3.2.10

TXRX0
PROM_SIBYTE_BC : prom-2.0.2 : Fri Apr 7 13:13:34 2006
NFP_TXRX : R2.1.0.0BC-103106 : Tue Oct 31 17:46:10 2006
TXRX1
NFP_TXRX : R2.1.0.0BC-103106 : Tue Oct 31 17:46:10 2006
FP0
NFP_FP : R2.1.0.0BC-103106 : Tue Oct 31 17:36:32 2006
FP1
NFP_FP : R2.1.0.0BC-103106 : Tue Oct 31 17:36:32 2006
FC0
PROM_R9000 : prom-2.0.3 : Thu Apr 13 16:44:49 2006
FCNIM : R2.1.0.0BC-103006 : Mon Oct 30 22:19:06 2006
NTP Configuration :
remote refid st t when poll reach delay offset jitter
==============================================================================
*127.127.1.0 127.127.1.0 10 l 17 64 377 0.000 0.000 0.031
SC1 IP : 10.2.1.15
SC2 IP :
No of Virtual server(s) : 3
eng57>
Related Commands
cluster show cluster Displays the cluster configuration.
cluster show summary Displays the cluster configuration summary.

27-72
System Show Temperature
Synopsis
system show temperature
Description
Use the system show temperature command to display the temperature readings for
the interior of the NAS Gateway. The NAS Gateway contains a temperature sensor
that checks the ambient temperature inside the chassis and reports the temperature in
realtime. When you run the system show temperature command, the last gathered
temperature readings are displayed in number of degrees centigrade (ºC).
Note!
The formula for converting ºC to ºF is [(ºC * 1.8) + 32].
If the temperature sensor is not able to determine the temperature inside the
chassis, the NAS Gateway shows a zero (0).
Example
bobcat-pl> system show temperature
System temperature (celsius): 36

bobcat-pl>
In this example, the NAS Gateway is displaying the temperature inside the chassis,
which is 36º C.
Related Commands
system show chassis Shows chassis hardware information of the NAS
Gateway.

27-73
System Show Uptime
Synopsis
system show uptime
Description
Use the system show uptime command to display the current time and how long the
system has been running.
Example:
eng13> system show uptime

11:42AM up 11 mins
eng13>
Related Commands
system show chassis Show chassis information.
system show coredump Show core dump information.
system show nodename Show this node's name.
system show readahead Show data cache readahead status.
system show temperature Show the chassis temperature.
system show version Show the system version information.
System Show Username
Synopsis
system show username

27-74
Description
Displays the user name used to log in to the NAS Gateway. For example, admin.
Also displays the NIS/LDAP/Windows domain name as username@domain. If the
user account is local to the NAS Gateway, the domain name is not displayed.
Example
eng57> system show username

User name is: admin
eng57>
System Show Version
Synopsis
system show version
Description
Use the system show version command to display system-wide information about
the hardware and software that is installed in the NAS Gateway. This command lists,
• The type of hardware component installed, and the version of firmware or software
loaded onto each component
• The date each version of firmware/software was created.
• The version numbers of selected hardware components

27-75
Example
bobcat-pl> system show version
chassis
--------
Model number: 2260
System revision: 01
System serial number: 505-0025-0001
MAC addr: 000734004900
BMFPGA : Version 1
Board revision:
Board serial number: 3010232
SSC
PROM_R9000 : prom-1.0.2 : Mon Jan 10 11:29:24 2005

TXRX0
PROM_SIBYTE_BC : prom-1.0.2 : Mon Jan 10 11:24:03 2005
NFP_TXRX : R1.3.0.0BCDBG-013106 : Tue Jan 31 14:59:22 2006
TXRX1
NFP_TXRX : R1.3.0.0BCDBG-013106 : Tue Jan 31 14:59:22 2006
FP0
NFP_FP : R1.3.0.0BCDBG-013106 : Tue Jan 31 14:54:37 2006
FP1
NFP_FP : R1.3.0.0BCDBG-013106 : Tue Jan 31 14:54:37 2006
FC0
PROM_R9000 : prom-1.0.2 : Mon Jan 10 11:29:24 2005
FCNIM : R1.3.0.0BCDBG-013106 : Tue Jan 31 14:59:54 2006
bobcat-pl> system show version
chassis
--------
Serial number: 0433010229
MAC addr: 000734004800

27-76
slot 0
-------
BMFPGA : Version 1
Board Revision: 1
slot 0, SSC
----------------------
PROM_R9000 : prom-2.0.7 : Tue Nov 2 10:45:48 2004
slot 1
-------
slot 1, TXRX0
----------------------
PROM_SIBYTE_BC : prom-2.0.7 : Thu Sep 23 15:25:47 2004
NFP_TXRX_BC : R1.2.1.0BCDBG-110204 : Tue Nov 2 13:39:09 2004
slot 1, TXRX1
----------------------
NFP_TXRX_BC : R1.2.1.0BCDBG-110204 : Tue Nov 2 13:39:09 2004
slot 1, FP0
----------------------
NFP_FP_BC : R1.2.1.0BCDBG-110204 : Tue Nov 2 13:34:52 2004
slot 1, FP1
----------------------
NFP_FP_BC : R1.2.1.0BCDBG-110204 : Tue Nov 2 13:34:52 2004
slot 2, FC0
----------------------
FCNIM_BC : R1.2.1.0BCDBG-110204 : Tue Nov 2 13:39:42 2004
slot 2, FC1
----------------------
slot 2, FC2
----------------------
slot 2, FC3
----------------------
bobcat-pl>
This example shows the NAS Gateway’s hardware. The hardware is listed for each of
the functional areas of the NAS Gateway, for example, the SSC components, file
processing components, or storage processing components. For each type of
functionality, the software recognizes relevant hardware components, such as
controllers and field-programmable gate arrays (FPGAs), and lists them along with the
version of software or firmware running on the components. In addition to the
hardware components and the version of installed software, the date that the software
was created is displayed.

27-77
Related Commands
system version Shows the installed software version of the NAS
Gateway.
System Time NTP Disable
Synopsis
system time ntp disable
Description
The NAS Gateway has the ability to use network time protocol (NTP) servers or NTP
broadcast messages to maintain time synchronization. When the NAS Gateway has
been enabled to listen for NTP broadcasts, you can stop the NAS Gateway from
listening to the broadcasts by running the system time ntp disable command.
When you run this command, the NAS Gateway stops synchronizing with any NTP
servers, and maintains the latest synchronized time on its own through the realtime
clock chip.
Note!
If NTP was active on the NAS Gateway and you disable NTP, you need to
restart the NAS Gateway before it can begin resynchronizing with a specific
server or a broadcast time signal on TCP port 123.
Example
cluster1-4> system time ntp disable

cluster1-4>
In this example, the NAS Gateway’s NTP software is disabled. After being disabled,
the NAS Gateway’s realtime clock chip continues to maintain time based on the last
time programmed into the clock chip. However, if you want to synchronize the NAS
Gateway with an NTP signal, you need to restart the NAS Gateway and run the
system time ntp server command to reorient the NAS Gateway to a specific time
server.

27-78
Related Commands
system time set Sets the current system time to the specified
time.
system time show Shows the current system time.
system time zone Controls the local system time zone.
System Time NTP Server
Synopsis
system time ntp server {-a|-d} IPADDR
Description
The NAS Gateway has the ability to synchronize with a specific NTP server instead of
listening for time signals broadcast on TCP port 123. For example, if you have a time
server for a specific network, that time server can be the one listening for broadcasts,
and the NAS Gateways in the subnet can synchronize with that dedicated time server.
Use the system time ntp server command to create a list of NTP servers to which
the NAS Gateway listens explicitly. With this command you can add or delete one or
more servers from the list.

27-79
Options
Table 27-14 : Options for the system time ntp server command
-a|-d Specifies one of the following actions that you

are performing with the server.
• -a adds the server to the NTP servers list.
• -d removes the server from the NAS
Gateway’s NTP servers list.
IPADDR The IP address of an NTP server.
Example
In the following example, an NTP sever is added to the NAS Gateway’s NTP servers
list.
cluster1-4> system time ntp server -a 101.68.98.7

cluster1-4>
In this example, the NTP time server 101.68.98.7 is added to the NAS Gateway’s NTP
servers list.
In the following example an NTP server is deleted from the NAS Gateway’s NTP
servers list.
cluster1-4> system time ntp server -d 101.68.98.7

cluster1-4>
In this example, the NTP time server 101.68.98.7 is deleted from the NAS Gateway’s
NTP servers list.
Related Commands
time.

27-80

System Time Set
Synopsis
system time set [[[[[[cc]yy]mm]dd]HH]MM[.SS]]
Description
The NAS Gateway’s real time clock can support either of two sources: a manually
programmed time from the system administrator, or an automatically programmed
time from an NTP server. Use the system time set command to manually program
the time into the NAS Gateway.
Note!
To avoid discrepancies always run the system time set command on all
NAS Gateways in the cluster, and run this command before configuring the
NTP server.

27-81
Options
Table 27-15 : Option for the system time set command
[[[[[[cc]yy]mm]dd] Type the time that you are entering

HH]MM[.SS]] into the NAS Gateway as:
[[[[[[cc]yy]mm]dd]HH]MM[.SS]]
where:
• cc is an optional argument for
specifying two digits of the
current millennium, for
example, 20 for the year 2002.
• yy is an optional argument for
specifying two digits for the
current year, for example, 02
for 2002.
• mm is an optional argument for
current month, for example, 04
for April.
• dd is an optional argument for
current date, for example, 20
for the twentieth day of the
month.
• HH is an optional argument for
current hour, in 24-hour time,
for example, 16 for 4 p.m.

27-82
Table 27-15 : Option for the system time set command (Continued)
• MM is a mandatory argument
for specifying two digits for the
current minutes, for example,
30 for the 30th minute of the
hour.
• .SS is an optional argument for
current seconds, for
example,.45 for the 45th
second of the minute. Make
sure to separate minutes (MM)
and seconds (.SS) with a
period.
Example
cluster1-4> system time set 200409301835.45

cluster1-4>
In this example the date and time that is programmed into the realtime clock chip is
2004, 09/30, 18:35:45, or September 30th, 2002 at 6:35 and 45 seconds p.m.
Related Commands
System Time Show
Synopsis
system time show [-v]

27-83
Description
The NAS Gateway’s realtime clock can support either of two sources: a manually
programmed time from the system administrator, or an automatically programmed
time from a NTP server. Use the system time show command to list the system time
that has been programmed into the NAS Gateway’s realtime clock chip. This
command supports both manually programmed time values and time values scanned
from synchronizing with an NTP server.
The NAS Gateway’s time is maintained in Greenwich mean time (GMT). You can use
the system time set command to program the NAS Gateway’s time in local time.
Note!
The NTP implementation in use on the NAS Gateway has been created by the
University of Delaware. For detailed information about NTP, consult the
University of Delaware’s iteration of NTP.
Options
-v is the option for setting optional verbose mode if the NAS
Gateway is receiving its time information from an NTP server.
Verbose mode shows the system time, and NTP server
information, such as stratum, and the amount of time lost as time
signals traverse servers and stratum. If the NAS Gateway has not
been configured with and NTP time source, do not specify -v.
Example
In the following example, the system time show command is run in standard mode
with time programmed into the realtime clock by the system administrator.
cluster1-4> system time show

Thu Feb 9 16:29:12 PST 2006
cluster1-4>
In this example, the system time show command shows the system time as tracked
by the realtime clock chip.

27-84
In the following example system time is displayed in verbose mode with time
information scanned from synchronizing with an NTP server.
eng59> system time show -v

Mon Jan 22 10:27:30 PST 2007
status=06f4 leap_none, sync_ntp, 15 events, event_peer/strat_chg,
version="ntpd 4.1.0 Wed Nov 15 12:11:39 PST 2006 (2)",
processor="pmonmips", system="OpenBSD2.8", leap=00, stratum=3,
precision=-18, rootdelay=148.088, rootdispersion=131.315, peer=24661,
refid=10.0.0.18,
reftime=c95f7fb1.39ffc547 Mon, Jan 22 2007 10:23:45.226, poll=10,
clock=c95f8092.97f5e84f Mon, Jan 22 2007 10:27:30.593, state=4,
offset=-19.424, frequency=-8.844, jitter=26.917, stability=0.041
remote refid st t when poll reach delay offset jitter
==============================================================================
127.127.1.0 127.127.1.0 10 l 38 64 377 0.000 0.000 0.004
*10.0.0.18 192.5.41.40 2 u 225 1024 377 69.994 -32.170 27.378
eng59>
If NTP is enabled, the verbose mode of the system time show command displays the
• The NAS Gateway’s date and time stamp.
• The status of NTP, including whether NTP is synchronized, the number of NTP-
defined protocol events, and the last event encountered.
• The version of NTP and when it was last updated. NAS Gateway system
information about the processor type, the operating system (OS) kernel, the
distance from the root time server, and the stratum on which the NAS Gateway
resides.
• NTP accuracy metrics determined by calculations such as signal delay, signal
dispersion, and the location of the reference clock.
• The calculated reference time value, the date and time stamp of that reference time
value, and the number of times the NAS Gateway has polled the time server.
• The clock value, date and time stamp on the clock, and the clock status metric.
• Time signal compensation metrics, such as the signal offset and frequency, and the
jitter and stability metrics.
The NAS Gateway’s NTP table shows the following information:
• The name of the remote clock
• The reference ID of the remote clock

27-85
• The stratum on which each clock source resides

• The number of clock ticks
• When each clock tick occurs
• The number of times the server has been polled
• The calculated signal reach value
• The calculated signal delay
• The calculated signal offset
• The calculated signal jitter
Related Commands
time.
System Time Zone
Synopsis
system time zone [-l] [TIMEZONE]
Description
You can program the NAS Gateway’s realtime clock automatically with time from a
NTP server. Because NTP uses GMT, the NAS Gateway uses the local time zone and
converts it to GMT. Use the system time zone command to pick one of 500 time
zones that the NAS Gateway prompts you with. Use the page up (u) or page down (d)
function to locate the correct time zone. As an alternative, you can search by typing a
forward slash (/), then the name of the time zone you want. You can also use the Enter
key to scroll line-by line through the display, or use the up or down arrows to scroll
line-by-line through the display in the corresponding direction. After selecting the
time zone, you can stop the page up or down function by typing q.

27-86
Options
Table 27-16 : Options for the system time zone command
-l An optional argument that shows all time zones on

the NAS Gateway in one of the following ways:
• If you specify no arguments, the NAS Gateway
shows its current time zone.
• If you specify this argument, the NAS Gateway
shows the entire list of supported time zones in
alphabetical order. You can scroll through the list
to locate the time zone that is geographically
closest to your location.
Note!
Do not use the time zone “Factory” unless explicitly
instructed by ONStor staff.
TIMEZONE Specifies the time zone in one of the following ways:

• If you specify no arguments, the NAS Gateway
displays its current time zone.
• If you specify this argument, the NAS Gateway
accepts the time zone string you type, and
programs it into the runtime.
Note!
The time zone string you type needs to be one of the
supported time zones displayed through system time
zone -l command. You need to type the time zone
exactly as it is displayed in the time zone list.

27-87
Example
The following example shows the current time zone.
cluster1-4> system time zone

Current time zone is
US/Pacific
cluster1-4>
In this example a time zone has been set already for the NAS Gateway. Therefore,
when you run this command, the configured time zone is displayed.
The following example shows the list of supported time zones.
cluster1-4> system time zone -l

Africa/Abidjan
Africa/Accra
Africa/Addis_Ababa
Africa/Algiers
Africa/Asmera
Africa/Bamako
Africa/Bangui
Africa/Banjul
Africa/Bissau
Africa/Blantyre
Africa/Brazzaville
Africa/Bujumbura
Africa/Cairo
Africa/Casablanca
Africa/Ceuta
Africa/Conakry
<<Display continues...>>
In this example, the NAS Gateway shows the list of supported time zones in
alphabetical order. Scroll through the list to find the time zone that you want, make a
note of it exactly as it appears in the list. To configure the NAS Gateway’s time zone,
type the time zone string exactly as it appears on the list. For illustrative purposes, this
example only shows the first part of the list.
In the following example, the NAS Gateway’s time zone is set.
cluster1-4> system time zone US/Hawaii

cluster1-4>

27-88
In this example, the NAS Gateway’s time zone is set to the time zone for the US state
of Hawaii. Use the system time show command to display the local time of Hawaii.
Related Commands
time.
System Traceroute
Synopsis
system traceroute {HOSTNAME | IPADDR}
Description
Use the system traceroute command to display the Internet route to another host or
gateway. The NAS Gateway supports trace route functions to destination IP addresses
or hosts or gateways.
Note!
For a host name to be resolved you need to have previously configured NIS or
DNS name resolution services in the network.
Options
HOSTNAME | IPADDR are the variables used to identify the device
whose route you want to trace. If you are tracing the rout to an IP
address, type the IP address in dotted decimal format. If you are
tracing the route to a host or gateway name, the name needs to be
a DNS or NIS resolvable name.

27-89
Example
cluster1-4> system traceroute 10.1.1.189

traceroute to 10.1.1.189 (10.1.1.189), 64 hops max, 40 byte packets
1 10.1.1.189 (10.1.1.189) 0.7 ms 0.7 ms 0.7 ms
cluster1-4>
In this example, the trace route is performed on an IP address. The results of the trace
route are shown:
• The number of allowable hops on the route
• The size of packets used
• The transmission delay on the route
Related Commands
int add Assigns an IP address to an interface.
int show Shows the interface table for the virtual server.
system ping Pings the specified host name or IP address.
System Upgrade
Synopsis
system upgrade [-f] [-s] {ftp://USER@IPADDR/PATHNAME | ftp://
USER:PASSWORD@IPADDR/PATHNAME}
Description
Use the system upgrade command to upgrade the NAS Gateway. You can upgrade
by downloading the archived upgrade file from an FTP server.
Downloads software from the specified location to one of the NAS Gateway's compact
flash modules. The password for the FTP user account can be optionally specified in
the command line. If not specified in the command line, the system prompts for the
password. PATHNAME is the name of an archive file to be downloaded from the FTP

27-90
server IPADDR. The NAS Gateway has two compact flash modules that can receive the
downloaded software. One of the compact flash modules is considered the active flash
and the other is considered the standby flash. The terms active and standby refer to
which flash module the NAS Gateway booted from last. It is important to understand
that the term active and standby are relative. If the NAS Gateway boots from a
different compact flash than it did the last time, there is a new active flash. By default,
software is downloaded to the active flash, but you can specify that the standby flash
receives the software.

27-91
Options
Table 27-17 : Options for the system upgrade command
-f An optional argument that

forces the software upgrade
regardless of the current
software version. Use this
option when you are
upgrading to a version lower
or equal to the current version.
Note!
Please contact ONStor support
for for downgrade.
-s An optional argument for

upgrading to the standby
compact flash. If you specify
the -s option, the NAS
Gateway upgrades the standby
compact flash module, but
leaves the active compact flash
module as the current compact
flash. If you do not specify the
-s option, the active compact
flash module is upgraded.
IPADDR Specifies the IP address of the
device that will be
downloading the software onto
the NAS Gateway.

27-92
Table 27-17 : Options for the system upgrade command (Continued)
PASSWORD Specifies the password for the

user on the FTP server. The
password in an alphanumeric
character string from 6 to 64
characters.
PATHNAME Specifies the directory path to
the files that will be
downloaded to the NAS
Gateway. The PATHNAME is
the location on the device
specified in the IPADDR.
USER The user account on the FTP
server. If user name is not
specified, it is considered to be
an anonymous FTP.
Example
In the following example a NAS Gateway is upgraded through an FTP server.
cluster1-4> system upgrade -s ftp://admin:admin@11.12.13.14/home/

upgrade/R1.2.1-110104.tar.gz
cluster1-4>
In this example, the NAS Gateway is upgraded to the R1.2.1 version of the software.
In this example, the active compact flash module (the one that was most recently used
to start from) is upgraded. Because the upgrade is occurring through an FTP server
with the IP address 11.12.13.14, the user and password for logging on to the FTP
server are provided in the command. Because the R1.2.1 software doesn’t reside in the
root directory on the FTP server, the full path to software version R1.2.1 is specified in
the system upgrade command.

27-93
When the ftp server is located, a background process pulls the software to the active
compact flash on the SSC. When the upgrade is complete, the SSC begins an internal
TFTP process to load the start and runtime images. When the images are loaded, the
NAS Gateway restarts and resumes operation with newly upgraded runtime software
image.
In the following example a NAS Gateway is upgraded with the -s option.
cluster1-4> system upgrade ftp://admin:admin@11.12.13.14/home/

upgrade/R1.2.1-110104.tar.gz -s
cluster1-4>
In this example, the NAS Gateway is upgraded to the R1.2.1 version of the software.
In this example, the -s argument upgrades the standby compact flash module first (the
one that was not most recently used to start from). Because the upgrade is occurring
through an FTP server with the IP address 11.12.13.14, the user and password for
logging on to the FTP server are provided in the command. Because the R1.2.1
software doesn’t reside in the root directory on the FTP server, the full path to software
version R1.2.1 is specified in the system upgrade command.
Related Commands
system reboot Restarts the NAS Gateway from the specified
compact flash module.
System Version
Synopsis
system version [-s]
Description
Use the system version command to display a version string that identifies the system
software that currently installed on the NAS Gateway.

27-94
Options
-s is the option used to display the software version running on
the secondary compact flash module.
Example
eng11 ENG11VS0> system version

1.3.0.0
eng11 ENG11VS0>
Related Commands
system halt Halts the NAS Gateway.
system show chassis Show chassis information.
system show cifs Show cifs parallel commits.
system show coredump Show core dump information.
system show ipstat Show IP statistics.
system show nodename Show this node's name.
system show readahead Show data cache readahead status.
system show temperature Show the chassis temperature.
system show version Show the system version information.

Chapter 28: Tape Commands
This chapter documents the following tape commands:
• “Tape Alias Clear” on page 28-2
• “Tape Alias Set” on page 28-3
• “Tape Alias Show” on page 28-4
• “Tape Close” on page 28-5
• “Tape Display Device List” on page 28-6
• “Tape Display Device State” on page 28-11
• “Tape Display Media Changer List” on page 28-12
• “Tape Media Changer Alias Clear” on page 28-13
• “Tape Media Changer Alias Set” on page 28-14
• “Tape Media Changer Alias Show” on page 28-16
• “Tape Release” on page 28-16

28-2
Tape Alias Clear
Synopsis
tape alias clear ALIAS
Description
When a tape device alias is configured, you can remove it at any time by running the
tape alias clear command. When you run this command, the alias associated with
the tape device is removed, and you can manage the tape device through the device
name or the logical device.
Options
The ALIAS variable is the name of the alias that you are removing.
Example
eng43> tape alias clear tapedev11

Tape alias tapedev11 successfully cleared
eng43>
In this example, the alias tapedev11 is cleared from the media changer. When this
command completes, the tape device is addressable only by a device name, not the
alias.
Related Commands
tape alias set Sets the tape aliases.
tape alias show Shows the tape aliases.
tape devlist Lists all available tape devices.

28-3
Tape Alias Set
Synopsis
tape alias set DEVNAME LOGICALNAME ALIAS [-f]
Description
You can assign an alias to a tape device to facilitate identification of the device. When
you assign an alias, you associate a text string with the tape device’s actual device
name. For example, you could create an alias called tapedrive22 to identify a single
tape drive instead of referring to it as QUANTUM_PMC01P3145_0. You can create an
alias for a tape device by running the tape alias set command.
Options
Table 28-1 : Options for the tape alias set command
DEVNAME The physical device name of the tape

device as known to the ONStor™ NAS
Gateway.
LOGICALNAME The logical device name of the tape
device that you are creating an alias for.
ALIAS An alphanumeric text string that you are
assigning to the tape device. The alias
have up to 32 characters.
-f An optional argument for overwriting an
existing alias.

28-4
Example
eng43> tape alias set QUANTUM_PMC01P3145_0 NRNU1l tapedev11

Tape alias tapedev11 successfully set for
QUANTUM_PMC01P3145_0:NRNU1l
eng43>
In this example, the alias tapedev11 is set for the physical device
QUANTUM_PMC01P3145_0 and logical device NRNU1l. When this command
completes, the logical tape device is addressable by either logical device name or alias.
Related Commands
tape alias clear Clears the tape aliases.
tape alias show Shows the tape aliases.
Tape Alias Show
Synopsis
tape alias show [DEVICE_NAME]
Description
Tape devices that have been given aliases are kept in the tape devices alias list. You
use the tape alias show command to display the list of tape aliases and logical
names for a physical device. DEVICE_NAME specifies the name of the device. This
command lists all user defined aliases for tape devices. An alias can be set for a logical
tape device. Once an alias is set, one can manipulate the tape using that alias. Alias is
useful since one can give a meaningful name to a tape device.
This list contains the following information for tape devices that have been aliased:
• The device name
• The alias that has been assigned

28-5
Options
The DEVICE_NAME variable identifies the specific tape device
whose logical name and alias name you want to display.
Example
eng13> tape alias show

Physical Device Name Logical Name Alias
---------------------------------------- ------------ -----------
-----
IBM_1110020179_0 NRNU2h tape0
Related Commands
tape alias clear Clears the tape aliases.
Tape Close
Synopsis
tape close DEVNAME [-f]
Description
Use the tape close command to manually set a tape to the closed state. You can
specify one tape device by name and close it to reading and writing. This command is
helpful if the tape device is stalled in a busy open state, which occurs when the tape
device is in open state with no activity and is not closed by the client. While a tape
device is open, it cannot be used by another device. So, by running the tape close
command, you can force a tape device to close if it is stalled in open state.

28-6
Options
Table 28-2 : Options for the tape close command
DEVNAME The unique name of the tape controller

that you want to close to read and write
operations.
-f An optional argument that forcefully
closes the tape device. If you use this
option, any client that has the tape open
gets an error on its next tape command.
Use this option to close tape device
opened by failed clients.
Example
eng31> tape close QUANTUM_PMC29Y0613

tape close successful
eng31>
In this example, the tape close command is run on the tape device
QUANTUM_PMC29Y0613. This command closes the tape device to management or
administration commands.
Related Commands
Tape Display Device List
Synopsis
tape devlist [-v [DEVNAME]]

28-7
Description
When the NAS Gateway completes its storage area network (SAN) discovery, the tape
resources are virtualized and posted to a list. Use the tape devlist command to
view the tape devices list. The tape device list contains all discovered tape devices,
and provides operation and performance information about each device. The tape
devices are listed by their physical or logical device name. Tape devices contained in
the tape devices list are displayed regardless of their state. Therefore, if a tape device
is discovered and online, but has encountered an error condition that prevents it from
operating properly, the tape device still appears in the display.
Table 28-3 : Options for tape devlist command
-v Displays all devices in the

current virtual server in verbose
mode.
-v DEVNAME Displays a specific device in
verbose mode.

28-8
Example
The following example shows all available tape devices in the SAN.
eng43> tape devlist

Physical Device Name Vendor Product
ID
State Open-Attributes
---------------------------------------- --------------- ----------
---------- --
---- ---------- ---------------
QUANTUM_PMC01P3145_0 QUANTUM DLT8000
1 CLOSED N/A
QUANTUM_PMC01P3150_1 QUANTUM DLT8000
2 CLOSED N/A
QUANTUM_PMC24Y0725_1 QUANTUM SDLT320
3 CLOSED N/A
9 CLOSED N/A
10 CLOSED N/A
11 CLOSED N/A
SEAGATE_HM004Z6_1 SEAGATE ULTRIUM06242-
XXX
The tape devices list shows the following information:

• The tape device’s physical name
• The tape device’s vendor information
• The tape device’s product information
• The tape device’s numeric identifier
• The tape device’s state
• The tape device’s open attributes

28-9
The following example shows the logical device information for each physical device
with an option to page down or stop. Each physical device can have up to 12 logical
device names.
eng43> tape devlist -v

ID
WWN LUN
---------------------------------------- --------------- -----------------
--- --
---- ------------------ -----
QUANTUM_PMC01P3145_0 QUANTUM DLT8000 1
0x100000e00201f5c6 0
Logical Name State Alias Attributes

------------ ------------ ---------------- ----------
NRNU1l CLOSED N/A NO-REWIND/NO-UNLOAD/LOW-
DENSI
TY
NRNU1lc CLOSED N/A NO-REWIND/NO-UNLOAD/LOW-
DENSI
TY/COMPRESSED
NRNU1h CLOSED N/A NO-REWIND/NO-UNLOAD/HIGH-
DENS
ITY
NRNU1hc CLOSED N/A NO-REWIND/NO-UNLOAD/HIGH-
DENS
ITY/COMPRESSED
RNU1l CLOSED N/A REWIND/NO-UNLOAD/LOW-
DENSITY
RNU1lc CLOSED N/A REWIND/NO-UNLOAD/LOW-
DENSITY/
COMPRESSED
RNU1h CLOSED N/A REWIND/NO-UNLOAD/HIGH-
DENSITY
RNU1hc CLOSED N/A REWIND/NO-UNLOAD/HIGH-
DENSITY
/COMPRESSED
RU1l CLOSED N/A REWIND/UNLOAD/LOW-DENSITY
RU1lc CLOSED N/A REWIND/UNLOAD/LOW-DENSITY/
COM
PRESSED
RU1h CLOSED N/A REWIND/UNLOAD/HIGH-DENSITY
RU1hc CLOSED N/A REWIND/UNLOAD/HIGH-DENSITY/
CO
MPRESSED
---more---[q:Quit][Enter]
The tape devices list shows the following information:

28-10
• The tape device’s physical name.

• The tape device’s logical device name. Each physical device can support up to 12
logical device names.
• The tape’s state. Valid states are as follows:
- CLOSED
- OPENING
- OPEN
- BUSY
- REWINDING
- UNLOADING
- CLOSING
• Any configured alias for each tape device. If the device has no configured alias,
the Alias field contains N/A.
• The tape’s attributes. Valid values are as follows:
- density, either high density (HIGH-DENSITY) or low density (LOW-
DENSITY).
- compression state, either compression is enabled (COMPRESSED) or
compression is not enabled. If the tape attributes do not explicitly say
COMPRESSED, compression is not enabled on the tape drive.
- rewind state, either rewind (REWIND) or do not rewind (NO-
REWIND) when the tape is closed.
- unload state, either unload a tape (UNLOAD) or do not unload (NO-
UNLOAD) a tape when it is closed.
Related Commands
tape close Closes the specified tape device.
tape mc Lists all available media changer devices.

28-11
Tape Display Device State
Synopsis
tape devstate DEVNAME
Description
The tape device state contains information about the tape device’s operational
parameters. If a tape device is open, you can query the tape device for its operational
parameters by running the tape devstate command.
The tape needs to be open for the tape devstate command to complete, otherwise,
the NAS Gateway shows an error message indicating that the device is not open.
Options
The DEVNAME variable is the unique name of the tape drive on
which you are checking state information. The DEVNAME string
can be a physical device name or a logical device name.
Example
eng43> tape devstate QUANTUM_PMC01P3145_0

Flags: NO REWIND, NO UNLOAD, density 0: BOM
File number: 0
Block number: 0
Fixed block size: 0
Total space: 37580963840
Space remaining: INVALID
Soft Errors: INVALID
eng43>
This command shows the following information about a specific tape device:
• Flags, such as rewind state, unload state, or density.
• The current file number on which the tape head is located.
• The current block number on which the tape head is located.

28-12
• The tape device’s fixed block size, if the tape device is configured for fixed block
size. If the tape device is configured for variable block size, this field shows a zero
(0).
• The total space, in bytes, that the tape device supports.
• The amount of available space that remains on the tape device. If this value shows
INVALID, the NAS Gateway does not support calculating available space.
• A list of the soft errors on the tape device. If this value shows INVALID, the NAS
Gateway does not support soft error detection.
Related Commands
Tape Display Media Changer List
Synopsis
tape mc devlist
Description
You can display the Media Changers List that the NAS Gateway has discovered by
running the tape mc devlist command. The media changers are listed by their
physical or logical device name, and the media changers displayed are listed
regardless of their state. Therefore, if a media changer is discovered and online, but
has encountered an error condition that prevents it from operating properly, the
changer still appears in the display.

28-13
Example
eng43> tape mc devlist

Alias
---------------------------------------- --------------- ----------
---------- ----------------
ATL_PART_1_0 ATL P4000-6437052
N/
A
ATL_PART_3_0 ATL P4000-6437052
N/
A
STK_LLC02205345_0 STK L40
N/
A
ATL_PART_2_1 ATL P4000-6437052
N/
A
eng43>
This example shows the available media changers in the SAN. The media changer list
shows the following information:
• The physical device name for the tape
• The tape device’s vendor
• The tape device’s product or model number
• The tape device’s alias (if configured)
Related Commands
Tape Media Changer Alias Clear
Synopsis
tape mc alias clear ALIAS

28-14
Description
When a media changer alias is configured, you can remove it at any time by running
the tape mc alias clear command. When you run this command, the alias
associated with the media changer is removed, and you can manage the media changer
through the device name or the logical device.
Options
The ALIAS variable is the name of the alias you are removing.
Example
eng43> tape mc alias clear mediachanger1

Media changer alias mediachanger1 successfully cleared
eng43>
In this example, the alias mediachanger1 is cleared from the media changer. When this
command completes, the tape device is addressable only by a device name, not the
alias.
Related Commands
tape mc alias set Sets the alias for a media changer.
tape mc alias show Lists all user defined aliases for media changers.
Tape Media Changer Alias Set
Synopsis
tape mc alias set DEVNAME ALIAS [-f]
Description
You can assign media changers an alias to facilitate identification of the device. When
you assign an alias device, you associate a text string with the media changer’s actual
device name. For example, you could create an alias called mediachanger2 to identify

28-15
a media changer instead of referring to it as STK_LLC02205345_0. You can create an

alias for a media changer by running the tape mc alias set command.
Options
Table 28-4 : Options for the tape mc alias set command
DEVNAME The physical device name of the media

changer as known to the NAS Gateway.
ALIAS An alphanumeric text string that you are
assigning to the media changer. The alias
can have up to 32 characters.
-f An optional argument for overwriting an
existing alias.
Example
eng43> tape mc alias set ATL_PART_2_1 mediachanger1

Media changer alias debut successfully set for ATL_PART_2_1
eng43>
In this example, the alias mediachanger1 is set for the media changer ATL_PART_2_1.
When this command completes, the tape device is addressable by either device name
or alias.
Related Commands
tape mc alias clear Clears the specified media changer alias.
tape mc alias show Lists all user-defined aliases for media changers.

28-16
Tape Media Changer Alias Show
Synopsis
tape mc alias show
Description
Media changers that have been given aliases are kept in the media changers alias list.
You can display the media changers alias list by running the tape mc alias show
command.
This list contains the following information for media changers that have been aliased:
• The physical device name
• The alias that has been assigned
Example
eng43> tape mc alias show

Physical Device Name Alias
---------------------------------------- ----------------
ATL_PART_2_1 mediachanger1
eng43>
This example shows the media changers alias list.
Related Commands
tape mc alias clear Clears the specified media changer alias.
tape mc alias set Sets the alias for a media changer.
Tape Release
Synopsis
tape release DEVNAME

28-17
Description
Use the tape release command to release a reserved tape device.
Note!
Use this command with caution, because you could inadvertently release a tape
device that was reserved by someone else or another NAS Gateway.
Options
The DEVNAME variable is the name of the reserved tape device to
be released.
Example
eng43> tape release QUANTUM_PMC01P3145_0

eng43>
In this example, the reserved tape QUANTUM_PMC01P3145_0 is released.
Related Commands

28-18

Chapter 29: User Account
Commands
This chapter documents the following useraccount commands:
• “Useraccount Add” on page 29-2
• “Useraccount Delete” on page 29-4
• “Useraccount Modify Password” on page 29-5
• “Useraccount Show” on page 29-7

29-2
Useraccount Add
Synopsis
useraccount add USERNAME [-k “PUBKEY”]
Description
You can add a local user account by running the useraccount add command. This
command creates a new user account on the ONStor™ NAS Gateway. As part of the
account creation, you are required to specify a password for the user account you are
configuring.
When you type the user name, the NAS Gateway prompts you for the user account's
password. The password for the user account is an alphanumeric character string from
6 to 63 characters. For security purposes, the password is not displayed when you
configure it with this command.
Local user accounts are a method for adding user name and password information to
the NAS Gateway for purposes such as the following:
• Creating logon accounts that are stored on the NAS Gateway.
• Creating a challenge string or constructing an MD5 has for NDMP client and
server authentication.
Note!
If you want to start the ONStor VirusScan applet from any user account, you
need to configure that user account with BACKUP and RESTORE privileges
because the VirusScan applet needs to access files in read/write mode in the
virtual server. The scope of the privilege can be either VIRTUAL SERVER or
CLUSTER. For details on how to set privileges, see “Privilege Commands” on
page 20-1.

29-3
Options
Table 29-1 : Options for the useraccount add command
USERNAME The user account name. The user

account name is an alphanumeric
character string from 6 to 63 characters.
-k “PUBKEY” The secure shell (SSH) key for a local
user account when the user account is
created. The -k PUBKEY argument
needs to be the SSH key that the client
generated. If the key is not supplied or is
not an exact match with the client’s SSH
key, the user account cannot
automatically log on. Therefore, you
need to type a password every time the
user account accesses the NAS Gateway.
The first time you create a local user
account, you need to specify the
password, even if you use the -k
PUBKEY argument. The NAS Gateway
gives precedence to the SSH key, so if it
is specified, it is used and the password
is not. If the SSH key is removed, the
password is still configured, and you
need to type it for the local user account
to be granted access to the NAS
Gateway.
The PUBKEY value is a character string
of up to 4094 characters enclosed in
double quotation marks.

29-4
Example
eng43> useraccount add pubstest

Enter Password:
Enter Password:
Success: User account creation completed.
eng43>
In this example, the local user account pubstest is added to the NAS Gateway. As part
of the account creation, the NAS Gateway prompts you for the accounts password.
The password is not displayed while it is being configured.
Related Commands
useraccount delete Deletes a local user account.
useraccount modify Modifies the password for specified user
account.
useraccount show Shows all configured user accounts.
Useraccount Delete
Synopsis
useraccount delete USERNAME
Description
You can remove a local user account at any time by running the useraccount delete
command. When the local user account is deleted, the following occurs:
• The owner of the local user account cannot log on to the NAS Gateway through
that user account.
• NDMP authentication between the client and server is no longer possible through
that local user account.

29-5
Options
The USERNAME variable is the name of the user account. The user
account name is an alphanumeric character string from 6 to 63
characters.
Example
eng43> useraccount delete pubstest

Success: User account deletion completed.
eng43>
In this example, the local user account pubstest and its password are deleted.
Related Commands
useraccount add Adds a new useraccount to the system.
useraccount modify Modifies the password for user account.
Useraccount Modify Password
Synopsis
useraccount modify USERNAME [-k “PUBKEY”]
Description
You can modify the password for the local user account at any time by running the
useraccount modify command. This command changes the password associated
with a local user account, but does not allow changing the account itself. Therefore, if
you want to change the user account, you need to delete and recreate the user account
and supply a new password.
When you run the useraccount modify command, the NAS Gateway prompts you to
type the new password for a specified user account. The new password for the user
account is an alphanumeric character string from 6 to 63 characters. The new

29-6
password is immediately active. For security reasons, the password is not displayed
when you type it.
Options
Table 29-2 : Options for the useraccount modify password command
USERNAME The user account name. The user

account name is an alphanumeric
character string from 6 to 63 characters.
-k “PUBKEY” You can use the -k PUBKEY to modify a
local user account’s SSH key, or to
delete the SSH key from an existing
local user account. To delete the SSH
key, specify the -k PUBKEY argument
with double quotation marks but no SSH
key string. Set the key string to an empty
string (no value). If you delete the SSH
key for a local user account, you need to
specify the password every time that
local user account accesses the NAS
Gateway.
The PUBKEY value is a character string
of up to 4094 characters enclosed in
double quotation marks.

29-7
Example
eng43> useraccount modify pubstest

Enter New Password:
Enter Password:
Success: User account modification completed.
eng43>
In this example, the local user account pubstest is given a new password. When the
new password is configured, it is available for immediate use.
Related Commands
useraccount add Adds a new user account to the system.
Useraccount Show
Synopsis
useraccount show
Description
When a local user account is created, it is added to the local user account list. This list
contains all the currently defined local user accounts on the NAS Gateway. You can
display the configured local user accounts by running the useraccount show
command.

29-8
Example
eng43> useraccount show

-------------------------------------------------------------------
| User Name |
-------------------------------------------------------------------
| vs1-ndmp1 |
-------------------------------------------------------------------
| pubstest |
-------------------------------------------------------------------
eng43>
This example shows the local user account table. The local user account table shows
all the configured user accounts on the current NAS Gateway.
Related Commands
useraccount add Adds a new user account to the system.
useraccount modify Modifies the password for specified user
account.

Chapter 30: Virtual Server
Commands
This command documents the following virtual server commands:
• “Virtual Server Clear” on page 30-2
• “Virtual Server Clear Autocreate” on page 30-2
• “Virtual Server Clear Domain” on page 30-3
• “Virtual Server Set Unprotected” on page 30-5
• “Virtual Server Clear WINS Server” on page 30-5
• “Virtual Server Create” on page 30-6
• “Virtual Server Delete” on page 30-10
• “Virtual Server Disable” on page 30-12
• “Virtual Server Enable” on page 30-13
• “Virtual Server Move” on page 30-15
• “Virtual Server Set AutoCreate” on page 30-16
• “Virtual Server Set Context” on page 30-19
• “Virtual Server Set Domain” on page 30-20
• “Virtual Server Set Name Generic” on page 30-24
• “Virtual Server Set Protected” on page 30-26
• “Virtual Server Set WINS Server” on page 30-27
• “Virtual Server Show” on page 30-30
• “Virtual Server Statistics” on page 30-33

30-2
Virtual Server Clear
Synopsis
vsvr clear
Description
You can exit a specific virtual server by clearing its context. To do so, run the vsvr
clear command. This command does not delete a virtual server or release any
resources configured within a virtual server. Instead, when you run this command, you
return to the ONStor™ NAS Gateway context.
Example
eng31 PUBSTEST3> vsvr clear

eng31>
In this example, the context for virtual server pubstest3 is cleared. When the virtual
server context is cleared, you return to the NAS Gateway context.
Related Commands
commands.
Virtual Server Clear Autocreate
Synopsis
vsvr clear autocreate
Description
At any time, you can delete the autocreate facility by running the vsvr clear
autocreate command. Users no longer have a share to their home directory
automatically available when they log on. After deleting the autocreate facility, all

30-3
users need to manually navigate the file system to their home directories through the
virtual server.
Note!
To delete the autocreate facility, the virtual server needs to be in the disabled
state.
Example
eng31 PUBSTEST3> vsvr clear autocreate

eng31 PUBSTEST3>
In this example, the autocreate facility is deleted from the virtual server pubstest3.
When the vsvr clear autocreate command completes, the home share directories
are not exported automatically to logged in users. However, users can still connect to
shares explicitly.
Related Commands
commands
vsvr disable Disables the current virtual server
Virtual Server Clear Domain
Synopsis
vsvr clear domain ldap|nis|windows [DOMAINNAME]
Description
You can remove a domain from a virtual server by running the vsvr clear domain
command. This command removes the association of a domain and a virtual server as
long as the virtual server is in the disabled state. You can put the virtual server into
disabled state by running the vsvr disable command. When you delete the
association of a domain and a virtual server, the virtual server still exists, but it can no
longer use the domain’s services.

30-4
Options
Table 30-1 : Options for the vsvr clear domain command
ldap|nis|windows A list from which you specify one

domain type at a time to be removed.
DOMAINNAME The name of the LDAP, network
information services (NIS), or Windows
domain that you are deleting. Specify
this argument only if you are deleting an
LDAP, NIS, or Windows domain.
Example
In the following example, the LDAP domain domain1 is deleted from pubstest3.
eng31 PUBSTEST3> vsvr clear domain ldap domain1

eng31 PUBSTEST3>
In the following example, the NIS domain spectrum is deleted from the virtual server
pubstest3
eng31 PUBSTEST3> vsvr clear domain nis spectrum

eng31 PUBSTEST3>
In the following example, the Windows domain chromatis is deleted pubstest3.
eng31 PUBSTEST3> vsvr clear domain windows chromatis

eng31 PUBSTEST3>
Related Commands
commands.

30-5
vsvr disable Disables the current virtual server.
Virtual Server Set Unprotected
Synopsis
vsvr set unprotected
Description
This command clears the protected state for the current virtual server. A virtual server
that is not protected does not failover to another NAS Gateway in case of a failure. The
management virtual server does not support failover, therefore you cannot run this
command on the management virtual server.
Example
eng31 PUBSTEST3> vsvr set unprotected

eng31>
In this example, the protected state for virtual server pubstest3 is cleared.
Related Commands
commands.
Virtual Server Clear WINS Server
Synopsis
vsvr clear wins
Description
You can delete the Windows Internet naming service (WINS) server address from a
domain at any time by running the vsvr clear wins command. Use this command to

30-6
delete the IP address of the primary and secondary WINS server, if your network is
configured with redundant WINS servers. When you delete the WINS server, the
name to IP address resolution does not occur for the virtual server.
You can delete the WINS server IP addresses from a virtual server only if the virtual
server is in the disabled state. You can put the virtual server into disabled state by
running the vsvr disable command.
Example
eng31 PUBSTEST3> vsvr clear wins

eng31 PUBSTEST3>
In this example, the WINS servers for virtual server pubstest3 are deleted.
Related Commands
commands.
Virtual Server Create
Synopsis
vsvr create VIRTUALSERVER [-n NODE] [-u]
Description
Use the vsvr create command to create a virtual server on the NAS Gateway. By
default, the vsvr create command creates the virtual server on the current NAS
Gateway, but you can use the -n NODE argument to specify another NAS Gateway in
the cluster as the target of the vsvr create command. When you run this command,
the NAS Gateway is added in its default state of disabled.

30-7
The software supports a maximum of 32 nonmanagement virtual servers per cluster.

When you run the vsvr create command to create a virtual server, the software
checks the cluster to determine whether the limit has been reached.
When the vsvr create command completes, the command prompt changes to
include the name of the virtual server you just created. The changed command prompt
indicates that you have switched from the NAS Gateway context to the context of the
newly created virtual server. While you are in a virtual server context, all subsequent
configuration commands apply to the virtual server. For example, if you are in the
context of the virtual server pubstest, and you create a volume, the volume is assigned
to pubstest only. By default, any virtual server you create is in the disabled state and
needs to be explicitly enabled to support file services and IP connectivity to clients.
Note!
• A virtual server does not provide file services unless it is in the enabled
state. To enable a virtual server, run the vsvr enable command. This
command activates all the resources for file services and makes the
resources available to clients.
• Even though virtual server names are displayed in uppercase, they are
case insensitive when entered at the command prompt. Therefore, you can
specify a virtual server name in uppercase or lowercase when you run any
of the vsvr commands.

30-8
Options
Table 30-2 : Options for the vsvr create command
VIRTUALSERVER An alphanumeric character string of up

to 15 characters. Do not use special
characters in the virtual server name,
such as * , ?, and /. Virtual server names
start with an alphabetic or numeric
character, and each virtual server name
needs to be unique within a cluster.
-u An optional argument that sets the
virtual server to unprotected mode.
When unprotected mode is set, the
virtual server does not switch over to a
different NAS Gateway in case of a
failure. By default the virtual server is
created in protected mode. To set an
existing unprotected virtual server to
protected mode, use the vsvr set
protected command. See page 26
for details.
-n NODE An optional argument that configures
the virtual server on any node in a
cluster.
If you specify the -n option and type a
node name, the virtual server is created
on that node.
If you do not specify the -n option, the
virtual server is created on the current
NAS Gateway.

30-9
Example
In the following example a virtual server is created.
eng31> vsvr create pubstest3

eng31 PUBSTEST3>
In this example, the virtual server pubstest3 is created. The command prompt contains
only the NAS Gateway’s node name when you run this command to indicate that you
are in the NAS Gateway context when you run the vsvr create command. While you
are in the NAS Gateway context, all commands you run apply to the NAS Gateway.
However, at the completion of the vsvr create command, you are in the context of
the virtual server that you just created, in this example pubstest3. The command
prompt changes to indicate that you are now in the context of pubstest3. When you are
in the context of a virtual server, all subsequent virtual server commands apply to that
virtual server.
In the following example a virtual server is created on a different NAS Gateway.
eng31> vsvr create pubstest3 -n MadMax

eng31 PUBSTEST3>
In this example the command vsvr create is run from the eng31 NAS Gateway to
create the virtual server pubstest3 on the MadMax NAS Gateway.
In the following example a virtual server is created in unprotected mode.
eng31> vsvr create pubstest3 -u

eng31 PUBSTEST3>
Related Commands
interface create Assigns an IP address to a physical interface.
route add default Adds a default static route.
route add net Adds a network static route.
server.

30-10
vsvr enable Enables the current virtual server.

vsvr set domain nis Sets the NIS domain name for the virtual server.
vsvr set domain windows Sets the windows domain name for the virtual
server.
Virtual Server Delete
Synopsis
vsvr delete [VIRTUALSERVER]
Description
At any time, you can delete a virtual server by running the vsvr delete command. It
will fail if the virtual server still owns some volumes. You have to delete the volumes
first before deleting the virtual server. When you run this command, the NAS Gateway
automatically removes IP interfaces that are assigned to the virtual server although
you can also delete these resources individually through their corresponding
commands. When a virtual server has been deleted, domain bindings are removed, and
export interfaces no longer exist, so client connectivity to the virtual server no longer
exists.
The vsvr delete command deletes the virtual server configuration and removes it
from memory and all databases. This command is different than the vsvr disable
command, which keeps the virtual server configuration, but deactivates it. Because the
vsvr delete command deletes the virtual server configuration, it is the last step in
deleting the virtual server.
After you delete a virtual server, you automatically revert to the NAS Gateway
context, and the resources that were associated with the deleted virtual server are now
available for assignment to another virtual server.

30-11
Note!
The vsvr delete command is available through the NAS Gateway context and a
virtual server context. The context you are in when you run this command
affects whether you need to specify an argument in one of the following ways.
• If you run the vsvr delete command through the NAS Gateway context,
you need to specify the virtual server to delete.
• If you run the vsvr delete command from the context of a specific virtual
server, you do not need to specify the virtual server name. The virtual
server that has the current context is deleted.
When you run the vsvr delete command, the NAS Gateway prompts you for
confirmation with the following prompt:
Are you sure? [y|n]
Type Y to confirm the deletion, or type N to cancel the deletion of the virtual server. If
you accept the deletion, the virtual server is removed from the configuration and
deleted from runtime.
Note!
The NAS Gateway requires at least one virtual server for processing client I/O.
Do not delete the only virtual server in a cluster, otherwise, you will isolate
clients from storage area network (SAN) resources.
Options
The VIRTUALSERVER variable is an alphanumeric character string
of up to 15 characters.
Example
eng31 PUBSTEST3> vsvr delete

Done
eng31>
In this example, the virtual server pubstest3 is deleted. When the virtual server is
deleted, you return to the NAS Gateway context.

30-12
Related Commands
volume delete Deletes the volume
vsvr enable Enables the current virtual server.
vsvr set Sets the virtual server for all future commands.
vsvr show Shows one or more virtual servers.
Virtual Server Disable
Synopsis
vsvr disable
Description
When a virtual server is in the disabled state, it has no runtime resources allocated to
support IP interfaces or shares, and it is not active in runtime. Resources are still
configured in the virtual server, but the resources are not active in runtime. Therefore,
the virtual server does not process client input, participate in a domain, or support load
balancing functionality. The virtual server is disabled by default, but you can enable it
with the vsvr enable command.
You can disable virtual servers by running the vsvr disable command. When you
disable a virtual server, any runtime resources used by IP is deleted, and the NAS
Gateway refuses any new clients or requests. Running the vsvr disable command
changes the virtual server’s state in runtime, but it does not delete any configuration.
Disabling a virtual server is required before you can do the following:
• Adding the virtual server to a domain, through the vsvr set domain command,
which can only be done when the virtual server is disabled. As an alternative to
disabling the server to set the domain, you can leave the virtual server in its default
state of disabled when you are initially configuring the virtual server. After all the
virtual server’s parameters are configured, including the domain, you can run the
vsvr enable command to activate the virtual server.

30-13
• Changing the configuration of a previously enabled virtual server. You can change
the configuration of a virtual server that has previously been enabled only by
disabling the virtual server, then making the required configuration changes, then
reenabling the virtual server.
You can disable a virtual server by running the vsvr disable command. However, at
least one virtual server needs to remain enabled in each cluster to support client file
access. Do not disable the last virtual server unless you want to halt file access through
the NAS Gateway.
Example
eng31 PUBSTEST3> vsvr disable

Done
eng31 PUBSTEST3>
In this example, the virtual server pubstest3 is disabled. Disabling a virtual server
discontinues IP connectivity and file services to the clients. The disable function
prompts you for confirmation before disabling the virtual server.
Related Commands
Virtual Server Enable
Synopsis
vsvr enable
Description
When you have created a virtual server with the vsvr create command, the virtual
server is in disabled state by default.

30-14
To enable a virtual server, it is not required that the virtual server have any configured
resources, for example, IP interfaces, volumes, or shares. Therefore, you can create the
virtual server, and immediately run the vsvr enable command to enable it in
runtime. When the virtual server is active in runtime, you can switch to the virtual
server by running the vsvr set command and continue configuring volumes and
shares. However, to configure most of the virtual server parameters within the context
of that virtual server, the virtual server needs to be in the disabled state.
You can configure some virtual server parameters regardless of whether the virtual
server disabled or enabled. However, the virtual server needs to be enabled for it to
operate.
The vsvr enable command does not write parameters into the configuration because
the NAS Gateway adds parameters to the configuration as soon as they are configured.
Instead, this command makes the virtual server available in runtime by setting up
internal sockets and bind points for IP interfaces, and activating the virtual server so
that you can configure and use shares.
You can activate the virtual server by running the vsvr enable command. Any new
or changed virtual server parameters become active when you run this command.
Example
eng31 PUBSTEST3> vsvr enable

Done
eng31 PUBSTEST3>
In this example, the virtual server pubstest3 is enabled. The enable function only
brings the virtual server online in runtime. Enable has no relation to whether a virtual
server has been correctly configured. Therefore, a virtual server can be incorrectly
configured but still enabled.
Related Commands

30-15
Virtual Server Move
Synopsis
vsvr move [-f DSTNASGATEWAY | -g DSTGROUP]
Description
In certain circumstances, you might need to move a virtual server to a different single
NAS Gateway or NAS Gateway group. For example, if you are upgrading an NAS
Gateway in a multinode cluster, you can switch the virtual servers from one NAS
Gateway to another NAS Gateway, or another NAS Gateway group in the cluster,
while you are performing the upgrade on an NAS Gateway. You can move a virtual
server by running the vsvr move command. This command causes a graceful failover
of the virtual server to a different NAS Gateway. When the vsvr move command
completes, the virtual server configuration, the IP interfaces, volumes, and shares
configured on the virtual server are retained and relocated to a NAS Gateway or NAS
Gateway group that you name. After the move completes, the virtual server is in
disabled state.
Note!
Unprotected servers do not automatically fail over in case of a failure. Use the
vsvr move command to explicitly move them.
Moving a virtual server is beneficial for several usages:
• Load Balancing.
• If a hot swap procedure is required on the NAS Gateway.
• If an event causes a protected mode virtual server to switch to a NAS Gateway, and
you want to switch the virtual server back to its original NAS Gateway after the
event has been remedied.
Note!
When moving virtual servers, make sure that the IP subnets for the virtual
servers you are moving are accessible from the destination NAS Gateway. The
destination gateway, or one of the gateways within the destination group also
needs to have the same lport names as the ones used by the interfaces of the
virtual server, since lport configuration is local to each Gateway.

30-16
Options
Table 30-3 : Options for the vsvr move command
-f DSTNASGATEWAY The name of the single NAS Gateway to

which you are moving the virtual server.
-g DSTGROUP The name of the NAS Gateway group to
which you are moving the virtual.
Example
eng31 PUBSTEST3> vsvr move -f pubstest1

eng31 PUBSTEST3>
In this example, virtual server pubstest3 is moved to the NAS Gateway pubstest1 of
the NAS Gateway group MadMax.
Related Commands
cluster show group Shows cluster group configuration.
Virtual Server Set AutoCreate
Synopsis
vsvr set autocreate VOLNAME PATHNAME
Description
Each virtual server can contain an autocreate volume, which supports home directories
for users. The autocreate volume feature has been implemented for use by common
Internet file services (CIFS) clients only. You can configure the autocreate volume
through the vsvr set autocreate command. With this command you can configure
the volume and path to users’ home directories.

30-17
When the autocreate volume and path are created, they are listed as part of the virtual
server’s configuration. When the virtual server is enabled, the volume and path are
exported along with any specific shares that are configured in the virtual server. If you
are using the autocreate feature, you do not need to configure individual shares for
each user. Instead, you can specify the autocreate volume and path only once. The
NAS Gateway then creates the share to each user’s home directory.
Part of the vsvr set autocreate command is a path. For a share with the user’s
name to appear in the shares list, a directory with the same name has to exist in the
path. For example, assume the path is \users\local\homes on the volume pubstest. For
a share called paulw pointing to that directory to appear in the shares list, the directory
\users\local\homes\paulw needs to exist on the volume pubstest. If the directory has a
different name than the path you specify, the share named for the user is not listed in
the shares list. For example, if the actual directory in the network is
\users\local\homes\paulw and the path specified in the vsvr set autocreate
command is specified as \user\local\homes, the homes directory share for paulw is not
displayed in the shares list because of the difference in the word “users.”
Consider the following when using the autocreate volume feature:
• You can run vsvr set autocreate only when the virtual server is in the disabled
state.
• The volume you specify as the autocreate volume needs to be read-writable.
• The volume containing home directories need to exist.
• The path to the home directories needs to exist in the file system on the home
directories volume.
• Have a home directory for each user.
• The user’s home directory name needs to be the same as the user’s windows logon.
• If a user logs in with a different name, the user can directly connect to the home
directories of other users. For example, user paulw can connect to the home
directory of johndoe even though this share is not listed by default for paulw. After
a user has connected to another user’s home directory share, this share is listed in
the connected user’s shares list as long as the user remains connected to that share.
For example, paulw will see a share johndoe while listing the shares in the same
virtual server, but only for as long as paulw is connected to the johndoe share.

30-18
Options
Table 30-4 : Options for the vsvr set autocreate command
VOLNAME An alphanumeric character string of up

to 127 characters that identifies the
volume in which the homes directory are
configured. Type the volume name.
Volume names can begin with an
alphanumeric character, an underscore (
_ ), or a hyphen ( - ). The volume needs
to exist before you run this command.
PATHNAME An alphanumeric character string of up
to 256 characters that specifies the
absolute path to the directory in which
the user home directories are configured,
for example: \users\local\homes. You do
not need to specify the user name as part
of the path. The NAS Gateway scans the
user name from the user’s logon and
uses the name to determine which home
directory is shared with which user.
Example
eng31 PUBSTEST3> vsvr set autocreate vol1 \users\homes\local

eng31 PUBSTEST3>
In this example, the autocreate volume and path are specified for the virtual server
pubstest. When users log on to this virtual server, their home share directories are

30-19
automatically exported to them. All other shares are available to users if the shares are
configured to export to them, and if the users have the proper share level privileges.
Related Commands
Virtual Server Set Context
Synopsis
vsvr set VIRTUALSERVER
Description
Each NAS Gateway can contain more than one virtual server. By running the vsvr
set command, you can switch the context of a virtual server. From within that context
you can configure the virtual server’s resources.
Note!
This command is cluster aware, so when you run it you can change context to
any virtual server in the cluster regardless of NAS Gateway on which it resides.
To switch a server’s context, the virtual server needs to exist. You can switch between
virtual servers regardless of a virtual server’s state as long as the virtual server exists.
Each time you switch the context of a virtual server, the NAS Gateway posts a
confirmation message to the command line. In addition, you can tell the vsvr set
command has completed by looking at the command prompt after you run the
command:
• If the command completes on an existing virtual server, the command prompt
contains the name of the new virtual server, and you are in the context of the new
virtual server.

30-20
• If the command does not complete, the command prompt shows the name of the
same virtual server that you were in before running the command. You are in the
context of the same virtual server because you have not changed.
Note!
Even though virtual server names are displayed in uppercase, they are case
insensitive when entered at the command prompt. Therefore, you can specify a
virtual server name in uppercase or lowercase when you run any of the vsvr
commands.
Options
The VIRTUALSERVER variable is an alphanumeric character string
of up to 15 characters.
Example
eng31 pubstest3> vsvr set vs1-production

eng31 VS1-PRODUCTION>
In this example, the virtual server pubstest3 is switched to the context of the virtual
server vs1-production. When the vsvr set command completes, the command
prompt changes to indicate the new virtual server to which you have changed. When
you are in the new virtual server’s context, all subsequent commands apply to that
virtual server.
Related Commands
vsvr clear Clears the virtual server for all future
commands.
Virtual Server Set Domain
Synopsis
vsvr set domain ldap|nis|windows DOMAINNAME [ADMINUSER] [-o
ORGUNIT]

30-21
Description
For a virtual server to participate in services provided by a domain, you need to
associate the virtual server with the domain. For example, to enable authentication of
users, you can configure the domain servers for each virtual server. The incoming NFS
clients would be authenticated by LDAP or NIS domains and the CIFS clients would
be authenticated by the Windows domain. You can associate the following types of
domains with a virtual server:
• LDAP domain
• Windows domain (DNS)
• UNIX domain (NIS)
Note!
To support name authentication services, the domains need to exist on the NAS
Gateway. You can add domains with the domain add command. The domain
add command does not require a specific virtual server context, so you can run
the domain add commands from the NAS Gateway context.
You can add a virtual server to a domain only if the virtual server is in the disabled
state. You can put the virtual server into disabled state by running the vsvr disable
command.
Note!
• With this command, you need to also specify a password for the windows
domains. This is the password of the ADMINUSER that you specified.
With the Windows domain passwords, the software imposes a minimum
length of six characters. Make sure that you specify a password of six
characters or more when entering a password on EverON™ software.

30-22
Options
Table 30-5 : Options for the vsvr set domain command
ldap|nis|windows A list from which you specify one

domain type at a time. You can set each
domain type for a virtual server by
running this command once for each
domain type.
DOMAINNAME The name of the LDAP, NIS, or
Windows domain that you are adding.
Type the domain name.
ADMINUSER The name of the Windows domain
administrator. This field is required only
if you are configuring the virtual server
in a Windows domain.
-o ORGUNIT The organizational unit in which the
computer object for the virtual server
should be created. This option is only set
for a Kerberos domain.
ORGUNIT may consist of the following
command-delimited keywords:
• ou - in the format ou=aaa. If aaa
contains spaces, it must be enclosed
in double quotes.
• dc - in the format dc=bbb
If ORGUNIT is not specified, the
computer object is created under the
“CN=Computers” object in the Active
Directory.

30-23
Example
In the following example, the virtual server pubstest3 is configured with the LDAP
domain domain1.
eng31 PUBSTEST3> vsvr set domain ldap domain1

eng31 PUBSTEST3>
In the following example, the virtual server pubstest3 is configured with the NIS
domain spectrum.
eng31 PUBSTEST3> vsvr set domain nis spectrum

eng31 PUBSTEST3>
In the following example, the virtual server pubstest3 is configured in the Windows
domain chromatis. Because the virtual server is added to a Windows domain, the
command also contains a valid Windows administrator name to allow the virtual
server to join the domain..
eng31 PUBSTEST3> vsvr set domain windows chromatis enguser

Password:
eng31 PUBSTEST3>
In the following example, the organizational unit is muddy and the domain is
smallpond.lab.
eng233 YC> vsvr set domain windows smallpond enguser -o

ou=muddy,dc=smallpond,dc=lab
Enter Password:
eng233 YC>
Related Commands
domain show windows Shows the list of windows domains configured.

30-24
Virtual Server Set Name Generic
Synopsis
vsvr set name generic NAME
Description
You can rename an existing virtual server, with the vsvr set name generic command.
Use this command to change name of an existing virtual server. Changing the generic
name of a virtual server will not change its NetBIOS name. The virtual server ID does
not change when you change the virtual server name. Consider the following when
using the virtual server set name generic command:
• The command works only in the context of the virtual server whose name you
want to change.
• You need to disable the virtual server who’s name you want to change. Use the
vsvr disable and vsvr enable commands to disable, then reenable, the virtual
server.
• You cannot rename the management virtual server.
• The new name for the virtual server has the same restrictions as the original name
you used when you created the virtual server with the vsvr create command.
Restrictions are as follows:
- The new virtual server name needs to start with an alphanumeric
character, or with a dash ( - ) or an underscore ( _ ).
- The new virtual server name can have up to 15 characters.
- The new virtual server name cannot use a name starting with
“VS_MGMT”, which is reserved for the management virtual server.
- The new virtual server name cannot be the reserved word “all”.
Note!
Virtual server names are case insensitive, so the name “vs1” is the same as the
name “VS1”.

30-25
Options
The NAME variable is the new name you are giving to the virtual
server.
Example
eng46 SALES> vsvr set name generic channelsales

eng46 CHANNELSALES>
In this example, assuming the virtual server SALES is disabled, the virtual server name
is changed from SALES to CHANNELSALES. After the name change is complete,
reenable to bring the virtual server back online.
Related Commands
vsvr set Sets the context of the current virtual server.
vsvr enable Enables the virtual server.
Virtual Server Set Name Netbios
Synopsis
vsvr set name netbios NAME
Description
The vsvr set name netbios NAME command sets the NetBIOS name used by
CIFS on a specified virtual server. By default, the NetBIOS name is the same as the
virtual server name, as long as it does not exceed 15 bytes. This command overrides
that rule. The virtual server must be disabled before you can run this command.
Options
The NAME variable is the NetBIOS name you are giving to the

30-26
virtual server. This name cannot exceed 15 bytes in length.
Example
eng13 REN> vsvr set name netbios MARKETING

eng13 REN> vsvr show
Virtual Server
==============
ID : 7 (protected)
Status : Disabled
Name : REN
NetBIOS name : MARKETING
IP address 1 : 10.3.113.11/255.255.0.0
Windows domain : --Not-Set--
Unix domain : onstorlab
LDAP domain : --Not-Set--
Volumes owned : ren-vol1
Volumes mounted : ren-vol1
Related Commands
vsvr set Sets the context of the current virtual server.
vsvr name generic Changes the name of the virtual server.
Virtual Server Set Protected
Synopsis
vsvr set protected

30-27
Description
This command sets the protected state for the current virtual server. A virtual server
that is protected fails over to another NAS Gateway in case of a failure.
Example
eng31 pubstest3> vsvr set protected

eng31 pubstest3>
In this example, virtual server pubstest3 is set to protected state. Therefore, if a failure
occurs on NAS Gateway eng31, the virtual server can fail over to another NAS
Gateway.
Related Commands
Virtual Server Set WINS Server
Synopsis
vsvr set wins PRIMARYIPADDR [SECONDARYIPADDR]
Description
Each CIFS network can contain one or more WINS server. The WINS server functions
as a name server that governs the translation of NETBIOS or domain names to IP
addresses.
Each virtual server needs to be active in a domain. If the NAS Gateway cannot locate a
domain, the NAS Gateway queries the WINS server at the specified IP address. The
WINS server, in turn, locates the domain and reports the IP address of the domain’s
domain controller to the NAS Gateway. With the vsvr set wins command, you can
specify the IP address of the WINS server that a virtual server should use. Some
networks operate with redundant WINS servers, so as an option, you can specify the

30-28
primary and secondary WINS server’s IP addresses with the vsvr set wins
command.
You can specify the WINS server addresses for a virtual server only if the virtual
server is in the disabled state. You can put the virtual server into disabled state by
running the vsvr disable command.
Note!
This command is required if the WINS server is on a different subnet than the
virtual server. The WINS server can be integrated into the Windows domain
controller. If that is the case, you can use the domain controller’s IP address. If
the WINS server is configured on a different server than the domain controller,
type the IP address of the standalone WINS server.

30-29
Options
Table 30-6 : Options for the vsvr set wins command
PRIMARYIPADDR The IP address of the primary WINS server.

Because the WINS server can reside in a
standalone server or on the domain controller,
specify either the IP address of the standalone
WINS server, or the IP address of the domain
controller, whichever is pertinent to your
network configuration. Type the IP address in
dotted decimal notation.
[SECONDARYIPADDR] An optional argument that specifies the IP
address of the secondary WINS server (if one
is configured in your network). Because the
WINS server can reside in a standalone server
or on the domain controller, specify either the
IP address of the standalone WINS server, or
the IP address of the domain controller,
whichever is pertinent to your network
configuration. Type the IP address in dotted
decimal notation.
Example
eng31 PUBSTEST3> vsvr set wins 33.44.55.66 33.44.128.11

eng31 PUBSTEST3>
In this example, the virtual server pubstest3 is configured with the primary WINS
server 33.44.55.66, and the secondary WINS server at 33.44.128.11.

30-30
Related Commands
Virtual Server Show
Synopsis
vsvr show ([VIRTUALSERVER] [-v] | all ([-n NODE] | [-v])))
Description
When you run the vsvr create command, a virtual server is created and added to the
cluster database. At any time, you can view the state of a virtual server by running the
vsvr show command. This command shows all virtual servers by their virtual server
ID, and it shows the runtime state of the virtual server. If the state is enabled, the
virtual server can provide IP connectivity and file system mount points to clients. If
the state is disabled, the virtual server has no IP connectivity and mount points are not
exported. You can enable a disabled virtual server with the vsvr enable command.
In addition to listing all virtual servers, the vsvr show command retrieves different
types of information about a configured virtual server. At any time, you can filter the
output of the vsvr show command in the following ways:
• Use the vsvr show command with the keyword all to display the information
about all virtual servers in the cluster. You can specify this option from any NAS
Gateway in the cluster.
• You display the information about a specific virtual server by running the vsvr
show command and specifying the virtual server name. you can This option shows
detailed information about the specified virtual server, such as the following:
- The server’s ID number, and its mode as a protected server if that mode
is configured.
- The Windows or NIS domain in which the server is registered.
- The server’s mode

30-31
- The server’s state

- The IP interface the server owns.
- The autocreate volume name that is exported through the CIFS share
autocreation.
- The autocreate path for supporting CIFS share autocreation. The path is
created as part of the virtual server autocreate volume.
- The volumes owned by the virtual server.
- The volumes mounted on the virtual server.
Note!
Even though virtual server names are displayed in uppercase, they are case
insensitive when entered at the command prompt. Therefore, you can specify a
virtual server name in uppercase or lowercase when you run any of the vsvr
commands.
If a failover occurs, you can locate the virtual server by running the vsvr show
command. This command runs on the local NAS Gateway by default. If you run the
vsvr show command, and the virtual server is displayed, it resides on the local NAS
Gateway. If you run the vsvr show command, and the virtual server is not displayed, it
is not currently on the local NAS Gateway. You can run the vsvr show all command
to ensure that the virtual server is still in the cluster. Then you can run the vsvr show
-n NODE command on another NAS Gateway in the cluster, where NODE is the node
name of a NAS Gateway.
After locating the virtual server, you can run the vsvr set NAME command to change
to the virtual server, where NAME is the name of the virtual server. The vsvr set
NAME command is cluster aware, so change context to the specified virtual server
regardless of the NAS Gateway on which it is located. When you have changed
context to the virtual server, you can run any of the vsvr commands to move, manage,
or display the virtual server.

30-32
Options
Table 30-7 : Options for the vsvr show command
VIRTUALSERVER An optional alphanumeric character string of

up to 15 characters that identifies a particular
virtual server you want to display. Type the
virtual server’s name to display detailed
information about that virtual server.
all An optional keyword for listing all virtual
servers configured in a cluster. When you
specify the “all” keyword, the runtime state
of each virtual server is also listed in the
resulting display.
-n NODE An optional that specifies to display
information about all virtual servers on a
specified NAS Gateway.
-v This displays additional information about
the virtual server, such as the failover state,
the number of volumes owned by the virtual
server, and the name of the NAS gateway to
which the virtual server is assigned.
Note!
If you do not enter either of these optional arguments, the virtual server
show command shows all virtual servers configured on the current NAS
Gateway.

30-33
Example
The following example lists all virtual servers on the current the NAS Gateway.
eng31 PUBSTEST3> vsvr show

Virtual servers on NAS Gateway eng31
ID State Name
=================================
1 Enabled VS1-PRODUCTION
2 Disabled PUBSTEST2
3 Enabled PUBSTEST3
eng31 PUBSTEST3>
The following example lists detailed information of a virtual server.
eng62 VS62D> vsvr show pubstest3

Virtual Server
==============
ID : 5 (protected)
Status : Enabled
Name : VS62D
NetBIOS name : VS62D
IP address 1 : 10.3.162.4/255.255.0.0
IP address 2 : 10.3.162.88/255.255.0.0
Windows domain : MATRIX
Unix domain : --Not-Set--
LDAP domain : openauthdom
Volumes owned : vol62d1 volNgmTest
Volumes mounted : vol62d1 volNgmTest
eng62 VS62D>
Virtual Server Statistics
Synopsis
vsvr stats [all | agg] [-i SECONDS] [-C. COUNT]

30-34
Description
Use the vsvr stats command to display virtual server statistics. You can configure
this command to show a scrolling display of performance statistics at regular intervals
for either all virtual servers on a NAS Gateway or for a particular virtual server. To
stop scrolling of the display, type Ctrl+Z. The vsvr stats command provides
statistics on two types of operations: speed and throughput. Speed is measured in the
number of operations per second, and throughput is measured in bytes, kilobytes, or
megabytes per second. Speed operations on which the vsvr stats command
provides statistics include the following:
• NFS request operations received from clients
• NFS responses successfully sent to clients
• CIFS requests received from clients
• CIFS responses successfully sent to clients
Throughput operations on which the vsvr stat command provides statistics include
the following:
• Number of NFS bytes, kilobytes, or megabytes per second received from clients
• Number of NFS bytes, kilobytes, or megabytes per second sent to clients
• Number of CIFS bytes, kilobytes, or megabytes per second received from clients
• Number of CIFS bytes, kilobytes, or megabytes per second sent to clients

30-35
Options
Table 30-8 : Options for the vsvr stats command
all|agg A choice list for displaying statistics of

all virtual servers on the NAS Gateway.
The option all shows statistics of all
enabled virtual servers on the NAS
Gateway.
The option agg shows the aggregate
statistics of all enabled virtual servers on
the NAS Gateway.
-i SECONDS An optional argument that specifies a
time interval in seconds between
consecutive displays of statistics on the
console. The default value is 5 seconds.
-c COUNT An optional argument to specify the
number of reports to display.
Example
eng40 VS_ENG40_1> vsvr stats all -i 6
------------------------------------------------------------------------------------------------
--
| ENG49-2 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
| ENG49-7 | 0 | 26209 | 0 | 26209 | 0 | 1.55M | 0 | 1.65M |
| ENG49-5 | 0 | 794 | 0 | 791 | 0 | 6.93M | 0 | 10.10M |
| ENG49-ONSTORL | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
| ENG49HELIX | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
| ENG49-6 | 143 | 0 | 143 | 0 | 23.00K | 0 | 23.86K | 0 |
| ENG49-4 | 2649 | 0 | 2648 | 0 | 654.11K | 0 | 1.11M | 0 |
| VS-NGM-TEST | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
| VS-ERIK1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
| VS_MGMT_379 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
------------------------------------------------------------------------------------------------
In this example, statistics for all enabled virtual servers on a NAS Gateway are
displayed consecutively every 6 seconds.

30-36

Chapter 31: Virus Scan Commands
This chapter documents the following virus scan commands:
• “Virus Scan Disable Incoming” on page 31-2
• “Virus Scan Disable Outgoing” on page 31-3
• “Virus Scan Enable Incoming” on page 31-4
• “Virus Scan Enable Outgoing” on page 31-6
• “Virus Scan Extension Add” on page 31-8
• “Virus Scan Extension Delete” on page 31-10
• “Virus Scan Extension Reset” on page 31-12
• “Virus Scan Extension Set” on page 31-13
• “Virus Scan Extension Show” on page 31-15
• “Virus Scan Log Clear” on page 31-17
• “Virus Scan Log Facility” on page 31-18
• “Virus Scan Log Host” on page 31-19
• “Virus Scan Log Show” on page 31-20
• “Virus Scan Log Show Config” on page 31-23
• “Virus Scan Server Add” on page 31-24
• “Virus Scan Server Delete” on page 31-26
• “Virus Scan Server Show” on page 31-27

31-2
Virus Scan Disable Incoming
Synopsis
vscan disable incoming PROTOCOL [,PROTOCOL]
Description
For each virtual server, you can configure the ONStor™ NAS Gateway’s virus-
scanning capability to scan incoming traffic, outgoing traffic, or both. To disable virus
scanning on a virtual server for incoming traffic, run the vscan disable incoming
command. You need to be in a virtual server context to use this command. The NAS
Gateway presents a yes/no confirmation prompt that you need to respond to by typing
either Y or N before the NAS Gateway acts on this command.
Options
The PROTOCOL[,PROTOCOL] variable has a value of either
Common Internet File System (CIFS) or Network File System
(NFS). You can specify one or both protocols. If you specify both
protocols, separate them with a comma. For example, cifs,nfs.
Example
eng6 VSTEST-ENG6> vscan disable incoming CIFS,NFS

eng6 VSTEST-ENG6>
In this example, the incoming CIFS and the incoming NFS have been disabled. You
can verify this new configuration by running the vscan server show command,
which shows the virus-scanning status of the CIFS and NFS.
Related Commands
vscan disable outgoing Disables virus scanning on outgoing CIFS or
NFS reads.

31-3
vscan enable incoming Enables virus scanning on incoming CIFS or

NFS writes.
vscan enable outgoing Enables virus scanning on outgoing CIFS or
NFS reads.
vscan extension add Adds the specified extension to the set to be
scanned.
vscan log show Shows locally stored virus scan log messages.
vscan server add Adds a virus scan server for the virtual server.
Virus Scan Disable Outgoing
Synopsis
vscan disable outgoing PROTOCOL [,PROTOCOL]
Description
For each virtual server, you can configure the NAS Gateway’s virus-scanning
capability to scan incoming traffic, outgoing traffic, or both. To disable virus scanning
on a virtual server for outgoing traffic, run the vscan disable outgoing command.
You need to be in a virtual server context to use this command. The NAS Gateway
presents a yes/no confirmation prompt that you need to respond to by typing either Y
or N before the NAS Gateway acts on this command.
Options

31-4
Example
eng6 VSTEST-ENG6> vscan disable outgoing CIFS

eng6 VSTEST-ENG6>
In this example, the outgoing CIFS has been disabled. You can verify this new
configuration by running the vscan server show command, which shows the virus-
scanning status of the CIFS and NFS.
Related Commands
vscan disable incoming Disables virus scanning on incoming CIFS or
NFS writes.
NFS writes.
NFS reads.
scanned.
Virus Scan Enable Incoming
Synopsis
vscan enable incoming PROTOCOL [,PROTOCOL]
Description
capability to scan incoming traffic, outgoing traffic, or both. To enable virus scanning
on a virtual server for incoming traffic, run the vscan enable incoming command.
You need to be in a virtual-server context to use this command. You need to have

31-5
already added one or more scan servers to the virtual server. The NAS Gateway
presents a yes/no confirmation prompt that you need to respond to by typing either Y
or N before the NAS Gateway acts on this command.
Options
Example
eng6 VSTEST-ENG6> vscan enable incoming CIFS,NFS

eng6 VSTEST-ENG6>
In this example, the incoming CIFS and the incoming NFS have been enabled. You
can verify this new configuration by running the vscan server show command,
which shows the virus-scanning status of the CIFS and NFS.
Related Commands
NFS reads.
NFS writes.
NFS reads.
scanned.

31-6
Virus Scan Enable Outgoing
Synopsis
vscan enable outgoing PROTOCOL [,PROTOCOL] [-scanfailureok]
Description
capability to scan incoming traffic, outgoing traffic, or both. To enable virus scanning
on a virtual server for outgoing traffic, run the vscan enable outgoing command.
You need to be in a virtual server context to use this command. One or more scan
servers need to have been added to the virtual server. The optional parameter
-scanFailureOK indicates that if a virus scan cannot be completed, the traffic is
allowed to proceed; the default is that it fails. If a virus is detected and cannot be
cleaned, the file is deleted when possible. There is no quarantine facility.

31-7
Options
Table 31-1 : Options for the vscan enable outgoing command
PROTOCOL [,PROTOCOL] A protocol that can be either

CIFS or NFS. You can specify
one or both protocols. If you
specify both protocols separate
them with a comma, for example,
cifs,nfs.
-scanfailureok An optional parameter for
allowing traffic to proceed if a
virus scan cannot be completed.
The default is that it will fail.
Example
eng6 VSTEST-ENG6> vscan enable outgoing CIFS

eng6 VSTEST-ENG6>
In this example, the outgoing CIFS has been enabled. You can verify this new
configuration by running the vscan server show command, which shows the virus-
scanning status of the CIFS and NFS.
Related Commands
NFS writes.
NFS reads.
NFS writes.

31-8

scanned.
Virus Scan Extension Add
Synopsis
vscan extension add EXTENSION [,EXTENSION]
Description
capability to scan incoming traffic, outgoing traffic, or both. Although the default list
of extensions that you can use to scan for known viruses is extensive, new malicious
code in the form of worms and viruses may use different file extensions. You may
need to add these new extensions to your NAS Gateway virus-scan configuration
extension list to enable screening for these new threats.
To add file extensions for the NAS Gateway to scan, run the vscan extension add
command. You need to be in a virtual server context to use this command. To use the
default list of extensions searched by the ONStor™ VirusScan applet, you do not need
to use this command. The following list shows the default extensions scanned by the
NAS Gateway’s virus-scan feature.
386 CPL HTM MSO PPT VSD

ACM CSC HTML OBD RTF VSS
ACV CSH HTT OBT SCR VST
ADT DLL INF OCX SH VXD
AX DOC INI OV. SHB WSF
BAT DOT JS PIF SHS WSH

31-9
BIN DRV JSE PL SMM XL

BTM EXE JTD PM SYS
CLA HLP MDB POT VBE
COM HTA MP. PPS VBS
Options
EXTENSION [,EXTENSION] are variables which are alphanumeric
character strings of up to 4 characters. The string can also include
a period (.) that matches any single character. Case is ignored.
Chose an extension from the list of defaults, or, if you have a
specific extension not mentioned in the following list, specify it
in this command with this string.
You can add multiple extensions by separating them with
commas.
Example
eng6 VSTEST-ENG6> vscan extension add irs,kfc,exe

eng6 VSTEST-ENG6>
In this example, the extensions IRS, KFC, and EXE have been added to be filtered and
scanned by the virus-scanning feature on the virtual server VSTEST-ENG6 on NAS
Gateway eng6.
Related Commands
NFS writes.
NFS reads.

31-10
vscan extension delete Deletes a specified extension from the list of

virus scan extensions.
vscan extension set Sets the specified list of extensions to be
scanned.
vscan extension show Shows a list of existing virus scan extensions.
vscan server add Adds a virus scan server for the virtual
Virus Scan Extension Delete
Synopsis
vscan extension delete EXTENSION [,EXTENSION]
Description
capability to scan incoming traffic, outgoing traffic, or both. When you configure virus
scanning, a default list of extensions is provided. You can delete any of the default
extensions listed in the following list or any custom extensions, by running the vscan
extension delete command. You need to be in a virtual server context to use this
command. The following list shows the default extensions scanned by the NAS
Gateway’s virus-scan feature.


31-11

BTM EXE JTD PM SYS
CLA HLP MDB POT VBE
COM HTA MP. PPS VBS
Options
commas.
Example
eng6 VSTEST-ENG6> vscan extension delete irs,kfc,exe

eng6 VSTEST-ENG6>
In this example, the extensions IRS and KFC have been deleted from the list that the
virus-scanning feature scans for viruses on virtual server VSTEST-ENG6 on NAS
Gateway eng6.
Related Commands
NFS writes.
NFS reads.

31-12
vscan extension add Adds a specified extension to the list of virus

scan extensions.
Virus Scan Extension Reset
Synopsis
vscan extension reset
Description
Use the vscan extension reset command to reset a customized list of extension to
the system default. The following list shows the file extensions that are supported by
default.

BTM EXE JTD PM SYS
CLA HLP MDB POT VBE
COM HTA MP. PPS VBS

31-13
Example
eng46 TECHPUBS> vscan extension reset

eng46 TECHPUBS>
Related Commands
NFS writes.
NFS reads.
vscan extension set Sets a specified extension to the list of virus scan
extensions.
Virus Scan Extension Set
Synopsis
vscan extension set EXTENSION [,EXTENSION]
Description
capability to scan incoming traffic, outgoing traffic, or both. As part of this feature, the
NAS Gateway supports a number of default file extensions to be scanned. The
following list shows the file extensions that are supported by default.

31-14

BTM EXE JTD PM SYS
CLA HLP MDB POT VBE
COM HTA MP. PPS VBS
You can replace the list of extensions with a new one. To replace the list of extensions,
run the vscan extension set command. You need to be in a virtual-server context to
use this command.
Options
commas.

31-15
Example
eng6 VSTEST-ENG6> vscan extension set irs,kfc,pbs,mtv

eng6 VSTEST-ENG6>
In this example, the extensions IRS, KFC, PBS, and MTV have been configured to be
the list that the NAS Gateway supports for virus scanning.
Related Commands
NFS writes.
NFS reads.
scan extensions.
Virus Scan Extension Show
Synopsis
vscan extension show
Description
capability to scan incoming traffic, outgoing traffic, or both. Although the default list
of extensions that you can use to scan for known viruses is extensive, new malicious
code in the form of worms and viruses may use different file extensions. You may

31-16
need to add these new extensions to your NAS Gateway virus-scan configuration
extension list to enable screening for these new threats.
To list the file extensions to be scanned, run the vscan extension show command.
You need to be in a virtual-server context to use this command. Depending on the
number of virus scan extensions you have chosen to scan, the list can include the
whole default list, or only the extensions you have chosen specifically to scan.
Example
eng6 VSTEST-ENG6> vscan extension show

386
ACM
ACV
BAT
BIN
COM
CSH
.
<<display continues>>
.
VSD
VXD
WSF
WSH
eng6 VS_PUBSTEST_1>
This example shows the current list of file extensions that the NAS Gateway supports
for virus scanning.
Related Commands
NFS writes.
NFS reads.

31-17

scan extensions.
vscan extension set Sets the specified list of extensions to be
scanned.
Virus Scan Log Clear
Synopsis
vscan log clear
Description
capability to scan incoming traffic, outgoing traffic, or both. When virus scan feature
finds a file that needs to be cleaned, it logs it in the virus scan log so that you have a
viewable record of what scanning and cleaning has occurred.
One virus scan log exists for all virtual servers, but after the date-time stamp, the
records are prefixed with the virtual server name ID for filtering. The log is maintained
in /var/log/vscan, and you can access it from the command-line interface (CLI) by
running the vscan log show command. To clear the virus scan log, run the vscan
log clear command. You do not need to be in virtual server context to use this
command.
Example
eng6 VSTEST-ENG6> vscan log clear

eng6 VSTEST-ENG6>
In this example, the virus scan log is cleared. When the virus scan log is cleared, all
existing entries are deleted. New entries are added as the NAS Gateway encounters
files for scanning.

31-18
Related Commands
NFS writes.
NFS reads.
Virus Scan Log Facility
Synopsis
vscan log facility {local0|local1|local2|local3|local4|
local5|local6|local7}
Description
The virus scan log facility interfaces with the standard syslogd capability to provide
logging of system information at the specified level of priority. By using this facility,
you can locally save system messages, forward them to a remote host, or display them
on the system console. Virus scan log messages use the same user-level facility codes
as the standard UNIX syslog program. You can use these facility levels to filter
messages from different NAS Gateways at a common syslog host.
Options
local0|local1|local2|local3|local4|local5|local6|loc
al7 are facility codes. The default value is local0.
Example
eng11> vscan log facility local2

eng11>
In this example, the facility code is set to local2.

31-19
Related Commands
vscan log show config Shows the current log configuration.
Virus Scan Log Host
Synopsis
vscan log host IPADDR
Description
The virus scan log facility interfaces with the standard syslogd capability to provide
logging of system information at the specified level of priority. By using this facility,
you can locally save system messages, forward them to a remote host, or display them
on the system console.
You can forward the virus scan log messages to syslog daemons running on a specified
host. If the host address is set to 0 all virus scan log messages are forwarded to the
local syslog daemon. Virus scan log messages for priority less than info are not saved
in the local log. If a nonzero syslog host is specified, all messages are forwarded to the
specified host using the currently configured facility code. In this case, make sure that
the remote syslog host is configured to receive syslog messages from other hosts
because some implementations, by default, are configured to not receive syslog
messages forwarded by other hosts. Remote logon is disabled by default, so all
messages are sent to the local host.
You can specify the syslogd host for sending virus scan log messages with the vscan
log host command.
Options
The IPADDR variable is the IP address of a remote host that runs
syslogd and is capable of receiving virus scan log messages from
this NAS Gateway.

31-20
Example
eng11> vscan log host 192.168.172.1

eng11>
In this example, 192.168.172.1 is specified as the syslogd host for sending virus scan
log messages.
Related Commands
vscan log show config Shows the current log configuration.
Virus Scan Log Show
Synopsis
vscan log show [NUMLINES]
Description
capability to scan incoming traffic, outgoing traffic, or both. When files are scanned
they are written to the virus scan log file. This log file contains virus scanning events,
which are logged with the most recent event at the top, in chronological order. Each
event contains the following information:
• Month, day, time (hh:mm:ss)
• NAS Gateway name ID.
• Scanner (the ONStor virus-scan applet service)
• Status of the scanner
• Applet restarts
• Volume name and file name with complete path for infected files
• Communication errors between the NAS Gateway and applet
You do not need to be in virtual-server context to use this command.

31-21
There is one log for all virtual servers, but after the date-time stamp, the records are
prefixed with the virtual server name ID for filtering. The log is maintained in /var/
log/vscan, and you can access it from the CLI by running the vscan log show
command.
Options
The NUMLINES variable is an optional argument that determines
the number of lines you want to display. The virus scan log is
listed in a top-down order, so the most recent events are displayed
from the top. The number you type is the number of lines from
the top.

31-22
Example
eng6 VSTEST-ENG6> vscan log show

eng6 VSTEST-ENG6>
Apr 9 10:16:56 eng6 : scanner 129.1.1.11 has restarted, restarting
pending requests
Apr 9 17:56:32 eng1 : 3: found infected file:
vol1\\mtvscan0_28600\\eicar.vbe
vol1\\mtvscan1_28600\\eicar.vbe
vol1\\mtvscan1_28600\\eicar.vss
vol1\\mtvscan1_28600\\eicar.wsh
vol1\\mtvscan0_28600\\eicar.ini
vol1\\mtvscan0_28600\\eicar.xlx
Apr 12 10:08:23 eng1 : 2: found infected file: testvol\\eicar.MDB
Apr 12 18:41:44 eng6 : 7: unrecoverable error on scanner 10.1.1.11:
vol1\\topfra me_bg.gif :5
Apr 12 18:41:44 eng6 : 7: unrecoverable error on scanner 10.1.1.11:
vol1\\vertli ne.gif :5
Apr 12 18:44:45 eng6 : 7: failed to send request to scanner
10.1.1.13: 0x00000102
pending requests
10.1.1.13: 0x00000102
pending requests
10.1.1.13: 0x00000102
pending requests
If there are any recorded events in the log, they display when the vscan log show
command is run. If there are no event records in the log, nothing shows when the
vscan log show command is run.
Related Commands
NFS writes.

31-23

NFS reads.
vscan log clear Clears locally stored virus scan log messages.
Virus Scan Log Show Config
Synopsis
vscan log show config
Description
You can use the vscan log show config command to view the current virus scan
log configuration and general event log configuration that applies to the virus scan log.
Displaying the virus scan log configuration shows the following information:
• The event log state, either enabled or disabled
• The event log level
• The event log display setting, either enabled or disabled
• The virus scan log host address
• The virus scan log facility level
Note!
If the virus scan log is on a remote host, this command does not display any
virus scan log messages. You can specify the virus scan log to be located on a
remote host by the vscan log host command.

31-24
Example
eng57> vscan log show config

vscan log configuration
-----------------------
Vscan Log Facility: local7
Vscan Host Addr: 0.0.0.0
eng57>
This example show the following information:

• The virus scan log facility is set to local7.
• The virus scan host IP address is 0.0.0.0.
Related Commands
Virus Scan Server Add
Synopsis
vscan server add IPADDR
Description
capability to scan incoming traffic, outgoing traffic, or both. The ONStor VirusScan
applet that is installed on the virus-scan server provides the necessary connectivity
between the NAS Gateway and the third-party virus-scan software. The VirusScan
applet supports the Symantec™ AntiVirus™ Scan Engine and the McAfee® Anti-
Virus Engine API 4.3.20 of the McAfee VirusScan Enterprise 8.0i package. The virus-
scan server is connected to your network and communicates with the NAS Gateway
through the Gigabit Ethernet (GE) ports to provide the virus scanning.
To use this feature on each virtual server, you need to add a virus-scan server to the
virtual server configuration by running the vscan server add command within the
virtual server context. The virtual server can be in enabled or disabled state when you

31-25
run the vscan server add command. This command does not support adding
multiple virus-scan servers through a comma-separated server list. If you want to add
more than one virus-scan server to your virtual server, for instance, for load balancing
of virus-scanning tasks, you need to add each virus-scan server individually with the
vscan server add command in the specified virtual-server context. Have the IP
addresses of available virus-scan servers ready for entering into the appropriate
commands.
Note!
• Be sure you have your third-party equipment with the Symantec™
AntiVirus™ Scan Engine set up, powered on, connected, installed, and
configured before you run the vscan server add command.
• Be sure you have your VirusScan applet installed and properly configured
on the server. See the section “Installing the Virus-Scan Applet” in the
System Administrator’s Guide.
Options
The IPADDR variable is the IP address of the selected virus-scan
server. If the NAS Gateway is configured to support name
resolution, you can specify the virus scan server’s name.
Example
eng6 VSTEST-ENG6> vscan server add 10.1.13

eng6 VSTEST-ENG6>
In this example, the server 10.1.1.13 is added to the virtual server VSTEST-ENG6 on
NAS Gateway eng6 to act as the virus-scan server. For this command to work, it is
assumed that the designated server already has the VirusScan applet installed,
configured, and running on it.
Related Commands
NFS writes.

31-26

NFS reads.
scan extensions.
vscan extension set Sets the specified list of extensions to be the list
to be scanned.
vscan server delete Deletes a virus scan server of the virtual server.
vscan server show Shows the list of virus scan servers for the
virtual server.
Virus Scan Server Delete
Synopsis
vscan server delete IPADDR
Description
You can remove virus scan servers from the NAS Gateway’s list of virus scan servers
by running the vscan server delete command. To remove the last virus-scan server
from a virtual server, you need to first disable virus scanning on that virtual server. To
remove a virus-scan server from your NAS Gateway configuration, you need to be in a
virtual-server context.
Options
The IPADDR variable is the IP address of the selected virus-scan
server. If the NAS Gateway is configured to support name
resolution, you can specify the virus scan server’s name.

31-27
Example
eng6 VSTEST-ENG6> vscan server delete 10.1.13

eng6 VSTEST-ENG6>
In this example, the virus scan server 10.1.1.13 is deleted from the virtual server
VSTEST-ENG6 on NAS Gateway eng6. To verify that this action has taken place, run
the vscan server show command.
Related Commands
NFS writes.
NFS reads.
scan extensions.
vscan extension set Sets the specified list of extensions to be the list
to be scanned.
vscan server add Adds a virus scan server to the virtual server.
vscan server show Shows the list of virus scan servers for the
virtual server.
Virus Scan Server Show
Synopsis
vscan server show

31-28
Description
Use the vscan server show command to display a list of all virus scan servers on the
Example
eng46 TECHPUBS> vscan server show

Virus scan configuration:
delete infected files: yes

quarantine infected files: no
incoming CIFS: disabled
outgoing CIFS: disabled
allow access to CIFS clients if scan fails: no
incoming NFS: disabled
outgoing NFS: disabled
allow access to NFS clients if scan fails: no
The virus scan servers:
10.3.46.10
eng46 TECHPUBS>
This example shows virus scan configuration information, such as whether the virus
scan server is set to delete and quarantine infected files and the IP address of the NAS
Gateway on which the virus scan server runs.
Related Commands
vscan server delete Deletes a virus scan server for the virtual server.

Chapter 32: Volume Commands
This chapter documents the following volume commands:
• “Volume Add Virtual Server” on page 32-2
• “Volume Add Array” on page 32-4
• “Volume Delete” on page 32-17
• “Volume Create” on page 32-6
• “Volume Delete” on page 32-17
• “Volume Import” on page 32-19
• “Volume Modify” on page 32-21
• “Volume Offline” on page 32-30
• “Volume Online” on page 32-31
• “Volume Share Export” on page 32-33
• “Volume Share Import” on page 32-36
• “Volume Show” on page 32-38

32-2
Volume Add Virtual Server
Synopsis
volume add vsvr VOLNAME VIRTUALSERVER
Description
Use the volume add vsvr command to reassign a volume that has been disconnected
from its virtual server. The resulting reassignment of the volume allows clients to
access to the volume’s data.
Assign a volume to a virtual server only if the volume is not already associated with a
virtual server. For example, if the NAS Gateway configuration is lost or becomes
corrupted, you can use this command as part of the recovery process for the NAS
Gateway. Restart the NAS Gateway after the recovery process.
Note!
You can determine if a volume is currently owned by a virtual server, by
running the volume show command. If the Virtual Server column is
empty, use this command to assign it to a new virtual server.

32-3
Options
Table 32-1 : Options for the volume add vsvr command
VOLNAME An existing volume that needs to be

assigned to the virtual server. You
cannot assign a volume that is already
associated with a virtual server. Type the
virtual server name.
VIRTUALSERVER The name of the existing virtual server
to which the volume in VOLNAME is
assigned.
Example
cluster1-4> volume add vsvr pubstest techpubs

Done.
cluster1-4>
In this example, the volume pubstest is added to the virtual server techpubs. When you
reassign a volume to a new virtual server, the volume becomes available to clients
only after the file processing ports are reset to refresh the export interfaces. The
resetting of the file processing ports is not shown in this example.
Related Commands
vsvr clear Clears the current virtual server for all future
commands.
commands.

32-4
Volume Add Array
Synopsis
volume add array VOLNAME ARRAY
Description
As part of the volume create command, you need to specify one array from which a
volume obtains it logical unit numbers (LUNs). After this initial configuration, you
can add more arrays to a volume to allow for additional volume space. Each volume
can have a maximum of 8 additional arrays plus the initial array configured for the
volume, for a total of 9 arrays.
You can add arrays to a volume by running the volume add array command. This
command adds up to 8 arrays by name to a volume. The volume needs to exist for the
volume array command to complete. Arrays need to be added manually. The
ONStor™ NAS Gateway has no method for picking arrays and automatically adding
them to the correct volume.

32-5
Options
Table 32-2 : Options for the volume array add command
VOLNAME The volume to which you are adding an

array. Specify the name of the volume
that you are configuring.
ARRAY A list of device names for one or more
arrays from which the volume obtains its
LUNs. You can enter a single array
name, or a comma-separated array list of
up to 8 arrays. Type the device name as
shown in the lun show command.
Example
cluster1-4> volume add array pubstest IBM_KPZ0P941

Done.
cluster1-4>
In this example, the volume pubstest is configured with array IBM_KPZ0P941. When
the volume is created, it exists on this RAID only. However, after the volume is
created and brought online, you can specify up to eight additional arrays where the
data for pubstest can reside or where additional volume space can be assigned for
pubstest.
Related Commands
lun show disk Shows the list of disk devices.
volume modify Modifies the attributes of the volume.
commands.

32-6
Volume Create
Synopsis
volume create VOLNAME ARRAY [-A ATIMEUPDATES] [-c CHARSUBST] [-e
SHAREDREAD] [-g MINAUTOGROW][ [-h HIGHWATERMARK] [-l
MINLUNSIZE] [-L LANGUAGE] [-m] [-o OPLOCKS] [-q HARDQUOTA] [-r
RAIDLEVEL][-s SOFTQUOTA] [-S STABILITY] [-t CHARSUBSTTABLE] [-u
MAXLUNSIZE]
Description
The NAS Gateway supports logical volumes. Logical volumes can have different
applications, for example, volumes for mirroring or volumes for core dumps. But,
regardless of the applications for which logical volumes are used, the NAS Gateway’s
Volume Manager software only manages one type of volume, the logical volume.
Use the volume create command to create and manage the NAS Gateway’s logical
volumes, and assign parameters for its operation. The parameters you assign facilitate
the allocation of additional volume space when specified usage thresholds are
exceeded and more volume space is needed.
The volume create command automatically:
• Allocates disk space for the volume
• Makes disk space accessible to the operating system by bringing the volume online
• Creates a file system on the volume.
To create a volume with default parameters assigned, run the volume create
command and supply volume and array name.
As an alternative, you can create a volume with custom parameters. Use these
parameters to specify usage conditions for the volume’s automatic growth, and LUN
conditions for creating and growing the volume with compatible LUNs. For a detailed
description of each volume parameter, see Table 32-3 on page 32-8.
The volume create command executes different depending on whether you use an
array name or a device name:

32-7
When you run the volume create command, you can specify an array name or device
name. If you specify a device name, the following options are ignored during creation,
but used during automatic growth:
• -g MINAUTOGROW
• -l MINLUNSIZE
• -u MAXLUNSIZE
When you are creating a volume on a specific device or array, the -r RAIDLEVEL
argument of volume create is not supported because the volume inherits the RAID
level of the device.
After the volume is created, it resides in a virtual server. End users can access the
volume through network file service (NFS) or common Internet file service (CIFS)
shares that have been configured in the same virtual server as the volume. After a
volume is created, it remains on disk, and is visible during restarting and power
cycling.

32-8
Options
Table 32-3 : Options for the volume create command
VOLNAME The name of the volume you are creating.

Volume names can be any alphanumeric
character string of up to 127 characters.
Volume names can start only with the
following characters:
• alphabetic
• numeric
• a dash (-)
• an underscore ( _ ).
ARRAY or DEVICE The name of a RAID array from which the
volume obtains LUNs, or a specific device
name. Through this argument you can target
a specific array or device name for using
LUNs to build the volume based on whether
you type an array name or a device name:
• An array name is a string that consists of
a make and serial number, for example,
IBM_60432. You can also use an asterisk
as a wildcard in the array name, for
example, I* to select all IBM arrays,
IBM_6* to select all IBM arrays with a
serial number that starts with 6, or
IBM_60432_* to select any LUN in the
specific array IBM_60432_.
• A device name is a string that consists of
make, serial number, and LUN ID, for
example, IBM_60432_255.

32-9
Table 32-3 : Options for the volume create command (Continued)
-c CHARSUBST An optional argument that sets the CIFS

invalid character substitution option to
enabled or disabled. When enabled, if NFS
creates a file name with the invalid characters
"*:<>?\|, the NAS Gateway automatically
substitutes a list defined by
CHARSUBSTTABLE. The value for
CHARSUBST can be enabled or disabled.
The default value for CHARSUBST is
disabled. You cannot set this to enabled
without also providing a value for
CHARSUBSTTABLE.
-e SHAREDREAD An optional argument that specifies the state
of the CIFS no shared read open flag for the
volume. This flag is read by NFS requests,
and the state you set affects whether NFS
clients can access files on the volume. You
can set this variable to allow or disallow. By
default, the shared read is allowed. Specify
the shared read argument with the following
construction:
• -e sharedread=allow permits NFS
requests to ignore the no shared read flag.
NFS requests are allowed, and NFS
clients are able to read files on the
volume.
• -e sharedread=disallow causes
NFS requests to respect the no shared
read flag. NFS requests are not allowed,
and NFS clients are not permitted to read
files on the volume.

32-10

minimum growth size specified for the
volume. This parameter sets the smallest
amount of disk space to be added to the
volume if the automatic volume growth
feature is triggered and the NAS Gateway
determines that the volume needs more disk
space. This value is also used as the default
size of the volume when it is initially created.
Type the value in megabytes. This value must
be a nonzero value.
Default value: 500. The NAS Gateway gets
any amount of disk size larger than 500
megabytes.
-h HIGHWATERMARK An optional argument that specifies the
trigger that causes the volume space to grow
by the amount specified in the
MINAUTOGROW argument. Type the value
as a percentage of the total amount of used
space. The NAS Gateway uses the percentage
of total used space to calculate the actual
amount of disk space required. Set the high
watermark to a value between 25% and
100%. If you set the value to zero (0),
automatic volume space growth is disabled.

32-11
-l MINLUNSIZE An optional argument that specifies the

smallest logical disk to be used in the
logical disks. This parameter sets the smallest
single disk to be used for creating or resizing
a volume. Type the value in megabytes. If
you set the value to zero (0), the first
available disk, regardless of size, is used.
Default value: 0 (minimum disk size limits
are not enforced for LUN creation or
resizing).
-L LANGUAGE An optional argument that defines the valid
characters in file names stored on this
volume. File names with characters outside
the valid list are not created and permission is
denied. The default value is en_us. For a
complete list of supported language codes,
run the help volume create -L command.
-o OPLOCKS An optional argument that specifies whether
CIFS requests are permitted to obtain
OPLOCKS (opportunistic locks) on files.
The values for this option are allow and
disallow. When allowed, CIFS requests are
permitted to obtain OPLOCKS on files.
When disallowed, no CIFS OPLOCKS are
granted.
The default value for OPLOCKS is allow.
Ensure that the volume is online before
setting this option.

32-12
-q HARDQUOTA An optional argument that specifies the hard

quota, which is a maximum size of the
volume. Type the volume’s absolute
maximum size in 1 megabytes blocks. Set
this argument to 0 (the default) if you want
unlimited growth for the volume.
-r RAIDLEVEL An optional argument that specifies the
RAID level of the disks to be used while
creating the volume. If you leave this
argument blank, the NAS Gateway ignores
the RAID level, and uses whichever LUN is
available regardless of its RAID level.

32-13
-S STABILITY This option controls whether the file system

ensures that data and metadata are on disk
before an NFS or CIFS operation completes.
Possible values are normal, nameSpace, and
all. The stability of user data write operations
are controlled by NFS or CIFS clients.
• When set to normal, all metadata updates
are written synchronously to the file
system log before the operation
completes.
• When set to nameSpace, all name space
updates return to the client before those
changes are written to the file system log.
Note!
This violates NFS cache consistency rules, but
can be useful when doing an rsync-style
migration. CIFS will continue to function properly
when this option is used.
• When set to all, all file system updates
return to the client before those change
are written to the file system log. All user
data write and commit operations return
to the client before those changes are
written to disk. This yields the highest
performance for cases where it does not
matter whether data and name space
changes made in the last few seconds are
lost. If a client performs a commit
operation on the file, the changes are not
written synchronously to disk.

32-14
-s SOFTQUOTA An optional argument that specifies a value

in percentage of the HARDQUOTA. When
the SOFTQUOTA is met, the NAS Gateway
administrator is notified that allocated disk
space as a percentage of the hard quota has
reached this limit.
percentage. The percentage you specify is
automatically calculated in actual disk space.
Specify a percentage between 1 and 100. If
you specify zero (0), the soft quota is
disabled.
Default value: 0. Don’t monitor the soft
quota.
If the HARDQUOTA is 0, the SOFTQUOTA
will also be set to 0.
-t CHARSUBSTTABLE An optional argument that sets the CIFS
invalid character substitution table.
CHARSUBSTTABLE is a comma-separated
list of 2-byte Unicode value in hex format to
be substituted for the characters "*:<>?\|, for
example,
FF82,FF89,FF8A,FF8C,FF8E,FF8F,FF7F,FF
88.

32-15
-u MAXLUNSIZE An optional argument that specifies the

largest logical disk to be used in the volume.
A volume can comprise several logical disks.
This parameter sets the largest single disk
that to be used for creating or resizing a
volume. Type the value in megabytes. If you
set the value to zero (0), any size of disk can
be used.
Default value: 0 (minimum disk size limits
are not enforced for LUN creation or
resizing).
-A ATIMEUPDATES Enables or disables the automatic last access
time updates.
• When enabled, the file system
automatically updates the last access time
on files and directories when they are
read. This increases the file system
update load, but allows clients to see
what files are being used.
• When disabled, the last access time is
only updated when an NFS or CIFS client
explicitly sets the timestamp.
By default, this option is enabled.
Note!
If the high watermark is 0 and the hard quota is not equal to the minimum
automatic growth variable, the volume does not reach the hard quota size.

32-16
Example
In the following example, a volume is created with default values.
cluster1-4> volume create publitech IBM_ECV5TSHB_0

Done.
cluster1-4>
In this example, the command is creating a volume publitech on the RAID array
IBM_ECV5TSHB_0. Because no specific AutoGrow™ parameters are configured, the
volume is configured with all default settings.
In the following example, a volume is created with custom values.
cluster1-4> volume create pubstest HDS_00000011 -q 12901 -s 75 -g

500 -h 95 -l 0 -u 0
Done.
cluster1-4>
In this example, a volume pubstest is created on the RAID array HDS_00000011. This
volume has custom usage quotas:
• The hard quota for automatic resizing of the volume is set to 12901 megabytes.
• The soft quota for automatic resizing of the volume is set to 75 percent of usage.
• The minimum AutoGrow parameter allows allocation of any amount of LUN
space.
• The high watermark is set to 95 megabytes.
• The minimum LUN size can use any amount of disk space.
• The maximum LUN size can use any amount of disk space.
The AutoGrow feature is disabled along with the high watermark, and the minimum
and maximum LUN size parameters.
Related Commands
cifs share add Exports a directory on a volume to CIFS clients.
lun show disk Shows the list of disk devices.

32-17
nfs share add Exports a directory on a volume to NFS clients.

system create mgmtVolume Creates the management volume for the current
commands.
Volume Delete
Synopsis
volume delete VOLNAME
Description
Logical volumes are collection of LUNs that are not application specific and provide
storage space.
Use the volume delete command to remove any previously configured volumes that
you added with the volume create command. The volume delete command also
removes any usage parameters that you specified for automatic volume space growth
and releases the disk space held by the volume that you delete. When you run this
command, the NAS Gateway prompts you for confirmation. Type Y to accept the
deletion, or N to cancel the deletion when you see this prompt:
Are you sure? [y|n]
When you run the volume delete command, the NAS Gateway performs the following
tasks:
• Deletes any CIFS or NFS shares that are configured to export from the volume, so
you do not need to explicitly delete the shares.
• Deletes the specified volume.
• Frees any disk space that the deleted volume owned. The LUNs that supported the
now deleted volume remain labeled and appear in the lun show all command as
“free.” Because the LUNs are still labeled, you can use them for creation of a new
volume, or for automatic growth of an existing volume.

32-18
Note!
Deleted volume information is not stored in any nonvolatile memory. When
you delete a volume, all information about that volume no longer exists. If you
want the volume information, you need to manually recreate it.
Options
The VOLNAME variable is the name of the volume that you are
deleting. Volume names are alphanumeric character strings. The
volume name needs to begin with either an alphabetic or numeric
character, or a dash (-) or underscore ( _ ).
Example
cluster1-4> volume delete publitech

Are you sure ? [Y/N] : y
Done.
cluster1-4>
In this example, the volume publitech is deleted. The NAS Gateway prompts you for
confirmation before deleting the volume. At this prompt you can accept or cancel the
deletion by typing Y or N.
Related Commands
system create mgmtvolume Creates the management volume for the current
server.
commands.

32-19
Volume Import
Synopsis
volume import CLUSTERNAME VOLNAME [NEW_VOLNAME] -m
Description
You can import a volume from one cluster into a selected virtual server of another
cluster using the volume import command. Importing volumes is helpful if, for
example, a cluster fails. In that case you can import the volumes from the failed cluster
into a virtual server of an active cluster. Before importing a volume from a cluster, you
need to disable the volume to be imported and stop any active backup or mirror
sessions on that volume. You need to be in the virtual server context of the virtual
server to which you are importing the volume. After you have imported the volume,
you need to enable the volume before you can use it.
Before importing a volume from a cluster, consider the following:
• You need to disable the volume to be imported and stop any active backup or
mirror sessions on that volume.
• You need to be in the virtual server context of the virtual server to which you are
importing the volume.
• After you have imported the volume, you need to enable the volume before you
can use it.
• You can import only volumes that are visible through network or SAN
connectivity.
• If the volume importing fails while in progress, select Volume->Import again.
Note!
You need to run the lun rescan command before importing a volume. For
details see “LUN Rescan” on page 15-4.

32-20
Options
Table 32-4 : Options for the volume import command
CLUSTERNAME The name of the cluster from which you

are importing the volume.
VOLNAME The name of the volume that you are
importing.
NEW_VOLNAME An optional argument you can use to
rename the volume.
-m This option imports the volume as a mirror
volume. For example, this is used by the
DMIP feature once the baseline transfer has
been performed locally and the mirror is not
set remotely. For additional information, see
Chapter 13 of the System Administrator’s
Guide.
Example
In the following example volume techpubs1 is imported from cluster cluster1-4, and
the imported volume is renamed pubsvol2.
eng31 PUBSTEST3> volume import cluster1-4 techpubs1 pubsvol2

eng31 PUBSTEST3>
Related Commands
volume modify Modifies the attributes of the volume.

32-21
Volume Modify
Synopsis
volume modify VOLNAME [-A ATIMEUPDATES] [-c CHARSUBST] [-q
HARDQUOTA] [-s SOFTQUOTA] [-g MINAUTOGROW] [-h HIGHWATERMARK]
[-p NEWVOLNAME][-e SHAREDREAD] [-L LANGUAGE] [-o OPLOCKS] [-S
STABILITY] [-t CHARSUBSTTABLE] [-d DEVICE] [-f]
Description
Use the volume modify command to modify any of the usage parameters that affect
the automatic volume resizing feature. Use this command to set or reset different
usage values, disable individual features, or reenable individual features for a volume
without deleting and re-creating the volume.
However, the NAS Gateway does not enable concatenation of volumes, division into
multiple volumes, or reduction in size. This command is useful for renaming a volume
or changing its quota parameters. For the volume modify command to complete, the
volume needs to be offline or online depending on the parameter that you want to
modify:
• To change the -h HIGHWATERMARK, -e SHAREDREAD, or -L LANGUAGE
parameters, the volume needs to be online. If the volume is offline, you can
explicitly bring the volume online by running the volume online command. (See
“Volume Online” on page 32-31.)
• To change the -p NEWVOLNAME parameter, the volume needs to be offline. If the
volume is online, you can explicitly take the volume offline by running the volume
offline command. (See “Volume Offline” on page 32-30.)
• To change the -d DEVICE, -q HARDQUOTA, -s SOFTQUOTA, or -g
MINAUTOGROWTH, the volume can be online or offline. The state does not
matter for these parameters.
As part of the volume modify command, you can target a specific device as a
candidate for automatic growth on an existing volume by using the -d option. Each
volume can accept a maximum of 8 additional devices or arrays for use in AutoGrow.

32-22
If you specify a device on an array that is not already associated with a volume, the
array for the new device is added to the array list, but only if the volume has less than
8 arrays associated with it. If the volume has 8 or more arrays and you attempt to
assign another device to the volume, an ALERT-level notification is posted to the NAS
Gateway’s event log.
When the NAS Gateway attempts to automatically grow the volume, the hard quota
value is checked, and the specified device is added to the volume only if the hard quota
is not reached. The automatic growth depends on whether the volume is mounted:
• If the volume is mounted, a grow of the file system is triggered.
• If the volume is not mounted, the specified device is still added to the volume, but
waits in a pending state until the next automatic growth, which is triggered when
the file system usage reaches high watermark. At this point, the file system is
allowed to grow from the preallocated device.
Note!
• The NAS Gateway supports AutoGrow, but it does not support automatic
shrinking of a volume. Therefore, no option to delete a device from a
volume exists.
• If the high watermark is not set, the volume does not automatically grow.
• Although you can add a device to a volume even if the device and the
volume have a different RAID level, it can be a problematic procedure to
add devices with a different RAID level than the volume. Therefore, do
not mix RAID levels unless it is unavoidable.
By default, the NAS Gateway uses the RAID level of the device that was originally
used to create the volume. When you add devices, the NAS Gateway runs a check to
compare the device’s RAID level with the RAID level that was used to create the
volume. One of two outcomes can occur:
• If the device you are adding to the volume has the same RAID level as the device
used to create the volume, the volume modify command completes.
• If the device you are adding to the volume has a different RAID level than the
device used to create the volume, the volume modify command does not
complete. However, you can explicitly cause the command to complete by using
the -f option in the volume modify command.

32-23
Options
Table 32-5 : Options for the volume modify command
VOLNAME The name of the volume you are modifying.

Volume names can be any alphanumeric
character string of up to 127 characters. Volume
names can start only with the following
characters:
• alphabetic
• numeric
• a dash (-)
• an underscore ( _ ).
-c CHARSUBST An optional argument that sets the CIFS invalid
character substitution option to enabled or
disabled. When enabled, if NFS creates a file
name with the invalid characters "*:<>?\|, the
NAS Gateway automatically substitutes a list
defined by CHARSUBSTTABLE. The value for
CHARSUBST can be enabled or disabled.
The default value for CHARSUBST is disabled.
You cannot set this to enabled without also
providing a value for CHARSUBSTTABLE.
-q HARDQUOTA An optional argument that specifies the hard
quota, which is a maximum size of the volume.
Type the volume’s absolute maximum size in 1
megabyte blocks. Set this argument to 0 (the
default) if you want unlimited growth for the
volume.

32-24
Table 32-5 : Options for the volume modify command (Continued)
-s SOFTQUOTA An optional argument that specifies a value in

percentage of the HARDQUOTA. When the
SOFTQUOTA is met, the NAS Gateway
administrator is notified that allocated disk
space as a percentage of the hard quota has
reached this limit.
percentage. The percentage you specify is
automatically calculated in actual disk space.
Specify a percentage between 1 and 100. If you
specify zero (0), the soft quota is disabled.
Default value: 0. Don’t monitor the soft quota.
If the HARDQUOTA is 0, the SOFTQUOTA
will also be set to 0.
minimum growth size specified for the volume.
This parameter sets the smallest amount of disk
space to be added to the volume if the automatic
volume growth feature is triggered and the NAS
Gateway determines that the volume needs more
disk space. This value is also used as the default
size of the volume when it is initially created.
Type the value in megabytes. This value must be
a nonzero value.
Default value: 500. The NAS Gateway gets any
amount of disk size larger than 500 megabytes.

32-25
-h HIGHWATERMARK An optional argument that specifies the trigger

that causes the volume space to grow by the
amount specified in the MINAUTOGROW
argument. Type the value as a percentage of the
total amount of used space. The NAS Gateway
uses the percentage of total used space to
calculate the actual amount of disk space
required. Set the high watermark to a value
between 25% and 100%. If you set the value to
zero (0), automatic volume space growth is
disabled.
-p NEWVOLNAME Renames the current volume’s name to a new
volume name. Volume names are alphanumeric
character strings. The volume name needs to
begin with either an alphabetic or numeric
character, or a dash (-) or underscore ( _ ).

32-26
-e SHAREDREAD An optional argument that specifies the state of

the CIFS no shared read open flag for the
volume. This flag is read by NFS requests, and
the state you set affects whether NFS clients can
access files on the volume. You can set this
variable to allow or disallow. By default, the
shared read is allowed. Specify the shared read
argument with the following construction:
• -e sharedread=allow permits NFS
requests to ignore the no shared read flag.
NFS requests are allowed, and NFS clients
are able to read files on the volume.
• -e sharedread=disallow causes
NFS requests to respect the no shared read
flag. NFS requests are not allowed, and NFS
clients are not permitted to read files on the
volume.
-L LANGUAGE An optional argument that defines the valid
characters in file names stored on this volume.
File names with characters outside the valid list
are not created and permission is denied. The
default value is en_us.
You can select another value from the list
presented by this argument. However, if you
change the language of a volume, NFS and CIFS
clients may not be able to access or see every
file in a directory. When a volume is mirrored,
you need to recreate the mirrors when the
language is changed. Because of these issues,
use the -L option only on empty, nonmirrored
volumes.

32-27
-o OPLOCKS An optional argument that specifies whether

CIFS requests are permitted to obtain
OPLOCKS on files. The values for this option
are allow and disallow. When allowed, CIFS
requests are permitted to obtain OPLOCKS on
files. When disallowed, no CIFS OPLOCKS are
granted.
The default value for OPLOCKS is
allow. Ensure that the volume is online before
setting this option.
-t CHARSUBSTTABLE An optional argument that sets the CIFS invalid
character substitution table.
CHARSUBSTTABLE is a comma-separated list
of 2-byte Unicode value in hex format to be
substituted for the characters "*:<>?\|, for
example,
FF82,FF89,FF8A,FF8C,FF8E,FF8F,FF7F,FF88

32-28
-S STABILITY This option controls whether the file system

ensures that data and metadata are on disk
before an NFS or CIFS operation completes.
Possible values are normal, nameSpace, and all.
The stability of user data write operations are
controlled by NFS or CIFS clients.
• When set to normal, all metadata updates are
written synchronously to the file system log
before the operation completes.
• When set to nameSpace, all name space
updates return to the client before those
changes are written to the file system log.
Note!
This violates NFS cache consistency rules, but can
be useful when doing an rsync-style migration. CIFS
will continue to function properly when this option is
used.
• When set to all, all file system updates
return to the client before those change are
written to the file system log. All user data
write and commit operations return to the
client before those changes are written to
disk. This yields the highest performance for
cases where it does not matter whether data
and name space changes made in the last few
seconds are lost. If a client performs a
commit operation on the file, the changes are
not written synchronously to disk.

32-29
-A ATIMEUPDATES Enables or disables the automatic last access

time updates.
• When enabled, the file system automatically
updates the last access time on files and
directories when they are read. This
increases the file system update load, but
allows clients to see what files are being
used.
• When disabled, the last access time is only
updated when an NFS or CIFS client
explicitly sets the timestamp.
By default, this option is enabled.
-d DEVICE Name of the device you want to grow the volume
with. The device names can be displayed by using
the lun show disk command.
-f To be used in conjunction with the -d option. The -f

option forces manual growth with a device that has a
different RAID level than the volume named in the -d
option.
Example
cluster1-4> volume modify pubstest -q 899 -s 65 -g 524 -p pubtest1

cluster1-4>
In this example, the volume pubstest is modified as follows:

• The hard quota is changed to 899 megabytes.
• The soft quota is changed to 65%.
• The minimum AutoGrow size is changed to use LUNs no smaller than 524
megabytes when automatic volume growth expands the volume.

32-30
• The volume name is changed from pubstest to pubstest1.
Related Commands
system create mgmtvolume Creates the management volume for the current
volume add vsvr Assigns a volume to a virtual server.
server.
volume offline Takes the volume offline.
volume online Brings a volume online.
commands.
Volume Offline
Synopsis
volume offline VOLNAME
Description
During runtime, an existing volume needs to be online prior to it being mounted.
Volumes can be either online or offline. You might have to take a volume offline, for
example, for maintenance to the physical devices that support the LUNs that the
volume owns. Diagnostics can also require you to take the volume offline. The NAS
Gateway supports a command that deactivates the volume while keeping all its
configured parameters intact for when the volume is brought back online. You can take
a volume offline by running the volume offline command.
Note!
This command can be intrusive, so make sure that no one is using the volume
when you take the volume offline. When you take a volume offline, the shares
supporting the volume are no longer visible to clients.

32-31
Options
The VOLNAME variable is the name of the online volume that you
want to take offline.
Example
cluster1-4> volume offline pubstest

cluster1-4>
In this example, the volume pubstest is taken offline. While it is offline, clients cannot
mount pubstest, and its resources are not available to clients.
Related Commands
commands.
Volume Online
Synopsis
volume online VOLNAME [-o MODE]
Description
Volumes can be either online or offline. You might have to take a volume offline, for
example, for maintenance or diagnostics. If a volume is offline, it is still configured,
but it is not mountable; you cannot use it for core dumps or user data, and its resources
are not being shared.
You can take an offline volume online by running the volume online command.
When the volume comes back online, is automatically mounted with its previously
configured parameters.

32-32
Note!
When you bring a volume online, its shares are again visible in the list of
shares.
Options
Table 32-6 : Options for the volume online command
VOLNAME The offline volume that you want to

bring back online.
-o MODE An optional argument that sets the
access mode for the volume when it is
brought back online.
ro allows read-only access when the
volume comes back online
rw allows read-write access when the
volume comes back online. Read-write
access is the default.
Example
cluster1-4> volume online pubstest -o ro

cluster1-4>
In this example, the volume pubstest is brought online in read-only mode. When this
command is run, the volume is activated and can be mounted and shared with the same
configuration that it had prior to being taken offline.
Note!
The -o ro option can be used to mount mirror volumes on a different
virtual server in the cluster. , so that a read-only share can be created
and data can be accessed in read mode on a different NAS Gateway
than the one currently servicing the mirror.

32-33
Related Commands
commands.
Volume Share Export
Synopsis
volume share export VOLNAME LOCATION [-V VIRTUALSERVER]
(all|SHARELIST) [SHARELIST...]
Description
Exporting CIFS and NFS shares facilitates recovery efforts. CIFS and NFS shares are
exported to a share list text file from the source volume. The share list text file is then
imported to a target volume. The share list file consists of a list of shares and
corresponding options, share names, and comments, one per line. NFS shares are
exported using a path relative to the volume name, so the source and target volume
names can differ. CIFS share path names are independent of the volume name. The
following table shows actual share paths and the exported share path.

32-34
Table 33 : Share Paths
Actual Share Path Exported Share Path Description
\ \ CIFS root share

/vol1 / NFS root share
\dir1 \dir1 CIFS share
/vol1/dir1 /dir1 NFS share
IPCS$ Hidden CIFS shares are
not exported
Spaces in share names, path, and comments are supported. Share names with
spaces need to be enclosed in double quotation marks

32-35
Options
Table 32-1 : Options for the volume share export command
all All CIFS and NFS shares to be exported.

LOCATION The path to a file where to store the
exported shares.
SHARELIST One or more space-separated NFS
options or CIFS filename and comments
to be exported.
VOLNAME A source volume where file specified
with the LOCATION argument resides.
-V VIRTUALSERVER The virtual server that owns the source
volume specified with VOLNAME. The
default is the current virtual server.
Examples
16:57:37 eng56 ENG56-VS3> volume share export auto-vol

shareExportFile2 /auto-vol /auto-vol/sharedir/share11 /auto-vol/
sharedir/share12 sharename1 sharename2
Exported NFS share : /
Exported NFS share : /sharedir/share11
Exported CIFS share : sharename1
16:59:04 eng56 ENG56-VS3>

32-36

Existing file 'shareExportFile2' will be overwritten.
Related Commands
volume share import Imports volume shares.
Volume Share Import
Synopsis
volume share import VOLNAME LOCATION [-V VIRTUALSERVER]
Description
Run the volume share import command from the virtual server context to import a
previously exported list to a target volume. The exported volume list can be generated
by using the volume share export command.
When importing shares to a target volume, the share list file is parsed, and each share
is created on the target volume. The target volume must be online. An event log is
generated for each share to indicate whether the share creation on the target volume
succeeded or failed.
Note!
This command should only be used on out-of-cluster volumes.

32-37
Options
Table 32-2 : Options for the volume share import command
VOLNAME A target volume where the file specified

by the LOCATION argument resides.
LOCATION The path to a file containing the share
list information or created using the
volume share export command.
-V VIRTUALSERVER The virtual server that owns the target

volume specified with VOLNAME. The
default is the current virtual server.
Examples

Existing file 'shareExportFile2' will be overwritten.

32-38
17:21:41 eng56 ENG56-VS3> volume share import mauto-vol

shareExportFile2
Existing NFS share configuration will be overwritten.
/
Created NFS share: mauto-vol/
|
Created NFS share: mauto-vol/sharedir/share11
Are you sure ? [y|n] : n
Request cancelled
Error: Failed to create NFS share 'mauto-vol/sharedir/share12'
Related Commands
volume share export imports one or more volumes.
Volume Show
Synopsis
volume show [VOLNAME]
Description
Use the volume show command to display volume information in one of two ways:
• Volume Summary, which is a list of all volumes configured on a NAS Gateway
and information about the volume’s quota and AutoGrow parameters, and usage
metrics, and the name of the virtual server that owns the volume.
• Volume Details, which is a list of a specific volume and detailed information about
the volume such as the information from the Volume Summary plus information
about the RAID controller and RAID level that the volume supports, and
information about the LUNs that comprise the volume.

32-39
The volume show command is available regardless of the volume’s state. By default,
the volume information is displayed for the current NAS Gateway.
Options
The VOLNAME variable is the name of the volume that you want
to display. If you do not specify a particular volume, all volumes
on the current NAS Gateway are displayed.
Example
The following example shows the volume summary on the NAS Gateway..
eng57> volume show

Volume Summary
Name Status Type Current (MiB) HardQuota (MiB)

Used (MiB) Avail (MiB) Usage VirtualServer
-------------------------------------------------------------------
------------------------------------------------
vol1 Mounted Standard 10111.94 No Limit
35.22 10076.72 0.35 % VS1
DEE Mounted Standard 20335.94 500
51.81 20284.12 0.25 % VS1
vol_mgmt_453 Mounted Standard 20335.94 No Limit
51.49 20284.45 0.25 % VS_MGMT_453
vol2 Mounted Standard 10111.94 No Limit
35.11 10076.83 0.35 % VS1
eng57>
In this example, the volume summary contains four volumes. The volume summary
shows the following information:
• Name indicates the name assigned to the volume when it was created.
• Status indicates the operational status of the volume. Valid values are:
- Mounted, for a logical volume that is online and mounted by clients.
- Online, for a logical volume that is online, but not mounted.
- Offline, for a logical volume that has been taken offline with the
volume offline command or through a network or system event.

32-40
• Other values not shown in this example might include:

- NotMounted, for a logical volume that is not presently mounted.
- Mounted-RO, for a logical volume that is mounted with read-only
permission.
- Paused, for a logical volume that is in a paused state.
- Mounting, for a logical volume that is being mounted by clients
- Unmounting, for a logical volume that is being unmounted by clients.
- Failing, for a logical volume that is failing.
• Type indicates the type of virtual server that is supported. Valid values include:
- Standard, for a logical volume that is supporting standard file system
data. The management volume is also indicated by this value although
it does not support standard file system data. The management volume
is indicated by the prefix vol_mgmt in its name.
- Mirror, for a logical volume that is supporting ONStor™ Data Mirror
functionality,
- Core, for a logical volume that is supporting core dump functionality.
• Current (MiB) indicates the amount in megabytes of currently used volume space.
• HardQuota (MiB) indicates the number of megabytes that are assigned to the hard
quota for automatic volume resizing.
Note!
If the HARDQUOTA is 0, the SOFTQUOTA is also set to 0.
• Used (MiB) indicates the percentage of used disk space based on the number of
megabytes configured for the volume when the volume was created.
• Avail (MiB) indicates the amount of free disk space assigned to the volume. The
listed value is the amount of unused disk space in megabytes.
• Usage indicates a percentage value that indicates the amount of the volume’s
configured size that is currently being used.
• Virtual Server shows the name of the virtual server that owns the volume. The
virtual server showed is the one in which the volume was created.

32-41
In the following example, volume details for a specific volume are displayed.
eng57> volume show vol1

Volume Details
--------------
Name : vol1
Id : 0x1c500000069
Type : Standard
Version : 26
Virtual Server : VS1
Status : Mounted
Current Size (MiB): 10111.94
Used Size (MiB): 35.22
Available Size (MiB): 10076.72
Usage (%) : 0.35 %
Hard Quota (MiB): No Limit
Soft Quota (%) : N/A
High Water Mark (%) : N/A
Min. Auto Growth (MiB): 500
Shared Read : allow
Oplocks : allow
CharSubst : disabled
CharSubstTable : 0000,0000,0000,0000,0000,0000,0000,0000
Language : en_us
Automatic Atime Updates: enabled
Stability: normal
Arrays : LSI_E4600A
Vendor/model : None
RAID Level : Raid-0
Min. Lun Size (MiB): 0
Max. Lun Size (MiB): 0
LUN List
Idx Device Name Size (MiB)
--------------------------------------------------
1 LSI_E4600A_R46_eng57_mgmt 10239.94
-------------------------------------------------
eng57>
In this example, the volume details are displayed for the volume vol1. The volume
details display contains the following information:
• Name shows the configured name of the volume.

32-42
• ID shows the volume ID that was computed for the volume. This value is
computed internally and used by the NAS Gateway. It is not a configurable value,
and it is used for internal processes in the NAS Gateway.
• Type indicates the type of virtual server that is supported. Valid values include:
- Standard, for a logical volume that is supporting standard file system
data.
- Mirror, for a logical volume that is supporting Data Mirror
functionality,
- Management, for a logical volume that is supporting NAS Gateway
management functions.
- Core, for a logical volume that is supporting core dump functionality.
• Version shows the current layout version of the filesystem.
• Virtual Server shows the name of the virtual server that owns the volume. The
virtual server shown is the one in which the volume was created.
• Status indicates the operational status of the volume Valid values are:
- Mounted, for a logical volume that is online and mounted by clients.
- Online, for a logical volume that is online, but not mounted.
- Offline, for a logical volume that has been taken offline with the
volume offline command or through a network or system event.
• Current Size (MiB) indicates the amount in megabytes of currently used volume
space.
• Used Size (MiB) indicates the percentage of used disk space based on the number
of megabytes configured for the volume when the volume was created.
• Available Size (MiB) indicates the amount of free disk space assigned to the
volume. The listed value is the amount of unused disk space in megabytes.
• Usage (%) indicates a percentage value that indicates the amount of the volume’s
configured size that is currently being used.

32-43
• HardQuota (MiB) indicates the number of megabytes that are assigned to the hard
quota for automatic volume resizing. The default value is zero (0), which causes
the volume to have no absolute limit so volume growth is unlimited.
Note!
If the HARDQUOTA is 0, the SOFTQUOTA value is also set to 0.
• Soft Quota (%) indicates the percentage of the hard quota at which the automatic
volume resizing feature triggers. Valid values are:
- A percentage between 1 and 100.
- Zero (0), the soft quota is disabled. This is the default.
• High Water Mark (%) specifies the trigger that causes the volume space to grow by
the amount specified in the Min. Auto Grow field. Valid values are:
- A percentage from 25 to 100.
- Zero (0), which disables the automatic volume resizing feature.
• Min. Auto Growth (MiB) specifies the smallest amount of disk space that is added
to the volume if the automatic volume growth feature is triggered.
- The default value is 100, which causes the NAS Gateway to get any
amount of disk size larger than 100 megabytes.
- Zero (0) causes the NAS Gateway to get the next available LUN with
any amount of disk space.
• Shared Read indicates the state of the CIFS “no shared read” open flag for the
volume. This flag is read by NFS requests, and the state you set affects whether
NFS clients can access files on the volume.
- Allow permits NFS requests to ignore the “no shared read” flag.
Therefore, NFS requests are allowed, and NFS clients are able to read
files on the volume.
- Disallow causes NFS requests to respect the “no shared read” flag.
Therefore, NFS requests are not allowed, and NFS clients are not
permitted to read files on the volume.
• Oplocks specifies whether CIFS requests are permitted to obtain OPLOCKS on
files. Valid values are allow and disallow.

32-44
• CharSubst sets the CIFS invalid character substitution option to enabled or disabled.
• CharSubstTable sets the CIFS invalid character substitution table.
• Language defines the valid characters in file names stored on this volume.
• Arrays indicates device name of an array from which the volume obtains its LUNs.
• Vendor/Model specifies the vendor names or model number of the LUNs to be
used for the volume.
• RAID Level shows the RAID level that was configured on the LUNs in the volume,
when the volume was created. Supported RAID levels are:
- RAID 0
- RAID 0+1
- RAID 1
- RAID 3
- RAID 5
- N/A for volumes that have LUNs created without a specified RAID
level.
• Min. LUN Size (MiB) specifies the smallest logical disk to be used in the volume
creation or resizing. The default value zero (0) causes no minimum disk size limits
to be enforced for LUN creation or resizing, so any size of disk can be used.
• Max. LUN Size (MiB) specifies the largest single disk to be used for creating or
resizing a volume. The default value zero (0) causes no minimum disk size limits
to be enforced for LUN creation or resizing, so any size of disk can be used.
• LUN List shows a table of the LUNs that have been configured for this volume.
The LUN list shows each LUN’s index number, device name (which is the RAID
controller ID plus the LUN ID, and LUN size.
Related Commands
commands.

Instructions - Onstor Command Line

Enviado por

Dados do documento

Descrição original:

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Instructions - Onstor Command Line

Enviado por

Direitos autorais:

Formatos disponíveis

ONStor™ Bobcat 2200 Series

Customer Order Number: ONS-DOC-CR-2200, Rev E1

Chapter 1: Admin Password Command...................................................1-1

Chapter 2: ARP Commands ......................................................................2-1

Chapter 3: Auditing Commands ...............................................................3-1

Chapter 4: Autosupport Commands ........................................................4-1

690-0013-0001E1 ONStor™ 2200 Series NAS Gateway Command Reference

Chapter 5: CIFS Commands......................................................................5-1

Chapter 6: CIFS-GNS Commands.............................................................6-1

Chapter 7: Cluster Commands..................................................................7-1

ONStor™ 2200 Series NAS Gateway Command Reference 690-0013-0001E1

Chapter 8: Domain Commands.................................................................8-1

Chapter 9: Elog Commands ......................................................................9-1

Chapter 10: Filesystem Commands .......................................................10-1

690-0013-0001E1 ONStor™ 2200 Series NAS Gateway Command Reference

Chapter 11: ID Mapping Commands.......................................................11-1

Chapter 12: Interface Commands ...........................................................12-1

ONStor™ 2200 Series NAS Gateway Command Reference 690-0013-0001E1

Chapter 13: Localmap Commands .........................................................13-1

Chapter 14: Logical Ports Commands ...................................................14-1

Chapter 15: LUN Commands...................................................................15-1

Chapter 16: Mirror Commands................................................................16-1

690-0013-0001E1 ONStor™ 2200 Series NAS Gateway Command Reference

Chapter 17: NDMP Commands ...............................................................17-1

Chapter 18: NFS Commands...................................................................18-1

ONStor™ 2200 Series NAS Gateway Command Reference 690-0013-0001E1

Chapter 19: Port Commands...................................................................19-1

Chapter 20: Privilege Commands ...........................................................20-1

Chapter 21: Route Commands................................................................21-1

Chapter 22: SCSI Commands..................................................................22-1

690-0013-0001E1 ONStor™ 2200 Series NAS Gateway Command Reference

Chapter 23: Snapshot Commands..........................................................23-1

Chapter 24: SNMP Commands................................................................24-1

Chapter 25: Stats Show Ldavg Command .............................................25-1

Chapter 26: Symbolic Link Commands..................................................26-1

ONStor™ 2200 Series NAS Gateway Command Reference 690-0013-0001E1

690-0013-0001E1 ONStor™ 2200 Series NAS Gateway Command Reference

Chapter 28: Tape Commands..................................................................28-1

Chapter 29: User Account Commands...................................................29-1

Chapter 30: Virtual Server Commands...................................................30-1

ONStor™ 2200 Series NAS Gateway Command Reference 690-0013-0001E1

Chapter 31: Virus Scan Commands .......................................................31-1

Chapter 32: Volume Commands .............................................................32-1

690-0013-0001E1 ONStor™ 2200 Series NAS Gateway Command Reference

ONStor™ 2200 Series NAS Gateway Command Reference 690-0013-0001E1

690-0013-0001E1 ONStor™ 2200 Series NAS Gateway Command Reference

ONStor™ 2200 Series NAS Gateway Command Reference 690-0013-0001E1

690-0013-0001E1 ONStor™ 2200 Series NAS Gateway Command Reference

ONStor™ 2200 Series NAS Gateway Command Reference 690-0013-0001E1

Table F-1 ONStor Product Documentation

Document Name Part Number Revision Level

ONStor Bobcat 2200 Series NAS ONS-DOC-CR-2200 E1

ONStor Bobcat 2200 Series NAS ONS-DOC-GMGR E1

ONStor Bobcat 2200 Series NAS ONS-DOC-CMA B1

ONStor Bobcat NAS Gateway System ONS-DOC-SAG-2200 F1

690-0013-0001E1 ONStor™ 2200 Series NAS Gateway Command Reference

Table F-2 Product Documentation Revision History

ONStor Bobcat 2200 ONS-DOC-CR-2200 A1 01/18/05

ONStor Bobcat 2200 ONS-DOC-CR-2200 B1 03/15/06

ONStor Bobcat 2200 ONS-DOC-CR-2200 C1 08/17/06

ONStor Bobcat 2200 ONS-DOC-CR-2200 D1 01/23/07

ONStor Bobcat 2200 ONS-DOC-CR-2200 E1 05/18/07

ONStor™ 2200 Series NAS Gateway Command Reference 690-0013-0001E1