objects

type Choice struct {
	Value string `json:"value,omitempty"`
	Label string `json:"label,omitempty"`
}

type Cluster struct {
	NetboxObject
	// Name is the name of the cluster. This field is required.
	Name string `json:"name,omitempty"`
	// Type is the type of the cluster. This field is required.
	// e.g. oVirt,VMware...
	Type *ClusterType `json:"type,omitempty"`
	// ClusterGroup is the cluster group to which this cluster belongs.
	Group *ClusterGroup `json:"group,omitempty"`
	// ScopeType is the scope of the cluster.
	ScopeType constants.ContentType `json:"scope_type,omitempty"`
	// ScopeID is the ID of the scope object.
	ScopeID int `json:"scope_id,omitempty"`
	// Status is the operational status of the cluster. This field is required.
	Status ClusterStatus `json:"status,omitempty"`
	// TenantGroup is the tenant group to which this cluster belongs.
	TenantGroup *TenantGroup `json:"tenant_group,omitempty"`
	// Tenant is the tenant to which this cluster belongs.
	Tenant *Tenant `json:"tenant,omitempty"`
}

type ClusterGroup struct {
	NetboxObject
	// Name is the name of the cluster group. This field is required.
	Name string `json:"name,omitempty"`
	// Slug is the slugified version of the cluster group name. This field is read-only.
	Slug string `json:"slug,omitempty"`
}

type ClusterStatus struct {
	Choice
}

type ClusterType struct {
	NetboxObject
	// Name is the name of the cluster type. This field is required.
	Name string `json:"name,omitempty"`
	// Slug is the slugified version of the cluster type name. This field is read-only.
	Slug string `json:"slug,omitempty"`
}

type Contact struct {
	NetboxObject
	// Name is the name of the Contact. This field is required.
	Name string `json:"name,omitempty"`
	// Title is the title of the Contact.]
	Title string `json:"title,omitempty"`
	// Phone is the phone number of the contact.
	Phone string `json:"phone,omitempty"`
	// Email is the email of the contact.
	Email string `json:"email,omitempty"`
	// Address is the address of the contact.
	Address string `json:"address,omitempty"`
	// Link is the web link of the contact.
	Link string `json:"link,omitempty"`
	// Comments for the contact.
	Comments string `json:"comments,omitempty"`
}

type ContactAssignment struct {
	NetboxObject
	// Content type (e.g. virtualization.virtualmachine). This field is necessary
	ModelType constants.ContentType `json:"object_type,omitempty"`
	// ID of the dependent object. This field is necessary
	ObjectID int `json:"object_id,omitempty"`
	// Contact for this assignment. This field is necessary
	Contact *Contact `json:"contact,omitempty"`
	// Role of the Contact assignment. This field is necessary
	Role *ContactRole `json:"role,omitempty"`
	// Priority of the Contact Assignment
	Priority *ContactAssignmentPriority `json:"priority,omitempty"`
}

type ContactAssignmentPriority struct {
	Choice
}

type ContactGroup struct {
	NetboxObject
	// Name is the name of the ContactGroup. This field is required.
	Name string `json:"name,omitempty"`
	// Slug is the slug for the ContactGroup. This field is required.
	Slug string `json:"slug,omitempty"`
	// Parent contact group.
	Parent *ContactGroup `json:"parent,omitempty"`
}

type ContactRole struct {
	NetboxObject
	// Name is the name of the role. This field is required.
	Name string `json:"name,omitempty"`
	// Slug is the slug of the role. This field is required.
	Slug string `json:"slug,omitempty"`
}

type CustomField struct {
	ID int `json:"id,omitempty"`
	// Name of the custom field (e.g. host_cpu_cores). This field is required.
	Name string `json:"name,omitempty"`
	// Label represents name of the field as displayed to users (e.g. Physical CPU cores).
	// If not provided, the name will be used instead.
	Label string `json:"label,omitempty"`
	// Type is the type of the custom field.
	// Valid choices are: text, integer, boolean, date, url, select, multiselect. This field is required.
	Type CustomFieldType `json:"type,omitempty"`
	// Type of the related object (for object/multi-object fields only) (e.g. objects.device). This field is required.
	ObjectTypes []constants.ContentType `json:"object_types,omitempty"`
	// Description is a description of the field. This field is optional.
	Description string `json:"description,omitempty"`
	// Weighting for search. Lower values are considered more important. Default (1000).
	SearchWeight int `json:"search_weight,omitempty"`
	// Filter logic. This field is required. (Default loose).
	FilterLogic FilterLogic `json:"filter_logic,omitempty"`
	// UI visible. This field is required. (Default read-write).
	CustomFieldUIVisible *CustomFieldUIVisible `json:"ui_visible,omitempty"`
	// UI editable. This field is required. (Default read-write).
	CustomFieldUIEditable *CustomFieldUIEditable `json:"ui_editable,omitempty"`
	// Display Weight. Fields with higher weights appear lower in a form (default is 100).
	DisplayWeight int `json:"weight,omitempty"`
	// Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. "Foo").
	Default interface{} `json:"default"`
	// If this field is required or not.
	Required bool `json:"required"`
}

type CustomFieldType struct {
	Choice
}

type CustomFieldUIEditable struct {
	Choice
}

type CustomFieldUIVisible struct {
	Choice
}

type Device struct {
	NetboxObject

	// Device
	// Name is the name of the device.
	Name string `json:"name,omitempty"`
	// DeviceRole is the functional role of the device. This field is required.
	DeviceRole *DeviceRole `json:"role,omitempty"`

	// Hardware
	// DeviceType is the type of device. This field is required.
	DeviceType *DeviceType `json:"device_type,omitempty"`
	// Airflow is the airflow pattern of the device.
	Airflow *DeviceAirFlowType `json:"airflow,omitempty"`
	// Status is the status of the device.
	SerialNumber string `json:"serial,omitempty"`
	// AssetTag is an unique tag for identifying the device.
	AssetTag string `json:"asset_tag,omitempty"`

	// Location
	// Site is the site to which the device belongs. This field is required.
	Site *Site `json:"site,omitempty"`
	// Location is the location of the device.
	Location *Location `json:"location,omitempty"`

	// Management
	// Status of the device (e.g. active, offline, planned, etc.). This field is required.
	Status *DeviceStatus `json:"status,omitempty"`
	// Platform of the device (e.g. Cisco IOS, Dell OS9, etc.).
	Platform *Platform `json:"platform,omitempty"`

	// PrimaryIPv4 is the primary IPv4 address assigned to the server.
	PrimaryIPv4 *IPAddress `json:"primary_ip4,omitempty"`
	// PrimaryIPv6 is the primary IPv6 address assigned to the server.
	PrimaryIPv6 *IPAddress `json:"primary_ip6,omitempty"`

	// Virtualization
	// Cluster is the cluster to which the device belongs. (e.g. VMWare server belonging to a specific cluster).
	Cluster *Cluster `json:"cluster,omitempty"`

	// Tenancy
	// Tenant group
	Tenant *Tenant `json:"tenant,omitempty"`

	// The priority of the device in the virtual chassis
	// Priority
	// Additional comments.
	Comments string `json:"comments,omitempty"`
}

type DeviceAirFlowType struct {
	Choice
}

type DeviceRole struct {
	NetboxObject
	// Name is the name of the device role. This field is required.
	Name string `json:"name,omitempty"`
	// URL-friendly unique shorthand. This field is required.
	Slug string `json:"slug,omitempty"`
	// Color of the device role. This field is required.
	Color constants.Color `json:"color,omitempty"`
	// VMRole is whether this device role is used to represent virtual machines.
	VMRole bool `json:"vm_role,omitempty"`
}

type DeviceStatus struct {
	Choice
}

type DeviceType struct {
	NetboxObject
	// Manufacturer is the manufacturer of the device type. This field is required.
	Manufacturer *Manufacturer `json:"manufacturer,omitempty"`
	// Model is the model of the device type. This field is required.
	Model string `json:"model,omitempty"`
	// Slug is a URL-friendly unique shorthand. This field is required.
	Slug string `json:"slug,omitempty"`
}

type FilterLogic struct {
	Choice
}

type IDItem interface {
	GetID() int
	GetObjectType() constants.ContentType
	GetAPIPath() constants.APIPath
}

type IPAddress struct {
	NetboxObject
	// IPv4 or IPv6 address (with mask). This field is required.
	Address string `json:"address,omitempty"`
	// The status of this IP address.
	Status *IPAddressStatus `json:"status,omitempty"`
	// Role of the IP address.
	Role *IPAddressRole `json:"role,omitempty"`
	// Hostname or FQDN (not case-sensitive)
	DNSName string `json:"dns_name,omitempty"`
	// Tenancy
	Tenant *Tenant `json:"tenant,omitempty"`

	// AssignedObjectType is either a DeviceInterface or a VMInterface.
	AssignedObjectType constants.ContentType `json:"assigned_object_type,omitempty"`
	// ID of the assigned object (either an ID of DeviceInterface or an ID of VMInterface).
	AssignedObjectID int `json:"assigned_object_id,omitempty"`
}

type IPAddressOwner interface {
	GetID() int
	GetObjectType() constants.ContentType
	GetAPIPath() constants.APIPath
	GetPrimaryIPv4Address() *IPAddress
	GetPrimaryIPv6Address() *IPAddress
	SetPrimaryIPAddress(ip *IPAddress)
	SetPrimaryIPv6Address(ip *IPAddress)
}

type IPAddressRole struct {
	Choice
}

type IPAddressStatus struct {
	Choice
}

type IPRange struct {
	NetboxObject
}

type Interface struct {
	NetboxObject
	// Device is the device to which the interface belongs. This field is required.
	Device *Device `json:"device,omitempty"`
	// Name is the name of the interface. This field is required.
	Name string `json:"name,omitempty"`
	// Status whether the interface is enabled or not.
	Status bool `json:"enabled,omitempty"`
	// Type is the type of interface. This field is required. Can only be one of the predetermined values.
	Type *InterfaceType `json:"type,omitempty"`
	// Interface speed in kbps
	Speed InterfaceSpeed `json:"speed,omitempty"`
	// Related Interfaces
	// Parent is the parent interface, if any.
	ParentInterface *Interface `json:"parent,omitempty"`
	// BridgedInterface is the bridged interface, if any.
	BridgedInterface *Interface `json:"bridge,omitempty"`
	// LAG is the LAG to which the interface belongs, if any.
	LAG *Interface `json:"lag,omitempty"`
	// MTU is the maximum transmission unit (MTU) configured for the interface.
	MTU int `json:"mtu,omitempty"`
	// PrimaryMACAddress is the primary MAC address of the interface.
	PrimaryMACAddress *MACAddress `json:"primary_mac_address,omitempty"`

	// Duplex is the duplex mode of the interface
	Duplex *InterfaceDuplex `json:"duplex,omitempty"`

	// 802.1Q Mode
	Mode *InterfaceMode `json:"mode,omitempty"`
	// TaggedVlans is a list of all the VLANs to which the interface is tagged.
	TaggedVlans []*Vlan `json:"tagged_vlans,omitempty"`
	// UntaggedVlan
	UntaggedVlan *Vlan `json:"untagged_vlan,omitempty"`
	// VirtualDeviceContexts
	Vdcs []*VirtualDeviceContext `json:"vdcs,omitempty"`
}

type InterfaceDuplex struct {
	Choice
}

type InterfaceMode struct {
	Choice
}

type InterfaceSpeed int64

type InterfaceType struct {
	Choice
}

type Location struct {
	NetboxObject
	// Site is the site to which the location belongs. This field is required.
	Site *Site
	// Name is the name of the location. This field is required.
	Name string
	// URL-friendly unique shorthand. This field is required.
	Slug string
	// Status is the status of the location. This field is required.
	Status *SiteStatus
}

type MACAddress struct {
	NetboxObject
	// MAC is the MAC address. This field is required.
	MAC string `json:"mac_address,omitempty"`
	// AssignedObjectType is the type of object to which the MAC address is assigned.
	AssignedObjectType constants.ContentType `json:"assigned_object_type,omitempty"`
	// AssignedObjectID is the ID of the object to which the MAC address is assigned.
	AssignedObjectID int `json:"assigned_object_id,omitempty"`
}

type MACAddressOwner interface {
	GetID() int
	GetObjectType() constants.ContentType
	GetAPIPath() constants.APIPath
	GetPrimaryMACAddress() *MACAddress
	SetPrimaryMACAddress(mac *MACAddress)
}

type Manufacturer struct {
	NetboxObject
	// Name of the manufacturer (e.g. Cisco). This field is required.
	Name string `json:"name,omitempty"`
	// URL-friendly unique shorthand. This field is required.
	Slug string `json:"slug,omitempty"`
}

type NetboxObject struct {
	// Netbox's ID of the object.
	ID int `json:"id,omitempty"`
	// List of tags assigned to this object.
	Tags []*Tag `json:"tags,omitempty"`
	// Description represents custom description of the object.
	Description string `json:"description,omitempty"`
	// Array of custom fields, in format customFieldLabel: customFieldValue
	CustomFields map[string]interface{} `json:"custom_fields,omitempty"`
}

type OrphanItem interface {
	GetID() int
	GetObjectType() constants.ContentType
	GetAPIPath() constants.APIPath
	GetNetboxObject() *NetboxObject
}

type Platform struct {
	NetboxObject
	// Name of the platform. This field is required.
	Name string `json:"name,omitempty"`
	// URL-friendly unique shorthand. This field is required.
	Slug string `json:"slug,omitempty"`
	// Manufacturer is the manufacturer of the platform.
	Manufacturer *Manufacturer `json:"manufacturer,omitempty"`
}

type Prefix struct {
	NetboxObject
	// Prefix is a IPv4 or IPv6 network address (with mask). This field is required.
	Prefix string `json:"prefix,omitempty"`
	// Status of the prefix (default "active").
	Status *PrefixStatus `json:"status,omitempty"`

	// Site that this prefix belongs to.
	ScopeID   int                   `json:"scope_id,omitempty"`
	ScopeType constants.ContentType `json:"scope_type,omitempty"`

	// Vlan that this prefix belongs to.
	Vlan *Vlan `json:"vlan,omitempty"`

	// Tenant that this prefix belongs to.
	Tenant *Tenant `json:"tenant,omitempty"`

	Comments string `json:"comments,omitempty"`
}

type PrefixStatus struct {
	Choice
}

type Region struct {
	NetboxObject
	// Name is the name of the region. This field is required.
	Name string `json:"name,omitempty"`
	// Slug is a URL-friendly unique shorthand. This field is required.
	Slug string `json:"slug,omitempty"`
}

type Site struct {
	NetboxObject
	// Full name for the site. This field is required.
	Name string `json:"name,omitempty"`
	// URL-friendly unique shorthand. This field is required.
	Slug string `json:"slug,omitempty"`
	// Site status. This field is required.
	Status *SiteStatus `json:"status,omitempty"`
	// Tenant of the site
	Tenant *Tenant `json:"tenant,omitempty"`

	// Physical location of the building
	PhysicalAddress string `json:"physical_address,omitempty"`

	// Latitude of the site.
	Latitude float64 `json:"latitude,omitempty"`
	// Longitude of the site.
	Longitude float64 `json:"longitude,omitempty"`
}

type SiteGroup struct {
	NetboxObject
	// Name of the site group. This field is required.
	Name string `json:"name,omitempty"`
	// URL-friendly unique shorthand. This field is required.
	Slug string `json:"slug,omitempty"`
	// Parent SiteGroup of the site group
	Parent *SiteGroup `json:"parent,omitempty"`
}

type SiteStatus struct {
	Choice
}

type Tag struct {
	ID          int             `json:"id,omitempty"`
	Name        string          `json:"name,omitempty"`
	Slug        string          `json:"slug,omitempty"`
	Color       constants.Color `json:"color,omitempty"`
	Description string          `json:"description,omitempty"`
}

type Tenant struct {
	NetboxObject
	// Name is the name of the tenant. This field is required.
	Name string `json:"name,omitempty"`
	// Slug is the URL-friendly version of the tenant name. This field is read-only.
	Slug string `json:"slug,omitempty"`
	// Group is the tenant group to which this tenant belongs.
	Group *TenantGroup `json:"group,omitempty"`
}

type TenantGroup struct {
	NetboxObject
	// Name is the name of the tenant group. This field is required.
	Name string `json:"name,omitempty"`
	// Slug is the URL-friendly version of the tenant group name. This field is read-only.
	Slug string `json:"slug,omitempty"`
}

type VDCStatus struct {
	Choice
}

type VM struct {
	NetboxObject
	// Name is the name of the virtual machine. This field is required.
	Name string `json:"name,omitempty"`
	// Status is the status of the virtual machine. This field is required.
	Status *VMStatus `json:"status,omitempty"`
	// Site is the site to which this virtual machine belongs.
	Site *Site `json:"site,omitempty"`
	// Cluster is the cluster to which this virtual machine belongs.
	Cluster *Cluster `json:"cluster,omitempty"`
	// Host is a specific host that this virtual machine is hosted on.
	Host *Device `json:"device,omitempty"`

	// TenantGroup is the datacenter that this virtual machine belongs to.
	TenantGroup *TenantGroup `json:"tenant_group,omitempty"`
	// Tenant is the tenant to which this virtual machine belongs.
	Tenant *Tenant `json:"tenant,omitempty"`

	// Platform is the platform of the virtual machine.
	Platform *Platform `json:"platform,omitempty"`
	// PrimaryIPv4 is the primary IPv4 address assigned to the virtual machine.
	PrimaryIPv4 *IPAddress `json:"primary_ip4,omitempty"`
	// PrimaryIPv6 is the primary IPv6 address assigned to the virtual machine.
	PrimaryIPv6 *IPAddress `json:"primary_ip6,omitempty"`

	// VCPUs is the number of virtual CPUs allocated to the virtual machine.
	VCPUs float32 `json:"vcpus,omitempty"`
	// Memory is the amount of memory allocated to the virtual machine in MB.
	Memory int `json:"memory,omitempty"`
	// Disk is the amount of disk space allocated to the virtual machine in GB.
	Disk int `json:"disk,omitempty"`
	// Role of the virtual machine.
	Role *DeviceRole `json:"role,omitempty"`

	// Additional Comments
	Comments string `json:"comments,omitempty"`
}

type VMInterface struct {
	NetboxObject
	// VM that this interface belongs to. This field is required.
	VM *VM `json:"virtual_machine,omitempty"`
	// Name is the name of the interface. This field is required.
	Name string `json:"name,omitempty"`
	// PrimaryMACAddress is the primary MAC address of the interface.
	PrimaryMACAddress *MACAddress `json:"primary_mac_address,omitempty"`
	// MTU of the interface.
	MTU int `json:"mtu,omitempty"`
	// Enabled is true if interface is enabled, false otherwise.
	Enabled bool `json:"enabled,omitempty"`
	// Related parent interface of this interface.
	ParentInterface *VMInterface `json:"parent,omitempty"`
	// Related bridged interface
	BridgedInterface *VMInterface `json:"bridge,omitempty"`
	// 802.1Q VLAN Tagging Mode
	Mode *VMInterfaceMode `json:"mode,omitempty"`
	// When Mode=VMInterfaceModeTagged: TaggedVlans is a list of all the VLANs that are tagged on the interface.
	TaggedVlans []*Vlan `json:"tagged_vlans,omitempty"`
	// When mode=VMInterfaceModeAccess: UntaggedVlan is the VLAN that is untagged on the interface.
	UntaggedVlan *Vlan `json:"untagged_vlan,omitempty"`
}

type VMInterfaceMode struct {
	Choice
}

type VMStatus struct {
	Choice
}

type VidRange [2]int

type VirtualDeviceContext struct {
	NetboxObject
	// Name of the VirtualDeviceContext. This field is required.
	Name string `json:"name,omitempty"`
	// Device that VirtualDeviceContext belongs to. This field is required.
	Device *Device `json:"device,omitempty"`
	// Status of the VirtualDeviceContext. This field is required.
	Status *VDCStatus `json:"status,omitempty"`
	// Unique identifier for VirtualDeviceContext within Single Device.
	Identifier int `json:"identifier,omitempty"`
	// Tenant for this VirtualDeviceContext.
	Tenant *Tenant `json:"tenant,omitempty"`
	// Primary IPv4 for VirtualDeviceContext.
	PrimaryIPv4 *IPAddress `json:"primary_ipv4,omitempty"`
	// Primary IPv6 for VirtualDeviceContext.
	PrimaryIPv6 *IPAddress `json:"primary_ipv6,omitempty"`
}

type VirtualDisk struct {
	NetboxObject
	// VM that this disk belongs to. This field is required.
	VM *VM `json:"virtual_machine,omitempty"`
	// Name is the name of the disk. This field is required.
	Name string `json:"name,omitempty"`
	// Size is the size of the disk in MB. This field is required.
	Size int `json:"size,omitempty"`
}

type Vlan struct {
	NetboxObject
	// Name of the VLAN. This field is required.
	Name string `json:"name,omitempty"`
	// VID of the VLAN. This field is required.
	Vid int `json:"vid,omitempty"`
	// VlanGroup that this vlan belongs to.
	Group *VlanGroup `json:"group,omitempty"`
	// Status of the VLAN. This field is required. Default is "active".
	Status *VlanStatus `json:"status,omitempty"`
	// Tenant that this VLAN belongs to.
	Tenant *Tenant `json:"tenant,omitempty"`
	// Site that this VLAN belongs to.
	Site *Site `json:"site,omitempty"`
	// Comments about this Vlan.
	Comments string `json:"comments,omitempty"`
}

type VlanGroup struct {
	NetboxObject
	// Name of the VlanGroup. This field is required.
	Name string `json:"name,omitempty"`
	// Slug of the VlanGroup. This field is required.
	Slug string `json:"slug,omitempty"`
	// VidRanges is a list of VID ranges that this VlanGroup can use.
	VidRanges []VidRange `json:"vid_ranges,omitempty"`
	// ScopeType is the scope of the VlanGroup.
	ScopeType constants.ContentType `json:"scope_type,omitempty"`
	// ScopeID is the ID of the scope object.
	ScopeID int `json:"scope_id,omitempty"`
}

type VlanStatus struct {
	Choice
}

type WirelessLAN struct {
	NetboxObject
	// SSID is the name of the wireless lan. This field is required.
	SSID string `json:"ssid,omitempty"`
	// Vlan that the wireless lan is associated with.
	Vlan *Vlan `json:"vlan,omitempty"`
	// Group is the group of the wireless lan.
	Group *WirelessLANGroup `json:"group,omitempty"`
	// Status is the status of the wireless lan. This field is required.
	Status *WirelessLANStatus `json:"status,omitempty"`
	// Tenant of the wireless lan.
	Tenant *Tenant `json:"tenant,omitempty"`
	// AuthType is the authentication type of the wireless lan.
	AuthType *WirelessLANAuthType `json:"auth_type,omitempty"`
	// AuthCipher is the authentication cipher of the wireless lan.
	AuthCipher *WirelessLANAuthCipher `json:"auth_cipher,omitempty"`
	// AuthPsk is the pre-shared key of the wireless lan.
	AuthPsk string `json:"auth_psk,omitempty"`
	// Comments is the comments about the wireless lan.
	Comments string `json:"comments,omitempty"`
}

type WirelessLANAuthCipher struct {
	Choice
}

type WirelessLANAuthType struct {
	Choice
}

type WirelessLANGroup struct {
	NetboxObject
	// Name is the name of the wireless lan group. This field is required.
	Name string `json:"name,omitempty"`
	// Slug is the slug of the wireless lan group. This field is required.
	Slug string `json:"slug,omitempty"`
	// Parent is the parent wireless lan group.
	Parent *WirelessLANGroup `json:"parent,omitempty"`
}

type WirelessLANStatus struct {
	Choice
}