1 FLOWADM(1M) Maintenance Commands FLOWADM(1M)
2
3
4
5 NAME
6 flowadm - administer bandwidth resource control and priority for
7 protocols, services, containers, and virtual machines
8
9 SYNOPSIS
10 flowadm show-flow [-pP] [-S] [-s [-i interval]] [-l link]
11 [-o field[,...]] [flow]
12
13
14 flowadm add-flow [-t] [-R root-dir] -l link -a attr=value[,...]
15 -p prop=value[,...] flow
16 flowadm remove-flow [-t] [-R root-dir] {-l link | flow}
17
18
19 flowadm set-flowprop [-t] [-R root-dir] -p prop=value[,...] flow
20 flowadm reset-flowprop [-t] [-R root-dir] [-p prop[,...]] flow
21 flowadm show-flowprop [-cP] [-l link] [-o field[,...]]
22 [-p prop[,...]] [flow]
23
24
25 flowadm show-usage [-a] [-d | {-p plotfile -F format}] [-s time]
26 [-e time] -f filename [flow]
27
28
29 DESCRIPTION
30 The flowadm command is used to create, modify, remove, and show
31 networking bandwidth and associated resources for a type of traffic on
32 a particular link.
33
34
35 The flowadm command allows users to manage networking bandwidth
36 resources for a transport, service, or a subnet. The service is
49
50
51 Inbound and outbound packet are matched to flows in a very fast and
52 scalable way, so that limits can be enforced with minimal performance
53 impact.
54
55
56 The flowadm command can be used to identify a flow without imposing any
57 bandwidth resource control. This would result in the traffic type
58 getting its own resources and queues so that it is isolated from rest
59 of the networking traffic for more observable and deterministic
60 behavior.
61
62
63 flowadm is implemented as a set of subcommands with corresponding
64 options. Options are described in the context of each subcommand.
65
66 SUB-COMMANDS
67 The following subcommands are supported:
68
69 flowadm show-flow [-pP] [-s [-i interval]] [-o field[,...]] [-l link] [flow]
70 Show flow configuration information (the default) or statistics,
71 either for all flows, all flows on a link, or for the specified
72 flow.
73
74 -o field[,...]
75 A case-insensitive, comma-separated list of output fields to
76 display. The field name must be one of the fields listed below,
77 or a special value all, to display all fields. For each flow
78 found, the following fields can be displayed:
79
80 flow
81 The name of the flow.
82
83
84 link
85 The name of the link the flow is on.
86
87
88 ipaddr
89 IP address of the flow. This can be either local or remote
117 Continuously display network utilization by flow in a manner
118 similar to the way that prstat(1M) displays CPU utilization by
119 process.
120
121
122 -s, --statistics
123 Displays flow statistics.
124
125
126 -i interval, --interval=interval
127 Used with the -s option to specify an interval, in seconds, at
128 which statistics should be displayed. If this option is not
129 specified, statistics are displayed once.
130
131
132 -l link, --link=link | flow
133 Display information for all flows on the named link or
134 information for the named flow.
135
136
137
138 flowadm add-flow [-t] [-R root-dir] -l link -a attr=value[,...] -p
139 prop=value[,...] flow
140 Adds a flow to the system. The flow is identified by its flow
141 attributes and properties.
142
143 As part of identifying a particular flow, its bandwidth resource
144 can be limited and its relative priority to other traffic can be
145 specified. If no bandwidth limit or priority is specified, the
146 traffic still gets its unique layer 2, 3, and 4 queues and
147 processing threads, including NIC hardware resources (when
148 supported), so that the selected traffic can be separated from
149 others and can flow with minimal impact from other traffic.
150
151 -t, --temporary
152 The changes are temporary and will not persist across reboots.
153 Persistence is the default.
154
155
156 -R root-dir, --root-dir=root-dir
157 Specifies an alternate root directory where flowadm should
158 apply persistent creation.
159
160
161 -l link, --link=link
162 Specify the link to which the flow will be added.
163
164
165 -a attr=value[,...], --attr=value
166 A comma-separated list of attributes to be set to the specified
167 values.
168
169
170 -p prop=value[,...], --prop=value[,...]
171 A comma-separated list of properties to be set to the specified
172 values.
173
174
175
176 flowadm remove-flow [-t] [-R root-dir] -l {link | flow}
177 Remove an existing flow identified by its link or name.
178
179 -t, --temporary
180 The changes are temporary and will not persist across reboots.
181 Persistence is the default.
182
183
184 -R root-dir, --root-dir=root-dir
185 Specifies an alternate root directory where flowadm should
186 apply persistent removal.
187
188
189 -l link | flow, --link=link | flow
190 If a link is specified, remove all flows from that link. If a
191 single flow is specified, remove only that flow.
192
193
194
195 flowadm set-flowprop [-t] [-R root-dir] -p prop=value[,...] flow
196 Set values of one or more properties on the flow specified by name.
197 The complete list of properties can be retrieved using the show-flow
198 subcommand.
199
200 -t, --temporary
201 The changes are temporary and will not persist across reboots.
202 Persistence is the default.
203
204
205 -R root-dir, --root-dir=root-dir
206 Specifies an alternate root directory where flowadm should
207 apply persistent setting of properties.
208
|
1 FLOWADM(1M) Maintenance Commands FLOWADM(1M)
2
3
4
5 NAME
6 flowadm - administer bandwidth resource control and priority for
7 protocols, services, containers, and virtual machines
8
9 SYNOPSIS
10 flowadm show-flow [-pP] [-S] [-s [-i interval]] [-l link]
11 [-o field[,...]] [-z zonename] [flow]
12
13
14 flowadm add-flow [-t] [-R root-dir] [-z zonename] -l link
15 -a attr=value[,...] -p prop=value[,...] flow
16 flowadm remove-flow [-t] [-R root-dir] [-z zonename] {-l link | flow}
17
18
19 flowadm set-flowprop [-t] [-R root-dir] -p prop=value[,...] flow
20 flowadm reset-flowprop [-t] [-R root-dir] [-p prop[,...]] flow
21 flowadm show-flowprop [-cP] [-l link] [-o field[,...]]
22 [-p prop[,...]] [flow]
23
24
25 flowadm show-usage [-a] [-d | {-p plotfile -F format}] [-s time]
26 [-e time] -f filename [flow]
27
28
29 DESCRIPTION
30 The flowadm command is used to create, modify, remove, and show
31 networking bandwidth and associated resources for a type of traffic on
32 a particular link.
33
34
35 The flowadm command allows users to manage networking bandwidth
36 resources for a transport, service, or a subnet. The service is
49
50
51 Inbound and outbound packet are matched to flows in a very fast and
52 scalable way, so that limits can be enforced with minimal performance
53 impact.
54
55
56 The flowadm command can be used to identify a flow without imposing any
57 bandwidth resource control. This would result in the traffic type
58 getting its own resources and queues so that it is isolated from rest
59 of the networking traffic for more observable and deterministic
60 behavior.
61
62
63 flowadm is implemented as a set of subcommands with corresponding
64 options. Options are described in the context of each subcommand.
65
66 SUB-COMMANDS
67 The following subcommands are supported:
68
69 flowadm show-flow [-pP] [-s [-i interval]] [-o field[,...]] [-l link] [-z
70 zonename] [flow]
71 Show flow configuration information (the default) or statistics,
72 either for all flows, all flows on a link, or for the specified
73 flow.
74
75 -o field[,...]
76 A case-insensitive, comma-separated list of output fields to
77 display. The field name must be one of the fields listed below,
78 or a special value all, to display all fields. For each flow
79 found, the following fields can be displayed:
80
81 flow
82 The name of the flow.
83
84
85 link
86 The name of the link the flow is on.
87
88
89 ipaddr
90 IP address of the flow. This can be either local or remote
118 Continuously display network utilization by flow in a manner
119 similar to the way that prstat(1M) displays CPU utilization by
120 process.
121
122
123 -s, --statistics
124 Displays flow statistics.
125
126
127 -i interval, --interval=interval
128 Used with the -s option to specify an interval, in seconds, at
129 which statistics should be displayed. If this option is not
130 specified, statistics are displayed once.
131
132
133 -l link, --link=link | flow
134 Display information for all flows on the named link or
135 information for the named flow.
136
137
138 -z zonename
139 Operate on a link that has been delegated to the specified
140 zone.
141
142
143
144 flowadm add-flow [-t] [-R root-dir] [-z zonename] -l link -a attr=value[,...]
145 -p prop=value[,...] flow
146 Adds a flow to the system. The flow is identified by its flow
147 attributes and properties.
148
149 As part of identifying a particular flow, its bandwidth resource
150 can be limited and its relative priority to other traffic can be
151 specified. If no bandwidth limit or priority is specified, the
152 traffic still gets its unique layer 2, 3, and 4 queues and
153 processing threads, including NIC hardware resources (when
154 supported), so that the selected traffic can be separated from
155 others and can flow with minimal impact from other traffic.
156
157 -t, --temporary
158 The changes are temporary and will not persist across reboots.
159 Persistence is the default.
160
161
162 -R root-dir, --root-dir=root-dir
163 Specifies an alternate root directory where flowadm should
164 apply persistent creation.
165
166
167 -z zonename
168 Operate on a link that has been delegated to the specified
169 zone.
170
171
172 -l link, --link=link
173 Specify the link to which the flow will be added.
174
175
176 -a attr=value[,...], --attr=value
177 A comma-separated list of attributes to be set to the specified
178 values.
179
180
181 -p prop=value[,...], --prop=value[,...]
182 A comma-separated list of properties to be set to the specified
183 values.
184
185
186
187 flowadm remove-flow [-t] [-R root-dir] [-z zonename] -l {link | flow}
188 Remove an existing flow identified by its link or name.
189
190 -t, --temporary
191 The changes are temporary and will not persist across reboots.
192 Persistence is the default.
193
194
195 -R root-dir, --root-dir=root-dir
196 Specifies an alternate root directory where flowadm should
197 apply persistent removal.
198
199
200 -z zonename
201 Operate on a link that has been delegated to the specified
202 zone.
203
204
205 -l link | flow, --link=link | flow
206 If a link is specified, remove all flows from that link. If a
207 single flow is specified, remove only that flow.
208
209
210
211 flowadm set-flowprop [-t] [-R root-dir] -p prop=value[,...] flow
212 Set values of one or more properties on the flow specified by name.
213 The complete list of properties can be retrieved using the show-flow
214 subcommand.
215
216 -t, --temporary
217 The changes are temporary and will not persist across reboots.
218 Persistence is the default.
219
220
221 -R root-dir, --root-dir=root-dir
222 Specifies an alternate root directory where flowadm should
223 apply persistent setting of properties.
224
|