Syntax
$RMDBAPI |
SERVICE=GET
[{NAME=resource-name[MANNAME=manager-name]}|
{RSNAME=ft-ruleset-name[RMNAME=ft-rule-name]}]
CLASS=cc
SYSNAME=system-name
VERSION=version
|
Use
Use this call to retrieve information about a ResourceView definition in 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 |
|---|---|
|
SERVICE=GET |
Indicates that information about a definition is to be retrieved from the knowledge base. |
|
NAME=resource-name |
Specifies the name of the resource definition for which information is to be retrieved. This operand is not required if you are retrieving information about a system image definition, a file transfer rule set, or a file transfer rule. |
|
MANNAME=manager-name (FTM) |
Specifies the name of the manager that owns the resource, resource-name (for example, the definition of the file transfer manager that owns the monitor resource for which information is to be retrieved). |
|
RSNAME=ft-ruleset-name (FTM) |
Specifies the name of the file transfer rule set to which the specified rule, ft-rule-name, belongs. |
|
RMNAME=ft-rule-name (FTM) |
Specifies the name of the file transfer rule definition for which information is to be retrieved. This operand is not required if you are retrieving information about a file transfer rule set definition. |
|
CLASS=cc |
Specifies the two-digit identifier of the ResourceView definition class to which the definition belongs. |
|
SYSNAME=system-name |
Specifies the name of the system image for which information is to be retrieved or the name of the system image that owns the resource for which information is to be retrieved. For file transfer rule sets and rules in a CA NetMaster FTM region, the value of SYSNAME is FILTER. |
|
VERSION=version |
Specifies the version of the system image. For file transfer rule sets and rules in a CA NetMaster FTM region, the values of VERSION are 0006 and 0005 respectively. |
Returned Variables
|
Variable |
Description |
|---|---|
|
&ZRMDBfield-name |
Knowledge base information about the specified resource is returned in &ZRMDBfield-name variables. |
|
&SYSMSG |
Contains the message returned by $RMDBAPI. |
Return Codes
The following return codes indicate the success or failure of the retrieval processing:
|
&RETCODE |
Meaning |
|---|---|
|
0 |
Processing was successful. |
|
8 |
Processing failed. |
|
16 |
Error occurred in call syntax. |
Example
The following example retrieves information about the RES001 internal resource (class 21), located on the EASTPRD1 version 1 system image:
&CALL PROC=$RMDBAPI + SHARE=(ZRMDB>) + PARMS=(SERVICE=GET,+ NAME=RES001,+ CLASS=21,+ SYSNAME=EASTPRD1,+ VERSION=0001)