smp_conf_zone_man_pass(8)

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

NAME

6       smp_conf_zone_man_pass  -  invoke CONFIGURE ZONE MANAGER PASSWORD func‐
7       tion
8

SYNOPSIS

10       smp_conf_zone_man_pass [--expected=EX]  [--fpass=FP]  [--help]  [--hex]
11       [--interface=PARAMS]  [--new-fpass=NF]  [--new-pass=NP] [--password=PA]
12       [--raw]   [--sa=SAS_ADDR]    [--save=SAV]    [--verbose]    [--version]
13       SMP_DEVICE[,N]
14

DESCRIPTION

16       Sends  a  SAS  Serial  Management Protocol (SMP) CONFIGURE ZONE MANAGER
17       PASSWORD function request to an SMP target. The SMP target  is  identi‐
18       fied  by  the SMP_DEVICE and the --sa=SAS_ADDR. Depending on the inter‐
19       face, the SAS_ADDR may be deduced from the SMP_DEVICE. The  mpt  inter‐
20       face uses SMP_DEVICE to identify a HBA (an SMP initiator) and needs the
21       additional ,N to differentiate  between  HBAs  if  there  are  multiple
22       present.
23

OPTIONS

25       Mandatory  arguments to long options are mandatory for short options as
26       well.
27
28       -E, --expected=EX
29              set the 'expected  expander  change  count'  field  in  the  SMP
30              request.  The value EX is from 0 to 65535 inclusive with 0 being
31              the default value. When EX is greater  than  zero  then  if  the
32              value  doesn't match the expander change count of the SMP target
33              (i.e. the expander) when the request  arrives  then  the  target
34              ignores  the  request  and  sets  a  function result of "invalid
35              expander change count" in the response.
36
37       -F, --fpass=FP
38              where FP is the name of a file which contains the existing pass‐
39              word.   The  password may be in ASCII in which case it is on one
40              line surrounded by  either  single  quotes  are  double  quotes.
41              Alternatively  the  password  may be given in ASCII hexadecimal;
42              either as bytes separated by space, tab, comma or newline, or as
43              longer strings of hexadecimal bytes in which every 2 digits rep‐
44              resents a byte. Empty lines and  those  starting  with  "#"  are
45              ignored.   A  line starting with '-1' causes all remaining bytes
46              in the password to be filled with 0xff.
47
48       -h, --help
49              output the usage message then exit.
50
51       -H, --hex
52              output the response (less the CRC field) in hexadecimal.
53
54       -I, --interface=PARAMS
55              interface specific parameters. In this case  "interface"  refers
56              to  the  path through the operating system to the SMP initiator.
57              See the smp_utils man page for more information.
58
59       -N, --new-fpass=NF
60              where NF is the name of a file which contains the new  password.
61              The  format  of  this  file  is  the  same  as the file given in
62              --fpass=FP.
63
64       -n, --new-pass=NP
65              where NP is the new zone manager password which may be up to  32
66              bytes  long.  This  option  cannot  be  give  together  with the
67              --new-fpass=NF option. The default password is  32  NULLs  (zero
68              bytes)  and  PA is padded with NULLs to the right (to make it 32
69              bytes long in the request).
70
71       -P, --password=PA
72              where PA is the existing zone manager password which may  be  up
73              to  32  bytes long. This option cannot be give together with the
74              --fpass=FP option. The default password is 32 NULLs (zero bytes)
75              and  PA  is  padded with NULLs to the right (to make it 32 bytes
76              long in the request).
77
78       -r, --raw
79              send the response (less the CRC field) to stdout in binary.  All
80              error messages are sent to stderr.
81
82       -s, --sa=SAS_ADDR
83              specifies  the  SAS  address  of  the SMP target device. The mpt
84              interface  needs  this  option  and  it  will  typically  be  an
85              expander's  SAS address. The SAS_ADDR is in decimal but most SAS
86              addresses are shown in hexadecimal.  To give a number  in  hexa‐
87              decimal either prefix it with '0x' or put a trailing 'h' on it.
88
89       -S, --save=SAV
90              set the 'save' field in the SMP request. SAV may take these val‐
91              ues: 0 for updating the shadow values (default), 1 for  updating
92              the  saved values, 2 for updating shadow values and if available
93              the saved values, 3 for updating both saved and shadow values.
94
95       -v, --verbose
96              increase the verbosity of  the  output.  Can  be  used  multiple
97              times.
98
99       -V, --version
100              print the version string and then exit.
101

NOTES

103       Hexadecimal  bytes  (or  longer  hexadecimal strings) should not have a
104       leading "0x" or trailing "h" decoration.
105
106       The "well known" DISABLE password is 32 bytes of 0xff. The new password
107       can only be DISABLED if physical presence is supported and asserted.
108

CONFORMING TO

110       The  SMP  CONFIGURE  ZONE  MANAGER  PASSWORD function was introduced in
111       SAS-2 .
112

AUTHORS

114       Written by Douglas Gilbert.
115

REPORTING BUGS

117       Report bugs to <dgilbert at interlog dot com>.
118

COPYRIGHT

120       Copyright © 2011 Douglas Gilbert
121       This software is distributed under a FreeBSD license. There is NO  war‐
122       ranty;  not  even  for MERCHANTABILITY or FITNESS FOR A PARTICULAR PUR‐
123       POSE.
124