smp_conf_route_info(8)

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

NAME

6       smp_conf_route_info - invoke CONFIGURE ROUTE INFORMATION SMP function
7

SYNOPSIS

9       smp_conf_route_info   [--disable]   [--expected=EX]   [--help]  [--hex]
10       [--index=IN]       [--interface=PARAMS]       [--phy=ID]        [--raw]
11       [--routed=R_SAS_ADDR]     [--sa=SAS_ADDR]    [--verbose]    [--version]
12       SMP_DEVICE[,N]
13

DESCRIPTION

15       Sends a SAS Serial Management Protocol (SMP) CONFIGURE  ROUTE  INFORMA‐
16       TION function request to an SMP target. The SMP target is identified by
17       the SMP_DEVICE and the --sa=SAS_ADDR. Depending on the  interface,  the
18       SAS_ADDR  may  be  deduced from the SMP_DEVICE.  The mpt interface uses
19       SMP_DEVICE to identify a HBA (an SMP initiator)  and  needs  the  addi‐
20       tional ,N to differentiate between HBAs if there are multiple present.
21
22       There are two expander route table types: phy-based and expander-based.
23       The expander-based route table was introduced in SAS-2  and  supersedes
24       the phy-based route tables. The CONFIGURE ROUTE INFORMATION function is
25       associated with a phy-based route table. The REPORT  ROUTE  INFORMATION
26       function is provided to report phy-based route table entries.
27
28       Each  phy in a SAS expander that has an associated routing attribute of
29       "table" has a router table. The number of rows  (or  entries)  in  each
30       router  table  is  given  by  the "expander route indexes" field in the
31       response of the REPORT GENERAL function.
32

OPTIONS

34       Mandatory arguments to long options are mandatory for short options  as
35       well.
36
37       -d, --disable
38              set  the  "disable  expander  route  entry" flag in a row of the
39              router table associated with --phy=ID of the  given  SMP  target
40              (e.g.  an  expander).   Within  the router table the row that is
41              disabled is identified by the  expander  route  index  given  by
42              --index=IN.
43
44       -E, --expected=EX
45              set  the  'expected  expander  change  count'  field  in the SMP
46              request.  The value EX is from 0 to 65535 inclusive with 0 being
47              the  default  value.  When  EX  is greater than zero then if the
48              value doesn't match the expander change count of the SMP  target
49              (i.e.  the  expander)  when  the request arrives then the target
50              ignores the request and  sets  a  function  result  of  "invalid
51              expander change count" in the response.
52
53       -h, --help
54              output the usage message then exit.
55
56       -H, --hex
57              output the response (less the CRC field) in hexadecimal.
58
59       -i, --index=IN
60              expander route index. IN is a value between 0 and 65535. Default
61              is   0.    More   precisely   the   maximum   index   value   is
62              (expander_route_indexes - 1).
63
64       -I, --interface=PARAMS
65              interface  specific  parameters. In this case "interface" refers
66              to the path through the operating system to the  SMP  initiator.
67              See the smp_utils man page for more information.
68
69       -p, --phy=ID
70              phy identifier. ID is a value between 0 and 254. Default is 0.
71
72       -r, --raw
73              send  the response (less the CRC field) to stdout in binary. All
74              error messages are sent to stderr.
75
76       -R, --routed=R_SAS_ADDR
77              specifies the SAS address to  be  placed  in  a  row  (given  by
78              --index=IN)  of  the  router  table  associated  with  --phy=ID.
79              Default value is 0.  The R_SAS_ADDR is in decimal but  most  SAS
80              addresses are given in hexadecimal. To give a number in hexadec‐
81              imal either prefix it with '0x' or put a trailing 'h' on it.
82
83       -s, --sa=SAS_ADDR
84              specifies the SAS address of the SMP  target  device.  Typically
85              this  is  an  expander.  This  option  may  not be needed if the
86              SMP_DEVICE has the target's SAS address within it. The  SAS_ADDR
87              is  in  decimal but most SAS addresses are shown in hexadecimal.
88              To give a number in hexadecimal either prefix it  with  '0x'  or
89              put a trailing 'h' on it.
90
91       -v, --verbose
92              increase the verbosity of the output. Can be used multiple times
93
94       -V, --version
95              print the version string and then exit.
96

CONFORMING TO

98       The  SMP CONFIGURE ROUTE INFORMATION function was introduced in SAS-1 .
99       The "Expander change count" field was added in SAS-2 .
100

AUTHORS

102       Written by Douglas Gilbert.
103

REPORTING BUGS

105       Report bugs to <dgilbert at interlog dot com>.
106

COPYRIGHT

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