constants

Documentation

Index

• Constants
• Variables
• type APIPath
• type Color
• type ContentType
• type CtxKey
• type SourceType

Constants

const (
	DefaultOSName                  string = "Unknown"
	DefaultOSVersion               string = "X"
	DefaultCPUArch                 string = "unknown"
	DefaultManufacturer            string = "Generic Manufacturer"
	DefaultManufacturerDescription string = "Generic Manufacturer created by netbox-ssot"
	DefaultModel                   string = "Generic Model"
	DefaultSite                    string = "DefaultSite"
	DefaultDeviceTypeDescription   string = "Generic Device Type created by netbox-ssot"
)

const (
	ColorDarkRed    = "aa1409"
	ColorRed        = "f44336"
	ColorPink       = "e91e63"
	ColorRose       = "ffe4e1"
	ColorFuchsia    = "ff66ff"
	ColorPurple     = "9c27b0"
	ColorDarkPurple = "673ab7"
	ColorIndigo     = "3f51b5"
	ColorBlue       = "2196f3"
	ColorLightBlue  = "03a9f4"
	ColorCyan       = "00bcd4"
	ColorTeal       = "009688"
	ColorAqua       = "00ffff"
	ColorDarkGreen  = "2f6a31"
	ColorGreen      = "4caf50"
	ColorLightGreen = "8bc34a"
	ColorLime       = "cddc39"
	ColorYellow     = "ffeb3b"
	ColorAmber      = "ffc107"
	ColorOrange     = "ff9800"
	ColorDarkOrange = "ff5722"
	ColorBrown      = "795548"
	ColorLightGrey  = "c0c0c0"
	ColorGrey       = "9e9e9e"
	ColorDarkGrey   = "607d8b"
	ColorBlack      = "111111"
	ColorWhite      = "ffffff"
)

const (
	B   = 1
	KB  = 1000 * B
	MB  = 1000 * KB
	GB  = 1000 * MB
	TB  = 1000 * GB
	KiB = 1024 * B
	MiB = 1024 * KiB
	GiB = 1024 * MiB
	TiB = 1024 * GiB
)

Magic numbers for dealing with bytes.

const (
	IPv4            = 4
	IPv6            = 6
	MaxIPv4MaskBits = 32
	MaxIPv6MaskBits = 128
)

Magic numbers for dealing with IP addresses.

const (
	// Custom Field for matching object with a source. This custom field is important
	// for priority diff.
	CustomFieldSourceName        = "source"
	CustomFieldSourceLabel       = "Source"
	CustomFieldSourceDescription = "Name of the source from which the object was collected"

	// Custom field for adding source ID for each object.
	CustomFieldSourceIDName        = "source_id"
	CustomFieldSourceIDLabel       = "Source ID"
	CustomFieldSourceIDDescription = "ID of the object on the source API"

	// Custom field for all object to track when we have last seen them.
	CustomFieldOrphanLastSeenName         = "orphan_last_seen"
	CustomFieldOrphanLastSeenLabel        = "Orphan last seen"
	CustomFieldOrphanLastSeenDescription  = "Last time the orphan object was seen"
	CustomFieldOrphanLastSeenFormat       = "2006-01-02 15:04:05"
	CustomFieldOrphanLastSeenDefaultValue = int(^uint(0) >> 1)

	// Custom field dcim.device, so we can add number of cpu cores for each server.
	CustomFieldHostCPUCoresName        = "host_cpu_cores"
	CustomFieldHostCPUCoresLabel       = "Host CPU cores"
	CustomFieldHostCPUCoresDescription = "Number of CPU cores on the host"

	// Custom field for dcim.device, so we can add number of ram for each server.
	CustomFieldHostMemoryName        = "host_memory"
	CustomFieldHostMemoryLabel       = "Host memory"
	CustomFieldHostMemoryDescription = "Amount of memory on the host"

	// Custom field for dcim.device, so we can store uuid for it.
	CustomFieldDeviceUUIDName        = "uuid"
	CustomFieldDeviceUUIDLabel       = "uuid"
	CustomFieldDeviceUUIDDescription = "Universally Unique Identifier for a device"

	// Custom field for ModelTypeIPAddress, so we can determine if an ip is part of an arp table or not.
	CustomFieldArpEntryName        = "arp_entry"
	CustomFieldArpEntryLabel       = "Arp Entry"
	CustomFieldArpEntryDescription = "Was this IP collected from ARP table"
)

Names used for netbox objects custom fields attribute.

const (
	DeviceRoleFirewall            = "Firewall"
	DeviceRoleFirewallDescription = "Device role for marking firewall device."
	DeviceRoleFirewallColor       = "f57842"

	DeviceRoleSwitch            = "Switch"
	DeviceRoleSwitchDescription = "Device role for marking switch device."
	DeviceRoleSwitchColor       = "7aefea"

	DeviceRoleServer            = "Server"
	DeviceRoleServerDescription = "Device role for marking server."
	DeviceRoleServerColor       = "00add8"

	DeviceRoleContainer            = "Container"
	DeviceRoleContainerDescription = "VM role for separating containers from VMs."
	DeviceRoleContainerColor       = "0db7ed"

	DeviceRoleVM            = "VM"
	DeviceRoleVMDescription = "Role for representing VMs."
	DeviceRoleVMColor       = "81eaea"

	DeviceRoleVMTemplate            = "VM Template"
	DeviceRoleVMTemplateDescription = "VM role for separating VM templates from VMs."
	DeviceRoleVMTemplateColor       = "82c1ea"
)

Device Role constants.

const (
	UntaggedVID = 0
	DefaultVID  = 1
	MaxVID      = 4094
	TaggedVID   = 4095
)

const (
	MaxInterfaceNameLength   = 64
	MaxVMNameLength          = 64
	MaxVMInterfaceNameLength = 64

	//nolint:lll
	// Limitations for devices https://github.com/netbox-community/netbox/blob/d03d302eef3819db64cad8ae74dc5255647045f6/netbox/dcim/models/device_components.py.
	MaxDeviceNameLength   = 64
	MaxSerialNumberLength = 50
	MaxAssetTagLength     = 50
)

Netbox's limitations for max length of some fields.

const (
	CheckMark   = "\u2713"
	Rocket      = "\U0001F680"
	WarningSign = "\u26A0"
)

const (
	// API timeout in seconds.
	DefaultAPITimeout = 15
)

const DefaultArpTagColor = ColorRed

const DefaultArpTagName = "arp-entry"

const DefaultVlanGroupDescription = "Default netbox-ssot VlanGroup for all vlans that are not part of " +
	"any other vlanGroup. This group is required for netbox-ssot vlan index to work."

const DefaultVlanGroupName = "DefaultVlanGroup"

const (
	HTTPSDefaultPort = 443
)

const OrphanTagColor = ColorGrey

const OrphanTagDescription = "Tag used by netbox-ssot to mark orphaned objects"

const OrphanTagName = "netbox-ssot-orphan"

const SsotTagColor = "00add8"

const SsotTagDescription = "Tag used by netbox-ssot to mark devices that are managed by it"

const SsotTagName = "netbox-ssot"

const WildcardIP = "0.0.0.0"

Variables

var Arch2Bit = map[string]string{
	"x86_64":  "64-bit",
	"i386":    "32-bit",
	"i486":    "32-bit",
	"i586":    "32-bit",
	"i686":    "32-bit",
	"aarch64": "64-bit",
	"arm64":   "64-bit",
	"arm":     "32-bit",
	"arm32":   "32-bit",
	"ppc64le": "64-bit",
	"s390x":   "64-bit",
	"mips64":  "64-bit",
	"riscv64": "64-bit",
	"unknown": "unknown",
}

var SourceTagColorMap = map[SourceType]string{
	Ovirt:     ColorDarkRed,
	Vmware:    ColorLightGreen,
	Dnac:      ColorLightBlue,
	PaloAlto:  ColorDarkOrange,
	Fortigate: ColorDarkGreen,
	FMC:       ColorLightBlue,
	IOSXE:     "0d294f",
}

Default mappings of sources to colors (for tags), fallback mechanism. E.g. we name a source "prodvmware", tag "Source: prodvmware" is created with our color.

var SourceTypeTagColorMap = map[SourceType]string{
	Ovirt:     ColorRed,
	Vmware:    ColorGreen,
	Dnac:      ColorBlue,
	PaloAlto:  ColorOrange,
	Fortigate: ColorDarkGreen,
	FMC:       ColorBlue,
	IOSXE:     "0d294f",
}

Each source Mapping for source type tag. E.g. tag "paloalto" -> color orange.

Types

type APIPath

type APIPath string

Here all mappings are defined so we don't hardcode api paths of objects in our code.

const (
	// Tenancy paths.
	ContactGroupsAPIPath      APIPath = "/api/tenancy/contact-groups/"
	ContactRolesAPIPath       APIPath = "/api/tenancy/contact-roles/"
	ContactsAPIPath           APIPath = "/api/tenancy/contacts/"
	TenantsAPIPath            APIPath = "/api/tenancy/tenants/"
	TenantGroupsAPIPath       APIPath = "/api/tenancy/tenant-groups/"
	ContactAssignmentsAPIPath APIPath = "/api/tenancy/contact-assignments/"

	// IPAM paths.
	PrefixesAPIPath    APIPath = "/api/ipam/prefixes/"
	VlanGroupsAPIPath  APIPath = "/api/ipam/vlan-groups/"
	VlansAPIPath       APIPath = "/api/ipam/vlans/"
	IPAddressesAPIPath APIPath = "/api/ipam/ip-addresses/"

	// Virtualization paths.
	ClusterTypesAPIPath    APIPath = "/api/virtualization/cluster-types/"
	ClusterGroupsAPIPath   APIPath = "/api/virtualization/cluster-groups/"
	ClustersAPIPath        APIPath = "/api/virtualization/clusters/"
	VirtualMachinesAPIPath APIPath = "/api/virtualization/virtual-machines/"
	VMInterfacesAPIPath    APIPath = "/api/virtualization/interfaces/"

	// DCIM paths.
	DevicesAPIPath               APIPath = "/api/dcim/devices/"
	MACAddressesAPIPath          APIPath = "/api/dcim/mac-addresses/"
	DeviceRolesAPIPath           APIPath = "/api/dcim/device-roles/"
	DeviceTypesAPIPath           APIPath = "/api/dcim/device-types/"
	InterfacesAPIPath            APIPath = "/api/dcim/interfaces/"
	SitesAPIPath                 APIPath = "/api/dcim/sites/"
	SiteGroupsAPIPath            APIPath = "/api/dcim/site-groups/"
	RegionsAPIPath               APIPath = "/api/dcim/regions/"
	LocationsAPIPath             APIPath = "/api/dcim/locations/"
	ManufacturersAPIPath         APIPath = "/api/dcim/manufacturers/"
	PlatformsAPIPath             APIPath = "/api/dcim/platforms/"
	VirtualDeviceContextsAPIPath APIPath = "/api/dcim/virtual-device-contexts/"

	// Wireless paths.
	WirelessLANsAPIPath      APIPath = "/api/wireless/wireless-lans/"
	WirelessLANGroupsAPIPath APIPath = "/api/wireless/wireless-lan-groups/"

	// Extras paths.
	CustomFieldsAPIPath APIPath = "/api/extras/custom-fields/"
	TagsAPIPath         APIPath = "/api/extras/tags/"
)

type Color

type Color string

type ContentType

type ContentType string

const (
	// DCIM object types.
	ContentTypeDcimDevice               ContentType = "dcim.device"
	ContentTypeDcimDeviceRole           ContentType = "dcim.devicerole"
	ContentTypeDcimDeviceType           ContentType = "dcim.devicetype"
	ContentTypeDcimInterface            ContentType = "dcim.interface"
	ContentTypeDcimLocation             ContentType = "dcim.location"
	ContentTypeDcimManufacturer         ContentType = "dcim.manufacturer"
	ContentTypeDcimPlatform             ContentType = "dcim.platform"
	ContentTypeDcimRegion               ContentType = "dcim.region"
	ContentTypeDcimSite                 ContentType = "dcim.site"
	ContentTypeDcimSiteGroup            ContentType = "dcim.sitegroup"
	ContentTypeDcimVirtualDeviceContext ContentType = "dcim.virtualdevicecontext"
	ContentTypeDcimMACAddress           ContentType = "dcim.macaddress"

	// Extras object types.
	ContentTypeExtrasCustomField ContentType = "extras.customfield"
	ContentTypeExtrasTag         ContentType = "extras.tag"

	// IPAM object types.
	ContentTypeIpamIPAddress ContentType = "ipam.ipaddress"
	ContentTypeIpamVlanGroup ContentType = "ipam.vlangroup"
	ContentTypeIpamVlan      ContentType = "ipam.vlan"
	ContentTypeIpamPrefix    ContentType = "ipam.prefix"

	// Tenancy object types.
	ContentTypeTenancyTenantGroup       ContentType = "tenancy.tenantgroup"
	ContentTypeTenancyTenant            ContentType = "tenancy.tenant"
	ContentTypeTenancyContact           ContentType = "tenancy.contact"
	ContentTypeTenancyContactAssignment ContentType = "tenancy.contactassignment"
	ContentTypeTenancyContactGroup      ContentType = "tenancy.contactgroup"
	ContentTypeTenancyContactRole       ContentType = "tenancy.contactrole"

	// Virtualization object types.
	ContentTypeVirtualizationCluster        ContentType = "virtualization.cluster"
	ContentTypeVirtualizationClusterGroup   ContentType = "virtualization.clustergroup"
	ContentTypeVirtualizationClusterType    ContentType = "virtualization.clustertype"
	ContentTypeVirtualizationVirtualMachine ContentType = "virtualization.virtualmachine"
	ContentTypeVirtualizationVMInterface    ContentType = "virtualization.vminterface"

	// Wireless object type.
	ContentTypeWirelessLink     ContentType = "wireless.wirelesslink"
	ContentTypeWirelessLAN      ContentType = "wireless.wirelesslan"
	ContentTypeWirelessLANGroup ContentType = "wireless.wirelesslangroup"
)

Content types predefined in netbox.

type CtxKey

type CtxKey int

Constants used for variables in our contexts.

const (
	CtxSourceKey CtxKey = iota
)

type SourceType

type SourceType string

const (
	Ovirt     SourceType = "ovirt"
	Vmware    SourceType = "vmware"
	Dnac      SourceType = "dnac"
	Proxmox   SourceType = "proxmox"
	PaloAlto  SourceType = "paloalto"
	Fortigate SourceType = "fortigate"
	FMC       SourceType = "fmc"
	IOSXE     SourceType = "ios-xe"
)