W3cubDocs

/Ansible

flowadm - Manage bandwidth resource control and priority for protocols, services and zones.

New in version 2.2.

Synopsis

Create/modify/remove networking bandwidth and associated resources for a type of traffic on a particular link.

Options

parameter required default choices comments
dsfield
 no
- Identifies the 8-bit differentiated services field (as defined in RFC 2474). The optional dsfield_mask is used to state the bits of interest in the differentiated services field when comparing with the dsfield value. Both values must be in hexadecimal.
</div></td></tr>
<tr>

<td>link<br/><div style=”font-size: small;”></div></td> <td>no</td> <td></td>

<td><ul></ul></td> <td><div>Specifiies a link to configure flow on.</div></td></tr>

<tr>

<td>local_ip<br/><div style=”font-size: small;”></div></td> <td>no</td> <td></td>

<td><ul></ul></td> <td><div>Identifies a network flow by the local IP address.</div></td></tr>

<tr>

<td>local_port<br/><div style=”font-size: small;”></div></td> <td>no</td> <td></td>

<td><ul></ul></td> <td><div>Identifies a service specified by the local port.</div></td></tr>

<tr>

<td>maxbw<br/><div style=”font-size: small;”></div></td> <td>no</td> <td></td>

<td><ul></ul></td> <td><div>- Sets the full duplex bandwidth for the flow. The bandwidth is specified as an integer with one of the scale suffixes(K, M, or G for Kbps, Mbps, and Gbps). If no units are specified, the input value will be read as Mbps.
</div></td></tr>
<tr>

<td>name<br/><div style=”font-size: small;”></div></td> <td>yes</td> <td></td>

<td><ul></ul></td> <td><div>- A flow is defined as a set of attributes based on Layer 3 and Layer 4 headers, which can be used to identify a protocol, service, or a zone.
</div></br>
<div style=”font-size: small;”>aliases: flow<div></td></tr>
<tr>

<td>priority<br/><div style=”font-size: small;”></div></td> <td>no</td> <td>medium</td>

<td><ul><li>low</li><li>medium</li><li>high</li></ul></td> <td><div>Sets the relative priority for the flow.</div></td></tr>

<tr>

<td>remove_ip<br/><div style=”font-size: small;”></div></td> <td>no</td> <td></td>

<td><ul></ul></td> <td><div>Identifies a network flow by the remote IP address.</div></td></tr>

<tr>

<td>state<br/><div style=”font-size: small;”></div></td> <td>no</td> <td>present</td>

<td><ul><li>absent</li><li>present</li><li>resetted</li></ul></td> <td><div>Create/delete/enable/disable an IP address on the network interface.</div></td></tr>

<tr>

<td>temporary<br/><div style=”font-size: small;”></div></td> <td>no</td> <td></td>

<td><ul><li>true</li><li>false</li></ul></td> <td><div>Specifies that the configured flow is temporary. Temporary flows do not persist across reboots.</div></td></tr>

<tr>

<td>transport<br/><div style=”font-size: small;”></div></td> <td>no</td> <td></td>

<td><ul></ul></td> <td><div>- Specifies a Layer 4 protocol to be used. It is typically used in combination with <em>local_port</em> to identify the service that needs special attention.
</div></td></tr>
</table>

</br>

Examples

# Limit SSH traffic to 100M via vnic0 interface
flowadm: link=vnic0 flow=ssh_out transport=tcp local_port=22 maxbw=100M state=present

# Reset flow properties
flowadm: name=dns state=resetted

# Configure policy for EF PHB (DSCP value of 101110 from RFC 2598) with a bandwidth of 500 Mbps and a high priority.
flowadm: link=bge0 dsfield=0x2e:0xfc maxbw=500M priority=high flow=efphb-flow state=present

Return Values

Common return values are documented here Common Return Values, the following are the fields unique to this module:

name description returned type sample
dsfield flow's differentiated services value if dsfield is defined string 0x2e:0xfc
temporary flow's persistence always boolean True
name flow name always string http_drop
maxbw flow's maximum bandwidth if maxbw is defined string 100M
local_Ip flow's local IP address if local_ip is defined string 10.0.0.42
local_port flow's local port if local_port is defined int 1337
priority flow's priority if priority is defined string low
state state of the target always string present
link flow's link if link is defined string vnic0
transport flow's transport if transport is defined string tcp
remote_Ip flow's remote IP address if remote_ip is defined string 10.0.0.42

This is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

Next Previous

Copyright © 2016 Red Hat, Inc.
Last updated on Oct 31, 2016.

Ansible docs are generated from GitHub sources using Sphinx using a theme provided by Read the Docs. . Module documentation is not edited directly, but is generated from the source code for the modules. To submit an update to module docs, edit the 'DOCUMENTATION' metadata in the core and extras modules source repositories.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/flowadm_module.html