A P P E N D I X C

Command Reference

The Sun StorEdge QFS environment consists of a file system, daemons, processes, various types of commands (user, administrator, and so on), and tools. This appendix describes the commands that are included in the Sun StorEdge QFS software distributions.

The Sun StorEdge QFS commands operate in conjunction with the standard UNIX file system commands. All the commands are documented in UNIX `man`(1) pages.

This appendix contains the following sections:

- User Commands

- General System Administrator Commands

- File System Commands

- Application Programming Interface

- Operational Utilities

##

User Commands

By default, file system operations are transparent to the end user. Depending on your site practices, however, you might want to make some commands available to users at your site to fine-tune certain operations. TABLE C-1 summarizes these commands.

TABLE C-1 User Commands
Command | Description
--- | ---
`sdu`(1) | Summarizes disk usage. The sdu(1) command is based on the GNU version of the du(1) command.
`setfa`(1) | Sets file attributes.
`sfind`(1) | Searches for files in a directory hierarchy. The sfind(1) command is based on the GNU version of the find(1) command and contains options for searching based on Sun StorEdge QFS and SAM-QFS file attributes.
`sls`(1) | Lists contents of directories. The sls(1) command is based on the GNU version of the ls(1) command and contains options for displaying file system attributes and information.
`squota`(1) | Reports quota information.

##

General System Administrator Commands

TABLE C-2 summarizes the commands that you can use to maintain and manage the system.

TABLE C-2 General System Administrator Commands
Command | Description
--- | ---
`fsmadm`(1M) | Starts or stops the `fsmgmtd` daemon.
`fsmgr_setup`(1M) | Installs or upgrades the File System Manager software
`samcmd`(1M) | Executes one `samu`(1M) operator interface utility command.
`samexplorer`(1M) | Generates a Sun StorEdge QFS diagnostic report script.
`samu`(1M) | Invokes the full-screen, text-based operator interface. This interface is based on the `curses`(3CURSES) software library. The `samu` utility displays the status of devices and enables the operator to control automated libraries.

##

File System Commands

TABLE C-3 summarizes the commands that you can use to maintain the file system.

TABLE C-3 File System Commands
Commands | Description
--- | ---
`mount`(1M) | Mounts a file system. The man page name for this command is `mount_samfs`(1M).
`qfsdump`(1M) `qfsrestore`(1M) | Creates or restores a dump file containing the file data and metadata associated with a Sun StorEdge QFS file system.
`sambcheck`(1M) | Lists block usage for a file system.
`samchaid`(1M) | Changes the `file admin set ID` attribute. For use with quotas.
samfsck(1M) | Checks and repairs metadata inconsistencies in a file system and reclaims allocated, but unused, disk space.
`samfsconfig`(1M) | Displays configuration information.
`samfsdump`(1M) `samfsrestore`(1M) | Creates or restores a dump file of the metadata associated with a SAM-QFS file system.
`samfsinfo`(1M) | Displays information about the layout of a Sun StorEdge QFS or SAM-QFS file system.
`samfstyp`(1M) | Determines the Sun StorEdge QFS or SAM-QFS file system type.
`samgrowfs`(1M) | Expands a file system by adding disk devices.
`sammkfs`(1M) | Initializes a new file system from disk devices.
`samncheck`(1M) | Returns a full directory path name, given the mount point and inode number.
`samquota`(1M) | Reports, sets, or resets quota information.
`samquotastat`(1M) | Reports on active and inactive file system quotas.
`samsharefs`(1M) | Manipulates the Sun StorEdge QFS shared file system configuration information.
`samtrace`(1M) | Dumps the trace buffer.
`samunhold`(1M) | Releases SANergy file holds.
`trace_rotate`(1M) | Rotates trace files.

##

Application Programming Interface

You can use the application programming interface (API) to make file system requests from within a user application. The requests can be made locally or remotely to the machine on which the file system is running. The API consists of the `libsam` and `libsamrpc` libraries. These libraries contain library routines for obtaining file status; for setting archive, release, and stage attributes for a file; and for manipulating the library catalog of an automated library. The `sam-rpcd` remote procedure call daemon handles remote requests. To automatically start the `sam-rpcd` daemon, set `samrpc=on` in the `defaults.conf` file.

For more information about the API, see the `intro_libsam`(3) man page. This man page provides overview information for using the library routines in `libsam` and `libsamrpc`.

##

Operational Utilities

Within the Sun StorEdge QFS environment, you can use the `samu`(1M) operator utility and File System Manager to perform basic operations. TABLE C-4 summarizes the operational tools.

TABLE C-4 Operational Utilities
GUI Tools | Description
--- | ---
File System Manager | Provides a web-based graphical user interface to the Sun StorEdge QFS software. You can use this interface to configure, control, monitor, and reconfigure the components of your Sun StorEdge QFS environment. For information on installing File System Manager, see Installing the File System Manager Software. For information on using the File System Manager, see its online help.
`samu`(1M) | Provides the starting point for accessing the `samu`(1M) operator utility.

Copyright © 2006, Sun Microsystems, Inc. All Rights Reserved.