WS-API APIs

Example: password=password123

The request identifier of the request to be cancelled. Operations in progress can be retrieved by running the getSMQueue API.

Example: requestID=12345

Example: password=stornext

Specifies one or more media to be moved. A valid medium identifier may contain up to 16 alphanumeric characters, including spaces. Leading and trailing spaces are not permitted. The number of media that can be specified is restricted by the CLI software. Currently, the maximum allowed number is 64.

Example: mediaIDs=1234

Specifies the name of the archive to which the specified media are to be moved. Valid archive names may contain up to 16 alphanumeric characters, including spaces. Leading and trailing spaces are not permitted.

Example: archiveName=lto

Example: password=stornext

The path and file name of the file(s) to retrieve. The full path name starting from the root directory is required as input to the command. Each file path must specify a file in a migration directory.

Example: files=/stornext/dir/a

Updates the access time of the requested files.

Example: updateATime=1

Used to retrieve a specific copy of filename if one exists. A number from 1 to N.

Example: copy=2

The new path and file name into which to retrieve the file. The location specified for the new file must be a local file system. Retrieval to an NFS-mounted file system is not permitted.

Example: newFileName=/dir/new/filename

The startByte must be less than endByte, and both must be within the byte range of the file. The byte range is inclusive. To retrieve a single byte, the startByte is equal to the endByte. If the startByte and endByte are specified, the newFileName must be specified. Otherwise, the command is rejected. The byte range is zero relative; therefore a specified byte range must be zero to the end byte minus 1.

Example: startByte=123

See the description for startByte

Example: endByte=456

The directory from which to start the recursive retrieve. All files from the specified directory and any subdirectories will be retrieved. Depending upon the number of files in the directory and subdirectories, running this option may use extensive Tertiary Manager resources.

Example: directory=/stornext/managed/pooldir/mp3

Specifies top priority and will cause all files for the retrieve request to be placed at the top of the retrieve queue.

Example: topPriority=1

If you specify a copy, you can NOT specify a startByte.

If you specify a directory, you can NOT specify a copy.

If you specify a newFileName, you can NOT specify more than one (1) files.

If you specify a newFileName, you can NOT specify a directory.

Example: password=stornext

The names of the file(s) on disk to store to media. The full path name starting from the root directory is required as input to the command. Multiple filenames must be separated by commas.

Example: files=/stornext/dir/a

Defines the type of medium to be used for storage. Depending on the type of platform used, the following media types are supported by Tertiary Manager software: AIT, AITW, LTO, LTOW, SDISK, 3590, 3592, 9840, 9940, T10K, DLT4, DLT2 (SDLT600 media)

Example: mediaType=LTOW

Number of copies of the file(s) to be stored. The value is the total number of copies, including the primary copy of the file. This number cannot exceed the number of copies defined in the policy class maxcopies parameter. To store more copies of the file than are specified in the default copies parameter in the policy class, the file's copy attribute must be modified. Use fschfiat filename -c to change this attribute. Then the -c option can be used with the doStore API to store additional copies of the file. If the number of copies stored is less than the number specified by the policy class definition or by the fschfiat command, the remaining copies are stored when the storage policy is applied.

Example: copies=2

The file retention policy for the filename specified. The files can be truncated immediately (i) or at policy application time (p) once all file copies are stored on a medium. If the retention option is not used, the file retention policy will be specified by the policy class definition.

Example: retention=i

Media Manager drive pool group used to store the file specified. The drive pool must be defined in Media Manager software. If the drivePool option is not used, the default drive pool group will be specified by the policy class definition. The special "_" character is permitted to identify the drive pool group.

Example: drivePool=pool3

Minimum file size in bytes to be stored. Files larger than or equal to the specified minSize will be stored. Files with a size less than specified minSize will not be stored.

Example: minSize=123456

Maximum allowable time in hours for the command to finish. This command normally runs until it completes. This option can be used to limit how long it should remain active. If the store has not completed in the specified amount of time, then any outstanding activity will be cancelled.

Example: runTime=2

Example: password=stornext

The names of the file(s) on disk to store to media. The file path(s) must also be in a migration directory. The full path name starting from the root directory is required as input to the command. Multiple filenames must be separated by commas.

Example: files=/stornext/dir/a

Example: password=stornext

The alias for storage subsystem and drives. The system administrator configures the possible values for component aliases during system configuration or by using the fsconfig command.

Example: componentAlias=sdisk

Example: password=stornext

The path name of at least one file is required. The full path name starting from the root directory is required.

Example: files=/stornext/dir/a

If checksum was turned on for the file when stored and this option is specified, the checksum value generated for the file will be displayed.

Example: checksum=1

Show whether the file has any objects stored to the Wide Area Storage.

Example: showIds=1

Example: password=stornext

The full path name starting from the root directory is required.

Example: file=/stornext/dir/a

The copy id to generate report for. If not specified, the information for the primary copy will be reported.

Example: copy=2

Example: password=stornext

Used to report on the blank media in the general scratch pool.

Example: scratchPoolOnly=1

Example: password=stornext

One or more media identifiers on which to report.

Example: mediaIDs=sdisk

Produce the long form of the report that contains the same information as the short form, plus a list of the file segments on the medium. The pathname that is shown is the name of the file at the time the file was stored. If the file has been renamed since that time that will not be reflected in this report. If the parent or name of an individual file cannot be found, the getMediaReport API will indicate that fact but still report the key.

Example: longReport=1

Example: password=stornext

The report type. Valid names are: file, media, moverhost, or moverrequest.

Example: report=file

The request identifier of the request to be reported. Valid when the report type is file or media.

Example: requestId=1234

The file option reports the current status and request identifier associated with a specified file or files. This method gets the active request identifier associated with a store or retrieve if a filename is known. However, because of potential dependencies, the original request identifier for The doStore API or The doRetrieve API issued by a particular user may not be discernible. Valid when the report type is file.

Example: file=/stornext/dir/a

Example: password=stornext

Example: password=stornext

Example: password=stornext

The destination affinity. This affinity must be defined for the file system in which the file resides. The file will be relocated to this affinity if it has not been truncated. If the file has been truncated, only the file's affinity association will change.

Example: affinity=tier1

One or more files to be relocated. The files must reside in a managed directory.

Example: file=/stornext/dir/a