Automation Services Application Program Interface › $RMDBAPI SERVICE=GET

$RMDBAPI SERVICE=GET

This API procedure function call retrieves information about a 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)

Syntax

This API procedure function call has the following format:

$RMDBAPI SERVICE=GET
       [{NAME=resource-name[MANNAME=manager-name]}|
        {RSNAME=ft-ruleset-name[RMNAME=ft-rule-name]}]
         CLASS=cc
         SYSNAME=system-name
         VERSION=version

Operands

This API procedure function call has the following operands:

SERVICE=GET

Specifies 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

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

(CA NetMaster FTM) Specifies the name of the file transfer rule set to which the specified rule, ft-rule-name, belongs.

RMNAME=ft-rule-name

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

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.

&ZRMDBfield-name

Contain the returned knowledge base information about the specified resource.

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: Retrieve Information About an Internal Resource

This 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)

More information:

ResourceView Definition Field Names