1.. _ethernet_mgmt_interface:
2
3Ethernet Management
4###################
5
6.. contents::
7    :local:
8    :depth: 2
9
10Overview
11********
12
13Ethernet management API provides functions to manage the Ethernet
14network interface low level status. The caller of these functions can:
15
16* raise ``carrier ON`` or ``carrier OFF`` management events
17* raise ``VLAN enabled`` or ``VLAN disabled`` management events
18
19Typically the ``carrier OFF`` event would be generated by the Ethernet
20device driver when it notices that the Ethernet cable is disconnected.
21The ``carrier ON`` event would be generated if the Ethernet device driver
22notices that the Ethernet cable is re-connected.
23
24Currently the VLAN events are generated by the Ethernet L2 layer when a
25specific VLAN tag is either enabled or disabled.
26
27The user application can monitor these events if it needs to act
28when the corresponding status changes.
29
30API Reference
31*************
32
33.. doxygengroup:: ethernet_mgmt
34