sg_copy_results(8)

1SG_COPY_RESULTS(8)                 SG3_UTILS                SG_COPY_RESULTS(8)
2
3
4

NAME

6       sg_copy_results  -  send  SCSI  RECEIVE  COPY  RESULTS  command  (XCOPY
7       related)
8

SYNOPSIS

10       sg_copy_results [--failed|--params|--receive|--status] [--help] [--hex]
11       [--list_id=ID] [--verbose] [--version] [--xfer_len=BTL] DEVICE
12

DESCRIPTION

14       This  utility is designed to query the status of the SCSI Extended Copy
15       (XCOPY) facility (see SPC-3 revision 23 sections 6.3 and 6.17), present
16       in  some  modern storage arrays. This utility sends a SCSI RECEIVE COPY
17       RESULTS command to the given DEVICE and displays the response.
18
19       During the draft stages of SPC-4 the T10  committee  has  expanded  the
20       XCOPY command so that it now has two variants: "LID1" (for a List Iden‐
21       tifier length of 1 byte) and "LID4" (for a List Identifier length of  4
22       bytes).   This  utility  supports the older, LID1 variant which is also
23       found in SPC-3 and earlier. While the LID1 variant in SPC-4 is  command
24       level  (binary)  compatible with XCOPY as defined in SPC-3, some of the
25       command naming has changed. This utility uses the  older,  SPC-3  XCOPY
26       names.
27
28       The  command has four distinct modes of operation, distinguished by the
29       service action field:
30
31       COPY STATUS
32              Displays the current status of the EXTENDED COPY command identi‐
33              fied by the list id field.
34
35       RECEIVE DATA
36              Return  the  held data read by the EXTENDED COPY command identi‐
37              fied by the list id field. This option is only meaningful if the
38              respective segment descriptor are supported.
39
40       OPERATING PARAMETERS
41              Return  copy  manager  operating parameters. This option is also
42              useful to determine if the SCSI Extended Copy facility  is  sup‐
43              ported.
44
45       FAILED SEGMENT DETAILS
46              Return copy target device sense data and other information about
47              any failed segments.
48
49

OPTIONS

51       Arguments to long options are mandatory for short options as well.
52
53       -f, --failed
54              sets the service action field to FAILED SEGMENT DETAILS [4].
55
56       -h, --help
57              output the usage message then exit.
58
59       -H, --hex
60              prints out the response buffer in hex.
61
62       -l, --list_id=ID
63              sets the list identifier field to ID (default: 0).
64
65       -p, --params
66              sets the service action field to OPERATING PARAMETERS [3].  This
67              is the default.
68
69       -r, --receive
70              sets the service action field to RECEIVE DATA [1].
71
72       -s, --status
73              sets the service action field to COPY STATUS [0].
74
75       -v, --verbose
76              increase the level of verbosity, (i.e. debug output).
77
78       -V, --version
79              print the version string and then exit.
80
81       -x, --xfer_len=BTL
82              sets the allocation length field to BTL. It is the byte transfer
83              length and is the maximum (byte) size of the response. BTL  must
84              be less than 10000 and defaults to 520.
85

NOTES

87       Decoding of RECEIVE DATA service action is not implemented.
88

EXAMPLES

90       Query the operating parameters for a device:
91
92       # sg_copy_results -p /dev/sdo
93       Receive copy results (report operating parameters):
94           Supports no list identifier: no
95           Maximum target descriptor count: 2
96           Maximum segment descriptor count: 1
97           Maximum descriptor list length: 92 bytes
98           Maximum segment length: 33553920 bytes
99           Inline data not supported
100           Held data limit: 0 bytes
101           Maximum stream device transfer size: 0 bytes
102           Total concurrent copies: 0
103           Maximum concurrent copies: 255
104           Data segment granularity: 512 bytes
105           Inline data granularity: 1 bytes
106           Held data granularity: 1 bytes
107           Implemented descriptor list:
108               Segment descriptor 0x02: Copy from block device to block device
109               Target descriptor 0xe4: Identification descriptor
110
111

EXIT STATUS

113       The  exit  status of sg_copy_results is 0 when it is successful. Other‐
114       wise see the sg3_utils(8) man page.
115

AUTHORS

117       Written by Douglas Gilbert.
118

REPORTING BUGS

120       Report bugs to <dgilbert at interlog dot com>.
121

COPYRIGHT

123       Copyright © 2012-2013 Hannes Reinecke and Douglas Gilbert
124       This software is distributed under a FreeBSD license. There is NO  war‐
125       ranty;  not  even  for MERCHANTABILITY or FITNESS FOR A PARTICULAR PUR‐
126       POSE.
127