.. image:: ../_static/openl2m_logo.png

=============
OpenL2M Icons
=============

Here are the icons used in OpenL2M, and their meanings:

* :ref:`Interface`
* :ref:`Eth`
* :ref:`Tabs`
* :ref:`Menu`

.. NOTE: sphinx-rtd-theme only support "fas", no "fa-solid" as of v3.0.2 !

.. _Interface:

.. list-table:: Interface Tab Icons
   :header-rows: 1

   * - Icon
     - Meaning
   * - :fas:`lock;`
     - Interface is in 802.1x authencation mode.
   * - :fas:`triangle-exclamation;`
     - Interface is in Error-Disabled state. Sometimes this means no transceiver in SFP/QSFP/etc. slot.
   * - :fas:`download;`
     - Click to download the interface data as a spreadsheet.
   * - :fas:`cogs;`
     - A routed interface. Hover will show routed subnet information, if known.
   * - :fas:`ellipsis-v;`
     - A 802.1q Tagged or Trunked interface. Hover will show allowed vlans. If enabled, you can click to edit 802.1q tags.
   * - :fas:`plus`
     - An access mode interface where the user can edit the untagged and 802.1q-tagged vlans.
   * - :fas:`project-diagram;`
     - IGMP snooping is enabled on interface.
   * - :fas:`link;`
     - Interface is an LACP interface, or member of LACP interface. Hover will show details
   * - :fas:`smile;`
     - This is a virtual interface. Hover will show subnet information, if known.
   * - :fas:`spinner;`
     - This is a software loopback Interface. Hover will show IP address information, if known.
   * - :fas:`archway;`
     - This is a (mpls) tunnel interface.
   * - :fas:`sitemap;`
     - A multicast interface.
   * - :fas:`vihara;`
     - An unknown other interface type.
   * - :fas:`phone;`
     - Interface has a voice-vlan configured. Hover will show voice vlan.
   * - :fas:`network-wired;`
     - Interface is a member of a VRF. Hover will show vrf membership.
   * - :fas:`bolt;`
     - Interface optical transceiver information. Hover will show details (e.g. 10_GBASE_LR_SFP)


.. _Eth:

.. list-table:: Eth/Arp/LLDP Tab Icons
   :header-rows: 1

   * - Icon
     - Meaning
   * - :fas:`download;`
     - Click to download the ethernet/lldp data as a spreadsheet
   * - :fas:`chart-diagram;`
     - Click to show a graphical version of all neighbor devices
   * - :fas:`question;`
     - Device capabilities not advertized (i.e. unknown type)
   * - :fas:`wifi;`
     - This is a wifi radio or access point.
   * - :fas:`phone;`
     - This is a VOIP phone.
   * - :fas:`ethernet;`
     - This is a switch, hub or network repeater.
   * - :fas:`cogs;`
     - This is a router.
   * - :fas:`desktop;`
     - This is a desktop pc or server.

.. _Tabs:

.. list-table:: Tabs Icons
   :header-rows: 1

   * - Icon
     - Meaning
   * - :fas:`ethernet;`
     - The basic Interface menu tab.
   * - :fas:`pen;`
     - The Bulk-Edit menu tab.
   * - :fas:`edit;`
     - The Edit VLANs tab.
   * - :fas:`sitemap;`
     - The ARP/Ethernet/LLDP tab.
   * - :fas:`info;`
     - The Device Information tab.
   * - :fas:`cogs;`
     - The Run Commands tab.
   * - :fas:`wrench;`
     - The Run Command-Templates tab.
   * - :fas:`cog;`
     - The command output tab.
   * - :fas:`list-ul;`
     - The logs tab.
   * - :fas:`exclamation-triangle;`
     - The warning messages tab.

.. _Menu:

.. list-table:: Menu and General Icons
   :header-rows: 1

   * - Icon
     - Meaning
   * - :fas:`search;fa-3x;`
     - Search for a device by name or RegEx.
   * - :fas:`ethernet;fa-5x;`
     - Click to go to Home screen.
   * - :fas:`star;`
     - See what is new!
   * - :fas:`book;`
     - Go to the online documentation.
   * - :fas:`pen;`
     - Go to OpenL2M Admin pages (admins only!).
   * - :fas:`ethernet;`
     - Go to admin page for this device (admins only!).
   * - :fas:`user-friends;`
     - Go to admin page for the group (admins only!).
   * - :fas:`list-ul;`
     - Go to all activity logs.
   * - :fas:`chart-pie;`
     - Go to device and usage statistics, and currently active users.
   * - :fas:`mountain;`
     - See top-N device and user activity page.
   * - :fas:`code;`
     - Go to the OpenL2M sources on Github.
   * - :fas:`key;`
     - Change your password (if enabled.)
   * - :fas:`clone;`
     - Toggle between light- and dark-mode.
   * - :fas:`user-secret;`
     - Go to your API keys.
   * - :fas:`user-circle;`
     - See your profile.
   * - :fas:`sign-out-alt;`
     - Logout from OpenL2M.