overrides.toml

# Manual topology overrides.
#
# Picked up automatically if this file sits in the working directory as
# overrides.toml, or point at it with --overrides. See docs/overrides.md.
#
# Selectors (`from`, `to`, `guest`, `host`) accept a MAC, an IP, or a
# hostname/device name as shown on the map.

# --- Devices the controller cannot see ---------------------------------------
# A controller only reports what it manages, so anything it does not adopt is
# invisible to it however capable that device is: an unmanaged switch with no
# management plane at all, a fully managed third-party switch, or UniFi gear
# that was powered off when you ran the fetch. Declaring it is the only way it
# reaches the map.
#
# Declared devices are drawn with a dotted outline, and are added before every
# other override, so the blocks below can reference this one by name.

[[device]]
name = "Basement switch"
kind = "switch"              # gateway, switch, ap, bridge, wired_client,
                             # wireless_client or unknown
ip = "10.0.0.9"              # optional
model = "NETGEAR GS308"      # optional, shown under the name
parent = "Core Switch"       # optional; without it the device floats
port = 24                    # optional, needs a parent
note = "No management at all, bought years ago."
# icon = "artwork/gs308.png" # optional, your own artwork


# --- Links the controller cannot see -----------------------------------------
# A direct connection the controller does not participate in. Without this the
# NAS can only be anchored to "uplink not reported by controller".

[[link]]
from = "nas"
to = "Rack Switch"
port = 10
speed = "10G"
note = "Direct SFP+ DAC"

# Ports may be written unquoted; they are normalised to strings.
[[link]]
from = "media-player"
to = "Core Switch"
port = 9

# A point-to-point wireless bridge, which renders dashed.
# [[link]]
# from = "Shed AP"
# to = "Garage"
# wireless = true
# note = "Wireless uplink"

# --- Fixing what the controller got wrong -------------------------------------
# Ubiquiti's fingerprint database is confident and occasionally wrong, which
# gives you both the wrong name and the wrong picture. `icon` is a file you
# supply; relative paths resolve against this file's directory, so a config plus
# an assets folder travel together. Nothing is downloaded for it.

#
# PNG needs nothing extra. If you point `icon` at an .svg instead, Graphviz
# drops it from the png and pdf outputs (it loads SVG only for its own svg
# format) and additionally demands an XML declaration on the first line.
#
# Two ways round that, and either is fine:
#
#     pip install 'unifi-map[svg]'    # rasterises the SVG on the way in
#
# or convert the file to PNG, which adds no dependency. See docs/overrides.md.

[[node]]
match = "10.0.30.22"
name = "Network Bidet"
icon = "assets/bidet.png"
note = "UniFi is convinced this is a smart toothbrush"

# A rename on its own is fine; so is artwork on its own.
[[node]]
match = "02:00:00:00:30:03"
name = "Garage freezer"

# --- Hiding things ------------------------------------------------------------
# Two reasons to hide something. Either it is noise (an access point whose radios
# you disabled on purpose is still "online" to the controller, so
# --show-offline no will not remove it), or it is something you would rather not
# put on a map you are about to hand to somebody else.
#
# Only leaf nodes can be hidden. Hiding a switch or an access point would orphan
# everything behind it, so that is refused rather than guessed at.

[[node]]
match = "10.0.20.99"
hide = true
note = "internal service, not for a diagram I am sharing"

[[node]]
match = "Garage"
hide = true
note = "radios disabled on purpose, online but doing nothing"

# --- Things running inside other things ---------------------------------------
# VMs and containers appear as their own clients with no hint of where they live.

[[hosted]]
guest = "build-runner"
host = "hypervisor"
note = "VM"

[[hosted]]
guest = "reverse-proxy"
host = "hypervisor"
note = "container"