Parameters for the AUTH request
You can use this information to understand the parameters for the DBRC AUTH request. Each parameter is explained as it relates to the AUTH request syntax diagram.
- name name
- Begin the name in column 1.
- TOKEN=address | (2-12)
- Specifies the address of the API token that was returned on the FUNC=STARTDBRC macro.
- AUTHLIST=name | (2 - 12)
- Specifies the list of database names or Fast Path areas to be authorized. The list consists of a fullword that contains the number of elements in the list, a fullword that contains the length of an element, followed by one or more elements. Each element consists of an 8-character DB name or Fast Path DEDB name and 8 characters of blanks (X'40') or a Fast Path area name.
- ACCESS=EX | RD | RO
- Specifies exclusive (EX), read (RD) or read-only (RO) authorization is requested. The default is EX.
- OUTPUT=output | (2 - 12)
- Specifies a field to receive a pointer to the authorization output
block DSPAPAUB.
The output address is 0 if no output was built. This can happen if nothing in the RECON data set satisfies the request or if an error occurs before any output could be built.
The storage for the output blocks is not preallocated by the caller. DBRC acquires storage from the specified subpool for these blocks. The caller must free this storage using the Buffer Release service (DSPAPI FUNC=RELBUF) specifying the returned output address.
- SUBPOOL= 0 | number
- Specifies the subpool number for the storage being obtained. If not specified, the default is the subpool specified by the FUNC=STARTDBRC request. Otherwise, subpool 0 is the default.
- UTILITY=IC | RECOV | REORG | NONE
- Specifies the intended utility function of the application. The functions include image copy (IC), database recovery (RECOV), database reorganization (REORG), or NONE. The default is NONE, indicating a normal database authorization request.
- RETCODE=return code | (2-12)
- If specified as a symbol, specifies the label of a word of storage to receive the return code. If specified as a register, the register must contain the address of a word of storage to receive the return code. Regardless of whether RETCODE is specified, register 15 contains the return code.
- RSNCODE=reason code | (2-12)
- If specified as a symbol, the symbol must be the label of a word of storage to receive the reason code. If specified as a register, the register must contain the address of a word of storage to receive the reason code. Regardless of whether RSNCODE is specified, register 0 contains the reason code.
- MF=S | L | M | E
- Specifies the macro form of the request.
- VERSION=2.0 | number
- Specifies the version number of the parameter list to be generated
by this macro.
To use the parameters associated with a version, you must specify the number of that version or a later version. If you specify an earlier version level, the parameter is not accepted by macro processing, and an error message is issued at assembly time. If parameters have a version dependency, the parameter descriptions with each request type identify the version number required.
The valid version number for the FUNC=AUTH request is 2.0 (the default).