Syntax
$RMCALL |
OPT=SERVICE SERVICE=ACTION ACTION=DBGET NAME=resource-name CLASS=cc SYSNAME=system-name VERSION=version |
Use
Use this call to retrieve information about a resource from the knowledge base.
If you make this call from an NCL procedure, ensure that you share the &ZRMDB-prefixed variables, for example, by adding the following statement before the call:
&CONTROL SHRVARS=(ZRMDB)
Operands
|
Operand |
Description |
|---|---|
|
OPT=SERVICE |
Indicates that an API service is to be performed. |
|
SERVICE=ACTION |
Indicates that an ACTION service is to be performed. |
|
ACTION=DBGET |
Indicates that database information about a resource is to be retrieved. |
|
NAME=resource-name |
Specifies the name of the resource for which information is to be retrieved. |
|
CLASS=cc |
Specifies the two-digit identifier of the ResourceView definition class to which the resource belongs. |
|
SYSNAME=system-name |
Specifies the name of the system image where the resource is defined. |
|
VERSION=version |
Specifies the version of the system image where the resource is defined. |
Returned Variables
|
Variable |
Description |
|---|---|
|
&ZRMDB* |
Reference definition information about the specified resource is returned in &ZRMDB* variables. |
|
&SYSMSG |
Contains the message returned by $RMCALL. |
Return Codes
The following return codes indicate the success or failure of command processing:
|
&RETCODE |
Meaning |
|---|---|
|
0 |
Processing was successful. |
|
8 |
Processing failed. |
|
16 |
Error occurred in call syntax. |
Example
The following example retrieves information about the internal resource (class 21) named RES001, located on version 0001 of the EASTPRD1 system:
&CALL PROC=$RMCALL + SHARE=(ZRMDB>) + PARMS=(OPT=SERVICE,+ SERVICE=ACTION,+ ACTION=DBGET,+ NAME=RES001,+ CLASS=21,+ SYSNAME=EASTPRD1,+ VERSION=0001)