A P P E N D I X C

Command Reference

The Sun StorEdge SAM-FS 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 SAM-FS software distribution.

The Sun StorEdge SAM-FS 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

- Automated Library Commands

- Archiver Commands

- Specialized Maintenance Commands

- Site-Customizable Scripts

- 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
--- | ---
`archive`(1) | Archives files and sets archive attributes on files.
`release`(1) | Releases disk space and sets release attributes on files.
`request`(1) | Creates a removable media file.
`sdu`(1) | Summarizes disk usage. The sdu(1) command is based on the GNU version of the du(1) command.
`segment`(1) | Sets segmented file attributes.
`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 Sun StorEdge SAM-FS 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.
`ssum`(1) | Sets the `checksum` attributes on files.
`stage`(1) | Sets `stage` attributes on files and copies offline files to disk.

##

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.
`samd`(1M) | Starts or stops robotic and removable media daemons.
`samexplorer`(1M) | Generates a Sun StorEdge SAM-FS diagnostic report script.
`samset`(1M) | Changes Sun StorEdge SAM-FS settings.
`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).
`sambcheck`(1M) | Lists block usage for a file system.
`samchaid`(1M) | Changes the `file admin set ID` attribute. This command is used 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 Sun StorEdge SAM-FS file system.
`samfsinfo`(1M) | Displays information about the layout of a Sun StorEdge SAM-FS file system.
`samfstyp`(1M) | Determines the Sun StorEdge SAM-FS 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.
`samtrace`(1M) | Dumps the trace buffer.
`samunhold`(1M) | Releases SANergy file holds.
`trace_rotate`(1M) | Rotates trace files.

##

Automated Library Commands

TABLE C-4 summarizes the automated library commands that you can use to configure, initialize, and maintain the automated libraries and devices within the Sun StorEdge SAM-FS environment.

TABLE C-4 Automated Library Commands
Command | Description
--- | ---
`auditslot`(1M) | Audits a single media cartridge slot within a specified automated library.
`build_cat`(1M) | Builds a media catalog file for an automated library. This command can also be used to populate the catalog file.
`chmed`(1M) | Sets or clears library catalog flags and values on a specific cartridge.
`cleandrive`(1M) | Requests that a tape drive be loaded with a cleaning tape.
`dump_cat`(1M) | Displays the content of a binary catalog file in various ASCII formats.
`import`(1M) `samexport`(1M) | Imports or exports a cartridge from a library by placing it in the mailbox. For network attached libraries, this command updates the library catalog, but it does not physically move cartridges.
`samload`(1M) `unload`(1M) | Loads or unloads a cartridge for a specified device.
`move`(1M) | Moves a cartridge from one slot to another.
`odlabel`(1M) | Labels optical disks for use with the Sun StorEdge SAM-FS system.
`samdev`(1M) | Adds `/dev/samst` logical device entries. This command is used to communicate automated library, optical disk, and tape drive information.
`tplabel`(1M) | Labels tapes for use with the Sun StorEdge SAM-FS system.

##

Archiver Commands

TABLE C-5 summarizes the commands that control the archiver's actions within the Sun StorEdge SAM-FS environment.

TABLE C-5 Archiver Commands
Command | Description
--- | ---
`archiver`(1M) | Evaluates the archiver commands file for syntax completeness and semantic accuracy.
`archiver.sh`(1M) | Logs exceptional archiver events.
`reserve`(1M) `unreserve`(1M) | Reserves and unreserves volumes.
`showqueue`(1M) | Displays the content of an archiver queue file.

##

Specialized Maintenance Commands

TABLE C-6 summarizes the various maintenance commands that you can use in a Sun StorEdge SAM-FS environment.

TABLE C-6 Specialized Maintenance Commands
Command | Description
--- | ---
`archive_audit`(1M) | Generates a report of all archived files on each cartridge.
`dmpshm`(1M) | Dumps the shared memory segments.
`exarchive`(1M) | Manipulates (exchanges) archive copies.
`itemize`(1M) | Catalogs an optical disk.
`rearch`(1M) `unrearch`(1M) | Marks or unmarks archive entries to be rearchived.
`sam-recycler`(1M) | Reclaims space used by expired archive copies from archive media.
`sam-releaser`(1M) | Releases disk space from online disk cache file systems.
`samdev`(1M) | Creates symbolic links in the `/dev/samst` directory that point to the actual devices to be used by the Sun StorEdge SAM-FS file system. This command is similar in function to the UNIX `makedev`(1M) command.
`samset`(1M) | Changes or displays variables used in Sun StorEdge SAM-FS operations.
`set_admin`(1M) | Adds or removes permission for an administrator group to execute administrator commands.
`set_state`(1M) | Sets the state of a Sun StorEdge SAM-FS device.
`stageback.sh`(1M) | Stages files from Sun StorEdge SAM-FS archive tapes.
`star`(1M) | Creates tape archives and adds or extracts files. This is a GNU version of the `tar`(1) command, and it has been extended for use with the Sun StorEdge SAM-FS file system. You can use this command in a disaster recovery situation if you need to read data from archive tapes.
`tapealert`(1M) | Decodes tape alert events.
`unarchive`(1M) | Deletes archive entries for one or more files.
`undamage`(1M) | Marks an archive entry for one or more files or directories as undamaged.

##

Site-Customizable Scripts

TABLE C-7 summarizes the site-customizable scripts that you can use to monitor and control the Sun StorEdge SAM-FS environment. By default, the software installs these scripts in `/opt/SUNWsamfs/examples`. You can move these scripts from `/opt/SUNWsamfs/examples` to `/etc/opt/SUNWsamfs/scripts` and modify them to perform the desired action for your site. For more information about these scripts, see their respective man pages.

TABLE C-7 Site-Customizable Scripts
Script | Description
--- | ---
`dev_down.sh`(1M) | Sends email to `root` when a device is marked `down` or `off`.
`load_notify.sh`(1M) | Notifies the operator when the Sun StorEdge SAM-FS software requests a cartridge that resides outside the library.
`log_rotate.sh`(1M) | Rotates log files.
`recover.sh`(1M) | Recovers files archived after the last `samfsdump`(1M) was taken.
`restore.sh`(1M) | Restores files to their online or partially online status.
`stageback.sh`(1M) | Stages files from archive media.
`tarback.sh`(1M) | Reloads files from archive media.

##

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 SAM-FS environment, you can use the `samu`(1M) operator utility and File System Manager to perform basic operations. TABLE C-8 summarizes the operational tools.

TABLE C-8 Operational Utilities
GUI Tools | Description
--- | ---
File System Manager | Provides a web-based graphical user interface to the Sun StorEdge SAM-FS software. You can use this interface to configure, control, monitor, and reconfigure the components of your Sun StorEdge SAM-FS environment. For information on installing File System Manager, see To Install 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.