Syntax
$RMDBAPI |
SERVICE=LIST [RSNAME=ft-ruleset-name] CLASS=cc [SYSNAME=system-name] [VERSION=version] |
Use
Use this call to list ResourceView definitions in the knowledge base.
If you make this call from an NCL procedure, ensure that you share the &ZRMLST-prefixed variables, for example, by adding the following statement before the call:
&CONTROL SHRVARS=(ZRMLST)
Operands
|
Operand |
Description |
|---|---|
|
SERVICE=LIST |
Indicates that selected definitions in the knowledge base are to be listed in &ZRMLSTnnnn variables. |
|
RSNAME=ft-ruleset-name (FTM) |
Specifies the name of the file transfer rule set that owns the rules to be listed. If you want to list the rule sets, do not specify this operand. |
|
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 that owns the resource definitions to be listed. Note: 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. Note: 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 |
|---|---|
|
&ZRMLSTnnnn |
Each knowledge base definition entry is returned in an &ZRMLSTnnnn variable. |
|
&SYSMSG |
Contains the message returned by $RMDBAPI. |
Return Codes
The following return codes indicate the success or failure of the list processing:
|
&RETCODE |
Meaning |
|---|---|
|
0 |
Processing was successful. |
|
8 |
Processing failed. |
|
16 |
Error occurred in call syntax. |
Example
The following example retrieves the list of all versions of the EASTPRD1 system image:
&CALL PROC=$RMDBAPI + SHARE=(ZRMLST>) + PARMS=(SERVICE=LIST,+ CLASS=01,+ SYSNAME=EASTPRD1)