YKDELPTH (deletes logical paths)

Applies to PTH.

This command deletes some or all of the logical paths identified in the path set specified by the PATH parameter.

Request body format

{ "action":"submit",
   "cliname":"YKDELPTH",
   "operands" : "
     [PATH(path-set-ID)]
     [△1PSN(storage-system-serial-number)[△1PCU(cu-number)]]
     [△1SSN(storage-system-serial-number)[△1SCU(cu-number)]]
     [△1PTID(path-group-ID)]
     [△1{FORWARD|REVERSE}]
     [△1FORCE]
     [△1TYPE({CU|DKC})]
}

Parameters specified in the request body

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

Specify the ID of the target path sets that are loaded. If only one path set is loaded, you can omit this parameter.

PSN(storage-system-serial-number) ~ <from 5 to 12 alphanumeric characters>

If this parameter is specified, for each logical path within the path set specified by the PATH parameter, inter-control unit logical paths will be deleted in all cases where the paths treat control units within storage systems (that have the serial number specified by this parameter) as main control units, and inter-disk controller logical paths will be deleted in all cases where the paths treat the storage system (that has the serial number specified by this parameter) as the primary storage system.

If neither this parameter nor any other parameters are specified, the command deletes all non-shared logical paths.

If this parameter is specified, out of the logical paths within the path set specified by the PATH parameter, inter-control unit logical paths will be deleted in all cases where the control unit number of the main control unit matches the value specified for this parameter. Inter-disk controller logical paths are not affected by this parameter.

If neither this parameter nor any other parameters are specified, the command deletes all non-shared inter-control unit logical paths.

If this parameter is specified, out of the logical paths within the path set specified by the PATH parameter, inter-control unit logical paths will be deleted in all cases where the paths treat control units within storage systems (that have the serial number specified by this parameter) as remote control units, and inter-disk controller logical paths will be deleted in all cases where the paths treat the storage system (that has the serial number specified by this parameter) as the secondary storage system.

If this parameter is not specified, the command deletes all logical paths with non-shared attributes unless another parameter is specified.

If this parameter is specified, out of the logical paths within the path set specified by the PATH parameter, inter-control unit logical paths will be deleted in all cases where the control unit number of the remote control unit matches the value specified for this parameter. Inter-disk controller logical paths are not affected by this parameter.

If this parameter is not specified, the command deletes all inter-control unit logical paths with non-shared attributes unless another parameter is specified.

If this parameter is specified, for each logical path within the path set specified by the PATH parameter, inter-disk controller logical paths that have the path group ID specified for this parameter are deleted.

If neither this parameter nor any other parameters are specified, the command deletes all non-shared logical paths.

Specify the direction in which the logical path is to be deleted.

If neither is specified, the command will delete a bidirectional logical path.

FORWARD

The command deletes logical paths that are identified in the path set specified by the PATH parameter, each of which is the forward logical path from the initiator node defined by path-set-ID-specified-by-PATH-parameter.PATH.n.Pri to the target node defined by path-set-ID-specified-by-PATH-parameter.PATH.n.Sec.

REVERSE

The command deletes logical paths that are identified in the path set specified by the PATH parameter. Each path is a reverse logical path from the initiator node defined by path-set-ID-specified-by-PATH-parameter.PATH.n.Sec to the target node defined by path-set-ID-specified-by-PATH-parameter.PATH.n.Pri.

If this parameter is specified, of those logical paths that are identified in the path set specified by the PATH parameter, the command also deletes the paths that have the shared attribute (those with the value Y assigned to path-set-ID-specified-by-PATH-parameter.PATH.n.Shared).

If this parameter is not specified, the command does not delete logical paths that have the shared attribute.

This parameter specifies the type (inter-control unit logical path or inter-disk controller logical path) of the logical path to be deleted.

If neither this parameter nor any other parameters are specified, the command deletes all logical paths.

CU

Out of the logical paths within the path set specified by the PATH parameter, the logical paths that have CU set for path-set-ID-specified-by-PATH-parameter.PATH.n.type are deleted.

DKC

Out of the logical paths within the path set specified by the PATH parameter, the logical paths that have DKC set for path-set-ID-specified-by-PATH-parameter.PATH.n.type are deleted.

Notes

• Before executing the command, create and load the path set definition file.

• If a message that contains sense information for the storage system is output, see the list of error codes in the Hitachi Storage Management Software for Mainframe Messages and then eliminate the cause of the error. Alternatively, in the Edit Logical Path Definition panel, specify a different, valid volume on which a device scan has been performed, in control unit, SSID, and command control address in the path set definition file for the command execution target.

• If all of the volumes in the control unit are Non Gen'ed volumes, load the route list before executing the command.

• If the storage system is directly connected to the host, the volume determined based on the following conditions is used as the I/O destination volume regardless of the specification of the YKLOAD command's VIACDEV parameter.

  • If the route list has been loaded and the command device has been defined for the target storage system, the command device is used.

  • If the route list has not been loaded, or if the route list has been loaded but the command device has not been defined for the target storage system, the volume specified in the path set definition file is used.

  • If the route list has not been loaded, or if the route list has been loaded but the command device has not been defined for the target storage system, and no volume is specified in the path set definition file, the volume specified in the disk configuration definition file is used.

Responses

See Responses returned by YKBLDPTH or YKDELPTH.

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 YKDELPTH command.

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