Overview

The table below provides a description for each category of a web service. The web services are organized into the high-level categories outlined in Table 1.

**Table 1:** Web Service Categories and General Descriptions
Category	Description
Archive	Return information about an archive, query an archive port, or change the state of an archive.
Directory	Modify the class attributes of a directory or retrieve or recover files from media.
Drive	Report or change the state of drive components and storage subsystems.
File	Report, retrieve, and store files to tiered storage.
Job	Return information about jobs.
Media	Manage media – copy, clean up, move, and report.
Object Storage	Report Object Storage components.
Policy	Manage and report policies.
Quota	Manage and report quotas.
Report	Return information about subsystem resource requests.
Schedule	Manage and report schedules.
System	Get the status of system and Tertiary Storage Manager (TSM) components. Manage and report backups.

Table 2 provides a brief description of each web service and the minimum access control required to execute the command (see Create the SWS V2 Web Service User).

**Table 2:** Web Service Descriptions
Web Service	Description	Minimum Access Control Required to Execute the Command
Archive
Query	Return information about an archive.	Destination, Read-Only
Query port	Query an archive port.	Destination, Read-Only
Change state	Change the state of an archive.	Destination, Read-Write
Directory
Change attributes	Modify the class attributes of a directory.	File, Read-Write
Retrieve files	Retrieve files from media and place them on disk.	File, Read-Write
Drive
State	Report the state of storage subsystem drive components and storage subsystems and Tertiary Storage Manager (TSM) software.	Destination, Read-Only
Change state	Change the state of a storage component in the Quantum storage subsystem.	Destination, Read-Write
File
Information	Generate a report about files known to the Tertiary Storage Manager.	File, Read-Only
Tape location	Generate a report about a file’s tape copy location.	File, Read-Only
Retrieve files	Retrieve files from media and place on disk.	File, Read-Write
Retrieve files / new location	Retrieve files from media and place into new disk file.	File, Read-Write
Relocate file from one affinity to another	Relocates a managed file from one disk affinity to another.	File, Read-Write
Retrieve files / partial	Retrieve partial files from media and place on disk.	File, Read-Write
Store	Expedite the storage of a file that currently resides on disk to media.	File, Read-Write
Remove disk copy	Remove the copy of a file from disk after the file was stored to a medium.	File, Read-Write
Modify class attributes	Modify the class attributes of a file.	File, Read-Write
Job
Asynchronous job status	Returns a status of the jobs that are invoked asynchronously.	None
Detailed mover job status	Returns a detailed status of the mover jobs that are invoked asynchronously.	None
Media
Information	Generate a media report based on their current status.	Destination, Read-Only
File background job status	Reports the status of the background job.	Destination, Read-Write
File inactive removal	Remove inactive versions of files.	Destination, Read-Write
File inactive remove by media	Clean all files on media that have been marked as logically blank.	Destination, Read-Write
File inactive removal list	List all media that has been marked as logically blank.	Destination, Read-Write
Move media	Move media from one archive to another.	Destination, Read-Write
Import cleaning media	Imports a list of cleaning media.	Destination, Read-Write
Import media	Imports a list of media.	Destination, Read-Write
Export media	Exports a list of media.	Destination, Read-Write
Copy media	Initiates copy-replace for a media.	Destination, Read-Write
Fragmentation report	Report on media fragmentation.	Destination, Read-Write
Eject media	Eject media out of an archive to be entered into another archive.	Destination, Read-Write
Enter media	Enter media that has been ejected out of an archive into another archive.	Destination, Read-Write
Purge media	Purges a list of media.	Destination, Read-Write
Attribute query	Queries for the attributes of one or more specified media.	Destination, Read-Only
Change media state	Change the class or state of a media.	Destination, Read-Write
Checkout media	Check media out of the Media Manager system.	Destination, Read-Write
List media for removal	List all media that are marked for removal.	Destination, Read-Write
List media by state	Lists media by state.	Destination, Read-Write
List media by location	Lists media by location.	Destination, Read-Write
Object Storage
Report Object Storage components	Report Object Storage components.	Destination, Read-Only
Policy
Class information	Report information on storage manager policies.	Policy, Read-Only
Modify a policy	Modify the processing parameters of a policy class.	Policy, Read-Write
Report policy class for a directory	Reports the policy class associated with directory.	Policy, Read-Only
Report policy class for a file system	Reports all policy classes with association points in a file system.	Policy, Read-Only
Quota
Manage quotas	Manage the quota system in the StorNext file system.	File, Read-Write
Report
Cancel requests	Cancels requests.	Policy, Read-Write
Files	Reports all files in the queue or specific files if a request identifiers or filename is specified.	Policy, Read-Only
Media	Reports the media movement for a request identifier or all media in queue.	Policy, Read-Only
Mover host	Reports the active mover host summary.	Policy, Read-Only
Mover request	Reports the active mover request summary.	Policy, Read-Only
Resource	Reports the active resource request summary.	Policy, Read-Only
Status	Reports the status summary information on requests.	Policy, Read-Only
Schedule
Report	Prints the report of a feature or schedule.	System, Read-Only
Create	This web service will create a schedule.	System, Read-Write
Update	This web service will update a schedule.	System, Read-Write
Delete	This web service deletes an existing schedule.	System, Read-Write
Reset	This web service resets an existing schedule.	System, Read-Write
System
Backup	Execute backup of configuration, database, and file system metadata.	System, Read-Write
Backup status	Retrieves the status of the backup operation.	System, Read-Only
File System Report	Reports the status of a file system and the status of stripe groups that belong to it.	File, Read-Only
Information	Retrieves the latest status of system components.	System, Read-Only
Parameters	Report the value for the specified Tertiary Manager System parameter.	Policy, Read-Only