Home > Commands N-Z > Commands R

RSM


Description | Syntax | Parameters | Switches | Related | Notes | Examples | Errorlevels | Availability

Manages media resources using Removable Storage. You can run batch scripts for applications that do not currently support the Removable Storage API.


Syntax

RSM {ALLOCATE | CREATEPOOL | DEALLOCATE | DELETEPOOL | DISMOUNT | EJECT | EJECTATAPI | ERASE | FREEMEDIA | INVENTORY | MOUNT | REFRESH | RENAME | UI | VIEW} /?

RSM ALLOCATE /Mmedia_pool_name /Ovalue { /LFlogical_media_id | /LGlogical_media_id | /PFlogical_media_id} | /PGlogical_media_id} [/LNlogical_media_name] [/LDlogical_media_description] [/PNpartition_name] [/PDpartition_description] [/Ttimeout] [/B]

RSM CREATEPOOL /Mmedia_pool_name /Avalue [/TFmedia_pool_type_id | /TGmedia_pool_type_id] [/D] [/R]

RSM DEALLOCATE {/LFlogical_media_id | /LGlogical_media_id | /PFlogical_media_id | /PGlogical_media_id}

RSM DELETEPOOL /Mmedia_pool_name

RSM DISMOUNT {/LFlogical_media_id | /LGlogical_media_id | /PFlogical_media_id | /PGlogical_media_id}

RSM DISMOUNT [/O[deferred]]

RSM EJECT {/PFphysical_media_id | /PGphysical_media_id | {/SFslot_id | /SGslot_id} {/LFlibrary_id | /LGlibrary_id}} | {/DFdrive_id | /DGdrive_id} {/LFlibrary_id | /LGlibrary_id}}

RSM EJECT [/Ovalue]

RSM EJECT [/Avalue]

RSM EJECT [/B]

RSM EJECTATAPI /Natapi_changer_number

RSM ERASE {/PFpartition_id | /PGpartition_id} [/B] [/Rvalue] [/Ttimeout]

RSM FREEMEDIA {/LFlogical_media_id | /LGlogical_media_id | /PFpartition_id | /PGpartition_id | {/SFslot_id | /SGslot_id} {/DFdrive_id | /DGdrive_id}}

RSM INVENTORY {/LFlibrary_id | /LGlibrary_id}} /Avalue

RSM MOUNT {/LFlogical_media_id | /LGlogical_media_id | /PFpartition_id | /PGpartition_id | {/SFslot_id | /SGslot_id} {/CFchanger_id | /CGchanger_id}}

RSM MOUNT [/LFdrive_id | /LGdrive_id]

RSM MOUNT /Ovalue

RSM MOUNT /Rvalue

RSM MOUNT /Ttimeout

RSM REFRESH {/LFlibrary_id | /LGlibrary_id} | {/PFphysical_media_id | /PGphysical_media_id} | /TGmedia_type_id}

RSM RENAME /TGmedia_type_id} [/B] [/Dnew_description] [[/Fobject_id | /Gobject_id] /Nnew_name]

RSM UI [/B] [/Ddestination] /Ooperation /TGmedia_type_id} {/LFcontainer_id | /LGcontainer_id} {/CFcontainer_id | /CGcontainer_id}}

RSM VIEW /Tvalue

RSM VIEW [/CGcontainer_id | /GUIDDISPLAY | /B | /Uui_type | /DESC]


Parameters
ALLOCATE (NTXP)
Allocate media from a media pool.
CREATEPOOL (NTXP)
Create a media pool.
DEALLOCATE (NTXP)
Deallocate media.
DELETEPOOL (NTXP)
Delete a media pool.
DISMOUNT (NTXP)
Dismount media from a drive.
EJECT (NTXP)
Eject media from a library.
EJECTATAPI (NTXP)
Eject media from an ATAPI changer.
ERASE (NT2003)
Erase the contents of a tape.
FREEMEDIA (NT2003)
write a free media label on a piece of media and return it to the Free media pool.
INVENTORY (NTXP)
Inventory media in a specified automated library.
MOUNT (NTXP)
Mount media in the designated library.
The logical media to be mounted can be specified using either the logical-media ID (LMID) or the logical media name.
REFRESH (NTXP)
Refresh a library, physical media, or all devices of a particular media type.
Causes a single poll of the target devices so that the Removable Storage database contains the current state of the device. Can be useful after media insert or eject operations.
RENAME (NT2003)
Change the friendly name or description of an RSM object.
VIEW (NTXP)
Display a list of media objects.
UI (NT2003)
Set the destination for UI messages.

Switches
/? (NTXP)
Displays help.
/Avalue (NTXP)
Permits the use of one of:
/B (NTXP)
Only the GUID for the allocate/eject/view operation is displayed. This aids in scripting where you want to pass the output of one command to the next with minimal parsing.
ERASE/RENAME: hides the text on completion, for scripting purposes.
VIEW: Displays only the object GUID for scripting purposes.
/CFchanger_id (NTXP)
Specifies the changer that contains the media to be mounted, using the friendly name.
/CFcontainer_id (NT2003)
Specifies the computer object for which you are redirecting messages of the type specified by /t, using the object's friendly name.
/CGchanger_id (NTXP)
MOUNT: Specifies the changer that contains the media to be mounted/viewed, using the GUID.
/CGcontainer_id (NT2003)
VIEW: Specifies the GUID for the object container. The type of container depends on the object type (parameter) specified with /t. If the container_ID is not specified, all instances of the applicable object type are displayed.
UI: Specifies the computer object for which you are redirecting messages of the type specified by /t, using the object's GUID.
/D (NTXP)
Permits the media pool to automatically draw media from the free media pool. If omitted, the media pool will not be permitted to draw media from the free media pool.
/Dnew_description (NT2003)
RENAME: Specified the new description for the RSM object.
/Ddestination (NT2003)
UI: Specifies the computer to which you are redirecting messages. If omitted, the local computer is used.
/DESC (NT2003)
Displays the objects' description.
/DFdrive_id (NTXP)
Specifies the drive holding the media to eject/freemedia/mount, using the friendly name.
/DGdrive_id (NTXP)
Specifies the drive holding the media to eject/freemedia/mount, using the GUID.
/Fobject_id (NT2003)
Specifies the object to be renamed, using its friendly name.
/Gobject_id (NT2003)
Specifies the object to be renamed, using its GUID.
/GUIDDISPLAY (NTXP)
Displays both the GUID and the friendly name for objects.
/LDlogical_media_description (NTXP)
Specifies the media to be allocated, using the logical media description.
/LFlogical_media_id (NTXP)
Specifies the media to be allocated/deallocated/mount, using the friendly name.
Logical_media_id specifies the next side of multi-sided media to allocate. This switch is optional and must be used with the Onext. After deallocating this media, the logical media ID is invalid.
/LFlibrary_id (NTXP)
Specifies the library containing the slot or drive from which to eject/inventory/refresh the media, using the friendly name.
/LFcontainer_id (NT2003)
UI: Specifies the library object for which you are redirecting messages of the type specified by /t, using the object's friendly name.
/LGlogical_media_id (NTXP)
Specifies the media to be allocated/deallocated/mount, using the GUID.
Logical_media_id specifies the next side of multi-sided media to allocate. This switch is optional and must be used with the Onext. After deallocating this media, the logical media ID is invalid.
/LGlibrary_id (NTXP)
Specifies the library containing the slot or drive from which to eject/inventory/refresh the media, using the GUID.
/LFcontainer_id (NT2003)
UI: Specifies the library object for which you are redirecting messages of the type specified by /t, using the object's GUID.
/LNlogical_media_name (NTXP)
Specifies the media to be allocated, using the logical media name.
/Mmedia_pool_name (NTXP)
Media are allocated from the specified media pool. This means that you will have allocated/created media in that pool.
/Natapi_changer_number (NTXP)
Specifies the changer number. Atapi_changer_number is the number found at the end of the string for the device name of the changer.
/Nnew_name (NT2003)
RENAME: Specifies the new name for the RSM object.
/Ovalue (NTXP)
Permits the use of one of:
/Ooperation (NT2003)
Specifies whether to add or remove items from the list of destinations, using one of:
/PDpartition_description (NTXP)
Specifies the media partition to be allocated, using the partition description.
/PFlogical_media_id (NTXP)
Specifies the partition to be allocated/deallocated, using the friendly name.
/PFpartition_id (NTXP)
Specifies the media side to mount, using the friendly name.
/PFphysical_media_id (NTXP)
Specifies the physical media to eject/refresh, using the friendly name.
/PGlogical_media_id (NTXP)
Specifies the partition to be allocated/deallocated, using the GUID.
/PGpartition_id (NTXP)
Specifies the media side to mount, using the GUID.
/PGphysical_media_id (NTXP)
Specifies the physical media to eject/refresh, using the GUID.
/PNpartition_name (NTXP)
Specifies the partition to be allocated, using the partition name.
/R (NTXP)
Permits the media pool to automatically return media to the free media pool. If omitted, the media pool will not be permitted to return media to the free media pool.
/Rvalue (NTXP)
Specifies the mount order, or priority:
/SFslot_id (NTXP)
Specifies the slot holding the media to eject/mount, using the friendly name.
/SGslot_id (NTXP)
Specifies the slot holding the media to eject/mount, using the GUID.
/Ttimeout (NTXP)
Specifies the command timeout, in milliseconds. The default timeout value is infinite.
/Tvalue (NTXP)
Displays a list of media objects of the specified type. When used without any parameter, displays a list of all media pools in the Removable Storage system (collection of libraries):
/Ttimeout (NTXP)
Specifies the command timeout, in milliseconds. The default timeout value is infinite.
/Tui_type (NT2003)
Specifies the type of message for which you are setting the destination, using one of:
/TFmedia_pool_type_id (NTXP)
Specifies the type of media the media pool will contain, using the friendly name. The default type is a media pool that contains other media pools.
/TGmedia_pool_type_id (NTXP)
Specifies the type of media the media pool will contain, using the GUID. The default type is a media pool that contains other media pools.
/TGmedia_type_id (NTXP)
Specifies the media type to be refreshed. Only the GUID can be specified. Can be used to refresh all removable media devices by specifying the GUID for the removable media.
/Uui_type (NT2003)
When used with the /tui_destination and /cg switches, displays the destinations to which UI messages of the specified type are directed. The type can be one of three:

Related

none.


Notes
Examples

none.


Errorlevels

none.


Availability
External
DOS
none
Windows
none
Windows NT
NTXP NT2003