===========================
Managing node group records
===========================

Node group records are displayed in a list on the **Node groups** page.
Navigate to the list by clicking the **Laywire** button in the top menu, and
then clicking **Node groups**.

The node group list can be navigated, searched, and sorted in the same way as
the node list. See the `node management documentation
<../nodes/managing-node-records.html>`__ for details.

.. contents::
    :local:
    :depth: 1

Adding a node group
===================

To add a node group, click the **Add node group** button located underneath the
heading on the node group list page:

|managing-node-group-records-1|

From here you can specify the following information. Fields marked with
an asterisk are required.

Name *
------

A descriptive name for the node group.

Space *
-------

The space the node group will be assigned to. The space determines which users
can see and manage the group.

Metadata
--------

Optional data about the node group, in key-value pairs. This is purely
user-defined. It can be used to store data such as location and CRM
identifiers.

Note
----

Any miscellaneous information you would like to include about the node group.

Once you have entered your information, click on **Save** to add the node
group. You will then be directed to the newly created node group's details
page.

Editing a node group
====================

To edit a node group record, navigate to the node group's details page by
clicking on its name in the node group list:

|managing-node-group-records-2|

Then, click the |edit| button next to the header on the **Configuration**
table:

|managing-node-group-records-3|

This will open the **Edit node group** modal. From here you can edit any of the
properties of the node group that were specified when it was created.

Deleting a node group
=====================

To delete a node group, navigate to the node group's details page and click the
**Delete** button underneath the node group's name:

|managing-node-group-records-4|

This will open up a modal asking you to confirm before the node group record is
**permanently** deleted.

.. |managing-node-group-records-1| image:: /attachments/laywire/node-groups/managing-node-group-records-1.png
    :scale: 75%
.. |managing-node-group-records-2| image:: /attachments/laywire/node-groups/managing-node-group-records-2.png
    :scale: 75%
.. |managing-node-group-records-3| image:: /attachments/laywire/node-groups/managing-node-group-records-3.png
    :scale: 75%
.. |managing-node-group-records-4| image:: /attachments/laywire/node-groups/managing-node-group-records-4.png
    :scale: 75%

.. |add| image:: /attachments/laywire/add.svg
    :width: 20px
.. |edit| image:: /attachments/laywire/edit.svg
    :width: 20px
.. |delete| image:: /attachments/laywire/delete.svg
    :width: 20px