notify when the policy class’s
softlimit and hardlimit are
reached.
for the policy class.
class (up to 4 characters in
length).
class (up to 5 characters in
length).
(including the primary) allowed
for each file in the policy class.
(including the primary) for
each file in the policy class.
This value cannot exceed the
maxcopies setting.
a file must reside unmodified
on disk before being
considered a candidate for
storage on media.
CommandOptionsDescription
[ -c mintrunctime ]Minimum time (in days) that a
[ -a affinity ]Lists disk affinities that the files
[ -i minreloctime ]Minimum time (in days) that a
[ -v drivepool ]Media Manager drive pool
[ -f i | p ]File retention policy (-f) for the
[ -r c | s ]Media classification cleanup
fsaddrelationAdds a directory-to-policy
directoryPath name of the directory to
-c classPolicy class to associate with
fsclassinfoReports policy class
[ class ]One or more policy classes to
[ -l ]Long report - processing
fsmodclassModifies the parameters of the
classThe policy class.
[ -d defaultcopies ]Total number of copies to store
file must reside unaccessed on
disk before being considered a
candidate for truncation.
in the policy class will traverse
in their lifecycle.
file must reside unaccessed on
disk before being considered a
candidate for relocation.
used to store or retrieve data
for the policy class.
policy class. Files can be:
• i - Truncated immediately
• p - Truncated at policy
application time
action. When all files are
deleted from a medium, the
medium can revert (-r) back to:
• c - Policy class blank pool
• s - System blank pool
class association.
associate with the policy class.
the directory.
processing parameters,
directory paths, and affinity
lists.
be listed.
parameters, directory paths,
and the disk affinity list for the
policy class.
policy class.
(including the primary) for
each file in the policy class.
CommandOptionsDescription
[ -f i | p ]File retention policy (-f) for the
[ -h hardlimit ]Maximum number of media
[ -l securitycode ]Security code for the policy
[ -m minstoretime ]Minimum time (in minutes) that
[ -c mintrunctime ]Minimum time (in days) that a
[ -i minreloctime ]Minimum time (in days) that a
[ -n notifyID ]E-mail address of the user to
[ -o acctnum ]Account number for the policy
[ -r c | s ]Media classification cleanup
[ -s softlimit ]Warning limit for the number of
[ -t mediatype ]Defines the media type to use.
[ -a affinity ]Lists disk affinities that the files
[ -v drivepool ]Media Manager drive pool
[ -x maxcopies ]Maximum number of copies
policy class. Files can be:
• i - Truncated immediately
• p - Truncated at policy
application time
allowed in the policy class.
class (up to 4 characters in
length).
a file must reside unmodified
on disk before being
considered a candidate for
storage on media.
file must reside unaccessed on
disk before being considered a
candidate for truncation.
file must reside unaccessed on
disk before being considered a
candidate for relocation.
notify when the policy class’s
softlimit and hardlimit are
reached.
class (up to 5 characters in
length).
action. When all files are
deleted from a medium, the
medium can revert (-r) back to:
• c - Policy class blank pool
• s - System blank pool
media allocated in the policy
class.
in the policy class will traverse
in their lifecycle.
used to store / retrieve data.
(including the primary) allowed
for each file in the policy class.
Page 1
Page 2Page 3
Device Management
CommandOptionsDescription
fschstateModifies the state of storage
[ componentalias ]Alias used for storage
[ -s state ]Desired state of drive
subsystems and drive
components.
subsystems and drive
components.
components or subsystems.
Valid values:
•MAINT
•ON
•OFF
Drive status. Valid values:
•FREE
• IN USE
•FAILED
• DELAYED
•CLEANING
File Management
CommandOptionsDescription
fschfiatModifies the class attributes
filenameFile having changed
[ -c copies ]Number of file copies to
[ -t e | p | i ]Indicates how truncation
[ -s e | p ]Indicates how storage
of the file.
attributes.
store, including the primary.
This value cannot exceed
the maxcopies setting.
policies (-t) operate on the
file:
• e - Excludes the file from
truncation when a
store or cleanup policy
application occurs.
• p - Truncates the file by
cleanup policy.
• i - Truncates the file
immediately.
policies (-s) operate on the
file:
• e - Excludes the file from
storage when a store
policy occurs.
• p - Stores the file by
storage policy.
CommandOptionsDescription
[ -r e | p ]Indicates how relocation
[ -a class ]Specifies an alternate
fspolicyManages disk data / space
[ -c class ]Policy class associated with
[ -e ]Invokes a high priority for
[ -s ]Invokes the storage policy.
[ -m minreloctime ]
[ -m minstoretime ]
[ -m mintrunctime ]
[ -o goal ]Percentage of used disk
[ -t ]Invokes the cleanup
[ -v drivepool ]Specifies the drivepool from
[ -b ]Scans file system for
[ -y filesystem ]File system to which the
[ -r ]Invokes the relocation
policies (-r) operate on the
file.
• e - Excludes the file from
relocation when a
relocation policy
occurs.
• p - Relocates the file by
relocation policy.
policy class that can be
associated with the file.
via file system or class.
data to be stored or
truncated.
immediate action on file
storage in a file system.
Minimum time (in minutes)
a file must reside
unaccessed on disk before
being considered a
candidate for relocation.
Minimum time (in minutes)
a file must reside on disk
before being considered a
candidate for storage.
Minimum time (in days) that
a file must reside
unaccessed on disk before
being considered a
candidate for truncation.
space at which a truncation
policy ceases to be applied.
(truncation) policy.
which to allocate drives
when storing files.
candidate files to store,
relocate or truncate and
rebuilds the candidate lists.
policy will be applied.
policy.
CommandOptionsDescription
[ -z minsize ]Minimum file size (in bytes)
fsretrieveRetrieves or recovers files
filenameFull path and name of the
[ -c ]Retrieves a secondary copy
[ -n newfilename ]New path and name into
-R directoryDirectory from which to
[ -b startbyte endbyte ] Specifies a byte range to
[ -a ]Updates the access time of
fsrmcopyRemoves a copy/copies of
filenameFile or files to remove from
[ -c copynum | a ]Deletes either a specific
[ -m mediaID ]Deletes all files on media
fsrmdiskcopyRemoves a file copy from
filenameFull path and name of the
fsstoreExpedites storage of data
filenameName of file on disk to store
[ -c copies ]Number of file copies to
to relocate or truncate.
from media and places the
files on disk.
file to retrieve.
of the file (if a second copy
exists).
which to retrieve the file.
start recursive retrieval.
retrieve. The value of
startbyte must be less than
the endbyte value. Both
values must be within the
file’s byte range.
the requested files.
a file from disk or media.
disk or media.
number (copynum) of file
copies or all file copies (a)
from the media.
which reside on disk.
disk after the file is stored to
media.
file copy to remove from
disk.
to media, instead of
allowing data migration by
SNMS software.
to media.
store, including the primary.
Page 4Page 5Page 6
CommandOptionsDescription
CommandOptionsDescription
CommandOptionsDescription
[ -f i | p ]File retention policy (-f) for
[ -t mediatype ]Defines the media type to
[ -v drivepool ]Specifies the Media
[ -z minsize ]Specifies the minimum file
fsversionSpecifies the file’s current
nameFile for which the version
[ -h ]Displays usage.
[ -a ]Lists all available versions
[ -v ]Verbose listing of the file’s
[ -c ver ]Modifies the file’s current
[ -f ]Forces the version change.
the file. Files can be:
• i - Truncated immediately
• p - Truncated at policy
application time
use for storage.
Manager drive pool group
used to store the file.
size (in bytes) to store.
version(s).
number will be checked.
of the file (current and
inactive).
current version (version
number and modification
time).
version to the specified
inactive version.
File System Recovery
CommandOptionsDescription
fsauditPerforms a file system
filesystemMount point for the file
[ -r ]Runs the fsaudit command
[ -f | -i ]For file system disaster
audit or recovery.
system to be audited or
recovered.
in recovery mode.
recovery, corrects file
system discrepancies in
non-interactive mode (-f) or
interactive mode (-i). In
interactive mode, the user
is prompted for permission
to correct each file system
discrepancy encountered
during the audit.
fsrecoverReports or recovers files
filenameFile to look for in the
dirnameDirectory containing file to
filepathnameFull path of the file to
dirpathnameFull path of the directory
-uIndicates that restore
-dIndicates that directory
[ -p ]Specifies that the user
[ -r ]Indicates recursive
[ -t starttime [ endtime ] ] Indicates a time range to
[ -v ]Number corresponding to
that were modified or
removed from disk.
Trashcan.
restore.
restore.
containing file to restore.
processing is requested.
processing is requested.
report display entries
owned by the user, file
entries to which the user
has read access, and
directory entries to which
the user has write access.
processing is requested.
restrict the length of the
user report. The format of
the starttime and endtime
parameters is:
YY:MM:DD:hh:mm:ss
the order in which the file
became invalid. The most
recent file version is 1.
Media Management
CommandOptionsDescription
fschmedstateModifies the state of
mediaIDThe media identifier.
media or a policy class to
which the media belongs.
[ -c class | -b ]For blank media:
• Changes the name of
the associated policy
class (-c class)
- or -
• Changes the policy
class to system blank
pool (-b).
[ -s state ]The media state. Valid
fscleanRemoves inactive file
-m mediaIDThe media identifier.
-s filesystemThe file system to clean.
-c classPolicy class associated
-t [ endtime ]Endtime option. This
fsdrvcleanCleans the specified
drivealiasThe drive alias.
fsmedcopyCopies, reports or
mediaIDThe media identifier.
[ -r ]Initiates copy-replace for
[ -d destinationmediaID ]Copies a data file to the
[ -b ]Specifies blank media for
values are:
• unsusp
•protect
• unprotect
•avail
• unavail
• unmark
version information.
with data to clean.
parameter should be less
than or equal to the
current time. The format
of the endtime parameter
is: YY:MM:DD:hh:mm:ss
Default: current time
drive.
Valid values: 1 to 255
characters
defragments media.
a medium.
destination media
identifier.
media destination.
Page 7Page 8Page 9
CommandOptionsDescription
CommandOptionsDescription
CommandOptionsDescription
[ -f fill ]Specifies the fill level
[ -t mediatype ]Defines media type to
[ -u runtime ]Maximum allowable time
[ -w fragmentation ]Percentage (0 to 100%)
fsmedinfoGenerates a report on
mediaIDThe media identifier.
[ -l ]Generates the long-form
fsrminfoRemoves file information
mediaIDThe media identifier.
[ -f ]Forces the removal of
vsarchiveqryQueries for information
archivename | -a
[ -c ]Indicates that detailed
[ -d ]Indicates that all drives
[ -m ]Indicates that all media
[ -t ]Indicates that detailed
threshold (between 0 and
100%).
use.
(in hours) for the
fsmedcopy command to
finish.
of wasted space out of
filled space on media.
the specified media.
report which includes a
list of files on the media.
from the SNMS
database.
database information.
about an archive.
Specifies the archive
(archivename) or all
archives (-a) to be
queried.
information on all media
classes associated with
the specified archive will
be reported.
associated with the
specified archive will be
reported.
associated with the
specified archive will be
reported.
information on all media
types associated with the
specified archive will be
reported.
[ -v ]Indicates that all drives,
[ -I ]Indicates that command
[ -h ]Requests help for the
[ -H hostname ]Hostname of the Media
[ -P priority ]Execution priority of the
[ -R retries ]Number of retries the CLI
[ -T timeout ]Time interval (in
[ -V number ]RPC program number for
vsdriveqryQueries for information
driveID | -aIndicates a specific drive
[ -I ]Indicates that command
[ -h ]Requests help for the
[ -H hostname ]Hostname of the Media
[ -P priority ]Execution priority of the
media classes, media,
and media types
associated with the
specified archive will be
reported.
line options are read from
stdin.
entered command.
Manager server.
entered command.
Default value: 15
Valid values: 1 to 32
software attempts if a
timeout is received.
Default: 3
seconds) that the
software waits for status
before returning a
timeout.
Default: 120
the software.
Default: 300016
on the specified drive.
(driveID) or all drives (-a)
will be queried.
line options are to be
read from stdin.
entered command.
Manager server.
entered command.
Default value: 15
Valid values: 1 to 32
[ -R retries ]Number of retries the CLI
[ -T timeout ]Time interval (in
[ -V number ]RPC program number for
vsdrivevaryChanges a drive state.
driveIDSpecifies the drive(s)
-p drivepoolSpecifies the drive pool
-s stateSpecifies the target state
[ -v ]Verbose listing (status
[ -I ]Indicates that command
[ -h ]Requests help for the
[ -H hostname ]Hostname of the Media
[ -P priority ]Execution priority of the
[ -R retries ]Number of retries the CLI
[ -T timeout ]Time interval (in
software attempts if a
timeout is received.
Default: 3
seconds) that the
software waits for status
before returning a
timeout.
Default: 120
the software.
Default: 300016
which state is to be
changed.
for which associated
drives’ states will be
changed.
of the specified drive.
information) of changed
drives.
line options are read from
stdin.
entered command.
Manager server.
entered command.
Default: 15
Valid values: 1 to 32
software attempts if a
timeout is received.
Default: 3
seconds) that the
software waits for status
before returning a
timeout.
Default: 120
Page 10
Page 11Page 12
CommandOptionsDescription
CommandOptionsDescription
CommandOptionsDescription
[ -V number ]RPC program number for
vsmedclassqryQueries for the attributes
mediaclassSpecifies a media class
[ -m ]Requests a list of media
[ -v ]Requests detailed
[ -I ]Indicates that command
[ -H hostname ]Hostname of the Media
[ -P priority ]Execution priority of the
[ -R retries ]Number of retries the CLI
[ -T timeout ]Time interval (in
[ -V number ]RPC program number for
vsmedqryQueries for the attributes
mediaIDSpecifies a media type
[ -l ]Indicates that command
the software.
Default: 300016
of a media class.
(mediaclass) or all media
classes (-a) on which to
request information.
identifiers for all media
associated with each
reported media class.
information for all media
associated with each
reported media class.
line options are to be
read from stdin.
Manager server.
entered command.
Default: 15
Valid values: 1 to 32
software attempts if a
timeout is received.
Default: 3
seconds) that the
software waits for status
before returning a
timeout.
Default: 120
the software.
Default: 300016
of one or more specified
media.
(mediaID) or all media
(-a) to be queried.
line options are to be
read from stdin.
[ -h ]Requests help for the
[ -H hostname ]Hostname of the Media
[ -P priority ]Execution priority of the
[ -R retries ]Number of retries the CLI
[ -T timeout ]Time interval (in
[ -V number ]RPC program number for
vspoolcfg-p drivepoolConfigures the specified
-c driveIDCreates a drive pool with
-dDeletes the drive pool.
-i driveIDInserts drives into an
-r driveIDRemoves drives from an
[ -l ]Indicates that command
[ -h ]Requests help for the
[ -H hostname]Hostname of the Media
[ -P priority ]Execution priority of the
[ -R retries ]Number of retries
[ -T timeout ]Time interval (in
entered command.
Manager server.
entered command.
Default: 15
software attempts if a
timeout is received.
Default: 3
seconds) that the
software waits for status
before returning a
timeout.
Default: 120
the software.
Default: 300016
drive pool.
a list of drive identifiers.
existing drive pool.
existing drive pool.
line options are to be
read from stdln.
entered command.
Manager server.
entered command.
attempted if the software
receives a timeout.
seconds) that the
software waits for status
before returning a
timeout.