Automation Services Application Program Interface › $RMDBAPI SERVICE=DELETE

$RMDBAPI SERVICE=DELETE

This API procedure function call deletes a ResourceView definition from the knowledge base.

Syntax

This API procedure function call has the following format:

$RMDBAPI SERVICE=DELETE
       [{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=DELETE

Specifies that a definition is to be deleted from the knowledge base.

NAME=resource-name

Specifies the name of the resource definition to be deleted.

You cannot delete a resource that owns dependent resources (for example, a CICS started task that owns CICS resources).

This operand is not required if you are deleting a system image, 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 whose definition is to be deleted).

RSNAME=ft-ruleset-name

(CA NetMaster FTM) Specifies the name of the file transfer rule set to be deleted or the name of the file transfer rule set from which the specified rule, ft-rule-name, is to be deleted.

You cannot delete an active rule set.

Note: When you delete a file transfer rule set, you also delete the rules it owns.

RMNAME=ft-rule-name

(CA NetMaster FTM) Specifies the name of the file transfer rule definition to be deleted.

This operand is not required if you are deleting a file transfer rule set.

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 be deleted or the name of the system image from which the specified resource is to be deleted.

Notes:

• When you delete a system image, you also delete the resources it owns.
• 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 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.

8

Indicates that processing failed.

16

Indicates that error occurred in the call syntax.

Example: Delete the Resource Definition for a Printer

This example deletes the RES001 printer definition (class 11) from the EASTPRD1 version 1 system image:

&CALL PROC=$RMDBAPI +
      PARMS=(SERVICE=DELETE,+
             NAME=RES001,+
             CLASS=11,+
             SYSNAME=EASTPRD1,+
             VERSION=0001)