.. _clicmd_src_plugins_npol:

===============================================================
Npol cli reference
===============================================================

npol interface clear
-------------------------------------------------------------------------

.. code-block:: console

    npol interface clear [interface | sw_if_index N]


Declaration: ``npol_interface_clear_cmd`` `src/plugins/npol/npol_interface.c line 153 <https://github.com/FDio/vpp/blob/master//src/plugins/npol/npol_interface.c#L153>`_

Implementation: ``npol_interface_clear_cmd_fn``


npol interface configure
-------------------------------------------------------------------------

.. code-block:: console

    npol interface configure [interface | sw_if_index N] rx <num_rx> tx <num_tx> rx-policy-def <rx-policy-def> tx-policy-def <tx-policy-def> rx-profile-def <rx-profile-def> tx-profile-def <tx-profile-def> [invert] <policy_id> ...


Declaration: ``npol_interface_configure_cmd`` `src/plugins/npol/npol_interface.c line 216 <https://github.com/FDio/vpp/blob/master//src/plugins/npol/npol_interface.c#L216>`_

Implementation: ``npol_interface_configure_cmd_fn``


npol ipset add
-------------------------------------------------------------------------

.. code-block:: console

    npol ipset add [prefix|proto ip port|ip]


Declaration: ``npol_ipsets_add_cmd`` `src/plugins/npol/npol_ipset.c line 173 <https://github.com/FDio/vpp/blob/master//src/plugins/npol/npol_ipset.c#L173>`_

Implementation: ``npol_ipsets_add_cmd_fn``


npol ipset add member
-------------------------------------------------------------------------

.. code-block:: console

    npol ipset add member [id] [prefix]


Declaration: ``npol_ipsets_add_member_cmd`` `src/plugins/npol/npol_ipset.c line 272 <https://github.com/FDio/vpp/blob/master//src/plugins/npol/npol_ipset.c#L272>`_

Implementation: ``npol_ipsets_add_member_cmd_fn``


npol ipset del
-------------------------------------------------------------------------

.. code-block:: console

    npol ipset del [id]


Declaration: ``npol_ipsets_del_cmd`` `src/plugins/npol/npol_ipset.c line 213 <https://github.com/FDio/vpp/blob/master//src/plugins/npol/npol_ipset.c#L213>`_

Implementation: ``npol_ipsets_del_cmd_fn``


npol ipset del member
-------------------------------------------------------------------------

.. code-block:: console

    npol ipset del member [id] [prefix]


Declaration: ``npol_ipsets_del_member_cmd`` `src/plugins/npol/npol_ipset.c line 331 <https://github.com/FDio/vpp/blob/master//src/plugins/npol/npol_ipset.c#L331>`_

Implementation: ``npol_ipsets_del_member_cmd_fn``


npol match
-------------------------------------------------------------------------

.. code-block:: console

    npol match [<interface>|sw_if_index <idx>] [ip4|ip6] [inbound|outbound] 1.1.1.1;65000->3.3.3.3;8080 tcp


Declaration: ``npol_match`` `src/plugins/npol/npol.c line 79 <https://github.com/FDio/vpp/blob/master//src/plugins/npol/npol.c#L79>`_

Implementation: ``npol_match_fn``


npol policy add
-------------------------------------------------------------------------

.. code-block:: console

    npol policy add [rx rule_id rule_id ...] [tx rule_id rule_id ...] [update [id]]


Declaration: ``npol_policies_add_cmd`` `src/plugins/npol/npol_policy.c line 143 <https://github.com/FDio/vpp/blob/master//src/plugins/npol/npol_policy.c#L143>`_

Implementation: ``npol_policies_add_cmd_fn``


npol policy del
-------------------------------------------------------------------------

.. code-block:: console

    npol policy del [id]


Declaration: ``npol_policies_del_cmd`` `src/plugins/npol/npol_policy.c line 184 <https://github.com/FDio/vpp/blob/master//src/plugins/npol/npol_policy.c#L184>`_

Implementation: ``npol_policies_del_cmd_fn``


npol rule add
-------------------------------------------------------------------------

.. code-block:: console

    npol rule add [allow|deny|log|pass][filter[==|!=]value][[src|dst][==|!=][prefix|set ID|[port-port]]]

.. code-block:: console

    Add a rule, with given filters and entries
    filters can be `icmp-type`, `icmp-code` and `proto`


Declaration: ``npol_rules_add_cmd`` `src/plugins/npol/npol_rule.c line 210 <https://github.com/FDio/vpp/blob/master//src/plugins/npol/npol_rule.c#L210>`_

Implementation: ``npol_rules_add_cmd_fn``


npol rule del
-------------------------------------------------------------------------

.. code-block:: console

    npol rule del [id]


Declaration: ``npol_rules_del_cmd`` `src/plugins/npol/npol_rule.c line 254 <https://github.com/FDio/vpp/blob/master//src/plugins/npol/npol_rule.c#L254>`_

Implementation: ``npol_rules_del_cmd_fn``


show npol ipsets
-------------------------------------------------------------------------

.. code-block:: console

    show npol ipsets


Declaration: ``npol_ipsets_show_cmd`` `src/plugins/npol/npol_ipset.c line 126 <https://github.com/FDio/vpp/blob/master//src/plugins/npol/npol_ipset.c#L126>`_

Implementation: ``npol_ipsets_show_cmd_fn``


show npol policies
-------------------------------------------------------------------------

.. code-block:: console

    show npol policies [verbose]


Declaration: ``npol_policies_show_cmd`` `src/plugins/npol/npol_policy.c line 96 <https://github.com/FDio/vpp/blob/master//src/plugins/npol/npol_policy.c#L96>`_

Implementation: ``npol_policies_show_cmd_fn``


show npol rules
-------------------------------------------------------------------------

.. code-block:: console

    show npol rules


Declaration: ``npol_rules_show_cmd`` `src/plugins/npol/npol_rule.c line 160 <https://github.com/FDio/vpp/blob/master//src/plugins/npol/npol_rule.c#L160>`_

Implementation: ``npol_rules_show_cmd_fn``