YKDROP (deletes loaded configuration files)

This command deletes, from the BCM Web API server, the configuration files loaded by the YKLOAD command.

Request body format

{ "action":"submit",
   "cliname":"YKDROP",
   "operands" : "[{GROUP(copy-group-ID)| PATH(path-set-ID)} ]
                  "
}

Parameters specified in the request body

GROUP(copy-group-ID) ~ <GROUP string>

Specify the copy group ID of the copy group definition file to be deleted from the BCM Web API server.

PATH(path-set-ID) ~ <dataset prefix of 40 or fewer characters>

Specify the path set ID of the path set definition file to be deleted from the BCM Web API server.

If you omit both the GROUP and PATH parameters, all the configuration files loaded by the YKLOAD command are deleted from the BCM Web API server.

Responses

See Responses common to all CLI commands.

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 of the YKDROP command.

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