1 '\" te
2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH FLOWADM 1M "April 9, 2016"
7 .SH NAME
8 flowadm \- administer bandwidth resource control and priority for protocols,
9 services, containers, and virtual machines
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fBflowadm show-flow\fR [\fB-pP\fR] [\fB-S\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [\fB-l\fR \fIlink\fR]
14 [\fB-o\fR \fIfield\fR[,...]] [\fIflow\fR]
15 .fi
16
17 .LP
18 .nf
19 \fBflowadm add-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR \fIlink\fR \fB-a\fR \fIattr\fR=\fIvalue\fR[,...]
20 \fB-p\fR \fIprop\fR=\fIvalue\fR[,...] \fIflow\fR
21 \fBflowadm remove-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] {\fB-l\fR \fIlink\fR | \fIflow\fR}
22 .fi
23
24 .LP
25 .nf
26 \fBflowadm set-flowprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-p\fR \fIprop\fR=\fIvalue\fR[,...] \fIflow\fR
27 \fBflowadm reset-flowprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-p\fR \fIprop\fR[,...]] \fIflow\fR
28 \fBflowadm show-flowprop\fR [\fB-cP\fR] [\fB-l\fR \fIlink\fR] [\fB-o\fR \fIfield\fR[,...]]
29 [\fB-p\fR \fIprop\fR[,...]] [\fIflow\fR]
30 .fi
31
32 .LP
33 .nf
34 \fBflowadm show-usage\fR [\fB-a\fR] [\fB-d\fR | {\fB-p\fR \fIplotfile\fR \fB-F\fR \fIformat\fR}] [\fB-s\fR \fItime\fR]
35 [\fB-e\fR \fItime\fR] \fB-f\fR \fIfilename\fR [\fIflow\fR]
36 .fi
37
38 .SH DESCRIPTION
39 .LP
40 The \fBflowadm\fR command is used to create, modify, remove, and show
41 networking bandwidth and associated resources for a type of traffic on a
42 particular link.
43 .sp
44 .LP
45 The \fBflowadm\fR command allows users to manage networking bandwidth resources
46 for a transport, service, or a subnet. The service is specified as a
47 combination of transport and local port. The subnet is specified by its IP
48 address and subnet mask. The command can be used on any type of data link,
49 including physical links, virtual NICs, and link aggregations.
50 .sp
51 .LP
52 A flow is defined as a set of attributes based on Layer 3 and Layer 4 headers,
53 which can be used to identify a protocol, service, or a virtual machine. When a
54 flow is identified based on flow attributes, separate kernel resources
55 including layer 2, 3, and 4 queues, their processing threads, and other
56 resources are uniquely created for it, such that other traffic has minimal or
57 zero impact on it.
58 .sp
59 .LP
60 Inbound and outbound packet are matched to flows in a very fast and scalable
61 way, so that limits can be enforced with minimal performance impact.
62 .sp
63 .LP
64 The \fBflowadm\fR command can be used to identify a flow without imposing any
65 bandwidth resource control. This would result in the traffic type getting its
66 own resources and queues so that it is isolated from rest of the networking
67 traffic for more observable and deterministic behavior.
68 .sp
69 .LP
70 \fBflowadm\fR is implemented as a set of subcommands with corresponding
71 options. Options are described in the context of each subcommand.
72 .SH SUBCOMMANDS
73 .LP
74 The following subcommands are supported:
75 .sp
76 .ne 2
77 .na
78 \fB\fBflowadm show-flow\fR [\fB-pP\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]]
79 [\fB-o\fR \fIfield\fR[,...]] [\fB-l\fR \fIlink\fR] [\fIflow\fR]\fR
80 .ad
81 .sp .6
82 .RS 4n
83 Show flow configuration information (the default) or statistics, either for all
84 flows, all flows on a link, or for the specified \fIflow\fR.
85 .sp
86 .ne 2
87 .na
88 \fB\fB-o\fR \fIfield\fR[,...]\fR
89 .ad
90 .sp .6
91 .RS 4n
92 A case-insensitive, comma-separated list of output fields to display. The field
93 name must be one of the fields listed below, or a special value \fBall\fR, to
94 display all fields. For each flow found, the following fields can be displayed:
95 .sp
96 .ne 2
97 .na
98 \fB\fBflow\fR\fR
99 .ad
100 .sp .6
101 .RS 4n
102 The name of the flow.
103 .RE
104
105 .sp
106 .ne 2
107 .na
108 \fB\fBlink\fR\fR
109 .ad
110 .sp .6
111 .RS 4n
112 The name of the link the flow is on.
113 .RE
114
115 .sp
116 .ne 2
117 .na
118 \fB\fBipaddr\fR\fR
119 .ad
120 .sp .6
121 .RS 4n
122 IP address of the flow. This can be either local or remote depending on how the
123 flow was defined.
124 .RE
125
126 .sp
127 .ne 2
128 .na
129 \fB\fBtransport\fR\fR
130 .ad
131 .sp .6
132 .RS 4n
133 The name of the layer for protocol to be used.
134 .RE
135
136 .sp
137 .ne 2
138 .na
139 \fB\fBport\fR\fR
140 .ad
141 .sp .6
142 .RS 4n
143 Local port of service for flow.
144 .RE
145
146 .sp
147 .ne 2
148 .na
149 \fB\fBdsfield\fR\fR
150 .ad
151 .sp .6
152 .RS 4n
153 Differentiated services value for flow and mask used with \fBDSFIELD\fR value
154 to state the bits of interest in the differentiated services field of the IP
155 header.
156 .RE
157
158 .RE
159
160 .sp
161 .ne 2
162 .na
163 \fB\fB-p\fR, \fB--parsable\fR\fR
164 .ad
165 .sp .6
166 .RS 4n
167 Display using a stable machine-parsable format.
168 .RE
169
170 .sp
171 .ne 2
172 .na
173 \fB\fB-P\fR, \fB--persistent\fR\fR
174 .ad
175 .sp .6
176 .RS 4n
177 Display persistent flow property information.
178 .RE
179
180 .sp
181 .ne 2
182 .na
183 \fB\fB-S\fR, \fB--continuous\fR\fR
184 .ad
185 .sp .6
186 .RS 4n
187 Continuously display network utilization by flow in a manner similar to the way
188 that \fBprstat\fR(1M) displays CPU utilization by process.
189 .RE
190
191 .sp
192 .ne 2
193 .na
194 \fB\fB-s\fR, \fB--statistics\fR\fR
195 .ad
196 .sp .6
197 .RS 4n
198 Displays flow statistics.
199 .RE
200
201 .sp
202 .ne 2
203 .na
204 \fB\fB-i\fR \fIinterval\fR, \fB--interval\fR=\fIinterval\fR\fR
205 .ad
206 .sp .6
207 .RS 4n
208 Used with the \fB-s\fR option to specify an interval, in seconds, at which
209 statistics should be displayed. If this option is not specified, statistics are
210 displayed once.
211 .RE
212
213 .sp
214 .ne 2
215 .na
216 \fB\fB-l\fR \fIlink\fR, \fB--link\fR=\fIlink\fR | \fIflow\fR\fR
217 .ad
218 .sp .6
219 .RS 4n
220 Display information for all flows on the named link or information for the
221 named flow.
222 .RE
223
224 .RE
225
226 .sp
227 .ne 2
228 .na
229 \fB\fBflowadm add-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR
230 \fIlink\fR \fB-a\fR \fIattr\fR=\fIvalue\fR[,...] \fB-p\fR
231 \fIprop\fR=\fIvalue\fR[,...] \fIflow\fR\fR
232 .ad
233 .sp .6
234 .RS 4n
235 Adds a flow to the system. The flow is identified by its flow attributes and
236 properties.
237 .sp
238 As part of identifying a particular flow, its bandwidth resource can be limited
239 and its relative priority to other traffic can be specified. If no bandwidth
240 limit or priority is specified, the traffic still gets its unique layer 2, 3,
241 and 4 queues and processing threads, including NIC hardware resources (when
242 supported), so that the selected traffic can be separated from others and can
243 flow with minimal impact from other traffic.
244 .sp
245 .ne 2
246 .na
247 \fB\fB-t\fR, \fB--temporary\fR\fR
248 .ad
249 .sp .6
250 .RS 4n
251 The changes are temporary and will not persist across reboots. Persistence is
252 the default.
253 .RE
254
255 .sp
256 .ne 2
257 .na
258 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
259 .ad
260 .sp .6
261 .RS 4n
262 Specifies an alternate root directory where \fBflowadm\fR should apply
263 persistent creation.
264 .RE
265
266 .sp
267 .ne 2
268 .na
269 \fB\fB-l\fR \fIlink\fR, \fB--link\fR=\fIlink\fR\fR
270 .ad
271 .sp .6
272 .RS 4n
273 Specify the link to which the flow will be added.
274 .RE
275
276 .sp
277 .ne 2
278 .na
279 \fB\fB-a\fR \fIattr\fR=\fIvalue\fR[,...], \fB--attr\fR=\fIvalue\fR\fR
280 .ad
281 .sp .6
282 .RS 4n
283 A comma-separated list of attributes to be set to the specified values.
284 .RE
285
286 .sp
287 .ne 2
288 .na
289 \fB\fB-p\fR \fIprop\fR=\fIvalue\fR[,...], \fB--prop\fR=\fIvalue\fR[,...]\fR
290 .ad
291 .sp .6
292 .RS 4n
293 A comma-separated list of properties to be set to the specified values.
294 .RE
295
296 .RE
297
298 .sp
299 .ne 2
300 .na
301 \fB\fBflowadm remove-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR
302 {\fIlink\fR | \fIflow\fR}\fR
303 .ad
304 .sp .6
305 .RS 4n
306 Remove an existing flow identified by its link or name.
307 .sp
308 .ne 2
309 .na
310 \fB\fB-t\fR, \fB--temporary\fR\fR
311 .ad
312 .sp .6
313 .RS 4n
314 The changes are temporary and will not persist across reboots. Persistence is
315 the default.
316 .RE
317
318 .sp
319 .ne 2
320 .na
321 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
322 .ad
323 .sp .6
324 .RS 4n
325 Specifies an alternate root directory where \fBflowadm\fR should apply
326 persistent removal.
327 .RE
328
329 .sp
330 .ne 2
331 .na
332 \fB\fB-l\fR \fIlink\fR | \fIflow\fR, \fB--link\fR=\fIlink\fR | \fIflow\fR\fR
333 .ad
334 .sp .6
335 .RS 4n
336 If a link is specified, remove all flows from that link. If a single flow is
337 specified, remove only that flow.
338 .RE
339
340 .RE
341
342 .sp
343 .ne 2
344 .na
345 \fB\fBflowadm set-flowprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-p\fR
346 \fIprop\fR=\fIvalue\fR[,...] \fIflow\fR\fR
347 .ad
348 .sp .6
349 .RS 4n
350 Set values of one or more properties on the flow specified by name. The
351 complete list of properties can be retrieved using the \fBshow-flow\fR
352 subcommand.
353 .sp
354 .ne 2
355 .na
356 \fB\fB-t\fR, \fB--temporary\fR\fR
357 .ad
358 .sp .6
359 .RS 4n
360 The changes are temporary and will not persist across reboots. Persistence is
361 the default.
362 .RE
363
364 .sp
365 .ne 2
366 .na
367 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
368 .ad
369 .sp .6
370 .RS 4n
371 Specifies an alternate root directory where \fBflowadm\fR should apply
372 persistent setting of properties.
373 .RE
374
375 .sp
376 .ne 2
377 .na
378 \fB\fB-p\fR \fIprop\fR=\fIvalue\fR[,...], \fB--prop\fR=\fIvalue\fR[,...]\fR
379 .ad
380 .sp .6
381 .RS 4n
382 A comma-separated list of properties to be set to the specified values.
383 .RE
384
385 .RE
386
387 .sp
388 .ne 2
389 .na
390 \fB\fBflowadm reset-flowprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-p\fR
391 [\fIprop\fR=\fIvalue\fR[,...]] \fIflow\fR\fR
392 .ad
393 .sp .6
394 .RS 4n
395 Resets one or more properties to their default values on the specified flow. If
396 no properties are specified, all properties are reset. See the
397 \fBshow-flowprop\fR subcommand for a description of properties, which includes
398 their default values.
399 .sp
400 .ne 2
401 .na
402 \fB\fB-t\fR, \fB--temporary\fR\fR
403 .ad
404 .sp .6
405 .RS 4n
406 Specifies that the resets are temporary. Temporary resets last until the next
407 reboot.
408 .RE
409
410 .sp
411 .ne 2
412 .na
413 \fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
414 .ad
415 .sp .6
416 .RS 4n
417 Specifies an alternate root directory where \fBflowadm\fR should apply
418 persistent setting of properties.
419 .RE
420
421 .sp
422 .ne 2
423 .na
424 \fB\fB-p\fR \fIprop\fR=\fIvalue\fR[,...], \fB--prop\fR=\fIvalue\fR[,...]\fR
425 .ad
426 .sp .6
427 .RS 4n
428 A comma-separated list of properties to be reset.
429 .RE
430
431 .RE
432
433 .sp
434 .ne 2
435 .na
436 \fB\fBflowadm show-flowprop\fR [\fB-cP\fR] [\fB-l\fR \fIlink\fR] [\fB-p\fR
437 \fIprop\fR[,...]] [\fIflow\fR]\fR
438 .ad
439 .sp .6
440 .RS 4n
441 Show the current or persistent values of one or more properties, either for all
442 flows, flows on a specified link, or for the specified flow.
443 .sp
444 By default, current values are shown. If no properties are specified, all
445 available flow properties are displayed. For each property, the following
446 fields are displayed:
447 .sp
448 .ne 2
449 .na
450 \fB\fBFLOW\fR\fR
451 .ad
452 .sp .6
453 .RS 4n
454 The name of the flow.
455 .RE
456
457 .sp
458 .ne 2
459 .na
460 \fB\fBPROPERTY\fR\fR
461 .ad
462 .sp .6
463 .RS 4n
464 The name of the property.
465 .RE
466
467 .sp
468 .ne 2
469 .na
470 \fB\fBVALUE\fR\fR
471 .ad
472 .sp .6
473 .RS 4n
474 The current (or persistent) property value. The value is shown as \fB--\fR
475 (double hyphen), if it is not set, and \fB?\fR (question mark), if the value is
476 unknown. Persistent values that are not set or have been reset will be shown as
477 \fB--\fR and will use the system \fBDEFAULT\fR value (if any).
478 .RE
479
480 .sp
481 .ne 2
482 .na
483 \fB\fBDEFAULT\fR\fR
484 .ad
485 .sp .6
486 .RS 4n
487 The default value of the property. If the property has no default value,
488 \fB--\fR (double hyphen), is shown.
489 .RE
490
491 .sp
492 .ne 2
493 .na
494 \fB\fBPOSSIBLE\fR\fR
495 .ad
496 .sp .6
497 .RS 4n
498 A comma-separated list of the values the property can have. If the values span
499 a numeric range, the minimum and maximum values might be shown as shorthand. If
500 the possible values are unknown or unbounded, \fB--\fR (double hyphen), is
501 shown.
502 .RE
503
504 Flow properties are documented in the "Flow Properties" section, below.
505 .sp
506 .ne 2
507 .na
508 \fB\fB-c\fR
509 .ad
510 .sp .6
511 .RS 4n
512 Display using a stable machine-parsable format.
513 .RE
514
515 .sp
516 .ne 2
517 .na
518 \fB\fB-P\fR, \fB--persistent\fR\fR
519 .ad
520 .sp .6
521 .RS 4n
522 Display persistent flow property information.
523 .RE
524
525 .sp
526 .ne 2
527 .na
528 \fB\fB-p\fR \fIprop\fR[,...], \fB--prop\fR=\fIprop\fR[,...]\fR
529 .ad
530 .sp .6
531 .RS 4n
532 A comma-separated list of properties to show.
533 .RE
534
535 .RE
536
537 .sp
538 .ne 2
539 .na
540 \fB\fBflowadm show-usage\fR [\fB-a\fR] [\fB-d\fR | {\fB-p\fR \fIplotfile\fR
541 \fB-F\fR \fIformat\fR}] [\fB-s\fR \fItime\fR] [\fB-e\fR \fItime\fR]
542 [\fIflow\fR]\fR
543 .ad
544 .sp .6
545 .RS 4n
546 Show the historical network flow usage from a stored extended accounting file.
547 Configuration and enabling of network accounting through \fBacctadm\fR(1M) is
548 required. The default output will be the summary of flow usage for the entire
549 period of time in which extended accounting was enabled.
550 .sp
551 .ne 2
552 .na
553 \fB\fB-a\fR\fR
554 .ad
555 .sp .6
556 .RS 4n
557 Display all historical network usage for the specified period of time during
558 which extended accounting is enabled. This includes the usage information for
559 the flows that have already been deleted.
560 .RE
561
562 .sp
563 .ne 2
564 .na
565 \fB\fB-d\fR\fR
566 .ad
567 .sp .6
568 .RS 4n
569 Display the dates for which there is logging information. The date is in the
570 format \fIDD\fR/\fIMM\fR/\fIYYYY\fR.
571 .RE
572
573 .sp
574 .ne 2
575 .na
576 \fB\fB-F\fR \fIformat\fR\fR
577 .ad
578 .sp .6
579 .RS 4n
580 Specifies the format of \fIplotfile\fR that is specified by the \fB-p\fR
581 option. As of this release, \fBgnuplot\fR is the only supported format.
582 .RE
583
584 .sp
585 .ne 2
586 .na
587 \fB\fB-p\fR \fIplotfile\fR\fR
588 .ad
589 .sp .6
590 .RS 4n
591 When specified with \fB-s\fR or \fB-e\fR (or both), outputs flow usage data to
592 a file of the format specified by the \fB-F\fR option, which is required.
593 .RE
594
595 .sp
596 .ne 2
597 .na
598 \fB\fB-s\fR \fItime\fR, \fB-e\fR \fItime\fR\fR
599 .ad
600 .sp .6
601 .RS 4n
602 Start and stop times for data display. Time is in the format
603 \fIYYYY\fR.\fIMM\fR.\fIDD\fR,\fIhh\fR:\fImm\fR:\fIss\fR.
604 .RE
605
606 .sp
607 .ne 2
608 .na
609 \fB\fB-f\fR \fIfilename\fR\fR
610 .ad
611 .sp .6
612 .RS 4n
613 Read extended accounting records of network flow usage from \fIfilename\fR.
614 .RE
615
616 .sp
617 .ne 2
618 .na
619 \fB\fIflow\fR\fR
620 .ad
621 .sp .6
622 .RS 4n
623 If specified, display the network flow usage only from the named flow.
624 Otherwise, display network usage from all flows.
625 .RE
626
627 .RE
628
629 .SS "Flow Attributes"
630 .LP
631 The flow operand that identify a flow in a \fBflowadm\fR command is a
632 comma-separated list of one or more keyword, value pairs from the list below.
633 .sp
634 .ne 2
635 .na
636 \fB\fBlocal_ip\fR[\fB/\fR\fIprefix_len\fR]\fR
637 .ad
638 .sp .6
639 .RS 4n
640 Identifies a network flow by the local IP address. \fIvalue\fR must be a IPv4
641 address in dotted-decimal notation or an IPv6 address in colon-separated
642 notation. \fIprefix_len\fR is optional.
643 .sp
644 If \fIprefix_len\fR is specified, it describes the netmask for a subnet
645 address, following the same notation convention of \fBifconfig\fR(1M) and
646 \fBroute\fR(1M) addresses. If unspecified, the given IP address will be
647 considered as a host address for which the default prefix length for a IPv4
648 address is \fB/32\fR and for IPv6 is \fB/128\fR.
649 .RE
650
651 .sp
652 .ne 2
653 .na
654 \fB\fBremote_ip\fR[\fB/\fR\fIprefix_len\fR]\fR
655 .ad
656 .sp .6
657 .RS 4n
658 Identifies a network flow by the remote IP address. The syntax is the same as
659 \fBlocal_ip\fR attributes
660 .RE
661
662 .sp
663 .ne 2
664 .na
665 \fB\fBtransport\fR={\fBtcp\fR|\fBudp\fR|\fBsctp\fR|\fBicmp\fR|\fBicmpv6\fR}\fR
666 .ad
667 .sp .6
668 .RS 4n
669 Identifies a layer 4 protocol to be used. It is typically used in combination
670 with local_port to identify the service that needs special attention.
671 .RE
672
673 .sp
674 .ne 2
675 .na
676 \fB\fBlocal_port\fR\fR
677 .ad
678 .sp .6
679 .RS 4n
680 Identifies a service specified by the local port.
681 .RE
682
683 .sp
684 .ne 2
685 .na
686 \fB\fBdsfield\fR[\fB:\fR\fIdsfield_mask\fR]\fR
687 .ad
688 .sp .6
689 .RS 4n
690 Identifies the 8-bit differentiated services field (as defined in RFC 2474).
691 .sp
692 The optional \fIdsfield_mask\fR is used to state the bits of interest in the
693 differentiated services field when comparing with the \fBdsfield\fR value. A
694 \fB0\fR in a bit position indicates that the bit value needs to be ignored and
695 a \fB1\fR indicates otherwise. The mask can range from \fB0x01\fR to
696 \fB0xff\fR. If \fIdsfield_mask\fR is not specified, the default mask \fB0xff\fR
697 is used. Both the \fBdsfield\fR value and mask must be in hexadecimal.
698 .RE
699
700 .sp
701 .LP
702 The following five types of combinations of attributes are supported:
703 .sp
704 .in +2
705 .nf
706 local_ip[/\fIprefixlen\fR]=\fIaddress\fR
707 remote_ip[/\fIprefixlen\fR]=\fIaddress\fR
708 transport={tcp|udp|sctp|icmp|icmpv6}
709 transport={tcp|udp|sctp},local_port=\fIport\fR
710 dsfield=\fIval\fR[:\fIdsfield_mask\fR]
711 .fi
712 .in -2
713 .sp
714
715 .sp
716 .LP
717 On a given link, the combinations above are mutually exclusive. An attempt to
718 create flows of different combinations will fail.
719 .SS "Restrictions"
720 .LP
721 There are individual flow restrictions and flow restrictions per zone.
722 .SS "Individual Flow Restrictions"
723 .LP
724 Restrictions on individual flows do not require knowledge of other flows that
725 have been added to the link.
726 .sp
727 .LP
728 An attribute can be listed only once for each flow. For example, the following
729 command is not valid:
730 .sp
731 .in +2
732 .nf
733 # \fBflowadm add-flow -l vnic1 -a local_port=80,local_port=8080 httpflow\fR
734 .fi
735 .in -2
736 .sp
737
738 .sp
739 .LP
740 \fBtransport\fR and \fBlocal_port\fR:
741 .sp
742 .LP
743 TCP, UDP, or SCTP flows can be specified with a local port. An ICMP or ICMPv6
744 flow that specifies a port is not allowed. The following commands are valid:
745 .sp
746 .in +2
747 .nf
748 # \fBflowadm add-flow -l e1000g0 -a transport=udp udpflow\fR
749 # \fBflowadm add-flow -l e1000g0 -a transport=tcp,local_port=80 \e
750 udp80flow\fR
751 .fi
752 .in -2
753 .sp
754
755 .sp
756 .LP
757 The following commands are not valid:
758 .sp
759 .in +2
760 .nf
761 # \fBflowadm add-flow -l e1000g0 -a local_port=25 flow25\fR
762 # \fBflowadm add-flow -l e1000g0 -a transport=icmpv6,local_port=16 \e
763 flow16\fR
764 .fi
765 .in -2
766 .sp
767
768 .SS "Flow Restrictions Per Zone"
769 .LP
770 Within a zone, no two flows can have the same name. After adding a flow with
771 the link specified, the link will not be required for display, modification, or
772 deletion of the flow.
773 .SS "Flow Properties"
774 .LP
775 The following flow properties are supported. Note that the ability to set a
776 given property to a given value depends on the driver and hardware.
777 .sp
778 .ne 2
779 .na
780 \fB\fBmaxbw\fR\fR
781 .ad
782 .sp .6
783 .RS 4n
784 Sets the full duplex bandwidth for the flow. The bandwidth is specified as an
785 integer with one of the scale suffixes(\fBK\fR, \fBM\fR, or \fBG\fR for Kbps,
786 Mbps, and Gbps). If no units are specified, the input value will be read as
787 Mbps. The default is no bandwidth limit.
788 .RE
789
790 .sp
791 .ne 2
792 .na
793 \fB\fBpriority\fR\fR
794 .ad
795 .sp .6
796 .RS 4n
797 Sets the relative priority for the flow. The value can be given as one of the
798 tokens \fBhigh\fR, \fBmedium\fR, or \fBlow\fR. The default is \fBmedium\fR.
799 .RE
800
801 .SH EXAMPLES
802 .LP
803 \fBExample 1 \fRCreating a Policy Around a Mission-Critical Port
804 .sp
805 .LP
806 The command below creates a policy around inbound HTTPS traffic on an HTTPS
807 server so that HTTPS obtains dedicated NIC hardware and kernel TCP/IP
808 resources. The name specified, \fBhttps-1\fR, can be used later to modify or
809 delete the policy.
810
811 .sp
812 .in +2
813 .nf
814 # \fBflowadm add-flow -l bge0 -a transport=TCP,local_port=443 https-1\fR
815 # \fBflowadm show-flow -l bge0\fR
816 FLOW LINK IP ADDR PROTO PORT DSFLD
817 https1 bge0 -- tcp 443 --
818 .fi
819 .in -2
820 .sp
821
822 .LP
823 \fBExample 2 \fRModifying an Existing Policy to Add Bandwidth Resource Control
824 .sp
825 .LP
826 The following command modifies the \fBhttps-1\fR policy from the preceding
827 example. The command adds bandwidth control and give the policy a high
828 priority.
829
830 .sp
831 .in +2
832 .nf
833 # \fBflowadm set-flowprop -p maxbw=500M,priority=high https-1\fR
834 # \fBflowadm show-flow https-1\fR
835 FLOW LINK IP ADDR PROTO PORT DSFLD
836 https1 bge0 -- tcp 443 --
837
838 # \fBflowadm show-flowprop https-1\fR
839 FLOW PROPERTY VALUE DEFAULT POSSIBLE
840 https-1 maxbw 500 -- --
841 https-1 priority HIGH -- LOW,NORMAL,HIGH
842 .fi
843 .in -2
844 .sp
845
846 .LP
847 \fBExample 3 \fRLimiting the UDP Bandwidth Usage
848 .sp
849 .LP
850 The following command creates a policy for UDP protocol so that it cannot
851 consume more than 100Mbps of available bandwidth. The flow is named
852 \fBlimit-udp-1\fR.
853
854 .sp
855 .in +2
856 .nf
857 # \fBflowadm add-flow -l bge0 -a transport=UDP -p maxbw=100M, \e
858 priority=low limit-udp-1\fR
859 .fi
860 .in -2
861 .sp
862
863 .LP
864 \fBExample 4 \fRShowing Flow Usage
865 .sp
866 .LP
867 Flow usage statistics can be stored using the extended accounting facility,
868 \fBacctadm\fR(1M).
869
870 .sp
871 .in +2
872 .nf
873 # \fBacctadm -e extended -f /var/log/net.log net\fR
874
875 # \fBacctadm net\fR
876 Network accounting: active
877 Network accounting file: /var/log/net.log
878 Tracked Network resources: extended
879 Untracked Network resources: none
880 .fi
881 .in -2
882 .sp
883
884 .sp
885 .LP
886 The historical data that was saved can be retrieved in summary form using the
887 \fBshow-usage\fR subcommand of \fBflowadm\fR.
888
889 .LP
890 \fBExample 5 \fRSetting Policy, Making Use of \fBdsfield\fR Attribute
891 .sp
892 .LP
893 The following command sets a policy for EF PHB (DSCP value of 101110 from RFC
894 2598) with a bandwidth of 500 Mbps and a high priority. The \fBdsfield\fR value
895 for this flow will be \fB0x2e\fR (101110) with the \fBdsfield_mask\fR being
896 \fB0xfc\fR (because we want to ignore the 2 least significant bits).
897
898 .sp
899 .in +2
900 .nf
901 # \fBflowadm add-flow -l bge0 -a dsfield=0x2e:0xfc \e
902 -p maxbw=500M,priority=high efphb-flow\fR
903 .fi
904 .in -2
905 .sp
906
907 .sp
908 .LP
909 Display summary information:
910
911 .sp
912 .in +2
913 .nf
914 # \fBflowadm show-usage -f /var/log/net.log\fR
915 FLOW DURATION IPACKETS RBYTES OPACKETS OBYTES BANDWIDTH
916 flowtcp 100 1031 546908 0 0 43.76 Kbps
917 flowudp 0 0 0 0 0 0.00 Mbps
918 .fi
919 .in -2
920 .sp
921
922 .sp
923 .LP
924 Display dates for which logging information is available:
925
926 .sp
927 .in +2
928 .nf
929 # \fBflowadm show-usage -d -f /var/log/net.log\fR
930 02/19/2008
931 .fi
932 .in -2
933 .sp
934
935 .sp
936 .LP
937 Display logging information for \fBflowtcp\fR starting at 02/19/2008, 10:38:46
938 and ending at 02/19/2008, 10:40:06:
939
940 .sp
941 .in +2
942 .nf
943 # \fBflowadm show-usage -s 02/19/2008,10:39:06 -e 02/19/2008,10:40:06 \e
944 -f /var/log/net.log flowtcp\fR
945 FLOW TIME IPACKETS RBYTES OPACKETS OBYTES BANDWIDTH
946 flowtcp 10:39:06 1 1546 4 6539 3.23 Kbps
947 flowtcp 10:39:26 2 3586 5 9922 5.40 Kbps
948 flowtcp 10:39:46 1 240 1 216 182.40 bps
949 flowtcp 10:40:06 0 0 0 0 0.00 bps
950 .fi
951 .in -2
952 .sp
953
954 .sp
955 .LP
956 Output the same information as above as a plotfile:
957
958 .sp
959 .in +2
960 .nf
961 # \fBflowadm show-usage -s 02/19/2008,10:39:06 -e 02/19/2008,10:40:06 \e
962 -p /home/plot/myplot -F gnuplot -f /var/log/net.log flowtcp\fR
963 # \fBTime tcp-flow\fR
964 10:39:06 3.23
965 10:39:26 5.40
966 10:39:46 0.18
967 10:40:06 0.00
968 .fi
969 .in -2
970 .sp
971
972 .SH EXIT STATUS
973 .ne 2
974 .na
975 \fB\fB0\fR\fR
976 .ad
977 .sp .6
978 .RS 4n
979 All actions were performed successfully.
980 .RE
981
982 .sp
983 .ne 2
984 .na
985 \fB\fB>0\fR\fR
986 .ad
987 .sp .6
988 .RS 4n
989 An error occurred.
990 .RE
991
992 .SH ATTRIBUTES
993 .LP
994 See \fBattributes\fR(5) for descriptions of the following attributes:
995 .sp
996
997 .sp
998 .TS
999 box;
1000 c | c
1001 l | l .
1002 ATTRIBUTE TYPE ATTRIBUTE VALUE
1003 _
1004 Interface Stability Committed
1005 .TE
1006
1007 .SH SEE ALSO
1008 .LP
1009 \fBacctadm\fR(1M), \fBdladm\fR(1M), \fBifconfig\fR(1M), \fBprstat\fR(1M),
1010 \fBroute\fR(1M), \fBattributes\fR(5), \fBdlpi\fR(7P)