| RmmApi.openApi() |
Use this method to check that DFSMSrmm is active and available
to process commands. |
| RmmApi.closeApi() |
Use this method when you no longer want to communicate with
DFSMSrmm using this command session. |
| RmmCommand.issueCmd() |
Use this method to issue a subcommand to DFSMSrmm. DFSMSrmm
returns the subcommand return code and reason code. To access the
output from the subcommand, use the getBufferSfi method or the getBufferXml
method. |
| RmmCommand.getBufferSfi() |
Use this method to obtain a string that contains the SFI output
buffer from subcommand processing. Use this method after using the
RmmCommand.issueCmd method and after using the RmmCommand.getNextEntry
method. |
| RmmCommand.getBufferXml() |
Use this method to obtain a string that contains the XML output
converted from the SFI output of subcommand processing. |
| RmmCommand.getNextEntry() |
Use this method to retrieve information for the next resource
or set of resources when there is more than one resource to be returned.
For example, SEARCH subcommands and LISTCONTROL subcommands can return
more than one resource. The getBufferXml and getBufferSfi methods
can return multiple resources in a buffer; be sure to process all
the returned data (XML or SFIs) before using the getNextEntry method
if more entries may exist. |
| RmmInterface.getMessageText() |
Use this method to obtain a string that contains the DFSMSrmm
information or error message for the last command issued or the last
getNextEntry method processing. |
| RmmInterface.getApiRc() |
Use this method to obtain the return code from the last API
request. Use the getMessageText method to retrieve the corresponding
information or error message. See EDGXCI return and reason codes for information about message processing. |
| RmmInterface.getApiRs() |
Use this method to obtain the reason code from the last API
request. Use the getMessageText method to retrieve the corresponding
information or error message. See EDGXCI return and reason codes for information about message processing. |
| RmmTransaction.runCommandXml() |
Use this method to return a string containing the XML output
converted from the SFI output of subcommand processing. It may also
return error messages and return and reason codes for the command
in the XML. |
| RmmTransaction.runCommandXmlShort() |
Use this method to return a string containing the XML output
for key values only. Only specific search commands return key fields.
For example: - For SearchVolume, only the volser is returned.
- For SearchDataset, only the datasetname, volume, and filesequence
number are returned.
- For SearchOwner, only the owner ID is returned.
- For SearchRack/SearchBin, only the rack/bin number, location,
and media name are returned.
Other commands work as well, but they return all of the data,
not just the key values. |
z/OS DFSMSrmm Application Programming Interface
Copyright IBM Corporation 1990, 2014