smp_zoned_broadcast(8)

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

NAME

6       smp_zoned_broadcast - invoke ZONED BROADCAST SMP function
7

SYNOPSIS

9       smp_zoned_broadcast    [--broadcast=BT]   [--expected=EX]   [--fszg=FS]
10       [--help]   [--hex]   [--interface=PARAMS]    [--raw]    [--sa=SAS_ADDR]
11       [--szg=ZGL] [--verbose] [--version] SMP_DEVICE[,N]
12

DESCRIPTION

14       Sends  a  SAS Serial Management Protocol (SMP) ZONED BROADCAST function
15       request to  an  SMP  target.  The  SMP  target  is  identified  by  the
16       SMP_DEVICE  and  the  --sa=SAS_ADDR.  Depending  on  the interface, the
17       SAS_ADDR may be deduced from the SMP_DEVICE.  The  mpt  interface  uses
18       SMP_DEVICE  to  identify  a  HBA (an SMP initiator) and needs the addi‐
19       tional ,N to differentiate between HBAs if there are multiple present.
20
21       This function requires zoning  to  be  enabled.  To  send  a  Broadcast
22       (Change)  in the absence of zoning, the least intrusive way seems to be
23       to use a PHY CONTROL request to send a link reset to an  expander  phy.
24       Broadcast  (Change) should cause a management application client behind
25       an SMP initiator port (e.g. a SAS HBA) to start a discover process.
26

OPTIONS

28       Mandatory arguments to long options are mandatory for short options  as
29       well.
30
31       -b, --broadcast=BT
32              BT is the broadcast type, an integer in the range 0 (default) to
33              15.  Broadcast (Change) corresponds to 0 and will cause SMP ini‐
34              tiators  that  receive  it  to  do their discover process. Other
35              known broadcast types are listed in the NOTES section. BT may be
36              decimal  (default)  or hexadecimal prefixed by '0x' (or '0X') or
37              with a 'h' (or 'H') suffix.
38
39       -E, --expected=EX
40              set the 'expected  expander  change  count'  field  in  the  SMP
41              request.  The value EX is from 0 to 65535 inclusive with 0 being
42              the default value. When EX is greater  than  zero  then  if  the
43              value  doesn't match the expander change count of the SMP target
44              (i.e. the expander) when the request  arrives  then  the  target
45              ignores  the  request  and  sets  a  function result of "invalid
46              expander change count" in the response.  In SPL-1 this field  is
47              marked as "restricted (for expected expander change count)".
48
49       -F, --fszg=FS
50              where FS is the name of a file which contains one or more source
51              zone groups to send a broadcast to. The zone groups can be given
52              in  decimal  (default) or hexadecimal prefixed by '0x' (or '0X')
53              or with a 'h' (or 'H') suffix. A zone group is a number  in  the
54              range  0 to 255. Each zone group can be separated by space, tab,
55              comma or newline. Empty lines and those starting  with  "#"  are
56              ignored.
57
58       -h, --help
59              output the usage message then exit.
60
61       -H, --hex
62              output the response (less the CRC field) in hexadecimal.
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       -r, --raw
70              send  the response (less the CRC field) to stdout in binary. All
71              error messages are sent to stderr.
72
73       -s, --sa=SAS_ADDR
74              specifies the SAS address of the  SMP  target  device.  The  mpt
75              interface  needs  this  option  and  it  will  typically  be  an
76              expander's SAS address. The SAS_ADDR is in decimal but most  SAS
77              addresses  are  shown in hexadecimal.  To give a number in hexa‐
78              decimal either prefix it with '0x' or put a trailing 'h' on it.
79
80       -S, --szg=ZGL
81              one or more source zone groups for broadcast  can  appear  as  a
82              comma  separated list ZGL. The may be decimal (default) or hexa‐
83              decimal prefixed by '0x' (or '0X') or with a 'h' (or  'H')  suf‐
84              fix. A zone group is a number in the range 0 to 255. Either this
85              option or --fszg=FS (but not both) should be given.
86
87       -v, --verbose
88              increase the verbosity of  the  output.  Can  be  used  multiple
89              times.
90
91       -V, --version
92              print the version string and then exit.
93

NOTES

95       The following is a list of broadcast types:
96       0        Broadcast (Change)
97       1        Broadcast (Reserved change 0)
98       2        Broadcast (Reserved change 1)
99       3        Broadcast (SES)
100       4        Broadcast (Expander)
101       5        Broadcast (Asynchronous event)
102       6        Broadcast (Reserved 3)
103       7        Broadcast (Reserved 4)
104       8        Broadcast (Zone activate)
105
106       The remaining zone types (9 to 15) may be issued by the ZONED BROADCAST
107       function.
108

CONFORMING TO

110       The SMP ZONED BROADCAST function was introduced in SAS-2 .
111

AUTHORS

113       Written by Douglas Gilbert.
114

REPORTING BUGS

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

COPYRIGHT

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