.TH SMP_ZONE_UNLOCK "8" "June 2011" "smp_utils\-0.96" SMP_UTILS
.SH NAME
smp_zone_unlock \- invoke ZONE UNLOCK SMP function
.SH SYNOPSIS
.B smp_zone_unlock
[\fI\-\-activate\fR] [\fI\-\-expected=EX\fR] [\fI\-\-help\fR]
[\fI\-\-hex\fR] [\fI\-\-interface=PARAMS\fR] [\fI\-\-raw\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 Serial Management Protocol (SMP) ZONE UNLOCK function request to
an 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
If this function is successful then a Broadcast (Change) is sent from either
each zone group whose zone permission table entries or zone phy information
has changed; or from zone group 1. Broadcast (Change) should cause a
management application client behind an SMP initiator port (e.g. a SAS HBA)
to start a discover process.
.SH OPTIONS
Mandatory arguments to long options are mandatory for short options as well.
.TP
\fB\-a\fR, \fB\-\-activate\fR
sets the ACTIVATE REQUIRED bit in the function request. When it is set the
function call will fail with a function result of NOT ACTIVATED if the
expander has not "processed the activate step".
.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\-\-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\-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\-s\fR, \fB\-\-sa\fR=\fISAS_ADDR\fR
specifies the SAS address of the SMP target device. The mpt interface needs
this option and it will typically be an expander's SAS address. 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 ZONE UNLOCK function was introduced in SAS\-2 .
.SH AUTHORS
Written by Douglas Gilbert.
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
Copyright \(co 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_zone_activate, smp_zone_lock, smp_ena_dis_zoning(smp_utils)