YKBTSCAN (scans volumes)

This command performs local scans, remote scans, and NG scans.

YKBTSCAN scans the volumes in the specified range, and then creates a disk configuration definition file for the detected volumes. Use device numbers or volume serial numbers to specify the range of local scans. Use the serial number of the storage system, and the device addresses (control units and command control addresses) to specify the range of remote and NG scans. Because device numbers and subchannel set IDs cannot be obtained by remote scans or NG scans, dummy device numbers and dummy subchannel set IDs are assigned to the detected volumes.

To execute YKBTSCAN from a REXX script, assign (before you execute YKBTSCAN) the dataset of the parameter to be input from SYSIN by using the DD name SYSIN.

Request body format

{ "action":"submit",
  "cliname":"YKBTSCAN",
  "operands":"
   [STORCLAS(storage-class)]
   [△1VOLUME(volser)]
   [△1UNIT(device-type)]
   [△1SPACE(quantity,increment)]
  ",
  "CLIPARMS":[
   ["PREFIX(prefix)"]
   [,"DAD(local-DADID)"]
   [,"ROUTE(route-list-ID[,{route-label|*}])"]
   [   {,"DEVN([s]nnnn[:[s]nnnn][,[s]nnnn[:[s]nnnn]]...)[△1 SCHSET(ALL)]"
        |,"VOLSER('volser'[:'volser'][,'volser'[:'volser']]...)"                    }...]
   [ ,"RDAD(remote-DADID)"
        ,"SN(nnnnn)[△1RANGE(nnnn[:nnnn])] [△1 DUMMY([s]nnnn[,CCA])]"
        [,"SN(nnnnn)[△1RANGE(nnnn[:nnnn])] [△1 DUMMY([s]nnnn[,CCA])]"   ]... 
        [,"RENUM"]
   ]
   [,"NGDAD(Non-Gen'ed- DADID)"
     ,"SN(nnnnn)[△1RANGE(nnnn[:nnnn])][△1DUMMY([s]nnnn[,CCA])]"
          [,"SN(nnnnn)[△1RANGE(nnnn[:nnnn])][△1DUMMY([s]nnnn[,CCA])]"   ]... 
          [,"RENUM"]
  ]
}

Parameters specified in the request body

STORCLAS(storage-class)~ <storage class string>

Specify this parameter if you want to assign the disk configuration definition file to a specific storage class.

Specify this parameter if you want to assign the disk configuration definition file to a specific volume. Only one volume can be specified.

Specify this parameter if you want to assign the disk configuration definition file to a specific device type.

Specify the amount for the primary and secondary allocations in blocks when allocating the disk configuration definition file. One block is 4,096 bytes.

If you do not specify this parameter, the capacity of the disk configuration definition file is automatically calculated and allocated as the primary quantity.

PREFIX(prefix)~ <PREFIX string>

Specify the prefix in the disk configuration definition file.

Specify the current host's device address domain ID.

Specify the route list ID to be used when performing a remote scan or an NG scan.

If a route label is specified, the command device with the specified route label will be used.

If * is specified, any command device that is included in the specified route list will be used regardless of whether that command device has a route label.

If both a route label and * are omitted, command devices without a route label will be used.

You cannot omit the ROUTE parameter for remote scans. If you omit the ROUTE parameter for an NG scan, the volume detected by a local scan that is the first volume in the disk configuration definition file will be used as a command device.

Specify the device number of a volume to be local-scanned. To specify the range of a scan, insert a colon (:) between the first and the last device numbers for scanning. To specify ranges for multiple scans, separate the ranges by a comma (,).

When multiple subchannel sets are used, if you want to scan a specific subchannel set, specify a 5-digit number by adding the 1-digit subchannel set ID before the device number. To scan all subchannel sets, specify the DEVN parameter without specifying a subchannel set ID, and specify the SCHSET(ALL) parameter. If you specify the DEVN parameter without specifying the subchannel set ID, but omit the SCHSET(ALL) parameter, volumes whose subchannel set ID is 0 will be scanned.

When specifying the range to be scanned by specifying subchannel set IDs, specify the same value for both the first and last subchannel set IDs.

Specify this parameter when multiple subchannel sets are used. If you specify the SCHSET(ALL) parameter but do not specify a subchannel set ID for the DEVN parameter, the volumes in all subchannel sets will be scanned. However, if you specify a subchannel set ID, only the volumes in the specified subchannel set ID will be scanned. If you omit both the SCHSET(ALL) parameter and the subchannel set ID, the volumes whose subchannel set ID is 0 will be scanned.

Specify the volume serial number of a volume to be local-scanned. To specify the range of a scan, insert a colon (:) between the first and the last volume serial numbers for scanning. To specify ranges for multiple scans, separate the ranges by a comma (,).

Business Continuity Manager will scan online volumes corresponding to the specified volume serial numbers.

When multiple subchannel sets are used, Business Continuity Manager will scan the volumes whose device numbers are the same as those of the scanned online volumes in all subchannel sets.

Specify the device address domain ID to be used for a remote scan.

Specify the device address domain ID to be used for an NG scan.

Specify the serial number of the storage system to be remote-scanned or NG-scanned.

Specify the four-digit value that consists of the CU number (the first two digits) of the CU to which the volume to be remote-scanned or NG-scanned belongs, and that of the CCA value (the last two digits) of the volume. To specify the range of a scan, insert a colon (:) between the first and the last volume device numbers of the volumes to be scanned.

Specify the dummy device number to be assigned to the first detected volume by a remote scan or an NG scan.

The dummy device numbers to be assigned to the second detected volume and the volumes thereafter will be counted up from the specified value. The first two digits of the dummy device number are counted up for each CU, and the last two digits are counted up for each volume. If you specified CCA, the CCA value of the volume is assigned to be the last two digits of the dummy device number.

You can add a 1-digit dummy subchannel set ID before the device number. The dummy subchannel set ID of the first detected volume is assigned to the second and subsequent volumes.

If a new scan is performed but the DUMMY parameter is not specified, null will be set as the dummy device number.

For details on how to assign a dummy device number, see the Hitachi Business Continuity Manager Reference Guide.

Specify this if you want to reassign the dummy subchannel set ID and dummy device number of a volume detected by a remote scan or an NG scan.

If you specify the RENUM parameter but omit the DUMMY parameter, the specification is invalid.

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 table shown below lists the return codes to be returned when YKBTSCAN terminates.

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