Automation Services Application Program Interface › $RMDBAPI SERVICE=LIST

$RMDBAPI SERVICE=LIST

This API procedure function call lists 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)

Syntax

This API procedure function call has the following format:

$RMDBAPI SERVICE=LIST
        [RSNAME=ft-ruleset-name]
         CLASS=cc
        [SYSNAME=system-name]
        [VERSION=version]

Operands

This API procedure function call has the following operands:

SERVICE=LIST

Specifies that selected definitions in the knowledge base are to be listed in &ZRMLSTnnnn variables.

RSNAME=ft-ruleset-name

(CA NetMaster 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 resource 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.

Return Variables

This API procedure function call returns the following variables:

&SYSMSG

Contains the returned message.

&ZRMLSTnnnn

Contain the returned knowledge base definition entries.

Return Codes

The following return codes indicate the success or failure of the list processing:

Return Codes

Return codes indicate the success or failure of processing. This API procedure function call returns the following return codes in the &RETCODE variable:

0

Indicates that processing was successful.

8

Indicates that processing failed.

16

Indicates that error occurred in the call syntax.

Example: List the Versions of a System Image

This example retrieves the list of all versions of the EASTPRD1 system image:

&CALL PROC=$RMDBAPI +
      SHARE=(ZRMLST>) +
      PARMS=(SERVICE=LIST,+
             CLASS=01,+
             SYSNAME=EASTPRD1)