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  Management  Protocol  (SMP)  CONFIGURE  ROUTE  INFORMATION
16       request  function  to a SMP target. The SMP target is identified by the
17       SMP_DEVICE and the  --sa=SAS_ADDR.  Depending  on  the  interface,  the
18       SAS_ADDR  may be deduced from the SMP_DEVICE.  With one interface there
19       is one SMP_DEVICE per machine so the SMP_DEVICE,N syntax is  needed  to
20       differentiate between HBAs if there are multiple present.
21
22       Each  phy in a SAS expander that has an associated routing attribute of
23       "table" has a router table. The number of rows  (or  entries)  in  each
24       router  table  is  given  by  the "expander route indexes" field in the
25       response of the REPORT GENERAL function.
26

OPTIONS

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

CONFORMING TO

92       The  SMP CONFIGURE ROUTE INFORMATION function was introduced in SAS-1 .
93       The "Expander change count" field was added in SAS-2 .
94

AUTHORS

96       Written by Douglas Gilbert.
97

REPORTING BUGS

99       Report bugs to <dgilbert at interlog dot com>.
100

COPYRIGHT

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