Automation Services Application Program Interface › $RMDBAPI SERVICE=CREATE

$RMDBAPI SERVICE=CREATE

This API procedure function call creates a ResourceView definition in the knowledge base.

Syntax

This API procedure function call has the following format:

$RMDBAPI SERVICE=CREATE
        [TRUNCATE={YES|NO}]
       [{NAME=resource-name[MANNAME=manager-name]}|
        {RSNAME=ft-ruleset-name[RMNAME=ft-rule-name]}]
         CLASS=cc
         SYSNAME=system-name
         VERSION=version
        [field-name-1=field value-1]
        [field-name-2=field value-2]
        …
        [field-name-n=field value-n]

Operands

Notes:

• Operand values must not contain the question mark (?) character.
• If possible, do not use the semi-colon (;) in values. By default, a semi-colon is interpreted as a command separator if the API is executed (EXEC) or started (START).
• If you must use the semi-colon and you are calling the API from an NCL procedure, use the &CALL verb.

This API procedure function call has the following operands:

SERVICE=CREATE

Specifies that you want to create a definition in the knowledge base.

TRUNCATE={YES|NO}

Specifies whether a field value is truncated if it is longer than the field length.

YES

Specifies that long values are truncated and the definition is created in the knowledge base.

NO

Specifies that no truncation is allowed. If a long value is encountered, the definition is not created in the knowledge base.

NAME=resource-name

Specifies the name of the resource definition to create (for example, the address of a DASD or the name of a started task).

This operand is not required if you are creating a system image, a file transfer rule set, or a file transfer rule definition.

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 whose definition you want to create).

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 to create.

This operand is not required if you are creating 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 to create or the name of the system image in which to create the specified resource.

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.

field-name-n=field-value-n

Specifies the values of the fields in the definition.

Return Variable

This API procedure function call returns the following variable:

&SYSMSG

Contains the returned message.

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.

4

Indicates that processing was successful, but truncation has occurred.

8

Indicates that processing failed.

16

Indicates that error occurred in the call syntax.

Example: Define a System Image

This example creates an EASTPRD1 version 2 system image definition (class 1), with truncation allowed:

&SDESC=&STR Eastern production system

&CALL PROC=$RMDBAPI +
      PARMS=(SERVICE=CREATE,+
             CLASS=01,+
             SYSNAME=EASTPRD1,+
             VERSION=0002,+
             SDESC=&SDESC)

More information:

System Image Fields

Resource Fields