Registering a Device or VM

Registering a device with Nazara is as straight forward as setting up the config file and running a simple command.

Example Registration Workflow (Physical Device)

On a physical device, a example registration workflow may look like this:

1. Set up Configuration

The user wrote a configuration file at /root/.config/nazara/config.toml

# Configuration parameters for the NetBox connection
[netbox]
netbox_api_token = "XXXXXXXX"
netbox_uri = "https://netbox.organisation.com"

# Common settings that always have to be provided
[common]
# The name of the device/VM
name = "user@"
description = ""
# A comment left by Nazara if anything gets modified by it.
comments = "Automatically registered by Nazara."
# The current status of the device/VM
status = "active"
primary_ip4 = "192.168.0.1"
primary_ip6 = ""

# ---------------------------------------------------------------
# Use [device] for devices, or [vm] if this is a virtual machine.
# ---------------------------------------------------------------

[device]
device_type = 1
role = 1
site = 1

2. Run nazara register

To register your device, simply run

nazara register

Common Issues

TOML Deserialization Error

This is most likely an issue with your config file. Make sure it has correct TOML syntax and all the fields specified in the template are present in your example.

Unexpected Response

We know this output is ugly but please bear with us we are on it. Check the output for a status code:

• 400 - Bad Request: This usually means that Nazara's payload was rejected by NetBox. Most commonly this means that you want to assign this device to a role, device type or site that does not exist (invalid ID). It can also mean that the device already exists so check if a device with the configured name has already been registered.

File OP error

This usually indicates that Nazara cannot open the config file at /root/.config/nazara/config.toml it's either missing, or you forgot to run Nazara as root.