Print this page
4508 flowadm not working as documented, or documentation incorrect
4538 flowadm man page does not list lport and rport as output fields for show-flow
7210 flowadm does not have show-usage command described in the manual page
@@ -5,29 +5,22 @@
NAME
flowadm - administer bandwidth resource control and priority for
protocols, services, containers, and virtual machines
SYNOPSIS
- flowadm show-flow [-pP] [-S] [-s [-i interval]] [-l link]
- [-o field[,...]] [flow]
-
-
flowadm add-flow [-t] [-R root-dir] -l link -a attr=value[,...]
- -p prop=value[,...] flow
+ [-p prop=value[,...]] flow
flowadm remove-flow [-t] [-R root-dir] {-l link | flow}
+ flowadm show-flow [-p] [-l link] [-o field[,...]] [flow]
flowadm set-flowprop [-t] [-R root-dir] -p prop=value[,...] flow
flowadm reset-flowprop [-t] [-R root-dir] [-p prop[,...]] flow
flowadm show-flowprop [-cP] [-l link] [-o field[,...]]
[-p prop[,...]] [flow]
- flowadm show-usage [-a] [-d | {-p plotfile -F format}] [-s time]
- [-e time] -f filename [flow]
-
-
DESCRIPTION
The flowadm command is used to create, modify, remove, and show
networking bandwidth and associated resources for a type of traffic on
a particular link.
@@ -51,11 +44,11 @@
Inbound and outbound packet are matched to flows in a very fast and
scalable way, so that limits can be enforced with minimal performance
impact.
- The flowadm command can be used to identify a flow without imposing any
+ The flowadm command can be used to define a flow without imposing any
bandwidth resource control. This would result in the traffic type
getting its own resources and queues so that it is isolated from rest
of the networking traffic for more observable and deterministic
behavior.
@@ -64,166 +57,152 @@
options. Options are described in the context of each subcommand.
SUBCOMMANDS
The following subcommands are supported:
- flowadm show-flow [-pP] [-s [-i interval]] [-o field[,...]] [-l link]
- [flow]
+ flowadm add-flow [-t] [-R root-dir] -l link -a attr=value[,...] [-p
+ prop=value[,...]] flow
- Show flow configuration information (the default) or statistics,
- either for all flows, all flows on a link, or for the specified
- flow.
+ Adds a flow to the system. The flow is identified by its flow
+ attributes and properties.
- -o field[,...]
+ As part of identifying a particular flow, its bandwidth resource
+ can be limited and its relative priority to other traffic can be
+ specified. If no bandwidth limit or priority is specified, the
+ traffic still gets its unique layer 2, 3, and 4 queues and
+ processing threads, including NIC hardware resources (when
+ supported), so that the selected traffic can be separated from
+ others and can flow with minimal impact from other traffic.
- A case-insensitive, comma-separated list of output fields to
- display. The field name must be one of the fields listed below,
- or a special value all, to display all fields. For each flow
- found, the following fields can be displayed:
+ -t, --temporary
- flow
+ The changes are temporary and will not persist across reboots.
+ Persistence is the default.
- The name of the flow.
+ -R root-dir, --root-dir=root-dir
- link
+ Specifies an alternate root directory where flowadm should
+ apply persistent creation.
- The name of the link the flow is on.
+ -l link, --link=link
- ipaddr
+ Specify the link to which the flow will be added.
- IP address of the flow. This can be either local or remote
- depending on how the flow was defined.
+ -a attr=value[,...], --attr=value
- transport
+ A mandatory comma-separated list of attributes to be set to the
+ specified values.
- The name of the layer for protocol to be used.
+ -p prop=value[,...], --prop=value[,...]
- port
+ An optional comma-separated list of properties to be set to the
+ specified values. Flow properties are documented in the "Flow
+ Properties" section, below.
- Local port of service for flow.
- dsfield
+ flowadm remove-flow [-t] [-R root-dir] -l {link | flow}
- Differentiated services value for flow and mask used with
- DSFIELD value to state the bits of interest in the
- differentiated services field of the IP header.
+ Remove an existing flow identified by its link or name.
+ -t, --temporary
+ The changes are temporary and will not persist across reboots.
+ Persistence is the default.
- -p, --parsable
- Display using a stable machine-parsable format.
+ -R root-dir, --root-dir=root-dir
+ Specifies an alternate root directory where flowadm should
+ apply persistent removal.
- -P, --persistent
- Display persistent flow property information.
+ -l link | flow, --link=link | flow
+ If a link is specified, remove all flows from that link. If a
+ single flow is specified, remove only that flow.
- -S, --continuous
- Continuously display network utilization by flow in a manner
- similar to the way that prstat(1M) displays CPU utilization by
- process.
+ flowadm show-flow [-pP] [-s [-i interval]] [-o field[,...]] [-l link]
+ [flow]
- -s, --statistics
+ Show flow configuration information, either for all flows, all
+ flows on a link, or for the specified flow.
- Displays flow statistics.
+ -o field[,...]
+ A case-insensitive, comma-separated list of output fields to
+ display. The field name must be one of the fields listed below,
+ or a special value all, to display all fields. For each flow
+ found, the following fields can be displayed:
- -i interval, --interval=interval
+ flow
- Used with the -s option to specify an interval, in seconds, at
- which statistics should be displayed. If this option is not
- specified, statistics are displayed once.
+ The name of the flow.
- -l link, --link=link | flow
+ link
- Display information for all flows on the named link or
- information for the named flow.
+ The name of the link the flow is on.
+ ipaddr
- flowadm add-flow [-t] [-R root-dir] -l link -a attr=value[,...] -p
- prop=value[,...] flow
+ IP address of the flow. This can be either local or remote
+ depending on how the flow was defined.
- Adds a flow to the system. The flow is identified by its flow
- attributes and properties.
- As part of identifying a particular flow, its bandwidth resource
- can be limited and its relative priority to other traffic can be
- specified. If no bandwidth limit or priority is specified, the
- traffic still gets its unique layer 2, 3, and 4 queues and
- processing threads, including NIC hardware resources (when
- supported), so that the selected traffic can be separated from
- others and can flow with minimal impact from other traffic.
+ proto
- -t, --temporary
+ The name of the layer for protocol to be used.
- The changes are temporary and will not persist across reboots.
- Persistence is the default.
+ lport
- -R root-dir, --root-dir=root-dir
+ Local port of service for flow.
- Specifies an alternate root directory where flowadm should
- apply persistent creation.
+ rport
- -l link, --link=link
+ Remote port of service for flow.
- Specify the link to which the flow will be added.
+ dsfld
- -a attr=value[,...], --attr=value
+ Differentiated services value for flow and mask used with
+ DSFIELD value to state the bits of interest in the
+ differentiated services field of the IP header.
- A comma-separated list of attributes to be set to the specified
- values.
- -p prop=value[,...], --prop=value[,...]
+ -p, --parsable
- A comma-separated list of properties to be set to the specified
- values.
+ Display using a stable machine-parsable format.
+ -P, --persistent
- flowadm remove-flow [-t] [-R root-dir] -l {link | flow}
+ Display persistent flow property information.
- Remove an existing flow identified by its link or name.
- -t, --temporary
+ -l link, --link=link | flow
- The changes are temporary and will not persist across reboots.
- Persistence is the default.
+ Display information for all flows on the named link or
+ information for the named flow.
- -R root-dir, --root-dir=root-dir
- Specifies an alternate root directory where flowadm should
- apply persistent removal.
-
-
- -l link | flow, --link=link | flow
-
- If a link is specified, remove all flows from that link. If a
- single flow is specified, remove only that flow.
-
-
-
flowadm set-flowprop [-t] [-R root-dir] -p prop=value[,...] flow
Set values of one or more properties on the flow specified by name.
The complete list of properties can be retrieved using the show-
- flow subcommand.
+ flowprop subcommand.
-t, --temporary
The changes are temporary and will not persist across reboots.
Persistence is the default.
@@ -326,66 +305,10 @@
A comma-separated list of properties to show.
- flowadm show-usage [-a] [-d | {-p plotfile -F format}] [-s time] [-e
- time] [flow]
-
- Show the historical network flow usage from a stored extended
- accounting file. Configuration and enabling of network accounting
- through acctadm(1M) is required. The default output will be the
- summary of flow usage for the entire period of time in which
- extended accounting was enabled.
-
- -a
-
- Display all historical network usage for the specified period
- of time during which extended accounting is enabled. This
- includes the usage information for the flows that have already
- been deleted.
-
-
- -d
-
- Display the dates for which there is logging information. The
- date is in the format DD/MM/YYYY.
-
-
- -F format
-
- Specifies the format of plotfile that is specified by the -p
- option. As of this release, gnuplot is the only supported
- format.
-
-
- -p plotfile
-
- When specified with -s or -e (or both), outputs flow usage data
- to a file of the format specified by the -F option, which is
- required.
-
-
- -s time, -e time
-
- Start and stop times for data display. Time is in the format
- YYYY.MM.DD,hh:mm:ss.
-
-
- -f filename
-
- Read extended accounting records of network flow usage from
- filename.
-
-
- flow
-
- If specified, display the network flow usage only from the
- named flow. Otherwise, display network usage from all flows.
-
-
-
Flow Attributes
The flow operand that identify a flow in a flowadm command is a comma-
separated list of one or more keyword, value pairs from the list below.
local_ip[/prefix_len]
@@ -402,11 +325,11 @@
remote_ip[/prefix_len]
Identifies a network flow by the remote IP address. The syntax is
- the same as local_ip attributes
+ the same as the local_ip attribute.
transport={tcp|udp|sctp|icmp|icmpv6}
Identifies a layer 4 protocol to be used. It is typically used in
@@ -417,10 +340,15 @@
local_port
Identifies a service specified by the local port.
+ remote_port
+
+ Identifies a service specified by the remote port.
+
+
dsfield[:dsfield_mask]
Identifies the 8-bit differentiated services field (as defined in
RFC 2474).
@@ -432,23 +360,25 @@
0xff is used. Both the dsfield value and mask must be in
hexadecimal.
- The following five types of combinations of attributes are supported:
+ The following six types of combinations of attributes are supported:
local_ip[/prefixlen]=address
remote_ip[/prefixlen]=address
transport={tcp|udp|sctp|icmp|icmpv6}
transport={tcp|udp|sctp},local_port=port
+ transport={tcp|udp|sctp},remote_port=port
dsfield=val[:dsfield_mask]
- On a given link, the combinations above are mutually exclusive. An
- attempt to create flows of different combinations will fail.
+ On a given link, the types of combinations above are mutually
+ exclusive. An attempt to create flows of different types on a given
+ link will fail.
Restrictions
There are individual flow restrictions and flow restrictions per zone.
Individual Flow Restrictions
@@ -520,12 +450,12 @@
modify or delete the policy.
# flowadm add-flow -l bge0 -a transport=TCP,local_port=443 https-1
# flowadm show-flow -l bge0
- FLOW LINK IP ADDR PROTO PORT DSFLD
- https1 bge0 -- tcp 443 --
+ FLOW LINK IPADDR PROTO LPORT RPORT DSFLD
+ https1 bge0 -- tcp 443 -- --
Example 2 Modifying an Existing Policy to Add Bandwidth Resource
Control
@@ -536,17 +466,17 @@
priority.
# flowadm set-flowprop -p maxbw=500M,priority=high https-1
# flowadm show-flow https-1
- FLOW LINK IP ADDR PROTO PORT DSFLD
- https1 bge0 -- tcp 443 --
+ FLOW LINK IPADDR PROTO LPORT RPORT DSFLD
+ https-1 bge0 -- tcp 443 -- --
# flowadm show-flowprop https-1
FLOW PROPERTY VALUE DEFAULT POSSIBLE
https-1 maxbw 500 -- --
- https-1 priority HIGH -- LOW,NORMAL,HIGH
+ https-1 priority high -- low,medium,high
Example 3 Limiting the UDP Bandwidth Usage
@@ -559,35 +489,13 @@
# flowadm add-flow -l bge0 -a transport=UDP -p maxbw=100M, \
priority=low limit-udp-1
- Example 4 Showing Flow Usage
+ Example 4 Setting Policy, Making Use of dsfield Attribute
- Flow usage statistics can be stored using the extended accounting
- facility, acctadm(1M).
-
-
- # acctadm -e extended -f /var/log/net.log net
-
- # acctadm net
- Network accounting: active
- Network accounting file: /var/log/net.log
- Tracked Network resources: extended
- Untracked Network resources: none
-
-
-
-
- The historical data that was saved can be retrieved in summary form
- using the show-usage subcommand of flowadm.
-
-
- Example 5 Setting Policy, Making Use of dsfield Attribute
-
-
The following command sets a policy for EF PHB (DSCP value of 101110
from RFC 2598) with a bandwidth of 500 Mbps and a high priority. The
dsfield value for this flow will be 0x2e (101110) with the dsfield_mask
being 0xfc (because we want to ignore the 2 least significant bits).
@@ -595,59 +503,10 @@
# flowadm add-flow -l bge0 -a dsfield=0x2e:0xfc \
-p maxbw=500M,priority=high efphb-flow
-
- Display summary information:
-
-
- # flowadm show-usage -f /var/log/net.log
- FLOW DURATION IPACKETS RBYTES OPACKETS OBYTES BANDWIDTH
- flowtcp 100 1031 546908 0 0 43.76 Kbps
- flowudp 0 0 0 0 0 0.00 Mbps
-
-
-
-
- Display dates for which logging information is available:
-
-
- # flowadm show-usage -d -f /var/log/net.log
- 02/19/2008
-
-
-
-
- Display logging information for flowtcp starting at 02/19/2008,
- 10:38:46 and ending at 02/19/2008, 10:40:06:
-
-
- # flowadm show-usage -s 02/19/2008,10:39:06 -e 02/19/2008,10:40:06 \
- -f /var/log/net.log flowtcp
- FLOW TIME IPACKETS RBYTES OPACKETS OBYTES BANDWIDTH
- flowtcp 10:39:06 1 1546 4 6539 3.23 Kbps
- flowtcp 10:39:26 2 3586 5 9922 5.40 Kbps
- flowtcp 10:39:46 1 240 1 216 182.40 bps
- flowtcp 10:40:06 0 0 0 0 0.00 bps
-
-
-
-
- Output the same information as above as a plotfile:
-
-
- # flowadm show-usage -s 02/19/2008,10:39:06 -e 02/19/2008,10:40:06 \
- -p /home/plot/myplot -F gnuplot -f /var/log/net.log flowtcp
- # Time tcp-flow
- 10:39:06 3.23
- 10:39:26 5.40
- 10:39:46 0.18
- 10:40:06 0.00
-
-
-
EXIT STATUS
0
All actions were performed successfully.
@@ -668,11 +527,16 @@
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
SEE ALSO
- acctadm(1M), dladm(1M), ifconfig(1M), prstat(1M), route(1M),
- attributes(5), dlpi(7P)
+ dladm(1M), flowstat(1M), ifconfig(1M), route(1M), attributes(5)
+NOTES
+ The display of statistics by the show-flow subcommand, and the show-
+ usage subcommand, have been removed. This functionality can now be
+ accessed using the flowstat(1M) utility.
- April 9, 2016 FLOWADM(1M)
+
+
+ February 26, 2020 FLOWADM(1M)