.. _clicmd_src_plugins_policer:

===============================================================
Policer cli reference
===============================================================

configure policer
-------------------------------------------------------------------------

.. code-block:: console

    configure policer [name <name> | index <index>] [type 1r2c | 1r3c | 2r3c-2698 | 2r3c-4115] [color-aware] [cir <cir>] [cb <cb>] [eir <eir>] [eb <eb>] [rate kbps | pps] [round closest | up | down] [conform-action drop | transmit | mark-and-transmit <dscp>] [exceed-action drop | transmit | mark-and-transmit <dscp>] [violate-action drop | transmit | mark-and-transmit <dscp>]


Declaration: ``configure_policer_command`` `src/plugins/policer/policer_cli.c line 624 <https://github.com/FDio/vpp/blob/master//src/plugins/policer/policer_cli.c#L624>`_

Implementation: ``policer_add_command_fn``


ip punt policer
-------------------------------------------------------------------------

.. code-block:: console

    ip punt policer [add|del] <index>





.. code-block:: console

    set ip punt policer <INDEX>



Declaration: ``ip4_punt_policer_command`` `src/plugins/policer/ip4_punt.c line 149 <https://github.com/FDio/vpp/blob/master//src/plugins/policer/ip4_punt.c#L149>`_

Implementation: ``ip4_punt_police_cmd``


ip6 punt policer
-------------------------------------------------------------------------

.. code-block:: console

    ip6 punt policer [add|del] <index>





.. code-block:: console

    set ip punt policer <INDEX>



Declaration: ``ip6_punt_policer_command`` `src/plugins/policer/ip6_punt.c line 137 <https://github.com/FDio/vpp/blob/master//src/plugins/policer/ip6_punt.c#L137>`_

Implementation: ``ip6_punt_police_cmd``


policer add
-------------------------------------------------------------------------

.. code-block:: console

    policer add name <name> [type 1r2c | 1r3c | 2r3c-2698 | 2r3c-4115] [color-aware] [cir <cir>] [cb <cb>] [eir <eir>] [eb <eb>] [rate kbps | pps] [round closest | up | down] [conform-action drop | transmit | mark-and-transmit <dscp>] [exceed-action drop | transmit | mark-and-transmit <dscp>] [violate-action drop | transmit | mark-and-transmit <dscp>]


Declaration: ``policer_add_command`` `src/plugins/policer/policer_cli.c line 637 <https://github.com/FDio/vpp/blob/master//src/plugins/policer/policer_cli.c#L637>`_

Implementation: ``policer_add_command_fn``


policer bind
-------------------------------------------------------------------------

.. code-block:: console

    policer bind [unbind] [name <name> | index <index>] <worker>


Declaration: ``policer_bind_command`` `src/plugins/policer/policer_cli.c line 655 <https://github.com/FDio/vpp/blob/master//src/plugins/policer/policer_cli.c#L655>`_

Implementation: ``policer_bind_command_fn``


policer del
-------------------------------------------------------------------------

.. code-block:: console

    policer del [name <name> | index <index>]


Declaration: ``policer_del_command`` `src/plugins/policer/policer_cli.c line 649 <https://github.com/FDio/vpp/blob/master//src/plugins/policer/policer_cli.c#L649>`_

Implementation: ``policer_del_command_fn``


policer input
-------------------------------------------------------------------------

.. code-block:: console

    policer input [unapply] [name <name> | index <index>] <interface>


Declaration: ``policer_input_command`` `src/plugins/policer/policer_cli.c line 661 <https://github.com/FDio/vpp/blob/master//src/plugins/policer/policer_cli.c#L661>`_

Implementation: ``policer_input_command_fn``


policer output
-------------------------------------------------------------------------

.. code-block:: console

    policer output [unapply] [name <name> | index <index>] <interface>


Declaration: ``policer_output_command`` `src/plugins/policer/policer_cli.c line 668 <https://github.com/FDio/vpp/blob/master//src/plugins/policer/policer_cli.c#L668>`_

Implementation: ``policer_input_command_fn``


show policer
-------------------------------------------------------------------------

.. code-block:: console

    show policer [name <name> | index <index>]


Declaration: ``show_policer_command`` `src/plugins/policer/policer_cli.c line 744 <https://github.com/FDio/vpp/blob/master//src/plugins/policer/policer_cli.c#L744>`_

Implementation: ``show_policer_command_fn``


show policer pools
-------------------------------------------------------------------------

.. code-block:: console

    show policer pools


Declaration: ``show_policer_pools_command`` `src/plugins/policer/policer_cli.c line 759 <https://github.com/FDio/vpp/blob/master//src/plugins/policer/policer_cli.c#L759>`_

Implementation: ``show_policer_pools_command_fn``