Add baremetal dump command to output deployment playbook (#1812)

This adds a new 'baremetal dump <hostname>' command that outputs
the deployment playbook for a given baremetal node to the console.
The command reuses the playbook generation logic from BaremetalDeploy
including NetBox integration for local_context_data, netplan_parameters,
and frr_parameters.

Usage:
  osism baremetal dump <hostname>
  osism manage baremetal dump <hostname>

AI-assisted: Claude Code

Signed-off-by: Christian Berendt <[email protected]>

Author: berendt

osism/commands/baremetal.py

@@ -284,6 +284,118 @@ def take_action(self, parsed_args):
                 continue
 
 
+class BaremetalDump(Command):
+    def get_parser(self, prog_name):
+        parser = super(BaremetalDump, self).get_parser(prog_name)
+
+        parser.add_argument(
+            "name",
+            type=str,
+            help="Dump deployment playbook for given baremetal node",
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        name = parsed_args.name
+
+        # Check if NetBox connection is available
+        if not utils.nb:
+            logger.error("NetBox connection not available")
+            return
+
+        try:
+            # Try to find device by name first
+            device = utils.nb.dcim.devices.get(name=name)
+
+            # If not found by name, try by inventory_hostname custom field
+            if not device:
+                devices = utils.nb.dcim.devices.filter(cf_inventory_hostname=name)
+                if devices:
+                    device = devices[0]
+
+            # If device not found, error out
+            if not device:
+                logger.error(f"Could not find device {name} in NetBox")
+                return
+
+            # Get default vars from NetBox local_context_data if available
+            default_vars = {}
+            if hasattr(device, "local_context_data") and device.local_context_data:
+                default_vars = device.local_context_data
+                logger.info(f"Using NetBox local_context_data for device {device.name}")
+            else:
+                logger.debug(
+                    f"No local_context_data found for device {device.name} in NetBox"
+                )
+
+            playbook = []
+            play = {
+                "name": "Run bootstrap",
+                "hosts": "localhost",
+                "connection": "local",
+                "gather_facts": True,
+                "vars": default_vars.copy(),
+                "roles": [
+                    "osism.commons.hostname",
+                    "osism.commons.hosts",
+                    "osism.commons.operator",
+                ],
+                "tasks": [
+                    {
+                        "name": "Restart rsyslog service after hostname change",
+                        "ansible.builtin.systemd": {
+                            "name": "rsyslog",
+                            "state": "restarted",
+                        },
+                    }
+                ],
+            }
+            play["vars"].update(
+                {"hostname_name": device.name, "hosts_type": "template"}
+            )
+
+            # Get netplan_parameters from NetBox custom fields (already a dict, no JSON parsing needed)
+            if (
+                "netplan_parameters" in device.custom_fields
+                and device.custom_fields["netplan_parameters"]
+            ):
+                play["vars"].update(
+                    {
+                        "network_allow_service_restart": True,
+                    }
+                )
+                play["vars"].update(device.custom_fields["netplan_parameters"])
+                play["roles"].append("osism.commons.network")
+
+            # Get frr_parameters from NetBox custom fields (already a dict, no JSON parsing needed)
+            if (
+                "frr_parameters" in device.custom_fields
+                and device.custom_fields["frr_parameters"]
+            ):
+                play["vars"].update(
+                    {
+                        "frr_dummy_interface": "loopback0",
+                    }
+                )
+                play["vars"].update(device.custom_fields["frr_parameters"])
+                play["roles"].append("osism.services.frr")
+
+            playbook.append(play)
+
+            # Output playbook to stdout
+            print(
+                yaml.dump(
+                    playbook,
+                    default_flow_style=False,
+                    explicit_start=True,
+                    indent=2,
+                    sort_keys=False,
+                )
+            )
+        except Exception as exc:
+            logger.error(f"Failed to generate playbook for {name}: {exc}")
+
+
 class BaremetalUndeploy(Command):
     def get_parser(self, prog_name):
         parser = super(BaremetalUndeploy, self).get_parser(prog_name)

setup.cfg

@@ -42,6 +42,7 @@ osism.commands:
     baremetal burnin = osism.commands.baremetal:BaremetalBurnIn
     baremetal delete = osism.commands.baremetal:BaremetalDelete
     baremetal deploy = osism.commands.baremetal:BaremetalDeploy
+    baremetal dump = osism.commands.baremetal:BaremetalDump
     baremetal list = osism.commands.baremetal:BaremetalList
     baremetal maintenance set = osism.commands.baremetal:BaremetalMaintenanceSet
     baremetal maintenance unset = osism.commands.baremetal:BaremetalMaintenanceUnset
@@ -97,6 +98,7 @@ osism.commands:
     manage baremetal burnin = osism.commands.baremetal:BaremetalBurnIn
     manage baremetal delete = osism.commands.baremetal:BaremetalDelete
     manage baremetal deploy = osism.commands.baremetal:BaremetalDeploy
+    manage baremetal dump = osism.commands.baremetal:BaremetalDump
     manage baremetal list = osism.commands.baremetal:BaremetalList
     manage baremetal maintenance set = osism.commands.baremetal:BaremetalMaintenanceSet
     manage baremetal maintenance unset = osism.commands.baremetal:BaremetalMaintenanceUnset