YKDSPRMT (outputs the statuses of routes and command devices)

This command outputs all routes and command devices in the route list definition files specified by the input parameters. However, if YES is specified for the STATUS parameter, the command device statuses of all routes that originate from the specified DAD are output.

Request body format

{ "action":"submit",
   "cliname":"YKDSPRMT",
   "CLIPARMS":[
     ["PREFIX△1prefix"]
     [,"DAD△1DADID"]
     [,"ROUTEID△1route-list-ID"]
     [,"STATUS△1{YES|NO}"]
]
}

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 definition file that you want to output.

STATUS {YES|NO}

Specify whether to acquire the command device status. If is parameter is omitted, the default value NO is assumed.

YES

From the specified route list definition file, outputs the command device statuses of all routes that originate from the DAD specified for the DAD parameter.

NO

Outputs the command devices of all routes that are in the specified route list definition file.

Responses

See Responses returned by YKDSPRMT.

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

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