RSM

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

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]

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.

/? (NTXP)

Displays help.

/Avalue (NTXP)

Permits the use of one of:

• always CREATEPOOL Opens the existing media pool or creates a new media pool if not found
• default INVENTORY Performs an inventory using the default method specified in the library's PROPERTIES dialog box
• existing CREATEPOOL Opens the existing media pool or returns an error if the media pool specified does not exist
• fast INVENTORY Performs a bar code inventory, if the specified library has a bar code reader installed. If the library has no bar code reader, Removable Storage checks the storage slots and reads the on-media identifier on media in slots that were previously empty
• full INVENTORY Performs a full on-media inventory of the library. Removable Storage mounts each tape or disk in the library and reads the on-media identifier
• new CREATEPOOL Creates a new media pool or returns an error if the media pool specified already exists
• none INVENTORY Performs no inventory
• queue EJECT Queues the media for later ejection. This can be used for libraries with multi-slot inject/eject (IE) ports
• start EJECT The default, starts the eject operation immediately. The media is ejected until a timeout occurs, or unless another eject command is issued with the /a option and STOP. Such eject commands must also specify the eject operation GUID using the /o option. The timeout parameter is specified in the library object (for all eject operations) for the library. To set this timeout parameter, you must use the Removable Storage API. Can also be used in conjunction with the /o switch to display the GUID of a particular eject operation
• stop EJECT Terminates the eject operation prior to a timeout expiring. The particular eject operation can be determined using the GUID displayed when START is used with the /a switch and the /o switch
• stop INVENTORY Stops the current inventory for the specified library, if one is being performed

/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:

• deferred DISMOUNT Dismounts with media kept in drive
• drive MOUNT Specifies that a particular drive is to be mounted. Used in conjunction with the /d switch
• eject_operation_id EJECT Used to specify the GUID for the particular eject operation
• errunavail ALLOCATE Prevents the submission of an operator request for new media if none can be allocated with the specified constraints
• errunavail MOUNT Generates an error if either the media or the drive is unavailable
• new ALLOCATE Allocates a partition that cannot be shared with another application. This can be used to reserve the second side of two-sided media
• next ALLOCATE Allocates the next side of media that was previously allocated using the new parameter
• offline MOUNT Generates an error if the media is offline
• read MOUNT Mounts the media for read access
• write MOUNT Mounts the media for write access. Completed media will not be mounted

/Ooperation (NT2003)

Specifies whether to add or remove items from the list of destinations, using one of:

• add Adds a new destination (computer name) to the list
• delete Removes an existing destination from the list
• deleteall Clears the entire destination list. When the destination list is empty, UI messages of the type specified by the /t swtich will not appear on any computer

/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:

• high
• highest
• low
• lowest
• normal (the default)

/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):

• changer
• computer (RENAME)
• drive_type
• drive
• iedoor
• ieport
• library
• librequest
• logical_media
• media_pool
• media_type
• oprequest (RENAME)
• partition
• physical_media
• storageslot
• ui_destination (VIEW)

/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:

• INFO Informational messages
• REQ Messages that are "requesting" in nature
• ERR Error messages

/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:

• info Informational messages
• req Messages that are "requesting" in nature
• err Error messages

none.

• 536870913 Invalid arguments were specified. Frequently, this is caused by a space after an argument switch
• 536870914 Duplicate argument switches were specified
• 536870915 No GUID matches the friendly name that was specified. Check capitalization because friendly names are case-sensitive
• 536870916 An insufficient number of argument switches were specified. Check to see if a required switch is missing
• 536870917 An invalid GUID was specified. Use the VIEW command to determine the correct GUID for an object
• 536870918 This is returned only by the EJECTATAPI command. Verify that the ATAPI changer is functioning correctly

none.

none.

External

DOS

none

Windows

none

Windows NT

NTXP NT2003