smp_rep_route_info(8)

1SMP_REP_ROUTE_INFO(8)              SMP_UTILS             SMP_REP_ROUTE_INFO(8)
2
3
4

NAME

6       smp_rep_route_info - invoke REPORT ROUTE INFORMATION SMP function
7

SYNOPSIS

9       smp_rep_route_info  [--help]  [--hex] [--index=IN] [--interface=PARAMS]
10       [--multiple] [--num=NUM] [--phy=ID] [--raw] [--sa=SAS_ADDR] [--verbose]
11       [--version] [--zero] SMP_DEVICE[,N]
12

DESCRIPTION

14       Sends  a  SAS Serial Management Protocol (SMP) REPORT ROUTE INFORMATION
15       function request to an SMP target. The SMP target is identified by  the
16       SMP_DEVICE  and  the SAS_ADDR. Depending on the interface, the SAS_ADDR
17       may be deduced from the SMP_DEVICE. The mpt interface  uses  SMP_DEVICE
18       to  identify  a  HBA  (an SMP initiator) and needs the additional ,N to
19       differentiate between HBAs if there are multiple present.
20
21       There are two expander route table types: phy-based and expander-based.
22       The  expander-based  route table was introduced in SAS-2 and supersedes
23       the phy-based route tables. The REPORT ROUTE  INFORMATION  function  is
24       associated  with  a phy-based route table. The CONFIGURE ROUTE INFORMA‐
25       TION function is provided to manually set up a phy-based route table.
26
27       Each phy in a SAS expander that has an associated routing attribute  of
28       "table"  has  a  router  table. The number of rows (or entries) in each
29       router table is given by the "expander  route  indexes"  field  in  the
30       response of the REPORT GENERAL function.
31
32       When the --multiple option is given, the REPORT ROUTE INFORMATION func‐
33       tion is called multiple times. The index value increments on each iter‐
34       ation,  starting from --index=IN (default 0). If --num=NUM is given and
35       NUM is greater than zero then that is the maximum number of  iterations
36       performed.  If  --num=NUM is not given (or NUM is zero) then iterations
37       continue until there are 4 adjacent disabled  route  entries  (or  some
38       error is detected).
39

OPTIONS

41       Mandatory  arguments to long options are mandatory for short options as
42       well.
43
44       -h, --help
45              output the usage message then exit.
46
47       -H, --hex
48              output the response (less the CRC field) in hexadecimal.
49
50       -i, --index=IN
51              expander route index. IN is a value between 0 and 65535. Default
52              is   0.    More   precisely   the   maximum   index   value   is
53              (expander_route_indexes - 1).
54
55       -I, --interface=PARAMS
56              interface specific parameters. In this case  "interface"  refers
57              to  the  path through the operating system to the SMP initiator.
58              See the smp_utils man page for more information.
59
60       -m, --multiple
61              call the  REPORT  ROUTE  INFORMATION  function  multiple  times,
62              starting  at  --index=IN,  incrementing  the index value on each
63              iteration for  a  maximum  of  --num=NUM  iterations.  For  each
64              enabled  route  table entry, one line is output. If --num=NUM is
65              not given (or NUM is zero)  then  iterations  continue  until  4
66              adjacent disabled entries are found (or some error occurs).
67
68       -n, --num=NUM
69              used  with  --multiple  option  to specify the maximum number of
70              iterations.
71
72       -p, --phy=ID
73              phy identifier. ID is a value between 0 and 254. Default is 0.
74
75       -r, --raw
76              send the response (less the CRC field) to stdout in binary.  All
77              error messages are sent to stderr.
78
79       -s, --sa=SAS_ADDR
80              specifies  the  SAS  address of the SMP target device. Typically
81              this is an expander. This  option  may  not  be  needed  if  the
82              SMP_DEVICE  has the target's SAS address within it. The SAS_ADDR
83              is in decimal but most SAS addresses are shown  in  hexadecimal.
84              To  give  a  number in hexadecimal either prefix it with '0x' or
85              put a trailing 'h' on it.
86
87       -v, --verbose
88              increase the verbosity of  the  output.  Can  be  used  multiple
89              times.
90
91       -V, --version
92              print the version string and then exit.
93
94       -z, --zero
95              zero  the  Allocated  Response Length field in the request. This
96              option also zeros the Request Length field in the request.  This
97              is  required  for strict SAS-1.1 compliance. However this option
98              should not be given in SAS-2  and  later;  if  it  is  given  an
99              abridged response may result.
100

CONFORMING TO

102       The  SMP  REPORT  ROUTE  INFORMATION function was introduced in SAS-1 .
103       The "Expander change count" field was added in SAS-2 .
104

AUTHORS

106       Written by Douglas Gilbert.
107

REPORTING BUGS

109       Report bugs to <dgilbert at interlog dot com>.
110

COPYRIGHT

112       Copyright © 2006-2011 Douglas Gilbert
113       This software is distributed under a FreeBSD license. There is NO  war‐
114       ranty;  not  even  for MERCHANTABILITY or FITNESS FOR A PARTICULAR PUR‐
115       POSE.
116