YKLISTID (displays a list of configuration file IDs)

Business Continuity Manager Web API Reference Guide

Version
9.9.1
Audience
anonymous
Part Number
MK-96HC137-03

This command outputs a list of configuration file IDs and information indicating whether each configuration file is loaded in the BCM Web API server.

Request body format

{ "action":"submit",
   "cliname":"YKLISTID",
    "operands":"[PREFIX(prefix) ]
                [△1CONFIG({ALL|HDA|GROUP|PATH|ROUTE}
                [,{ALL|HDA|GROUP|PATH|ROUTE}…])]
   "
}

Parameters specified in the request body

PREFIX(prefix) ~ <PREFIX string of 25 or fewer characters>

Specify the prefix of the configuration file. If you omit this parameter, the value of the default parameter dataset is assumed.

CONFIG({ALL|HDA|GROUP|PATH|ROUTE})<<ALL>>

Specify the type of the configuration file. You can specify multiple types by using commas to separate them. If you omit this parameter, ALL is assumed.

ALL

Outputs the IDs of all configuration files.

HDA

Outputs the storage serial number and device address domain ID of the disk configuration definition file.

GROUP

Outputs the ID of the copy group definition.

PATH

Outputs the ID of the path set definition file.

ROUTE

Outputs the ID of the route list definition file.

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 YKLISTID command ends.

Table. YKLISTID command return code list

Return code

Meaning

0

The command terminated normally.

8

No configuration files that meet the specified conditions were found.

32

An I/O error occurred.

40

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

  • Dataset name could not be acquired because a failure occurred in LISTCAT.

48

There is an error in the record specified for the parameter dataset.

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