YKDELRMT (deletes route lists)

Business Continuity Manager Web API Reference Guide

Version
9.8.8
File Size
1.6 MB
Audience
anonymous
Part Number
MK-96HC137-00

This command deletes the command devices in all routes that originate from the specified DAD, regardless of the route label, based on the route list definition file specified in the input parameter.

Request body format

{ "action":"submit",
   "cliname":"YKDELRMT",
   "CLIPARMS":[
     ["PREFIX△1prefix]
     [",DAD△1DADID"]
     [,"ROUTEID△1route-list-ID"]
   ]
}

Parameters specified in the request body

PREFIX prefix ~ <PREFIX string of 16 or fewer characters>

This is a common parameter included in the default parameter dataset. For details, see Creating a default parameter dataset.

DAD DADID ~ <DAD string>

This is a common parameter included in the default parameter dataset. For details, see Creating a default parameter dataset.

ROUTEID route-list-ID ~ <ROUTE string of 8 or fewer characters>

This is a common parameter included in the default parameter dataset. For this command, specify the route list ID of the route list configuration file from which command devices are to be deleted.

Notes

  • To execute this command, you must have permission to execute the YKDELCMD command.

  • If an error occurs for some of the command devices, this command continues processing for other the command devices.

Return code

If the CLI command has finished running, the return code of the CLI command is set in the rc key of the response. If an error occurs before the CLI command is run, the BCM Web API server sets the return code.

The following table lists and describes the return codes when the YKDELRMT command ends.

Table. YKDELRMT command return code list

Return code

Meaning

-3

The module cannot be loaded.

0

The command terminated normally.

4

Unknown XML attribute(s) or element(s) were encountered in the configuration file.

32

An I/O error occurred.

36

The configuration file is invalid.

40

  • OPEN, input, or output could not be performed for the temporary dataset.

  • An error occurred in the reading or writing of a REXX variable.

  • OPEN or input could not be performed for the configuration file.

44

There are no routes subject to operation.

48

There is an error in a specified parameter.

128

The user does not have permission to execute the command.

For details about return codes set by the BCM Web API server, see Return codes set by the BCM Web API server.