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] SMP_DEVICE[,N]
12

DESCRIPTION

14       Sends a SAS Management Protocol (SMP) REPORT ROUTE INFORMATION function
15       to a SMP target. The SMP target is identified by the SMP_DEVICE and the
16       SAS_ADDR.  Depending on the interface, the SAS_ADDR may be deduced from
17       the SMP_DEVICE. With one interface there is one SMP_DEVICE per  machine
18       so  the  SMP_DEVICE,N syntax is needed to differentiate between HBAs if
19       there are multiple present.
20
21       Each phy in a SAS expander that has an associated routing attribute  of
22       "table"  has  a  router  table. The number of rows (or entries) in each
23       router table is given by the "expander  route  indexes"  field  in  the
24       response of the REPORT GENERAL function.
25
26       When the --multiple option is given, the REPORT ROUTE INFORMATION func‐
27       tion is called multiple times. The index value increments on each iter‐
28       ation,  starting from --index=IN (default 0). If --num=NUM is given and
29       NUM is greater than zero then that is the maximum number of  iterations
30       performed.  If  --num=NUM is not given (or NUM is zero) then iterations
31       continue until there are 4 adjacent disabled  route  entries  (or  some
32       error is detected).
33

OPTIONS

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

CONFORMING TO

89       The  SMP  REPORT  ROUTE  INFORMATION function was introduced in SAS-1 .
90       The "Expander change count" field was added in SAS-2 .
91

AUTHORS

93       Written by Douglas Gilbert.
94

REPORTING BUGS

96       Report bugs to <dgilbert at interlog dot com>.
97

COPYRIGHT

99       Copyright © 2006-2008 Douglas Gilbert
100       This software is distributed under a FreeBSD license. There is NO  war‐
101       ranty;  not  even  for MERCHANTABILITY or FITNESS FOR A PARTICULAR PUR‐
102       POSE.
103