Tagging Nodes
=============

Understanding Tags
------------------

A **Tag** is a custom description that is applied to a Node (MAC + IP) or
Device (MAC)to help manage them. One or more identifying **Tags** can be
applied to a node or device. **Tags** may also be applied automatically
through the log function, or used as a grouping condition.

**Node Tags** apply to a MAC+IP address pair. They are suitable for tracking
or applying policy to a specific MAC address and a single IP address that it
uses. Because a **node tag** applies to a MAC+IP address pair, a tag will not
follow a device when it changes IP addresses, due to a change in static IP,
DHCP assigned IP, or a network segment change. The changed IP address and the
MAC address are considered to be a separate node.

In contrast, **MAC Tags** will apply to all nodes with the specific MAC
address. This makes MAC tags ideal for tracking and controlling devices which
may regularly change IP addresses, such as DHCP devices, or mobile devices that
regularly change networks.

Create Tag
----------

#. Go to **Preferences** in the top panel
#. Go to **Properties > Tag**
#. Click **Tasks > Create**
#. For **Name**, type unique name
#. For **Description**, describe what this Tag is for
#. For **Color**, click choose desired color and click **OK**
#. For **Schedule**, this is optional for Lifetime and Expiration
#. If you assign this tag to a separate administrator, check the administrator role entry and select Administrator.
#. Click **Save**

Tag for Individual Node
------------------------

#. Go to **Management > Node** in the top panel
#. Find and click on desired **IP address** of **Node**
#. Move to bottom tag of panel
#. Enter the category, name, assignment, description, and so on and click the ``ADD`` button.
#. Click **Update** Top button


Tag for Multiple Nodes
----------------------

#. Go to **Management > Node** in the top panel
#. Find and click **Checkbox** of desired Nodes
#. Click **Tasks > Node and Device > Edit Node Tags**
#. Select **Assign Selected Tags** from the drop-down in the upper left corner
   of the **Edit Tag Settings** panel
#. Find and click **Checkbox** of desired **Tag** (*You can choose more then
   one*)
#. Click **Save**

.. note:: In this panel you can select options from the drop-down to edit
   current Tag Settings.

Tag for MAC
-----------

#. Go to **Management > Node** in the top panel
#. Click **IP address** of the desired MAC Address
#. Move to bottom tag of panel
#. Enter the category, name, assignment, description, and so on and click the ``ADD`` button.
#. Click **Update** Top button

.. note:: When assigning a tag to a specific MAC address, all nodes with that
   MAC address will automatically be tagged as well.

Untag for individual Node
-------------------------

#. Go to **Management > Node** in the top panel
#. Find and click on desired **IP address** of **Node**
#. Click **Delete** for the tag you want to delete in the bottom right corner
   of the panel.
#. Click **Update**

Untag for Multiple Nodes
------------------------

#. Go to **Management > Node** in the top panel
#. Find and click **Checkbox** of desired Nodes
#. Click **Tasks > Node and Device > Edit Node Tag Settings**
#. Select **Remove Selected Tags** from the drop-down in the upper left corner
   of the **Edit Tag Settings** panel
#. Find and click **Checkbox** of desired **Tag** (*You can choose more then
   one*)
#. Click **Save**

.. note:: Select **Remove All Tags** to remove all tags from the node.

Untag for MAC
-------------

#. Go to **Management > Node** in the top panel
#. Click **IP address** of the desired MAC Address
#. Find and click on desired **IP address** of **Node**
#. Click **Delete** for the tag you want to delete in the bottom right corner
   of the panel.
#. Click **Update**


Tagging with Log Filter
-------------------------

You can automatically tag or untag a node when a specific log occurs.

- For more information on creating log filters. See :
  :doc:`/logs/create-log-filter`
- For more information on Tagging with log filter. See:
  :doc:`/logs/tagging-assets`