This documentation describes the Server currently in development.

netbox · 0.3.0

NetBox

Capabilities

topology · hosts

Connection configuration

Field	Type	Description	Default
`url` required	`string`	NetBox URL	`—`
`token` required · secret	`string`	API token	`—`
`insecure`	`boolean`	Skip TLS verification Disables certificate validation. Self-signed certs in trusted networks only.	`false`

Topology options

Field	Type	Description	Default
`groupDepth`	`string`	Group depth How deep the places nest: sites, locations within them, or down to the rack. site — Site, location — Location, rack — Rack	`location`
`siteFilter`	`string[]`	Sites	`—`
`tagFilter`	`string[]`	Tags	`—`
`roleFilter`	`string[]`	Roles	`—`
`excludeRoleFilter`	`string[]`	Exclude roles	`—`
`excludeTagFilter`	`string[]`	Exclude tags	`—`
`tenantFilter`	`string[]`	Tenants Tenant slugs.	`—`
`cloudClusterTypes`	`string[]`	Cloud cluster types Cluster types that are a cloud (such as aws). Each such cluster is drawn as a cloud that hosts its VMs. Nothing is guessed from names.	`—`
`roleTypes`	`string[]`	Role to node type One role-slug=type per line, such as hypervisor=server, for roles the built-in mapping does not know.	`—`
`statusFilter`	`string[]`	Device and VM statuses Statuses that are drawn. Default: active, staged, offline, failed, decommissioning (not planned or inventory).	`—`
`circuitStatusFilter`	`string[]`	Circuit statuses Statuses that are drawn. Default: active, offline, provisioning, deprovisioning.	`—`