.TH SMP_CONF_ROUTE_INFO "8" "May 2011" "smp_utils\-0.96" SMP_UTILS
.SH NAME
smp_conf_route_info \- invoke CONFIGURE ROUTE INFORMATION SMP function
.SH SYNOPSIS
.B smp_conf_route_info
[\fI\-\-disable\fR] [\fI\-\-expected=EX\fR] [\fI\-\-help\fR] [\fI\-\-hex\fR]
[\fI\-\-index=IN\fR] [\fI\-\-interface=PARAMS\fR] [\fI\-\-phy=ID\fR]
[\fI\-\-raw\fR] [\fI\-\-routed=R_SAS_ADDR\fR] [\fI\-\-sa=SAS_ADDR\fR]
[\fI\-\-verbose\fR] [\fI\-\-version\fR] \fISMP_DEVICE[,N]\fR
.SH DESCRIPTION
.\" Add any additional description here
.PP
Sends a SAS Management Protocol (SMP) CONFIGURE ROUTE INFORMATION
function request to a SMP target. The SMP target is identified by
the \fISMP_DEVICE\fR and the \fI\-\-sa=SAS_ADDR\fR. Depending on the
interface, the \fISAS_ADDR\fR may be deduced from the \fISMP_DEVICE\fR.
The mpt interface uses \fISMP_DEVICE\fR
to identify a HBA (an SMP initiator) and needs the additional \fI,N\fR to
differentiate between HBAs if there are multiple present.
.PP
There are two expander route table types: phy-based and expander-based.
The expander-based route table was introduced in SAS\-2 and supersedes the
phy-based route tables. The CONFIGURE ROUTE INFORMATION function is
associated with a phy-based route table. The REPORT ROUTE INFORMATION
function is provided to report phy-based route table entries.
.PP
Each phy in a SAS expander that has an associated routing attribute
of "table" has a router table. The number of rows (or entries) in
each router table is given by the "expander route indexes" field
in the response of the REPORT GENERAL function.
.SH OPTIONS
Mandatory arguments to long options are mandatory for short options as well.
.TP
\fB\-d\fR, \fB\-\-disable\fR
set the "disable expander route entry" flag in a row of the router table
associated with \fI\-\-phy=ID\fR of the given SMP target (e.g. an expander).
Within the router table the row that is disabled is identified by
the expander route index given by \fI\-\-index=IN\fR.
.TP
\fB\-E\fR, \fB\-\-expected\fR=\fIEX\fR
set the 'expected expander change count' field in the SMP request.
The value \fIEX\fR is from 0 to 65535 inclusive with 0 being the default
value. When \fIEX\fR is greater than zero then if the value doesn't match
the expander change count of the SMP target (i.e. the expander) when
the request arrives then the target ignores the request and sets a
function result of "invalid expander change count" in the response.
.TP
\fB\-h\fR, \fB\-\-help\fR
output the usage message then exit.
.TP
\fB\-H\fR, \fB\-\-hex\fR
output the response (less the CRC field) in hexadecimal.
.TP
\fB\-i\fR, \fB\-\-index\fR=\fIIN\fR
expander route index. \fIIN\fR is a value between 0 and 65535. Default is 0.
More precisely the maximum index value is (expander_route_indexes \- 1).
.TP
\fB\-I\fR, \fB\-\-interface\fR=\fIPARAMS\fR
interface specific parameters. In this case "interface" refers to the
path through the operating system to the SMP initiator. See the smp_utils
man page for more information.
.TP
\fB\-p\fR, \fB\-\-phy\fR=\fIID\fR
phy identifier. \fIID\fR is a value between 0 and 254. Default is 0.
.TP
\fB\-r\fR, \fB\-\-raw\fR
send the response (less the CRC field) to stdout in binary. All error
messages are sent to stderr.
.TP
\fB\-R\fR, \fB\-\-routed\fR=\fIR_SAS_ADDR\fR
specifies the SAS address to be placed in a row (given by \fI\-\-index=IN\fR)
of the router table associated with \fI\-\-phy=ID\fR. Default value is 0.
The \fIR_SAS_ADDR\fR is in decimal but most SAS addresses are given in
hexadecimal. To give a number in hexadecimal either prefix it with '0x' or
put a trailing 'h' on it.
.TP
\fB\-s\fR, \fB\-\-sa\fR=\fISAS_ADDR\fR
specifies the SAS address of the SMP target device. Typically this is an
expander. This option may not be needed if the \fISMP_DEVICE\fR has the
target's SAS address within it. The \fISAS_ADDR\fR is in decimal but most
SAS addresses are shown in hexadecimal. To give a number in hexadecimal
either prefix it with '0x' or put a trailing 'h' on it.
.TP
\fB\-v\fR, \fB\-\-verbose\fR
increase the verbosity of the output. Can be used multiple times
.TP
\fB\-V\fR, \fB\-\-version\fR
print the version string and then exit.
.SH CONFORMING TO
The SMP CONFIGURE ROUTE INFORMATION function was introduced in SAS\-1 .
The "Expander change count" field was added in SAS\-2 .
.SH AUTHORS
Written by Douglas Gilbert.
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
Copyright \(co 2006\-2011 Douglas Gilbert
.br
This software is distributed under a FreeBSD license. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH "SEE ALSO"
.B smp_utils, smp_rep_general, smp_rep_route_info(smp_utils)