docs: better docs, mv doxygen to sphinx
[vpp.git] / docs / reference / cmdreference / interface / setinterface.rst
diff --git a/docs/reference/cmdreference/interface/setinterface.rst b/docs/reference/cmdreference/interface/setinterface.rst
deleted file mode 100644 (file)
index 6906358..0000000
+++ /dev/null
@@ -1,193 +0,0 @@
-.. _interface:\r
-\r
-.. toctree::\r
-\r
-Set Interface Commands\r
-=======================\r
-This section covers those commands that are related to setting an interface:\r
-\r
-* `Set Interface`_\r
-* `Set Interface IP Address`_\r
-* `Set Interface L2 Bridge`_\r
-* `Set Interface MTU`_\r
-* `Set Interface Promiscuous`_\r
-* `Set Interface State`_\r
-\r
-.. note:: For a complete list of CLI Debug commands refer to the Debug CLI section of the `Source Code Documents <https://docs.fd.io/vpp/18.07/clicmd.html>`_ .\r
-\r
-Set Interface\r
-++++++++++++++++\r
-\r
-Summary/Usage\r
--------------\r
-\r
-Interface commands.\r
-\r
-Declaration and Implementation\r
--------------------------------\r
-\r
-**Declaration:** vnet_cli_set_interface_command (src/vnet/interface_cli.c line 484)\r
-\r
-Set Interface IP Address\r
-+++++++++++++++++++++++++\r
-\r
-Summary/Usage\r
--------------\r
-\r
-set interface ip address [del] <*interface*> <*ip-addr*>/<*mask*> | [all]\r
-\r
-Description\r
--------------\r
-\r
-Add an IP Address to an interface or remove and IP Address from an interface. \r
-The IP Address can be an IPv4 or an IPv6 address. Interfaces may have multiple IPv4 and IPv6\r
-addresses. There is no concept of primary vs. secondary interface addresses; they're just addresses.\r
-\r
-To display the addresses associated with a given interface, use the command **show interface address** <*interface*>.\r
-\r
-.. note:: \r
-       The debug CLI does not enforce classful mask-width / addressing constraints.\r
-\r
-Example Usage\r
---------------\r
-\r
-An example of how to add an IPv4 address to an interface:\r
-\r
-.. code-block:: console\r
-\r
-       vpp# set interface ip address GigabitEthernet2/0/0 172.16.2.12/24\r
-\r
-An example of how to add an IPv6 address to an interface:\r
-\r
-.. code-block:: console\r
-\r
-       vpp# set interface ip address GigabitEthernet2/0/0 ::a:1:1:0:7/126\r
-\r
-To delete a specific interface ip address:\r
-\r
-.. code-block:: console\r
-\r
-       vpp# set interface ip address GigabitEthernet2/0/0 172.16.2.12/24 del\r
-\r
-To delete all interfaces addresses (IPv4 and IPv6):\r
-\r
-.. code-block:: console\r
-\r
-       vpp# set interface ip address GigabitEthernet2/0/0 del all\r
-\r
-Declaration and Implementation\r
--------------------------------\r
-\r
-**Declaration:** set_interface_ip_address_command (src/vnet/ip/ip46_cli.c line 216)\r
-\r
-**Implementation:** add_del_ip_address\r
-\r
-\r
-Set Interface L2 Bridge        \r
-+++++++++++++++++++++++++\r
-\r
-Summary/Usage\r
--------------\r
-\r
-set interface l2 bridge <*interface*> <*bridge-domain-id*> [bvi|uu-fwd] [shg]\r
-\r
-Description\r
--------------\r
-\r
-Use this command put an interface into Layer 2 bridge domain. If a bridge-domain with the provided\r
-bridge-domain-id does not exist, it will be created. Interfaces in a bridge-domain forward packets\r
-to other interfaces in the same bridge-domain based on destination mac address. To remove an interface\r
-from a the Layer 2 bridge domain, put the interface in a different mode, for example Layer 3 mode.\r
-\r
-Optionally, an interface can be added to a Layer 2 bridge-domain as a Bridged Virtual Interface (bvi).\r
-Only one interface in a Layer 2 bridge-domain can be a bvi.\r
-\r
-Optionally, a split-horizon group can also be specified. This defaults to 0 if not specified.\r
-\r
-Example Usage\r
---------------\r
-Example of how to configure a Layer 2 bridge-domain with three interfaces (where 200 is the bridge-domain-id):\r
-\r
-.. code-block:: console\r
-\r
-       vpp# set interface l2 bridge GigabitEthernet0/8/0.200 200\r
-\r
-This interface is added a BVI interface:\r
-\r
-.. code-block:: console\r
-\r
-       vpp# set interface l2 bridge GigabitEthernet0/9/0.200 200 bvi\r
-\r
-This interface also has a split-horizon group of 1 specified:\r
-\r
-.. code-block:: console\r
-\r
-       vpp# set interface l2 bridge GigabitEthernet0/a/0.200 200 1\r
-\r
-Example of how to remove an interface from a Layer2 bridge-domain:\r
-\r
-.. code-block:: console\r
-\r
-       vpp# set interface l3 GigabitEthernet0/a/0.200\r
-\r
-Declaration and Implementation\r
--------------------------------\r
-\r
-**Declaration:** int_l2_bridge_cli (src/vnet/l2/l2_input.c line 949)\r
-\r
-**Implementation:** int_l2_bridge\r
-\r
-Set Interface MTU\r
-++++++++++++++++++\r
-\r
-Summary/Usage\r
--------------\r
-\r
-.. code-block:: shell\r
-\r
-    set interface mtu [packet|ip4|ip6|mpls] <value> <interface>\r
-\r
-Set Interface Promiscuous\r
-++++++++++++++++++++++++++\r
-\r
-Summary/Usage\r
--------------\r
-\r
-.. code-block:: shell\r
-\r
-    set interface promiscuous [on|off] <interface>.\r
-\r
-.. _setintstate:\r
-\r
-Set Interface State\r
-++++++++++++++++++++\r
-This command is used to change the admin state (up/down) of an\r
-interface.\r
-\r
-If an interface is down, the optional *punt* flag can also be set. The\r
-*punt* flag implies the interface is disabled for forwarding but punt\r
-all traffic to slow-path. Use the *enable* flag to clear *punt* flag\r
-(interface is still down).\r
-\r
-Summary/Usage\r
--------------\r
-\r
-.. code-block:: shell\r
-\r
-    set interface state <interface> [up|down|punt|enable].\r
-\r
-Example Usage\r
-----------------\r
-\r
-Example of how to configure the admin state of an interface to **up**:\r
-\r
-.. code-block:: console\r
-\r
-    vpp# set interface state GigabitEthernet2/0/0 up\r
-\r
-Example of how to configure the admin state of an interface to **down**:\r
-\r
-.. code-block:: console\r
-\r
-    vpp# set interface state GigabitEthernet2/0/0 down\r
-\r