The OSREQ macro permits the caller to request the following OAM
functions:
- Function
- Description
- Access
- Establishes resources common to a set of OAM requests. Returns
a token that must be specified with all other requests associated
with this set.
- Change
- Changes an object’s directory entry reference to management
class, storage class, and/or the expiration date, subject to the approval
of the ACS routines. It is also used to change an object's deletion-hold
status and to inform OAM of an external event trigger expiration criteria
for an object in event-based-retention mode.
- Delete
- Removes an object’s directory information and frees all
reusable resources allocated to the object.
- Query
- Interrogates the object directory and returns information describing
objects within the storage system. Specific and generic (wild card)
queries are permitted.
- Retrieve
- Locates the requested object and returns the entire object or
the specified portion of it in the virtual storage buffer provided
by the caller.
- Store
- Records an object’s management criteria, object storage
location, and other information in an object directory. Places the
new object into the object storage hierarchy at a specific hierarchy
level based on the storage class.
Use Store for objects
less than or equal to 256 megabytes. Use the Store Sequence functions
(Storebeg, Storeprt, and Storeend) for storing objects greater than
256 megabytes.
- Storebeg
- Begins the Store Sequence processing of an object. Store Sequence
processing can be used for an object whose total size is greater than
50 megabytes that is to be written to disk or tape (but not to optical).
Store Sequence processing must be used
for storing objects greater than 256 megabytes. See Adding objects to the object storage hierarchy and STOREBEG—Beginning a Store Sequence operation for more information.
- Storeprt
- Stores the next sequential contiguous part of an object being
stored with Store Sequence processing. See Adding objects to the object storage hierarchy and STOREPRT—Storing an individual part in a Store Sequence operation for more information.
- Storeend
- Ends the Store Sequence processing of an object, either to complete
the storage of the object or to effectively cancel the storage of
the object. See Adding objects to the object storage hierarchy and STOREEND—Ending a Store Sequence operation for
more information.
- Unaccess
- Frees the resources obtained with an OSREQ ACCESS request. The
token cannot be used after the UNACCESS invocation.
Implementing the functions contains detailed descriptions of the functions
and their corresponding syntax diagrams.