net rate-shaping color-policer

net rate-shaping color-policerBIG-IP TMSH Mannet rate-shaping color-policer(1)



NAME
       color-policer - Configures a policer, which can be applied to other
       configuration entities to meter or rate-shape traffic using color based
       classification of packets.

MODULE
       net rate-shaping

SYNTAX
       Configure the color-policer component within the net rate-shaping
       module using the syntax in the following sections.

   CREATE
	create color-policer [name]
	modify color-policer [name]
	    options:
	      action [action]
	      app-service [[string] | none]
	      committed-burst-size [integer]
	      description [string]
	      committed-information-rate [integer]
	      excess-burst-size [integer]

   DISPLAY
	list color-policer

	  options:
	    all-properties

   DELETE
	delete color-policer [name]

DESCRIPTION
       You can use a color-policer to create a metering/policing configuration
       to be applied to other configuration entities. For instance, to limit
       or track out of profile network traffic to a vCMP guest, a color-
       policer can be added to a vcmp traffic-profile and be applied to any
       number of vcmp guest objects.

       Based on the configuration of color-policer attributes a packet may be
       counted as either green, yellow, or red. These categories can be
       tracked for accounting purposes, as well as allowing for out of profile
       (Red) traffic to be dropped as a rate-shaping or DOS protection
       technique.

EXAMPLES
       list net color-policer

       Lists the current configuration of all color-policers.

       create net color-policer fiftyMpbsLimiter action drop-red committed-
       information-rate 50mbps committed-burst-size 10mb excess-burst-size
       10mb

       Configures a policer with a committed information rate (CIR) of 50 mbps
       committed burst size (CBS) of 10 mb, and excess burst size (EBS) of 10
       mb. See individual descriptions of options bellow for more detailed
       semantics.

OPTIONS
       action
	    One of drop-red or default. Drop-red means that a packet which
	    exceeds the excess burst rate of the policer, and is marked red
	    should be dropped immediately before even attempting to enqueue
	    the packet to/from the guest. Default means that the default
	    behavior for the resulting color packets should be taken, which
	    may vary depending on additional system configuration, and load.
	    For instance, a Red colored packet may be considered lowest
	    priority with respect to QOS queues associated with the guest.
	    Thus, allowing as much traffic through as is available, but
	    increasing the drop probability for packets out of profile in the
	    case that the system is under high enough data-plane traffic load.

       app-service
	    Specifies the name of the application service to which the object
	    belongs. The default value is none. Note: If the strict-updates
	    option is enabled on the application service that owns the object,
	    you cannot modify or delete the object. Only the application
	    service can modify or delete the object.

       committed-burst-size
	    When the data rate exceeds the committed-information-rate then the
	    committed-burst-size (by default specified in bytes) is the burst
	    size below which a packet is marked green, and above which it may
	    be marked yellow, or red.

       committed-information-rate
	    The committed rate of data transfer that is to be given to a
	    metered entity that the policer is associated with. Traffic is
	    marked green as long as it stays below this rate or if bursts
	    above this rate are smaller than the committed-burst-size.

       description
	    User defined description.

       excess-burst-size
	    An additional data burst size to be used on top of the committed-
	    burst-size. A packet is marked yellow if it exceeds the committed-
	    burst-size but not the additional excess-burst-size, and red if it
	    exceeds the excess-burst-size.

SEE ALSO
       create, delete, edit, glob,   list, modify, regex, show, tmsh

COPYRIGHT
       No part of this program may be reproduced or transmitted in any form or
       by any means, electronic or mechanical, including photocopying,
       recording, or information storage and retrieval systems, for any
       purpose other than the purchaser's personal use, without the express
       written permission of F5 Networks, Inc.

       F5 Networks and BIG-IP (c) Copyright 2011-2016. All rights reserved.



BIG-IP				  2016-03-14 net rate-shaping color-policer(1)