summaryrefslogtreecommitdiff
path: root/usr/src/man/man1m/flowadm.1m
diff options
context:
space:
mode:
Diffstat (limited to 'usr/src/man/man1m/flowadm.1m')
-rw-r--r--usr/src/man/man1m/flowadm.1m71
1 files changed, 6 insertions, 65 deletions
diff --git a/usr/src/man/man1m/flowadm.1m b/usr/src/man/man1m/flowadm.1m
index a0d2e936f6..b12ce6af96 100644
--- a/usr/src/man/man1m/flowadm.1m
+++ b/usr/src/man/man1m/flowadm.1m
@@ -3,7 +3,7 @@
.\" 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.
.\" 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.
.\" 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]
-.TH flowadm 1M "14 Feb 2009" "SunOS 5.11" "System Administration Commands"
+.TH FLOWADM 1M "Feb 14, 2009"
.SH NAME
flowadm \- administer bandwidth resource control and priority for protocols,
services, containers, and virtual machines
@@ -76,7 +76,6 @@ options. Options are described in the context of each subcommand.
The following subcommands are supported:
.sp
.ne 2
-.mk
.na
\fB\fBflowadm show-flow\fR [\fB-pP\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]]
[\fB-o\fR \fIfield\fR[,...]] [\fB-l\fR \fIlink\fR] [\fIflow\fR]\fR
@@ -87,7 +86,6 @@ Show flow configuration information (the default) or statistics, either for all
flows, all flows on a link, or for the specified \fIflow\fR.
.sp
.ne 2
-.mk
.na
\fB\fB-o\fR \fIfield\fR[,...]\fR
.ad
@@ -98,7 +96,6 @@ name must be one of the fields listed below, or a special value \fBall\fR, to
display all fields. For each flow found, the following fields can be displayed:
.sp
.ne 2
-.mk
.na
\fB\fBflow\fR\fR
.ad
@@ -109,7 +106,6 @@ The name of the flow.
.sp
.ne 2
-.mk
.na
\fB\fBlink\fR\fR
.ad
@@ -120,7 +116,6 @@ The name of the link the flow is on.
.sp
.ne 2
-.mk
.na
\fB\fBipaddr\fR\fR
.ad
@@ -132,7 +127,6 @@ flow was defined.
.sp
.ne 2
-.mk
.na
\fB\fBtransport\fR\fR
.ad
@@ -143,7 +137,6 @@ The name of the layer for protocol to be used.
.sp
.ne 2
-.mk
.na
\fB\fBport\fR\fR
.ad
@@ -154,7 +147,6 @@ Local port of service for flow.
.sp
.ne 2
-.mk
.na
\fB\fBdsfield\fR\fR
.ad
@@ -169,7 +161,6 @@ header.
.sp
.ne 2
-.mk
.na
\fB\fB-p\fR, \fB--parseable\fR\fR
.ad
@@ -180,7 +171,6 @@ Display using a stable machine-parseable format.
.sp
.ne 2
-.mk
.na
\fB\fB-P\fR, \fB--persistent\fR\fR
.ad
@@ -191,7 +181,6 @@ Display persistent flow property information.
.sp
.ne 2
-.mk
.na
\fB\fB-S\fR, \fB--continuous\fR\fR
.ad
@@ -203,7 +192,6 @@ that \fBprstat\fR(1M) displays CPU utilization by process.
.sp
.ne 2
-.mk
.na
\fB\fB-s\fR, \fB--statistics\fR\fR
.ad
@@ -214,7 +202,6 @@ Displays flow statistics.
.sp
.ne 2
-.mk
.na
\fB\fB-i\fR \fIinterval\fR, \fB--interval\fR=\fIinterval\fR\fR
.ad
@@ -227,7 +214,6 @@ displayed once.
.sp
.ne 2
-.mk
.na
\fB\fB-l\fR \fIlink\fR, \fB--link\fR=\fIlink\fR | \fIflow\fR\fR
.ad
@@ -241,7 +227,6 @@ named flow.
.sp
.ne 2
-.mk
.na
\fB\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[,...] \fB-p\fR
@@ -260,7 +245,6 @@ supported), so that the selected traffic can be separated from others and can
flow with minimal impact from other traffic.
.sp
.ne 2
-.mk
.na
\fB\fB-t\fR, \fB--temporary\fR\fR
.ad
@@ -272,7 +256,6 @@ the default.
.sp
.ne 2
-.mk
.na
\fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
.ad
@@ -284,7 +267,6 @@ persistent creation.
.sp
.ne 2
-.mk
.na
\fB\fB-l\fR \fIlink\fR, \fB--link\fR=\fIlink\fR\fR
.ad
@@ -295,7 +277,6 @@ Specify the link to which the flow will be added.
.sp
.ne 2
-.mk
.na
\fB\fB-a\fR \fIattr\fR=\fIvalue\fR[,...], \fB--attr\fR=\fIvalue\fR\fR
.ad
@@ -306,7 +287,6 @@ A comma-separated list of attributes to be set to the specified values.
.sp
.ne 2
-.mk
.na
\fB\fB-p\fR \fIprop\fR=\fIvalue\fR[,...], \fB--prop\fR=\fIvalue\fR[,...]\fR
.ad
@@ -319,7 +299,6 @@ A comma-separated list of properties to be set to the specified values.
.sp
.ne 2
-.mk
.na
\fB\fBflowadm remove-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR
{\fIlink\fR | \fIflow\fR}\fR
@@ -329,7 +308,6 @@ A comma-separated list of properties to be set to the specified values.
Remove an existing flow identified by its link or name.
.sp
.ne 2
-.mk
.na
\fB\fB-t\fR, \fB--temporary\fR\fR
.ad
@@ -341,7 +319,6 @@ the default.
.sp
.ne 2
-.mk
.na
\fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
.ad
@@ -353,7 +330,6 @@ persistent removal.
.sp
.ne 2
-.mk
.na
\fB\fB-l\fR \fIlink\fR | \fIflow\fR, \fB--link\fR=\fIlink\fR | \fIflow\fR\fR
.ad
@@ -367,7 +343,6 @@ specified, remove only that flow.
.sp
.ne 2
-.mk
.na
\fB\fBflowadm set-flowprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-p\fR
\fIprop\fR=\fIvalue\fR[,...] \fIflow\fR\fR
@@ -379,7 +354,6 @@ complete list of properties can be retrieved using the \fBshow-flow\fR
subcommand.
.sp
.ne 2
-.mk
.na
\fB\fB-t\fR, \fB--temporary\fR\fR
.ad
@@ -391,7 +365,6 @@ the default.
.sp
.ne 2
-.mk
.na
\fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
.ad
@@ -403,7 +376,6 @@ persistent setting of properties.
.sp
.ne 2
-.mk
.na
\fB\fB-p\fR \fIprop\fR=\fIvalue\fR[,...], \fB--prop\fR=\fIvalue\fR[,...]\fR
.ad
@@ -416,7 +388,6 @@ A comma-separated list of properties to be set to the specified values.
.sp
.ne 2
-.mk
.na
\fB\fBflowadm reset-flowprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-p\fR
[\fIprop\fR=\fIvalue\fR[,...]] \fIflow\fR\fR
@@ -429,7 +400,6 @@ no properties are specified, all properties are reset. See the
their default values.
.sp
.ne 2
-.mk
.na
\fB\fB-t\fR, \fB--temporary\fR\fR
.ad
@@ -441,7 +411,6 @@ reboot.
.sp
.ne 2
-.mk
.na
\fB\fB-R\fR \fIroot-dir\fR, \fB--root-dir\fR=\fIroot-dir\fR\fR
.ad
@@ -453,7 +422,6 @@ persistent setting of properties.
.sp
.ne 2
-.mk
.na
\fB\fB-p\fR \fIprop\fR=\fIvalue\fR[,...], \fB--prop\fR=\fIvalue\fR[,...]\fR
.ad
@@ -466,7 +434,6 @@ A comma-separated list of properties to be reset.
.sp
.ne 2
-.mk
.na
\fB\fBflowadm show-flowprop\fR [\fB-cP\fR] [\fB-l\fR \fIlink\fR] [\fB-p\fR
\fIprop\fR[,...]] [\fIflow\fR]\fR
@@ -481,7 +448,6 @@ available flow properties are displayed. For each property, the following
fields are displayed:
.sp
.ne 2
-.mk
.na
\fB\fBFLOW\fR\fR
.ad
@@ -492,7 +458,6 @@ The name of the flow.
.sp
.ne 2
-.mk
.na
\fB\fBPROPERTY\fR\fR
.ad
@@ -503,7 +468,6 @@ The name of the property.
.sp
.ne 2
-.mk
.na
\fB\fBVALUE\fR\fR
.ad
@@ -517,7 +481,6 @@ unknown. Persistent values that are not set or have been reset will be shown as
.sp
.ne 2
-.mk
.na
\fB\fBDEFAULT\fR\fR
.ad
@@ -529,7 +492,6 @@ The default value of the property. If the property has no default value,
.sp
.ne 2
-.mk
.na
\fB\fBPOSSIBLE\fR\fR
.ad
@@ -544,7 +506,6 @@ shown.
Flow properties are documented in the "Flow Properties" section, below.
.sp
.ne 2
-.mk
.na
\fB\fB-c\fR, \fB--parseable\fR\fR
.ad
@@ -555,7 +516,6 @@ Display using a stable machine-parseable format.
.sp
.ne 2
-.mk
.na
\fB\fB-P\fR, \fB--persistent\fR\fR
.ad
@@ -566,7 +526,6 @@ Display persistent flow property information.
.sp
.ne 2
-.mk
.na
\fB\fB-p\fR \fIprop\fR[,...], \fB--prop\fR=\fIprop\fR[,...]\fR
.ad
@@ -579,7 +538,6 @@ A comma-separated list of properties to show.
.sp
.ne 2
-.mk
.na
\fB\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] [\fB-e\fR \fItime\fR]
@@ -593,7 +551,6 @@ required. The default output will be the summary of flow usage for the entire
period of time in which extended accounting was enabled.
.sp
.ne 2
-.mk
.na
\fB\fB-a\fR\fR
.ad
@@ -606,7 +563,6 @@ the flows that have already been deleted.
.sp
.ne 2
-.mk
.na
\fB\fB-d\fR\fR
.ad
@@ -618,7 +574,6 @@ format \fIDD\fR/\fIMM\fR/\fIYYYY\fR.
.sp
.ne 2
-.mk
.na
\fB\fB-F\fR \fIformat\fR\fR
.ad
@@ -630,7 +585,6 @@ option. As of this release, \fBgnuplot\fR is the only supported format.
.sp
.ne 2
-.mk
.na
\fB\fB-p\fR \fIplotfile\fR\fR
.ad
@@ -642,7 +596,6 @@ a file of the format specified by the \fB-F\fR option, which is required.
.sp
.ne 2
-.mk
.na
\fB\fB-s\fR \fItime\fR, \fB-e\fR \fItime\fR\fR
.ad
@@ -654,7 +607,6 @@ Start and stop times for data display. Time is in the format
.sp
.ne 2
-.mk
.na
\fB\fB-f\fR \fIfilename\fR\fR
.ad
@@ -665,7 +617,6 @@ Read extended accounting records of network flow usage from \fIfilename\fR.
.sp
.ne 2
-.mk
.na
\fB\fIflow\fR\fR
.ad
@@ -684,7 +635,6 @@ The flow operand that identify a flow in a \fBflowadm\fR command is a
comma-separated list of one or more keyword, value pairs from the list below.
.sp
.ne 2
-.mk
.na
\fB\fBlocal_ip\fR[\fB/\fR\fIprefix_len\fR]\fR
.ad
@@ -703,7 +653,6 @@ address is \fB/32\fR and for IPv6 is \fB/128\fR.
.sp
.ne 2
-.mk
.na
\fB\fBremote_ip\fR[\fB/\fR\fIprefix_len\fR]\fR
.ad
@@ -715,7 +664,6 @@ Identifies a network flow by the remote IP address. The syntax is the same as
.sp
.ne 2
-.mk
.na
\fB\fBtransport\fR={\fBtcp\fR|\fBudp\fR|\fBsctp\fR|\fBicmp\fR|\fBicmpv6\fR}\fR
.ad
@@ -727,7 +675,6 @@ with local_port to identify the service that needs special attention.
.sp
.ne 2
-.mk
.na
\fB\fBlocal_port\fR\fR
.ad
@@ -738,7 +685,6 @@ Identifies a service specified by the local port.
.sp
.ne 2
-.mk
.na
\fB\fBdsfield\fR[\fB:\fR\fIdsfield_mask\fR]\fR
.ad
@@ -837,7 +783,6 @@ The following flow properties are supported. Note that the ability to set a
given property to a given value depends on the driver and hardware.
.sp
.ne 2
-.mk
.na
\fB\fBmaxbw\fR\fR
.ad
@@ -851,7 +796,6 @@ Mbps. The default is no bandwidth limit.
.sp
.ne 2
-.mk
.na
\fB\fBpriority\fR\fR
.ad
@@ -1035,7 +979,6 @@ Output the same information as above as a plotfile:
.SH EXIT STATUS
.sp
.ne 2
-.mk
.na
\fB\fB0\fR\fR
.ad
@@ -1046,7 +989,6 @@ All actions were performed successfully.
.sp
.ne 2
-.mk
.na
\fB\fB>0\fR\fR
.ad
@@ -1063,13 +1005,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
.TS
-tab() box;
-cw(2.75i) |cw(2.75i)
-lw(2.75i) |lw(2.75i)
-.
-ATTRIBUTE TYPEATTRIBUTE VALUE
+box;
+c | c
+l | l .
+ATTRIBUTE TYPE ATTRIBUTE VALUE
_
-Interface StabilityCommitted
+Interface Stability Committed
.TE
.SH SEE ALSO
generated by cgit v1.2.3 (git 2.39.1) at 2025-06-01 11:22:03 +0000