Computer and Software Support


Rss

This page is from Microsoft

Updated: January 21, 2005

Manages Remote Storage from the command line. Using the rss command, you can run batch scripts for applications that will allow them to access Remote Storage directly.

To display the Remote Storage parameters

 
Syntax
rss admin show [/recalllimit] [/mediacopies] [/schedule] [/general] [/manageables] [/managed] [/media] [/concurrency] [/adminexempt]
Parameters
/recalllimit
Displays the runaway recall limit.
/mediacopies
Displays the configured number of media copies.
/schedule
Displays the schedule.
/general
Displays general information about Remote Storage: version, status, number of volumes managed, number of tape cartridges used, data in remote storage.
/manageables
Displays the volumes that are available for management by Remote Storage.
/managed
Displays the volumes that are currently being managed by Remote Storage.
/media
Displays the set of media currently allocated for Remote Storage.
/concurrency
Displays the number of migrate jobs/recalls that can be executed concurrently.
/adminexempt
Displays whether administrators are exempt from the runaway recall limit.
Remarks
  • When rss admin show is invoked without additional parameters, the system displays all Remote Storage parameters.
Examples
rss admin show /manageables /general
Return to Top

To modify Remote Storage parameters

 
Syntax
rss admin set [/recalllimit:Limit] [/mediacopies:Number] [/schedule:NewSchedule] [/concurrency:Concurrency] [/adminexempt:{0 | 1}]
Parameters
/recalllimit:Limit
Sets the runaway recall limit to the specified number.
/schedule:NewSchedule
Schedules migration jobs as specified, using the following format:at {startup | idle | login | Time}everyOccurrence {day | week | month} Specifier Time where:Occurrence specifies how many days, weeks or months pass between jobs. For example, rss admin set /schedule every 10 day schedules a job every 10th day.Specifier is only valid if week or month is specified, and indicates the day of the week (0 = Sunday, 1 = Monday, and so on) if week is specified, or the day of the month (1..31) if month is specified.Time is specified using the 24 hour, HH:MM:SS format.
/concurrency:Concurrency
Specifies how many migrate jobs/recalls can be executed concurrently.
/adminexempt:{0 | 1}
Specifies whether administrators are exempt from the runaway recall limit. 0 indicates that they are not; 1 indicates that they are.
Examples
rss admin set /recalllimit:64 /mediacopies:2
Return to Top

To show parameters for a specified volume

 
Syntax
rss volume show {VolumeName1 [VolumeName2 ...] | *} [/dfs] [/size] [/access] [/rule] [/statistics]
Parameters
/dfs
Displays the desired free space setting for the volume.
/size
Displays the minimum size for files to be managed.
/access
Displays the last access date migration criteria for managed files.
/rule
Displays all include/exclude rules for the volume in appropriate format, indicating which are system rules that cannot be deleted.
Remarks
  • If you invoke rss volume show with a volume name or names and no other parameters, Remote Storage will display all parameters for the specified volumes.
  • If you use an asterisk (*) in place of a volume name, Remote Storage will display parameters for all volumes.
Examples
rss volume show d:
Return to Top

To modify settings for a specified volume

 
Syntax
rss volume set {VolumeName1 [VolumeName2 ...] | *} [/dfs:DesiredFreeSpace] [/size:LowerLimit] [/access:DaysNotAccessed] [/include:RulePath] [exclude:RulePath] [/recursive]
Parameters
/dfs:desired_free_space
Sets the desired free space setting for the volume to the specified percentage (for example, 20 = 20%).
/size:LowerLimit
Sets the minimum size in kilobytes (KB) for files to be managed. Only files larger than the specified size will be managed.
/access:DaysNotAccessed
Only files that have not been accessed in the specified number of days or longer will be managed. 180 days is the default.
/include:RulePath
Specifies an inclusion rule to be added to the volume, using the format Path[:FileExtension]. For example, rss volume set c: /include:\windows:*.dll would include all .dll files in the Windows directory in management.
/exclude:RulePath
Specifies an exclusion rule to be added to the volume, using the format Path[:FileExtension].
/recursive
This option should be used only with /include or /exclude, and specifies that the rule should be applied to all folders under the given path.
Remarks
  • If you use an asterisk (*) in place of a volume name, Remote Storage will modify settings for all volumes.
Examples
rss volume set * /access:90 /size:6
Return to Top

To manage a volume

 
Syntax
rss volume manage {VolumeName1 [VolumeName2 ...] | *} [/dfs:DesiredFreeSpace] [/size:LowerLimit] [/access:DaysNotAccessed] [/include:RulePath] [exclude:RulePath] [/recursive]
Parameters
/dfs:DesiredFreeSpace
Sets the desired free space setting for the volume to the specified percentage (for example, 20 = 20%). 5 is the default.
/size:LowerLimit
Sets the minimal size in kilobytes (KB) for files to be managed. Only files larger than the specified size will be managed. 12 is the default.
/access:DaysNotAccessed
Only files that have not been accessed in the specified number of days or longer will be managed. 180 days is the default.
/include:RulePath
Specifies an inclusion rule to be added to the volume for migration criteria, using the format Path[:FileExtension]. For example, rss volume manage c: /include:\windows:*.dll would include all .dll files in the Windows directory in management.
/exclude:RulePath
Specifies an exclusion rule to be added to the volume for migration criteria, using the format Path[:FileExtension].
/recursive
This option should be used only with /include or /exclude, and specifies that the rule should be applied to all folders under the given path.
Remarks
  • If you use an asterisk (*) in place of a volume name, Remote Storage will modify settings for all volumes.
Examples
rss volume manage * /dfs:80 /size:4 /access:60 /include:\Program Files:*
Return to Top

To stop managing a volume

 
Syntax
rss volume unmanage {VolumeName1 [VolumeName2 ...] | *} [/quick] [/full]
Parameters
/quick
Removes the volume or volumes from management without recalling all the files from remote storage. /quick is the default setting.
/full
Removes the volume or volumes from management and recalls all files from remote storage.
Remarks
  • If you use an asterisk (*) in place of a volume name, Remote Storage will stop management on all volumes.
  • /quick and /full cannot both be used in the same command.
Examples
rss volume unmanage *
Return to Top

To run or cancel a single Remote Storage job

 
Syntax
rss volume job {VolumeName1 [VolumeName2 ...] | *} [/type:{createfreespace | copyfiles | validate}] [/run] [/cancel] [/wait]
Parameters
/type:{createfreespace | copyfiles | validate} /type:{f | c | v}
Specifies the type of job to run. createfreespace runs a Create Free Space job for the managed volumes by truncating all pre-migrated files for each specified volume. copyfiles immediately copies files from the specified volumes to remote storage. validate checks to make sure that files on specified volumes still point to valid data in remote storage and updates the volume statistics. You can also use the abbreviated versions of these commands (that is, /type:{f | c | v}).
/run
Runs the specified job. /run is the default if neither /run nor /cancel is specified.
/cancel
Cancels the specified job, if it is running. Cancelling a job that is not running will do nothing.
/wait
Indicates that the jobs should run synchronously on each volume and that Remote Storage will wait until all jobs are complete or it encounters an error before returning to the command prompt. If /wait is not specified, all jobs will run asynchronously on each volume, and Remote Storage will return to the command prompt without waiting for the jobs to finish.
Remarks
  • If you use an asterisk (*) in place of a volume name, Remote Storage will stop management on all volumes.
  • When specifying the job type, you may either use the full name or the single character shortcut. For example, to run a Create Free Space job you can either specify /type:createfreespace or /type:f.
  • /run and /cancel cannot both be used in the same command.
Examples
rss volume job * /type:createfreespace
Return to Top

To remove an include or exclude rule

 
Syntax
rss volume delete {VolumeName1 [VolumeName2 ...] | *} /rule:RulePath
Parameters
/rule:RulePath
Specifies an inclusion or exclusion rule to delete from the volume, using the format Path[:FileExtension].
Remarks
  • If you use an asterisk (*) in place of a volume name, Remote Storage will stop management on all volumes.
Examples
rss volume delete c: \windows:*.dll
Return to Top

To display information about specified media

 
Syntax
rss media show [MediaName1 [MediaName2 ...] | *] [/name] [/status] [/capacity] [/freespace] [/version] [/copies]
Parameters
/name
Displayes the Removable Storage name for the media.
/status
Displays the media status (for example, Healthy, Read only, and so on)
/capacity
Displays the media capacity in gigabytes (GB).
/freespace
Displays the amount of free space on the media in gigabytes.
version
Displays the most recent update date for the media.
/copies
Displays the number of existing copies for the media and each copy's status.
Remarks
  • If you use an asterisk (*) in place of the media name, Remote Storage will show information for all media.
Examples
rss media show rs_tape2 rs_tape3 /capacity /freespace
Return to Top

To delete remote storage data from specified media

 
Syntax
rss media delete [MediaName1 [MediaName2 ...] | *] /copyset:[NumberOfSet]
Parameters
/copyset:[NumberOfSet]
Specifies the copy set to delete on the specified media.
Remarks
  • If you use an asterisk (*) in place of the media name, Remote Storage will delete the specified copy set on all media.
Examples
rss media delete rs_tape2 rs_tape3 /copyset:2
Return to Top

To synchronize a copy set

 
Syntax
rss media synchronize /copyset:NumberOfSet [/wait]
Parameters
/copyset:[NumberOfSet]
Specifies the number of the copy set to synchronize, from 1 to 3.
/wait
Runs the command in synchronous mode, and returns to the command prompt when the job is complete. If /wait is not specified, the command runs asynchronously and returns to the command prompt without waiting for the job to complete.
Examples
rss media synchronize /copyset:1
Return to Top

To recreate a master from a specified copy

 
Syntax
rss media recreatemaster [MediaName1 [MediaName2 ...]] /copyset:NumberOfSet [/wait]
Parameters
/copyset:[NumberOfSet]
Specifies the number of the copy set to use for recreating the master(s).
/wait
Runs the command in synchronous mode, and returns to the command prompt when the job is complete. If /wait is not specified, the command runs asynchronously and returns to the command prompt without waiting for the job to complete.
Examples
rss media recreatemaster rs_tape3 /copyset:2
Return to Top

To recall files from remote storage

 
Syntax
rss file recall [FileSpec1 [FileSpec2 ...]]
Parameters
FileSpec1
Specifies the files to be recalled. You can use the asterisk (*) and question mark (?) wildcard characters.
Remarks
  • This command is synchronous, which means that it will not return to the command prompt until Remote Storage has recalled all files.
Examples
rss file recall scratch.tmp tmp* file?
Return to Top

Formatting legend

Format Meaning
Italic Information that the user must supply
Bold Elements that the user must type exactly as shown
Ellipsis (...) Parameter that can be repeated several times in a command line
Between brackets ([]) Optional items
Between braces ({}); choices separated by pipe (|). Example: {even|odd} Set of choices from which the user must choose only one
Courier font Code or program output