smp_rep_zone_perm_tbl(8)

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

NAME

6       smp_rep_zone_perm_tbl - invoke REPORT ZONE PERMISSION TABLE function
7

SYNOPSIS

9       smp_rep_zone_perm_tbl    [--append]   [--bits=COL]   [--help]   [--hex]
10       [--interface=PARAMS] [--multiple] [--nocomma]  [--num=MD]  [--permf=FN]
11       [--raw]  [--report=RT] [--sa=SAS_ADDR] [--start=SS] [--verbose] [--ver‐
12       sion] SMP_DEVICE[,N]
13

DESCRIPTION

15       Sends one or more SAS Serial Management Protocol (SMP) REPORT ZONE PER‐
16       MISSION  TABLE  function  requests  to an SMP target. The SMP target is
17       identified by the SMP_DEVICE and the --sa=SAS_ADDR.  Depending  on  the
18       interface,  the  SAS_ADDR  may  be deduced from the SMP_DEVICE. The mpt
19       interface uses SMP_DEVICE to identify a  HBA  (an  SMP  initiator)  and
20       needs the additional ,N to differentiate between HBAs if there are mul‐
21       tiple present.
22
23       This SMP function returns zone permission descriptors  which  represent
24       rows  of the zone permission table. There is a row for each source zone
25       group starting at zone group 0 and finishing at zone group 127 or  zone
26       group  255.   Due  to  the  SMP response size restriction of 1028 bytes
27       (including trailing CRC), not all the zone permission table rows can be
28       returned in one REPORT ZONE PERMISSION TABLE function response. So mul‐
29       tiple function calls may be required with the --start=SS  option  being
30       used  on  the  latter  calls  to  specify the next starting source zone
31       group.
32
33       The --multiple option will send multiple REPORT ZONE  PERMISSION  TABLE
34       requests until all source zone groups (or starting from --start=SS) are
35       output. This option is the most convenient way to output the whole zone
36       permission  table.  In  the  absence  of the --multiple option only one
37       REPORT ZONE PERMISSION TABLE request is sent.
38
39       The output of this utility is designed to be useful  as  input  to  the
40       smp_conf_zone_perm_tbl  utility.  In other words these utilities can be
41       used to save and restore zone permission table settings.
42

OPTIONS

44       Mandatory arguments to long options are mandatory for short options  as
45       well.
46
47       -a, --append
48              used  in  conjunction  with  --permf=FN  to  append  to FN if it
49              already exists. If FN does not exist then it is created.
50
51       -B, --bits=COL
52              This is an alternate zone permission table represention  showing
53              single  bits with the origin (i.e. ZP[0,0]) in the top left. The
54              output is a bit array with COL columns and up to COL rows.  This
55              output resembles the example zone permission tables shown in the
56              SAS draft documents (at t10.org).   The  default  (i.e.  without
57              this  option)  is  output  that  reflects the byte oriented, big
58              endian nature of SCSI (and hence SMP) commands. The output  pro‐
59              duced   by  this  option  is  not  suitable  as  input  for  the
60              smp_conf_zone_perm_tbl utility.
61
62       -f, --start=SS
63              starting (first and lowest numbered) source zone group (default:
64              zone group 0).
65
66       -h, --help
67              output the usage message then exit.
68
69       -H, --hex
70              output the response (less the CRC field) in hexadecimal.
71
72       -I, --interface=PARAMS
73              interface  specific  parameters. In this case "interface" refers
74              to the path through the operating system to the  SMP  initiator.
75              See the smp_utils man page for more information.
76
77       -m, --multiple
78              starting  at  source  zone group 0 (or SS), multiple REPORT ZONE
79              PERMISSION TABLE requests are issued until the last  (127th  and
80              255th)  source zone descriptor is output. This option should not
81              be given together with the --num=MD option.
82
83       -N, --nocomma
84              output each zone group descriptor as a long string of  hexadeci‐
85              mal  digits,  two digits per byte. Default action is to output a
86              comma separated list of hexadecimal ASCII bytes  for  each  zone
87              group descriptor.
88
89       -n, --num=MD
90              where  MD  is  the  maximum  number  of  descriptors that can be
91              reported in the one response. The default value is 63. 63 is the
92              maximum  number  of "128 zone groups" sized descriptors that can
93              fit in one response. If the expander is using "256 zone  groups"
94              sized  descriptors  then  a maximum of 31 descriptors can fit in
95              one response. This option should not be given together with  the
96              --multiple option.
97
98       -P, --permf=FN
99              FN  is  a  file to write the zone permission descriptors to. The
100              default action is to output the zone permissions descriptors  to
101              stdout. Note that the whole permissions table may not fit in one
102              response. If the FN exists then it is  truncated  prior  to  the
103              write unless --append is given. To append to the existing FN add
104              the --append option.
105
106       -r, --raw
107              send the response (less the CRC field) to stdout in binary.  All
108              error messages are sent to stderr.
109
110       -R, --report=RT
111              set  the  'report  type'  field  in the SMP request. RT may take
112              these values: 0 for  report  current  values  (default);  1  for
113              report  the  shadow  values;  2  for  report saved values; 3 for
114              report default values.
115
116       -s, --sa=SAS_ADDR
117              specifies the SAS address of the  SMP  target  device.  The  mpt
118              interface  needs  this  option  and  it  will  typically  be  an
119              expander's SAS address. The SAS_ADDR is in decimal but most  SAS
120              addresses  are  shown in hexadecimal.  To give a number in hexa‐
121              decimal either prefix it with '0x' or put a trailing 'h' on it.
122
123       -f, --start=SS
124              See entry above, listed in order  by  its  short  option  letter
125              (i.e.  -f).
126
127       -v, --verbose
128              increase  the  verbosity  of  the  output.  Can be used multiple
129              times.
130
131       -V, --version
132              print the version string and then exit.
133

NOTES

135       When the --permf=FN is given and SS is greater than zero then a line of
136       the  form  "--start=SS" is written to FN just prior to the first row of
137       zone permissions.
138
139       There are some examples of the --permf=FN format in the examples direc‐
140       tory.
141

CONFORMING TO

143       The SMP REPORT ZONE PERMISSION TABLE function was introduced in SAS-2 .
144

AUTHORS

146       Written by Douglas Gilbert.
147

REPORTING BUGS

149       Report bugs to <dgilbert at interlog dot com>.
150

COPYRIGHT

152       Copyright © 2011 Douglas Gilbert
153       This  software is distributed under a FreeBSD license. There is NO war‐
154       ranty; not even for MERCHANTABILITY or FITNESS FOR  A  PARTICULAR  PUR‐
155       POSE.
156