Add nodes to device-specific groups

This functionality can be used to automatically add devices that
netlab cannot configure to the 'unprovisioned' group.

Author: ipspace

docs/dev/devices.md

@@ -114,6 +114,7 @@ Device parameters file can also include numerous *features*. The following featu
 * **features.initial.ipv6.lla** -- The device supports IPv6 interfaces using just link-local addresses.
 * **features.initial.ipv6.use_ra** -- The device (when running as a host) listens to IPv6 RA messages to generate a default route
 * **features.initial.roles** -- The list of roles a device can have (default: `[ router ]`)
+* **features.groups** -- The groups this device belongs to. You can set this feature to [`[ unprovisioned ]`](group-special-names) for devices that _netlab_ cannot configure yet. Don't forget to remove the **unprovisioned** group once you implement the Ansible [device configuration task list](dev-new-devices-configure).
 
 ```{tip}
 Please note that the MTU used by netlab is always the layer-3 MTU. If your device expects layer-2 MTU configuration, add the size of the layer-2 header to the interface **mtu** variable.
@@ -207,6 +208,7 @@ features:
     subif_name:
   vxlan: true
 ```
+
 ## Vagrant Template File
 
 If you'll use a Vagrant box to start the network device as a VM, you have to add a template that will generate the part of *Vagrantfile* (or *containerlab* configuration file) describing your virtual machine. See `netsim/templates/provider/...` directories for more details.
@@ -264,6 +266,7 @@ clab:
     ansible_become_method: enable
 ```
 
+(dev-new-devices-configure)=
 ## Configuring the Device
 
 To configure your device (including initial device configuration), you'll have to create an Ansible task list that deploys configuration snippets onto your device. *netlab* merges configuration snippets with existing device configuration (instead of building a complete configuration and replacing it).

netsim/augment/groups.py

@@ -299,24 +299,24 @@ def auto_create_members(
 '''
 Add node-level group settings to global groups
 '''
+def add_node_to_group(node: str, group: str, topology: Box) -> None:
+  g_data = topology.groups[group]
+  if g_data.get('type','node') != 'node':
+    log.error(
+      f"Cannot add node {node} to non-node group {group}",
+      category=log.IncorrectType,
+      module='groups')
+
+  data.append_to_list(g_data,'members',node)
+
 def add_node_level_groups(topology: Box) -> None:
   for name,n in topology.nodes.items():
     if not 'group' in n:
       continue
 
-    must_be_list(n,'group',f'nodes.{name}')
-
-    for grpname in n.group:
-      # Sanity check for node groups
-      if topology.groups[grpname].get('type','node') != 'node':
-        log.error(
-          f"Cannot use the 'group' attribute in node {n.name} to add a node to a non-node group {grpname}",
-          category=log.IncorrectType,
-          module='groups')
-        continue
-
-      # Add node name to the target group
-      data.append_to_list(topology.groups[grpname],'members',name)
+    if must_be_list(n,'group',f'nodes.{name}'):
+      for grpname in n.group:
+        add_node_to_group(name,grpname,topology)
 
 '''
 Check recursive group definitions

netsim/augment/nodes.py

@@ -14,7 +14,7 @@
 from .. import data
 from .. import utils
 from .. import providers
-from . import devices,addressing,links
+from . import devices,addressing,links,groups
 from ..data.validate import validate_attributes,get_object_attributes
 from ..data.types import must_be_int,must_be_string,must_be_id,must_be_device
 from ..data import global_vars,is_true_int
@@ -297,6 +297,9 @@ def find_node_device(n: Box, topology: Box) -> bool:
   if dev_def.get('node.module') and 'module' not in n:      # Have to copy default device module into node data
     n.module = dev_def.node.module                          # ... before modules are initialized
 
+  for group in dev_def.features.get('group',[]):
+    groups.add_node_to_group(n.name,group,topology)
+
   if 'attributes' in dev_def:                               # Add any device specific attributes to the data model
     topology.defaults.attributes = topology.defaults.attributes + dev_def.attributes