Module netbox

  • License: Inmanta EULA

  • Version: 3.7.1

Typedefs

typedef netbox::common::label_t

  • Base type string

  • Type constraint (std::length(self) <= 100)

typedef netbox::common::mtu_t

  • Base type int

  • Type constraint ((self >= 1) and (self <= 65536))

typedef netbox::common::name_1_100_t

  • Base type string

  • Type constraint ((std::length(self) >= 1) and (std::length(self) <= 100))

typedef netbox::common::name_1_64_t

  • Base type string

  • Type constraint ((std::length(self) >= 1) and (std::length(self) <= 64))

typedef netbox::common::pos_int32_t

  • Base type int

  • Type constraint ((self >= 0) and (self <= 2147483647))

typedef netbox::common::rack_size_t

  • Base type int

  • Type constraint ((self >= 0) and (self <= 32767))

typedef netbox::common::slug_t

  • Base type string

  • Type constraint ((std::validate_type('pydantic.constr',self,{'regex': '^[-a-zA-Z0-9_]+$'}) and (std::length(self) >= 1)) and (std::length(self) <= 100))

typedef netbox::common::string_200_t

  • Base type string

  • Type constraint (std::length(self) <= 200)

typedef netbox::common::string_50_t

  • Base type string

  • Type constraint (std::length(self) <= 50)

typedef netbox::common::string_64_t

  • Base type string

  • Type constraint (std::length(self) <= 64)

typedef netbox::common::unsigned_int8_t

  • Base type int

  • Type constraint ((self >= 0) and (self <= 255))

typedef netbox::common::vlan_id_t

  • Base type int

  • Type constraint ((self >= 1) and (self <= 4094))

typedef netbox::resources::writable_cable_request::color

  • Base type string

  • Type constraint (std::validate_type('pydantic.constr',self,{'regex': '^[0-9a-f]{6}$'}) and (std::length(self) <= 6))

typedef netbox::resources::writable_cable_request::length_unit

  • Base type string

  • Type constraint (self in ['km', 'm', 'cm', 'mi', 'ft', 'in', ''])

typedef netbox::resources::writablevlan_request::status

  • Base type string

  • Type constraint (self in ['active', 'reserved', 'deprecated'])

typedef netbox::resources::writablel2vpn_request::type

  • Base type string

  • Type constraint (self in ['vpws', 'vpls', 'vxlan', 'vxlan-evpn', 'mpls-evpn', 'pbb-evpn', 'epl', 'evpl', 'ep-lan', 'evp-lan', 'ep-tree', 'evp-tree'])

typedef netbox::resources::writable_custom_field_request::filter_logic

  • Base type string

  • Type constraint (self in ['disabled', 'loose', 'exact'])

typedef netbox::resources::writable_custom_field_request::maximum_value

  • Base type int

  • Type constraint ((self >= -9223372036854775808) and (self <= 9223372036854775807))

typedef netbox::resources::writable_custom_field_request::minimum_value

  • Base type int

  • Type constraint ((self >= -9223372036854775808) and (self <= 9223372036854775807))

typedef netbox::resources::writable_custom_field_request::name

  • Base type string

  • Type constraint ((std::validate_type('pydantic.constr',self,{'regex': '^[a-z0-9_]+$'}) and (std::length(self) >= 1)) and (std::length(self) <= 50))

typedef netbox::resources::writable_custom_field_request::ui_editable

  • Base type string

  • Type constraint (self in ['yes', 'no', 'hidden'])

typedef netbox::resources::writable_custom_field_request::ui_visible

  • Base type string

  • Type constraint (self in ['always', 'if-set', 'hidden'])

typedef netbox::resources::writable_custom_field_request::validation_regex

  • Base type string

  • Type constraint (std::length(self) <= 500)

typedef netbox::resources::writable_device_with_config_context_request::airflow

  • Base type string

  • Type constraint (self in ['front-to-rear', 'rear-to-front', 'left-to-right', 'right-to-left', 'side-to-rear', 'passive', 'mixed', ''])

typedef netbox::resources::writable_device_type_request::parent_child_status

  • Base type string

  • Type constraint (self in ['parent', 'child', ''])

typedef netbox::resources::writable_rack_request::weight_unit

  • Base type string

  • Type constraint (self in ['kg', 'g', 'lb', 'oz', ''])

typedef netbox::resources::writable_device_with_config_context_request::rack_face

  • Base type string

  • Type constraint (self in ['front', 'rear', ''])

typedef netbox::resources::writable_interface_request::duplex

  • Base type string

  • Type constraint (self in ['half', 'full', 'auto', ''])

typedef netbox::resources::writablevm_interface_request::mode

  • Base type string

  • Type constraint (self in ['access', 'tagged', 'tagged-all', ''])

typedef netbox::resources::writable_interface_request::poe_mode

  • Base type string

  • Type constraint (self in ['pd', 'pse', ''])

typedef netbox::resources::writable_interface_request::poe_type

  • Base type string

  • Type constraint (self in ['type1-ieee802.3af', 'type2-ieee802.3at', 'type3-ieee802.3bt', 'type4-ieee802.3bt', 'passive-24v-2pair', 'passive-24v-4pair', 'passive-48v-2pair', 'passive-48v-4pair', ''])

typedef netbox::resources::writable_interface_request::transmit_power__d_bm_

  • Base type int

  • Type constraint ((self >= 0) and (self <= 127))

typedef netbox::resources::writable_interface_request::wireless_channel

  • Base type string

  • Type constraint (self in ['2.4g-1-2412-22', '2.4g-2-2417-22', '2.4g-3-2422-22', '2.4g-4-2427-22', '2.4g-5-2432-22', '2.4g-6-2437-22', '2.4g-7-2442-22', '2.4g-8-2447-22', '2.4g-9-2452-22', '2.4g-10-2457-22', '2.4g-11-2462-22', '2.4g-12-2467-22', '2.4g-13-2472-22', '5g-32-5160-20', '5g-34-5170-40', '5g-36-5180-20', '5g-38-5190-40', '5g-40-5200-20', '5g-42-5210-80', '5g-44-5220-20', '5g-46-5230-40', '5g-48-5240-20', '5g-50-5250-160', '5g-52-5260-20', '5g-54-5270-40', '5g-56-5280-20', '5g-58-5290-80', '5g-60-5300-20', '5g-62-5310-40', '5g-64-5320-20', '5g-100-5500-20', '5g-102-5510-40', '5g-104-5520-20', '5g-106-5530-80', '5g-108-5540-20', '5g-110-5550-40', '5g-112-5560-20', '5g-114-5570-160', '5g-116-5580-20', '5g-118-5590-40', '5g-120-5600-20', '5g-122-5610-80', '5g-124-5620-20', '5g-126-5630-40', '5g-128-5640-20', '5g-132-5660-20', '5g-134-5670-40', '5g-136-5680-20', '5g-138-5690-80', '5g-140-5700-20', '5g-142-5710-40', '5g-144-5720-20', '5g-149-5745-20', '5g-151-5755-40', '5g-153-5765-20', '5g-155-5775-80', '5g-157-5785-20', '5g-159-5795-40', '5g-161-5805-20', '5g-163-5815-160', '5g-165-5825-20', '5g-167-5835-40', '5g-169-5845-20', '5g-171-5855-80', '5g-173-5865-20', '5g-175-5875-40', '5g-177-5885-20', '6g-1-5955-20', '6g-3-5965-40', '6g-5-5975-20', '6g-7-5985-80', '6g-9-5995-20', '6g-11-6005-40', '6g-13-6015-20', '6g-15-6025-160', '6g-17-6035-20', '6g-19-6045-40', '6g-21-6055-20', '6g-23-6065-80', '6g-25-6075-20', '6g-27-6085-40', '6g-29-6095-20', '6g-31-6105-320', '6g-33-6115-20', '6g-35-6125-40', '6g-37-6135-20', '6g-39-6145-80', '6g-41-6155-20', '6g-43-6165-40', '6g-45-6175-20', '6g-47-6185-160', '6g-49-6195-20', '6g-51-6205-40', '6g-53-6215-20', '6g-55-6225-80', '6g-57-6235-20', '6g-59-6245-40', '6g-61-6255-20', '6g-65-6275-20', '6g-67-6285-40', '6g-69-6295-20', '6g-71-6305-80', '6g-73-6315-20', '6g-75-6325-40', '6g-77-6335-20', '6g-79-6345-160', '6g-81-6355-20', '6g-83-6365-40', '6g-85-6375-20', '6g-87-6385-80', '6g-89-6395-20', '6g-91-6405-40', '6g-93-6415-20', '6g-95-6425-320', '6g-97-6435-20', '6g-99-6445-40', '6g-101-6455-20', '6g-103-6465-80', '6g-105-6475-20', '6g-107-6485-40', '6g-109-6495-20', '6g-111-6505-160', '6g-113-6515-20', '6g-115-6525-40', '6g-117-6535-20', '6g-119-6545-80', '6g-121-6555-20', '6g-123-6565-40', '6g-125-6575-20', '6g-129-6595-20', '6g-131-6605-40', '6g-133-6615-20', '6g-135-6625-80', '6g-137-6635-20', '6g-139-6645-40', '6g-141-6655-20', '6g-143-6665-160', '6g-145-6675-20', '6g-147-6685-40', '6g-149-6695-20', '6g-151-6705-80', '6g-153-6715-20', '6g-155-6725-40', '6g-157-6735-20', '6g-159-6745-320', '6g-161-6755-20', '6g-163-6765-40', '6g-165-6775-20', '6g-167-6785-80', '6g-169-6795-20', '6g-171-6805-40', '6g-173-6815-20', '6g-175-6825-160', '6g-177-6835-20', '6g-179-6845-40', '6g-181-6855-20', '6g-183-6865-80', '6g-185-6875-20', '6g-187-6885-40', '6g-189-6895-20', '6g-193-6915-20', '6g-195-6925-40', '6g-197-6935-20', '6g-199-6945-80', '6g-201-6955-20', '6g-203-6965-40', '6g-205-6975-20', '6g-207-6985-160', '6g-209-6995-20', '6g-211-7005-40', '6g-213-7015-20', '6g-215-7025-80', '6g-217-7035-20', '6g-219-7045-40', '6g-221-7055-20', '6g-225-7075-20', '6g-227-7085-40', '6g-229-7095-20', '6g-233-7115-20', '60g-1-58320-2160', '60g-2-60480-2160', '60g-3-62640-2160', '60g-4-64800-2160', '60g-5-66960-2160', '60g-6-69120-2160', '60g-9-59400-4320', '60g-10-61560-4320', '60g-11-63720-4320', '60g-12-65880-4320', '60g-13-68040-4320', '60g-17-60480-6480', '60g-18-62640-6480', '60g-19-64800-6480', '60g-20-66960-6480', '60g-25-61560-6480', '60g-26-63720-6480', '60g-27-65880-6480', ''])

typedef netbox::resources::writable_interface_request::wireless_role

  • Base type string

  • Type constraint (self in ['ap', 'station', ''])

typedef netbox::resources::writable_prefix_request::prefix

  • Base type string

  • Type constraint (std::length(self) >= 1)

typedef netbox::resources::writable_rack_request::height__u_

  • Base type int

  • Type constraint ((self >= 1) and (self <= 100))

typedef netbox::resources::writable_rack_request::outer_unit

  • Base type string

  • Type constraint (self in ['mm', 'in', ''])

typedef netbox::resources::writable_rack_request::starting_unit

  • Base type int

  • Type constraint ((self >= 1) and (self <= 32767))

typedef netbox::resources::writable_rack_request::width

  • Base type int

  • Type constraint (((self in [10, 19, 21, 23]) and (self >= 0)) and (self <= 32767))

typedef netbox::resources::writableip_address_request::address

  • Base type string

  • Type constraint (std::length(self) >= 1)

typedef netbox::resources::writableip_address_request::dns_name

  • Base type string

  • Type constraint (std::validate_type('pydantic.constr',self,{'regex': '^([0-9A-Za-z_-]+|\\*)(\\.[0-9A-Za-z_-]+)*\\.?$'}) and (std::length(self) <= 255))

typedef netbox::resources::writableip_address_request::role

  • Base type string

  • Type constraint (self in ['loopback', 'secondary', 'anycast', 'vip', 'vrrp', 'hsrp', 'glbp', 'carp', ''])

typedef netbox::resources::writablel2vpn_request::identifier

  • Base type int

  • Type constraint ((self >= -9223372036854775808) and (self <= 9223372036854775807))

typedef netbox::resources::writablevm_interface_request::mac_address

  • Base type string

  • Type constraint (std::length(self) >= 1)

typedef netbox::resources::writablevrf_request::route_distinguisher

  • Base type string

  • Type constraint (std::length(self) <= 21)

Entities

entity netbox::AbstractDevice

Parents: netbox::Resource

relation netbox::PrimaryIP inmanta_primary_ip [0:2]

other end: netbox::PrimaryIP.device [1]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::Credentials

Parents: std::Entity

Credentials used to communicate with netbox instance.

attribute string url

Base url to netbox instance

attribute string? api_token=null

Netbox token

attribute string? api_token_env_var=null

Name of environment variable with netbox token, used when api_token is not set

attribute bool agent_autostart=true

Configure default local agent for resources using this credentials

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::PrimaryIP

Parents: netbox::Resource

attribute int version
relation netbox::resources::IPAddress ip [1]
relation netbox::AbstractDevice device [1]

other end: netbox::AbstractDevice.inmanta_primary_ip [0:2]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::Resource

Parents: std::PurgeableResource, std::ManagedResource

Base entity for all netbox resources.

attribute bool send_event=true
relation netbox::Credentials credentials [1]

Relation to the credentials that give us access to the netbox api in which the resources should be managed.

entity netbox::ResourceWithCompatibilityBody

Parents: std::Entity

Base entity for resource which implement a custom “get_compatibility_body” method. This method allows to create/update the resource using a different format of body than what the handler was initially written for, but that is required to use for older versions of netbox.

By default, the handler will always try first with the current implementation, and if it fails, it will fallback to the compatibility body. If use_compatibilty_body is set to true, it skips the attempts with the current implementation and directly uses the compatibility body.

attribute bool use_compatibility_body=false

Whether to skip the attempt with the latest netbox body and directly use the compatibility body.

entity netbox::common::NestedConfigTemplateRequest

Parents: std::Entity

Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniquely identify the related object. This class should be subclassed to return a full representation of the related object on read.

attribute netbox::common::name_1_100_t? name=null

The following implements statements select implementations for this entity:

entity netbox::resources::Cluster

Parents: netbox::Resource, netbox::resources::IVlanGroup_scope

Adds support for custom fields and tags.

attribute string? comments=null
attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute int? group_id=null
attribute netbox::common::name_1_100_t name
attribute int? site_id=null
attribute netbox::resources::writable_cluster_request::status? status=null

  • planned - Planned * staging - Staging * active - Active * decommissioning - Decommissioning * offline - Offline

attribute int? tenant_id=null
Rel group:
rel site:
rel tenant:
rel type:

relation netbox::resources::ClusterGroup group [0:1]

other end: netbox::resources::ClusterGroup.clusters [0:*]

relation netbox::resources::Site site [0:1]

other end: netbox::resources::Site.clusters [0:*]

relation netbox::resources::Tenant tenant [0:1]

other end: netbox::resources::Tenant.clusters [0:*]

relation netbox::resources::ClusterType type [1]

other end: netbox::resources::ClusterType.clusters [0:*]

relation netbox::resources::Device devices [0:*]

other end: netbox::resources::Device.cluster [0:1]

relation netbox::resources::VirtualMachine virtual_machines [0:*]

other end: netbox::resources::VirtualMachine.cluster [0:1]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::ClusterGroup

Parents: netbox::Resource, netbox::resources::IVlanGroup_scope

Adds support for custom fields and tags.

attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute netbox::common::name_1_100_t? name=null
attribute netbox::common::slug_t slug
relation netbox::resources::Cluster clusters [0:*]

other end: netbox::resources::Cluster.group [0:1]

The following implements statements select implementations for this entity:

entity netbox::resources::ClusterType

Parents: netbox::Resource

Adds support for custom fields and tags.

attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute netbox::common::name_1_100_t? name=null
attribute netbox::common::slug_t slug
relation netbox::resources::Cluster clusters [0:*]

other end: netbox::resources::Cluster.type [1]

The following implements statements select implementations for this entity:

entity netbox::resources::CustomField

Parents: netbox::Resource

Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)

attribute int? choice_set=null
attribute string[]? content_types=null
attribute dict? default=null

Default value for the field (must be a JSON value). Encapsulate strings with double quotes (e.g. “Foo”).

attribute netbox::common::string_200_t? description=null
attribute netbox::resources::writable_custom_field_request::filter_logic? filter_logic=null

Loose matches any instance of a given string; exact matches the entire field. * disabled - Disabled * loose - Loose * exact - Exact

attribute netbox::common::string_50_t? group_name=null
attribute bool? is_cloneable=null

Replicate this value when cloning objects

attribute netbox::common::string_50_t? label=null
attribute netbox::resources::writable_custom_field_request::name name

Internal field name

attribute string? object_type=null
attribute bool? required=null

If true, this field is required when creating new objects or editing an existing object.

attribute netbox::common::rack_size_t? search_weight=null

Outer dimension of rack

attribute netbox::resources::writable_custom_field_request::type? type=null

The type of data this custom field holds * text - Text * longtext - Text (long) * integer - Integer * decimal - Decimal * boolean - Boolean (true/false) * date - Date * datetime - Date & time * url - URL * json - JSON * select - Selection * multiselect - Multiple selection * object - Object * multiobject - Multiple objects

attribute netbox::resources::writable_custom_field_request::ui_editable? ui_editable=null

Specifies whether the custom field value can be edited in the UI * yes - Yes * no - No * hidden - Hidden

attribute netbox::resources::writable_custom_field_request::ui_visible? ui_visible=null

Specifies whether the custom field is displayed in the UI * always - Always * if-set - If set * hidden - Hidden

attribute netbox::resources::writable_custom_field_request::maximum_value? validation_maximum=null

Maximum allowed value (for numeric fields)

attribute netbox::resources::writable_custom_field_request::minimum_value? validation_minimum=null

Minimum allowed value (for numeric fields)

attribute netbox::resources::writable_custom_field_request::validation_regex? validation_regex=null

Regular expression to enforce on text field values. Use ^ and $ to force matching of entire string. For example, <code>^[A-Z]{3}$</code> will limit values to exactly three uppercase letters.

attribute netbox::common::rack_size_t? weight=null

Outer dimension of rack

The following implements statements select implementations for this entity:

entity netbox::resources::Device

Parents: netbox::AbstractDevice

Adds support for custom fields and tags.

attribute netbox::resources::writable_device_with_config_context_request::airflow? airflow=null

  • front-to-rear - Front to rear * rear-to-front - Rear to front * left-to-right - Left to right * right-to-left - Right to left * side-to-rear - Side to rear * passive - Passive * mixed - Mixed

attribute netbox::common::string_50_t? asset_tag=null
attribute int? cluster_id=null
attribute string? comments=null
attribute int? config_template=null
attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute int? device_type_id=null
attribute netbox::resources::writable_device_with_config_context_request::rack_face? face=null

  • front - Front * rear - Rear

attribute number? latitude=null

GPS coordinate in decimal format (xx.yyyyyy)

attribute dict? local_context_data=null

Local config context data takes precedence over source contexts in the final rendered config context

attribute int? location=null
attribute number? longitude=null

GPS coordinate in decimal format (xx.yyyyyy)

attribute netbox::common::string_64_t name
attribute int? oob_ip=null
attribute int? platform=null
attribute number? position=null
attribute int? primary_ip4_id=null
attribute int? primary_ip6_id=null
attribute int? rack_id=null
attribute int? role_id=null
attribute netbox::common::string_50_t? serial=null
attribute int? site_id=null
attribute netbox::resources::writable_device_with_config_context_request::status? status=null

  • offline - Offline * active - Active * planned - Planned * staged - Staged * failed - Failed * inventory - Inventory * decommissioning - Decommissioning

attribute int? tenant_id=null
attribute netbox::common::unsigned_int8_t? vc_position=null
attribute netbox::common::unsigned_int8_t? vc_priority=null
attribute int? virtual_chassis=null
Rel cluster:
rel device_type:
rel primary_ip4:
rel primary_ip6:
rel rack:
rel role:
rel site:
rel tenant:

relation netbox::resources::Cluster cluster [0:1]

other end: netbox::resources::Cluster.devices [0:*]

relation netbox::resources::DeviceType device_type [0:1]

other end: netbox::resources::DeviceType.instances [0:*]

relation netbox::resources::IPAddress primary_ip4 [0:1]
relation netbox::resources::IPAddress primary_ip6 [0:1]
relation netbox::resources::Rack rack [0:1]

other end: netbox::resources::Rack.devices [0:*]

relation netbox::resources::DeviceRole role [0:1]

other end: netbox::resources::DeviceRole.devices [0:*]

relation netbox::resources::Site site [0:1]

other end: netbox::resources::Site.devices [0:*]

relation netbox::resources::Tenant tenant [0:1]

other end: netbox::resources::Tenant.devices [0:*]

relation netbox::resources::Interface interfaces [0:*]

other end: netbox::resources::Interface.device [1]

relation netbox::resources::VirtualMachine virtual_machines [0:*]

other end: netbox::resources::VirtualMachine.device [0:1]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::DeviceRole

Parents: netbox::Resource

Adds support for custom fields and tags.

attribute netbox::resources::device_role_request::color? color=null
attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute netbox::common::name_1_100_t? name=null
attribute netbox::common::slug_t slug
attribute bool? vm_role=null

Virtual machines may be assigned to this role :rel config_template:

relation netbox::resources::Device devices [0:*]

other end: netbox::resources::Device.role [0:1]

relation netbox::resources::device_role_request::ConfigTemplate config_template [0:1]
relation netbox::resources::VirtualMachine virtual_machines [0:*]

other end: netbox::resources::VirtualMachine.role [0:1]

The following implements statements select implementations for this entity:

entity netbox::resources::DeviceType

Parents: netbox::Resource

Adds support for custom fields and tags.

attribute netbox::resources::writable_device_type_request::airflow? airflow=null

  • front-to-rear - Front to rear * rear-to-front - Rear to front * left-to-right - Left to right * right-to-left - Right to left * side-to-rear - Side to rear * passive - Passive * mixed - Mixed

attribute string? comments=null
attribute dict? custom_fields=null
attribute int? default_platform=null
attribute netbox::common::string_200_t? description=null
attribute bool? exclude_from_utilization=null

Devices of this type are excluded when calculating rack utilization.

attribute string? front_image=null
attribute bool? is_full_depth=null

Device consumes both front and rear rack faces.

attribute int? manufacturer_id=null
attribute netbox::common::name_1_100_t? model=null
attribute netbox::common::string_50_t? part_number=null
attribute string? rear_image=null
attribute netbox::common::slug_t slug
attribute netbox::resources::writable_device_type_request::parent_child_status? subdevice_role=null

Parent devices house child devices in device bays. Leave blank if this device type is neither a parent nor a child. * parent - Parent * child - Child

attribute number? u_height=null
attribute number? weight=null
attribute netbox::resources::writable_device_type_request::weight_unit? weight_unit=null

  • kg - Kilograms * g - Grams * lb - Pounds * oz - Ounces :rel manufacturer:

relation netbox::resources::Device instances [0:*]

other end: netbox::resources::Device.device_type [0:1]

relation netbox::resources::Manufacturer manufacturer [0:1]

other end: netbox::resources::Manufacturer.device_types [0:*]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::IIPAddress_assigned_object

Parents: std::Entity

Shared superclass for all entities that can be referred by netbox::resources::IPAddress.assigned_object

Rel addresses:

relation netbox::resources::IPAddress addresses [0:*]

other end: netbox::resources::IPAddress.assigned_object [1]

entity netbox::resources::IL2VPNTermination_assigned_object

Parents: std::Entity

Shared superclass for all entities that can be referred by netbox::resources::L2VPNTermination.assigned_object

Rel l2vpn_termination:

relation netbox::resources::L2VPNTermination l2vpn_termination [0:*]

other end: netbox::resources::L2VPNTermination.assigned_object [1]

entity netbox::resources::IPAddress

Parents: netbox::Resource

Adds support for custom fields and tags.

attribute netbox::resources::writableip_address_request::address address
attribute string? comments=null
attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute netbox::resources::writableip_address_request::dns_name? dns_name=null

Hostname or FQDN (not case-sensitive)

attribute int? nat_inside=null

The IP for which this address is the “outside” IP

attribute netbox::resources::writableip_address_request::role? role=null

The functional role of this IP * loopback - Loopback * secondary - Secondary * anycast - Anycast * vip - VIP * vrrp - VRRP * hsrp - HSRP * glbp - GLBP * carp - CARP

attribute netbox::resources::writableip_address_request::status? status=null

The operational status of this IP * active - Active * reserved - Reserved * deprecated - Deprecated * dhcp - DHCP * slaac - SLAAC

attribute int? tenant_id=null
attribute int? vrf_id=null
Rel assigned_object:
rel tenant:
rel vrf:

relation netbox::resources::IIPAddress_assigned_object assigned_object [1]

other end: netbox::resources::IIPAddress_assigned_object.addresses [0:*]

relation netbox::resources::Tenant tenant [0:1]

other end: netbox::resources::Tenant.addresses [0:*]

relation netbox::resources::VRF vrf [0:1]

other end: netbox::resources::VRF.addresses [0:*]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::IVlanGroup_scope

Parents: std::Entity

Shared superclass for all entities that can be referred by netbox::resources::VlanGroup.scope

Rel vlan_group:

relation netbox::resources::VlanGroup vlan_group [0:*]

other end: netbox::resources::VlanGroup.scope [1]

entity netbox::resources::Interface

Parents: netbox::Resource, netbox::resources::IL2VPNTermination_assigned_object, netbox::resources::IIPAddress_assigned_object

Adds support for custom fields and tags.

attribute int? bridge_id=null
attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute netbox::resources::writable_interface_request::duplex? duplex=null

  • half - Half * full - Full * auto - Auto

attribute bool? enabled=null
attribute netbox::common::string_64_t? label=null
attribute int? lag_id=null
attribute string? mac_address=null
attribute bool? mark_connected=null

Treat as if a cable is connected

attribute bool? mgmt_only=null

This interface is used only for out-of-band management

attribute netbox::resources::writable_interface_request::mode? mode=null

IEEE 802.1Q tagging strategy * access - Access * tagged - Tagged * tagged-all - Tagged (All)

attribute int? module=null
attribute netbox::common::mtu_t? mtu=null
attribute netbox::common::name_1_64_t name
attribute int? parent_id=null
attribute netbox::resources::writable_interface_request::poe_mode? poe_mode=null

  • pd - PD * pse - PSE

attribute netbox::resources::writable_interface_request::poe_type? poe_type=null

  • type1-ieee802.3af - 802.3af (Type 1) * type2-ieee802.3at - 802.3at (Type 2) * type3-ieee802.3bt - 802.3bt (Type 3) * type4-ieee802.3bt - 802.3bt (Type 4) * passive-24v-2pair - Passive 24V (2-pair) * passive-24v-4pair - Passive 24V (4-pair) * passive-48v-2pair - Passive 48V (2-pair) * passive-48v-4pair - Passive 48V (4-pair)

attribute netbox::resources::writable_interface_request::wireless_channel? rf_channel=null

  • 2.4g-1-2412-22 - 1 (2412 MHz) * 2.4g-2-2417-22 - 2 (2417 MHz) * 2.4g-3-2422-22 - 3 (2422 MHz) * 2.4g-4-2427-22 - 4 (2427 MHz) * 2.4g-5-2432-22 - 5 (2432 MHz) * 2.4g-6-2437-22 - 6 (2437 MHz) * 2.4g-7-2442-22 - 7 (2442 MHz) * 2.4g-8-2447-22 - 8 (2447 MHz) * 2.4g-9-2452-22 - 9 (2452 MHz) * 2.4g-10-2457-22 - 10 (2457 MHz) * 2.4g-11-2462-22 - 11 (2462 MHz) * 2.4g-12-2467-22 - 12 (2467 MHz) * 2.4g-13-2472-22 - 13 (2472 MHz) * 5g-32-5160-20 - 32 (5160/20 MHz) * 5g-34-5170-40 - 34 (5170/40 MHz) * 5g-36-5180-20 - 36 (5180/20 MHz) * 5g-38-5190-40 - 38 (5190/40 MHz) * 5g-40-5200-20 - 40 (5200/20 MHz) * 5g-42-5210-80 - 42 (5210/80 MHz) * 5g-44-5220-20 - 44 (5220/20 MHz) * 5g-46-5230-40 - 46 (5230/40 MHz) * 5g-48-5240-20 - 48 (5240/20 MHz) * 5g-50-5250-160 - 50 (5250/160 MHz) * 5g-52-5260-20 - 52 (5260/20 MHz) * 5g-54-5270-40 - 54 (5270/40 MHz) * 5g-56-5280-20 - 56 (5280/20 MHz) * 5g-58-5290-80 - 58 (5290/80 MHz) * 5g-60-5300-20 - 60 (5300/20 MHz) * 5g-62-5310-40 - 62 (5310/40 MHz) * 5g-64-5320-20 - 64 (5320/20 MHz) * 5g-100-5500-20 - 100 (5500/20 MHz) * 5g-102-5510-40 - 102 (5510/40 MHz) * 5g-104-5520-20 - 104 (5520/20 MHz) * 5g-106-5530-80 - 106 (5530/80 MHz) * 5g-108-5540-20 - 108 (5540/20 MHz) * 5g-110-5550-40 - 110 (5550/40 MHz) * 5g-112-5560-20 - 112 (5560/20 MHz) * 5g-114-5570-160 - 114 (5570/160 MHz) * 5g-116-5580-20 - 116 (5580/20 MHz) * 5g-118-5590-40 - 118 (5590/40 MHz) * 5g-120-5600-20 - 120 (5600/20 MHz) * 5g-122-5610-80 - 122 (5610/80 MHz) * 5g-124-5620-20 - 124 (5620/20 MHz) * 5g-126-5630-40 - 126 (5630/40 MHz) * 5g-128-5640-20 - 128 (5640/20 MHz) * 5g-132-5660-20 - 132 (5660/20 MHz) * 5g-134-5670-40 - 134 (5670/40 MHz) * 5g-136-5680-20 - 136 (5680/20 MHz) * 5g-138-5690-80 - 138 (5690/80 MHz) * 5g-140-5700-20 - 140 (5700/20 MHz) * 5g-142-5710-40 - 142 (5710/40 MHz) * 5g-144-5720-20 - 144 (5720/20 MHz) * 5g-149-5745-20 - 149 (5745/20 MHz) * 5g-151-5755-40 - 151 (5755/40 MHz) * 5g-153-5765-20 - 153 (5765/20 MHz) * 5g-155-5775-80 - 155 (5775/80 MHz) * 5g-157-5785-20 - 157 (5785/20 MHz) * 5g-159-5795-40 - 159 (5795/40 MHz) * 5g-161-5805-20 - 161 (5805/20 MHz) * 5g-163-5815-160 - 163 (5815/160 MHz) * 5g-165-5825-20 - 165 (5825/20 MHz) * 5g-167-5835-40 - 167 (5835/40 MHz) * 5g-169-5845-20 - 169 (5845/20 MHz) * 5g-171-5855-80 - 171 (5855/80 MHz) * 5g-173-5865-20 - 173 (5865/20 MHz) * 5g-175-5875-40 - 175 (5875/40 MHz) * 5g-177-5885-20 - 177 (5885/20 MHz) * 6g-1-5955-20 - 1 (5955/20 MHz) * 6g-3-5965-40 - 3 (5965/40 MHz) * 6g-5-5975-20 - 5 (5975/20 MHz) * 6g-7-5985-80 - 7 (5985/80 MHz) * 6g-9-5995-20 - 9 (5995/20 MHz) * 6g-11-6005-40 - 11 (6005/40 MHz) * 6g-13-6015-20 - 13 (6015/20 MHz) * 6g-15-6025-160 - 15 (6025/160 MHz) * 6g-17-6035-20 - 17 (6035/20 MHz) * 6g-19-6045-40 - 19 (6045/40 MHz) * 6g-21-6055-20 - 21 (6055/20 MHz) * 6g-23-6065-80 - 23 (6065/80 MHz) * 6g-25-6075-20 - 25 (6075/20 MHz) * 6g-27-6085-40 - 27 (6085/40 MHz) * 6g-29-6095-20 - 29 (6095/20 MHz) * 6g-31-6105-320 - 31 (6105/320 MHz) * 6g-33-6115-20 - 33 (6115/20 MHz) * 6g-35-6125-40 - 35 (6125/40 MHz) * 6g-37-6135-20 - 37 (6135/20 MHz) * 6g-39-6145-80 - 39 (6145/80 MHz) * 6g-41-6155-20 - 41 (6155/20 MHz) * 6g-43-6165-40 - 43 (6165/40 MHz) * 6g-45-6175-20 - 45 (6175/20 MHz) * 6g-47-6185-160 - 47 (6185/160 MHz) * 6g-49-6195-20 - 49 (6195/20 MHz) * 6g-51-6205-40 - 51 (6205/40 MHz) * 6g-53-6215-20 - 53 (6215/20 MHz) * 6g-55-6225-80 - 55 (6225/80 MHz) * 6g-57-6235-20 - 57 (6235/20 MHz) * 6g-59-6245-40 - 59 (6245/40 MHz) * 6g-61-6255-20 - 61 (6255/20 MHz) * 6g-65-6275-20 - 65 (6275/20 MHz) * 6g-67-6285-40 - 67 (6285/40 MHz) * 6g-69-6295-20 - 69 (6295/20 MHz) * 6g-71-6305-80 - 71 (6305/80 MHz) * 6g-73-6315-20 - 73 (6315/20 MHz) * 6g-75-6325-40 - 75 (6325/40 MHz) * 6g-77-6335-20 - 77 (6335/20 MHz) * 6g-79-6345-160 - 79 (6345/160 MHz) * 6g-81-6355-20 - 81 (6355/20 MHz) * 6g-83-6365-40 - 83 (6365/40 MHz) * 6g-85-6375-20 - 85 (6375/20 MHz) * 6g-87-6385-80 - 87 (6385/80 MHz) * 6g-89-6395-20 - 89 (6395/20 MHz) * 6g-91-6405-40 - 91 (6405/40 MHz) * 6g-93-6415-20 - 93 (6415/20 MHz) * 6g-95-6425-320 - 95 (6425/320 MHz) * 6g-97-6435-20 - 97 (6435/20 MHz) * 6g-99-6445-40 - 99 (6445/40 MHz) * 6g-101-6455-20 - 101 (6455/20 MHz) * 6g-103-6465-80 - 103 (6465/80 MHz) * 6g-105-6475-20 - 105 (6475/20 MHz) * 6g-107-6485-40 - 107 (6485/40 MHz) * 6g-109-6495-20 - 109 (6495/20 MHz) * 6g-111-6505-160 - 111 (6505/160 MHz) * 6g-113-6515-20 - 113 (6515/20 MHz) * 6g-115-6525-40 - 115 (6525/40 MHz) * 6g-117-6535-20 - 117 (6535/20 MHz) * 6g-119-6545-80 - 119 (6545/80 MHz) * 6g-121-6555-20 - 121 (6555/20 MHz) * 6g-123-6565-40 - 123 (6565/40 MHz) * 6g-125-6575-20 - 125 (6575/20 MHz) * 6g-129-6595-20 - 129 (6595/20 MHz) * 6g-131-6605-40 - 131 (6605/40 MHz) * 6g-133-6615-20 - 133 (6615/20 MHz) * 6g-135-6625-80 - 135 (6625/80 MHz) * 6g-137-6635-20 - 137 (6635/20 MHz) * 6g-139-6645-40 - 139 (6645/40 MHz) * 6g-141-6655-20 - 141 (6655/20 MHz) * 6g-143-6665-160 - 143 (6665/160 MHz) * 6g-145-6675-20 - 145 (6675/20 MHz) * 6g-147-6685-40 - 147 (6685/40 MHz) * 6g-149-6695-20 - 149 (6695/20 MHz) * 6g-151-6705-80 - 151 (6705/80 MHz) * 6g-153-6715-20 - 153 (6715/20 MHz) * 6g-155-6725-40 - 155 (6725/40 MHz) * 6g-157-6735-20 - 157 (6735/20 MHz) * 6g-159-6745-320 - 159 (6745/320 MHz) * 6g-161-6755-20 - 161 (6755/20 MHz) * 6g-163-6765-40 - 163 (6765/40 MHz) * 6g-165-6775-20 - 165 (6775/20 MHz) * 6g-167-6785-80 - 167 (6785/80 MHz) * 6g-169-6795-20 - 169 (6795/20 MHz) * 6g-171-6805-40 - 171 (6805/40 MHz) * 6g-173-6815-20 - 173 (6815/20 MHz) * 6g-175-6825-160 - 175 (6825/160 MHz) * 6g-177-6835-20 - 177 (6835/20 MHz) * 6g-179-6845-40 - 179 (6845/40 MHz) * 6g-181-6855-20 - 181 (6855/20 MHz) * 6g-183-6865-80 - 183 (6865/80 MHz) * 6g-185-6875-20 - 185 (6875/20 MHz) * 6g-187-6885-40 - 187 (6885/40 MHz) * 6g-189-6895-20 - 189 (6895/20 MHz) * 6g-193-6915-20 - 193 (6915/20 MHz) * 6g-195-6925-40 - 195 (6925/40 MHz) * 6g-197-6935-20 - 197 (6935/20 MHz) * 6g-199-6945-80 - 199 (6945/80 MHz) * 6g-201-6955-20 - 201 (6955/20 MHz) * 6g-203-6965-40 - 203 (6965/40 MHz) * 6g-205-6975-20 - 205 (6975/20 MHz) * 6g-207-6985-160 - 207 (6985/160 MHz) * 6g-209-6995-20 - 209 (6995/20 MHz) * 6g-211-7005-40 - 211 (7005/40 MHz) * 6g-213-7015-20 - 213 (7015/20 MHz) * 6g-215-7025-80 - 215 (7025/80 MHz) * 6g-217-7035-20 - 217 (7035/20 MHz) * 6g-219-7045-40 - 219 (7045/40 MHz) * 6g-221-7055-20 - 221 (7055/20 MHz) * 6g-225-7075-20 - 225 (7075/20 MHz) * 6g-227-7085-40 - 227 (7085/40 MHz) * 6g-229-7095-20 - 229 (7095/20 MHz) * 6g-233-7115-20 - 233 (7115/20 MHz) * 60g-1-58320-2160 - 1 (58.32/2.16 GHz) * 60g-2-60480-2160 - 2 (60.48/2.16 GHz) * 60g-3-62640-2160 - 3 (62.64/2.16 GHz) * 60g-4-64800-2160 - 4 (64.80/2.16 GHz) * 60g-5-66960-2160 - 5 (66.96/2.16 GHz) * 60g-6-69120-2160 - 6 (69.12/2.16 GHz) * 60g-9-59400-4320 - 9 (59.40/4.32 GHz) * 60g-10-61560-4320 - 10 (61.56/4.32 GHz) * 60g-11-63720-4320 - 11 (63.72/4.32 GHz) * 60g-12-65880-4320 - 12 (65.88/4.32 GHz) * 60g-13-68040-4320 - 13 (68.04/4.32 GHz) * 60g-17-60480-6480 - 17 (60.48/6.48 GHz) * 60g-18-62640-6480 - 18 (62.64/6.48 GHz) * 60g-19-64800-6480 - 19 (64.80/6.48 GHz) * 60g-20-66960-6480 - 20 (66.96/6.48 GHz) * 60g-25-61560-6480 - 25 (61.56/8.64 GHz) * 60g-26-63720-6480 - 26 (63.72/8.64 GHz) * 60g-27-65880-6480 - 27 (65.88/8.64 GHz)

attribute number? rf_channel_frequency=null

Populated by selected channel (if set)

attribute number? rf_channel_width=null

Populated by selected channel (if set)

attribute netbox::resources::writable_interface_request::wireless_role? rf_role=null

  • ap - Access point * station - Station

attribute netbox::common::pos_int32_t? speed=null
attribute int[]? tagged_vlan_ids=null
attribute netbox::resources::writable_interface_request::transmit_power__d_bm_? tx_power=null
attribute netbox::resources::writable_interface_request::type? type=null

  • virtual - Virtual * bridge - Bridge * lag - Link Aggregation Group (LAG) * 100base-fx - 100BASE-FX (10/100ME FIBER) * 100base-lfx - 100BASE-LFX (10/100ME FIBER) * 100base-tx - 100BASE-TX (10/100ME) * 100base-t1 - 100BASE-T1 (10/100ME Single Pair) * 1000base-t - 1000BASE-T (1GE) * 2.5gbase-t - 2.5GBASE-T (2.5GE) * 5gbase-t - 5GBASE-T (5GE) * 10gbase-t - 10GBASE-T (10GE) * 10gbase-cx4 - 10GBASE-CX4 (10GE) * 1000base-x-gbic - GBIC (1GE) * 1000base-x-sfp - SFP (1GE) * 10gbase-x-sfpp - SFP+ (10GE) * 10gbase-x-xfp - XFP (10GE) * 10gbase-x-xenpak - XENPAK (10GE) * 10gbase-x-x2 - X2 (10GE) * 25gbase-x-sfp28 - SFP28 (25GE) * 50gbase-x-sfp56 - SFP56 (50GE) * 40gbase-x-qsfpp - QSFP+ (40GE) * 50gbase-x-sfp28 - QSFP28 (50GE) * 100gbase-x-cfp - CFP (100GE) * 100gbase-x-cfp2 - CFP2 (100GE) * 200gbase-x-cfp2 - CFP2 (200GE) * 400gbase-x-cfp2 - CFP2 (400GE) * 100gbase-x-cfp4 - CFP4 (100GE) * 100gbase-x-cxp - CXP (100GE) * 100gbase-x-cpak - Cisco CPAK (100GE) * 100gbase-x-dsfp - DSFP (100GE) * 100gbase-x-sfpdd - SFP-DD (100GE) * 100gbase-x-qsfp28 - QSFP28 (100GE) * 100gbase-x-qsfpdd - QSFP-DD (100GE) * 200gbase-x-qsfp56 - QSFP56 (200GE) * 200gbase-x-qsfpdd - QSFP-DD (200GE) * 400gbase-x-qsfp112 - QSFP112 (400GE) * 400gbase-x-qsfpdd - QSFP-DD (400GE) * 400gbase-x-osfp - OSFP (400GE) * 400gbase-x-osfp-rhs - OSFP-RHS (400GE) * 400gbase-x-cdfp - CDFP (400GE) * 400gbase-x-cfp8 - CPF8 (400GE) * 800gbase-x-qsfpdd - QSFP-DD (800GE) * 800gbase-x-osfp - OSFP (800GE) * 1000base-kx - 1000BASE-KX (1GE) * 10gbase-kr - 10GBASE-KR (10GE) * 10gbase-kx4 - 10GBASE-KX4 (10GE) * 25gbase-kr - 25GBASE-KR (25GE) * 40gbase-kr4 - 40GBASE-KR4 (40GE) * 50gbase-kr - 50GBASE-KR (50GE) * 100gbase-kp4 - 100GBASE-KP4 (100GE) * 100gbase-kr2 - 100GBASE-KR2 (100GE) * 100gbase-kr4 - 100GBASE-KR4 (100GE) * ieee802.11a - IEEE 802.11a * ieee802.11g - IEEE 802.11b/g * ieee802.11n - IEEE 802.11n * ieee802.11ac - IEEE 802.11ac * ieee802.11ad - IEEE 802.11ad * ieee802.11ax - IEEE 802.11ax * ieee802.11ay - IEEE 802.11ay * ieee802.15.1 - IEEE 802.15.1 (Bluetooth) * other-wireless - Other (Wireless) * gsm - GSM * cdma - CDMA * lte - LTE * sonet-oc3 - OC-3/STM-1 * sonet-oc12 - OC-12/STM-4 * sonet-oc48 - OC-48/STM-16 * sonet-oc192 - OC-192/STM-64 * sonet-oc768 - OC-768/STM-256 * sonet-oc1920 - OC-1920/STM-640 * sonet-oc3840 - OC-3840/STM-1234 * 1gfc-sfp - SFP (1GFC) * 2gfc-sfp - SFP (2GFC) * 4gfc-sfp - SFP (4GFC) * 8gfc-sfpp - SFP+ (8GFC) * 16gfc-sfpp - SFP+ (16GFC) * 32gfc-sfp28 - SFP28 (32GFC) * 32gfc-sfpp - SFP+ (32GFC) * 64gfc-qsfpp - QSFP+ (64GFC) * 64gfc-sfpdd - SFP-DD (64GFC) * 64gfc-sfpp - SFP+ (64GFC) * 128gfc-qsfp28 - QSFP28 (128GFC) * infiniband-sdr - SDR (2 Gbps) * infiniband-ddr - DDR (4 Gbps) * infiniband-qdr - QDR (8 Gbps) * infiniband-fdr10 - FDR10 (10 Gbps) * infiniband-fdr - FDR (13.5 Gbps) * infiniband-edr - EDR (25 Gbps) * infiniband-hdr - HDR (50 Gbps) * infiniband-ndr - NDR (100 Gbps) * infiniband-xdr - XDR (250 Gbps) * t1 - T1 (1.544 Mbps) * e1 - E1 (2.048 Mbps) * t3 - T3 (45 Mbps) * e3 - E3 (34 Mbps) * xdsl - xDSL * docsis - DOCSIS * gpon - GPON (2.5 Gbps / 1.25 Gps) * xg-pon - XG-PON (10 Gbps / 2.5 Gbps) * xgs-pon - XGS-PON (10 Gbps) * ng-pon2 - NG-PON2 (TWDM-PON) (4x10 Gbps) * epon - EPON (1 Gbps) * 10g-epon - 10G-EPON (10 Gbps) * cisco-stackwise - Cisco StackWise * cisco-stackwise-plus - Cisco StackWise Plus * cisco-flexstack - Cisco FlexStack * cisco-flexstack-plus - Cisco FlexStack Plus * cisco-stackwise-80 - Cisco StackWise-80 * cisco-stackwise-160 - Cisco StackWise-160 * cisco-stackwise-320 - Cisco StackWise-320 * cisco-stackwise-480 - Cisco StackWise-480 * cisco-stackwise-1t - Cisco StackWise-1T * juniper-vcp - Juniper VCP * extreme-summitstack - Extreme SummitStack * extreme-summitstack-128 - Extreme SummitStack-128 * extreme-summitstack-256 - Extreme SummitStack-256 * extreme-summitstack-512 - Extreme SummitStack-512 * other - Other

attribute int? untagged_vlan_id=null
attribute int[]? vdcs=null
attribute int? vrf_id=null
attribute int[]? wireless_lans=null
attribute string? wwn=null
Rel bridge:
rel device:
rel lag:
rel parent:
rel tagged_vlans:
rel untagged_vlan:
rel vrf:

relation netbox::resources::Interface bridged_interfaces [0:*]

other end: netbox::resources::Interface.bridge [0:1]

relation netbox::resources::Interface bridge [0:1]

other end: netbox::resources::Interface.bridged_interfaces [0:*]

relation netbox::resources::Device device [1]

other end: netbox::resources::Device.interfaces [0:*]

relation netbox::resources::Interface lag_interfaces [0:*]

other end: netbox::resources::Interface.lag [0:1]

relation netbox::resources::Interface lag [0:1]

other end: netbox::resources::Interface.lag_interfaces [0:*]

relation netbox::resources::Interface subinterfaces [0:*]

other end: netbox::resources::Interface.parent [0:1]

relation netbox::resources::Interface parent [0:1]

other end: netbox::resources::Interface.subinterfaces [0:*]

relation netbox::resources::Vlan tagged_vlans [0:*]

other end: netbox::resources::Vlan.tagged_vlan_interfaces [0:*]

relation netbox::resources::Vlan untagged_vlan [0:1]

other end: netbox::resources::Vlan.untagged_vlan_interfaces [0:*]

relation netbox::resources::VRF vrf [0:1]

other end: netbox::resources::VRF.interfaces [0:*]

relation netbox::resources::InterfaceCable a_cables [0:*]

other end: netbox::resources::InterfaceCable.a_terminations [1]

relation netbox::resources::InterfaceCable b_cables [0:*]

other end: netbox::resources::InterfaceCable.b_terminations [1]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::InterfaceCable

Parents: netbox::Resource, netbox::ResourceWithCompatibilityBody

Adds support for custom fields and tags.

attribute netbox::resources::writable_cable_request::color? color=null
attribute string? comments=null
attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute netbox::common::label_t? label=null

Physical label

attribute number? length=null
attribute netbox::resources::writable_cable_request::length_unit? length_unit=null

  • km - Kilometers * m - Meters * cm - Centimeters * mi - Miles * ft - Feet * in - Inches

attribute netbox::resources::writable_cable_request::status? status=null

  • connected - Connected * planned - Planned * decommissioning - Decommissioning

attribute int? tenant_id=null
attribute netbox::resources::writable_cable_request::type? type=null

  • cat3 - CAT3 * cat5 - CAT5 * cat5e - CAT5e * cat6 - CAT6 * cat6a - CAT6a * cat7 - CAT7 * cat7a - CAT7a * cat8 - CAT8 * dac-active - Direct Attach Copper (Active) * dac-passive - Direct Attach Copper (Passive) * mrj21-trunk - MRJ21 Trunk * coaxial - Coaxial * mmf - Multimode Fiber * mmf-om1 - Multimode Fiber (OM1) * mmf-om2 - Multimode Fiber (OM2) * mmf-om3 - Multimode Fiber (OM3) * mmf-om4 - Multimode Fiber (OM4) * mmf-om5 - Multimode Fiber (OM5) * smf - Singlemode Fiber * smf-os1 - Singlemode Fiber (OS1) * smf-os2 - Singlemode Fiber (OS2) * aoc - Active Optical Cabling (AOC) * power - Power :rel a_terminations: :rel b_terminations: :rel tenant:

relation netbox::resources::Interface a_terminations [1]

other end: netbox::resources::Interface.a_cables [0:*]

relation netbox::resources::Interface b_terminations [1]

other end: netbox::resources::Interface.b_cables [0:*]

relation netbox::resources::Tenant tenant [0:1]

other end: netbox::resources::Tenant.interface_cables [0:*]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::L2VPN

Parents: netbox::Resource

Adds support for custom fields and tags.

attribute string? comments=null
attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute int[]? export_targets=null
attribute netbox::resources::writablel2vpn_request::identifier? identifier=null
attribute int[]? import_targets=null
attribute netbox::common::name_1_100_t? name=null
attribute netbox::common::slug_t slug
attribute int? tenant_id=null
attribute netbox::resources::writablel2vpn_request::type? type=null

  • vpws - VPWS * vpls - VPLS * vxlan - VXLAN * vxlan-evpn - VXLAN-EVPN * mpls-evpn - MPLS EVPN * pbb-evpn - PBB EVPN * epl - EPL * evpl - EVPL * ep-lan - Ethernet Private LAN * evp-lan - Ethernet Virtual Private LAN * ep-tree - Ethernet Private Tree * evp-tree - Ethernet Virtual Private Tree :rel tenant:

relation netbox::resources::Tenant tenant [0:1]

other end: netbox::resources::Tenant.l2vpns [0:*]

relation netbox::resources::L2VPNTermination terminations [0:*]

other end: netbox::resources::L2VPNTermination.l2vpn [1]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::L2VPNTermination

Parents: netbox::Resource

Adds support for custom fields and tags.

attribute dict? custom_fields=null
Rel assigned_object:
rel l2vpn:

relation netbox::resources::IL2VPNTermination_assigned_object assigned_object [1]

other end: netbox::resources::IL2VPNTermination_assigned_object.l2vpn_termination [0:*]

relation netbox::resources::L2VPN l2vpn [1]

other end: netbox::resources::L2VPN.terminations [0:*]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::Manufacturer

Parents: netbox::Resource

Adds support for custom fields and tags.

attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute netbox::common::name_1_100_t? name=null
attribute netbox::common::slug_t slug
relation netbox::resources::DeviceType device_types [0:*]

other end: netbox::resources::DeviceType.manufacturer [0:1]

The following implements statements select implementations for this entity:

entity netbox::resources::Prefix

Parents: netbox::Resource

Adds support for custom fields and tags.

attribute string? comments=null
attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute bool? is_pool=null

All IP addresses within this prefix are considered usable

attribute bool? mark_utilized=null

Treat as fully utilized

attribute netbox::resources::writable_prefix_request::prefix? prefix=null
attribute int? role=null

The primary function of this prefix

attribute int? site_id=null
attribute netbox::resources::writable_prefix_request::status? status=null

Operational status of this prefix * container - Container * active - Active * reserved - Reserved * deprecated - Deprecated

attribute int? tenant_id=null
attribute int? vlan_id=null
attribute int? vrf_id=null
Rel site:
rel tenant:
rel vlan:
rel vrf:

relation netbox::resources::Site site [0:1]

other end: netbox::resources::Site.prefixes [0:*]

relation netbox::resources::Tenant tenant [0:1]

other end: netbox::resources::Tenant.prefixes [0:*]

relation netbox::resources::Vlan vlan [0:1]

other end: netbox::resources::Vlan.prefixes [0:*]

relation netbox::resources::VRF vrf [0:1]

other end: netbox::resources::VRF.prefixes [0:*]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::Rack

Parents: netbox::Resource, netbox::resources::IVlanGroup_scope

Adds support for custom fields and tags.

attribute netbox::common::string_50_t? asset_tag=null
attribute string? comments=null
attribute dict? custom_fields=null
attribute bool? desc_units=null

Units are numbered top-to-bottom

attribute netbox::common::string_200_t? description=null
attribute netbox::common::string_50_t? facility_id=null
attribute int? location=null
attribute netbox::common::pos_int32_t? max_weight=null
attribute netbox::common::rack_size_t? mounting_depth=null

Outer dimension of rack

attribute netbox::common::name_1_100_t name
attribute netbox::common::rack_size_t? outer_depth=null

Outer dimension of rack

attribute netbox::resources::writable_rack_request::outer_unit? outer_unit=null

  • mm - Millimeters * in - Inches

attribute netbox::common::rack_size_t? outer_width=null

Outer dimension of rack

attribute int? role=null

Functional role

attribute netbox::common::string_50_t? serial=null
attribute netbox::resources::writable_rack_request::starting_unit? starting_unit=null

Starting unit for rack

attribute netbox::resources::writable_rack_request::status? status=null

  • reserved - Reserved * available - Available * planned - Planned * active - Active * deprecated - Deprecated

attribute int? tenant_id=null
attribute netbox::resources::writable_rack_request::type? type=null

  • 2-post-frame - 2-post frame * 4-post-frame - 4-post frame * 4-post-cabinet - 4-post cabinet * wall-frame - Wall-mounted frame * wall-frame-vertical - Wall-mounted frame (vertical) * wall-cabinet - Wall-mounted cabinet * wall-cabinet-vertical - Wall-mounted cabinet (vertical)

attribute netbox::resources::writable_rack_request::height__u_? u_height=null

Height in rack units

attribute number? weight=null
attribute netbox::resources::writable_rack_request::weight_unit? weight_unit=null

  • kg - Kilograms * g - Grams * lb - Pounds * oz - Ounces

attribute netbox::resources::writable_rack_request::width? width=null

Rail-to-rail width * 10 - 10 inches * 19 - 19 inches * 21 - 21 inches * 23 - 23 inches :rel site: :rel tenant:

relation netbox::resources::Device devices [0:*]

other end: netbox::resources::Device.rack [0:1]

relation netbox::resources::Site site [1]

other end: netbox::resources::Site.racks [0:*]

relation netbox::resources::Tenant tenant [0:1]

other end: netbox::resources::Tenant.racks [0:*]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::Site

Parents: netbox::Resource, netbox::resources::IVlanGroup_scope

Adds support for custom fields and tags.

attribute int[]? asns=null
attribute string? comments=null
attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute netbox::common::string_50_t? facility=null
attribute int? group=null
attribute number? latitude=null

GPS coordinate in decimal format (xx.yyyyyy)

attribute number? longitude=null

GPS coordinate in decimal format (xx.yyyyyy)

attribute netbox::common::name_1_100_t? name=null
attribute netbox::common::string_200_t? physical_address=null
attribute int? region=null
attribute netbox::common::string_200_t? shipping_address=null
attribute netbox::common::slug_t slug
attribute netbox::resources::writable_site_request::status? status=null

  • planned - Planned * staging - Staging * active - Active * decommissioning - Decommissioning * retired - Retired

attribute int? tenant_id=null
attribute string? time_zone=null
Rel tenant:

relation netbox::resources::Cluster clusters [0:*]

other end: netbox::resources::Cluster.site [0:1]

relation netbox::resources::Device devices [0:*]

other end: netbox::resources::Device.site [0:1]

relation netbox::resources::Prefix prefixes [0:*]

other end: netbox::resources::Prefix.site [0:1]

relation netbox::resources::Rack racks [0:*]

other end: netbox::resources::Rack.site [1]

relation netbox::resources::Tenant tenant [0:1]

other end: netbox::resources::Tenant.sites [0:*]

relation netbox::resources::VirtualMachine virtual_machines [0:*]

other end: netbox::resources::VirtualMachine.site [0:1]

relation netbox::resources::Vlan vlans [0:*]

other end: netbox::resources::Vlan.site [0:1]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::Tenant

Parents: netbox::Resource

Adds support for custom fields and tags.

attribute string? comments=null
attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute int? group_id=null
attribute netbox::common::name_1_100_t? name=null
attribute netbox::common::slug_t slug
Rel group:

relation netbox::resources::Cluster clusters [0:*]

other end: netbox::resources::Cluster.tenant [0:1]

relation netbox::resources::Device devices [0:*]

other end: netbox::resources::Device.tenant [0:1]

relation netbox::resources::IPAddress addresses [0:*]

other end: netbox::resources::IPAddress.tenant [0:1]

relation netbox::resources::InterfaceCable interface_cables [0:*]

other end: netbox::resources::InterfaceCable.tenant [0:1]

relation netbox::resources::L2VPN l2vpns [0:*]

other end: netbox::resources::L2VPN.tenant [0:1]

relation netbox::resources::Prefix prefixes [0:*]

other end: netbox::resources::Prefix.tenant [0:1]

relation netbox::resources::Rack racks [0:*]

other end: netbox::resources::Rack.tenant [0:1]

relation netbox::resources::Site sites [0:*]

other end: netbox::resources::Site.tenant [0:1]

relation netbox::resources::TenantGroup group [0:1]

other end: netbox::resources::TenantGroup.tenants [0:*]

relation netbox::resources::VRF vrfs [0:*]

other end: netbox::resources::VRF.tenant [0:1]

relation netbox::resources::VirtualMachine virtual_machines [0:*]

other end: netbox::resources::VirtualMachine.tenant [0:1]

relation netbox::resources::Vlan vlans [0:*]

other end: netbox::resources::Vlan.tenant [0:1]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::TenantGroup

Parents: netbox::Resource

Extends PrimaryModelSerializer to include MPTT support.

attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute netbox::common::name_1_100_t? name=null
attribute int? parent_id=null
attribute netbox::common::slug_t slug
Rel parent:

relation netbox::resources::Tenant tenants [0:*]

other end: netbox::resources::Tenant.group [0:1]

relation netbox::resources::TenantGroup tenant_groups [0:*]

other end: netbox::resources::TenantGroup.parent [0:1]

relation netbox::resources::TenantGroup parent [0:1]

other end: netbox::resources::TenantGroup.tenant_groups [0:*]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::VMInterface

Parents: netbox::Resource, netbox::resources::IIPAddress_assigned_object

Adds support for custom fields and tags.

attribute int? bridge_id=null
attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute bool? enabled=null
attribute netbox::resources::writablevm_interface_request::mac_address? mac_address=null
attribute netbox::resources::writablevm_interface_request::mode? mode=null

IEEE 802.1Q tagging strategy * access - Access * tagged - Tagged * tagged-all - Tagged (All)

attribute netbox::common::mtu_t? mtu=null
attribute netbox::common::name_1_64_t name
attribute int? parent_id=null
attribute int[]? tagged_vlan_ids=null
attribute int? untagged_vlan_id=null
attribute int? vrf_id=null
Rel bridge:
rel parent:
rel tagged_vlans:
rel untagged_vlan:
rel virtual_machine:
rel vrf:

relation netbox::resources::VMInterface slave_interfaces [0:*]

other end: netbox::resources::VMInterface.bridge [0:1]

relation netbox::resources::VMInterface bridge [0:1]

other end: netbox::resources::VMInterface.slave_interfaces [0:*]

relation netbox::resources::VMInterface subinterfaces [0:*]

other end: netbox::resources::VMInterface.parent [0:1]

relation netbox::resources::VMInterface parent [0:1]

other end: netbox::resources::VMInterface.subinterfaces [0:*]

relation netbox::resources::Vlan tagged_vlans [0:*]

other end: netbox::resources::Vlan.tagged_vlan_vminterfaces [0:*]

relation netbox::resources::Vlan untagged_vlan [0:1]

other end: netbox::resources::Vlan.untagged_vlan_vminterfaces [0:*]

relation netbox::resources::VirtualMachine virtual_machine [1]

other end: netbox::resources::VirtualMachine.interfaces [0:*]

relation netbox::resources::VRF vrf [0:1]

other end: netbox::resources::VRF.vminterfaces [0:*]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::VRF

Parents: netbox::Resource

Adds support for custom fields and tags.

attribute string? comments=null
attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute bool? enforce_unique=null

Prevent duplicate prefixes/IP addresses within this VRF

attribute int[]? export_targets=null
attribute int[]? import_targets=null
attribute netbox::common::name_1_100_t? name=null
attribute netbox::resources::writablevrf_request::route_distinguisher? rd=null

Unique route distinguisher (as defined in RFC 4364)

attribute int? tenant_id=null
Rel tenant:

relation netbox::resources::IPAddress addresses [0:*]

other end: netbox::resources::IPAddress.vrf [0:1]

relation netbox::resources::Interface interfaces [0:*]

other end: netbox::resources::Interface.vrf [0:1]

relation netbox::resources::Prefix prefixes [0:*]

other end: netbox::resources::Prefix.vrf [0:1]

relation netbox::resources::VMInterface vminterfaces [0:*]

other end: netbox::resources::VMInterface.vrf [0:1]

relation netbox::resources::Tenant tenant [0:1]

other end: netbox::resources::Tenant.vrfs [0:*]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::VirtualMachine

Parents: netbox::AbstractDevice

Adds support for custom fields and tags.

attribute int? cluster_id=null
attribute string? comments=null
attribute int? config_template=null
attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute int? device_id=null
attribute netbox::common::pos_int32_t? disk=null
attribute netbox::common::pos_int32_t? memory=null
attribute netbox::common::name_1_64_t name
attribute int? platform=null
attribute int? primary_ip4_id=null
attribute int? primary_ip6_id=null
attribute int? role_id=null
attribute int? site_id=null
attribute netbox::resources::writable_virtual_machine_with_config_context_request::status? status=null

  • offline - Offline * active - Active * planned - Planned * staged - Staged * failed - Failed * decommissioning - Decommissioning

attribute int? tenant_id=null
attribute number? vcpus=null
Rel cluster:
rel device:
rel primary_ip4:
rel primary_ip6:
rel role:
rel site:
rel tenant:

relation netbox::resources::VMInterface interfaces [0:*]

other end: netbox::resources::VMInterface.virtual_machine [1]

relation netbox::resources::Cluster cluster [0:1]

other end: netbox::resources::Cluster.virtual_machines [0:*]

relation netbox::resources::Device device [0:1]

other end: netbox::resources::Device.virtual_machines [0:*]

relation netbox::resources::IPAddress primary_ip4 [0:1]
relation netbox::resources::IPAddress primary_ip6 [0:1]
relation netbox::resources::DeviceRole role [0:1]

other end: netbox::resources::DeviceRole.virtual_machines [0:*]

relation netbox::resources::Site site [0:1]

other end: netbox::resources::Site.virtual_machines [0:*]

relation netbox::resources::Tenant tenant [0:1]

other end: netbox::resources::Tenant.virtual_machines [0:*]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::Vlan

Parents: netbox::Resource, netbox::resources::IL2VPNTermination_assigned_object

Adds support for custom fields and tags.

attribute string? comments=null
attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute netbox::common::name_1_64_t? name=null
attribute int? role=null

The primary function of this VLAN

attribute int? site_id=null
attribute netbox::resources::writablevlan_request::status? status=null

Operational status of this VLAN * active - Active * reserved - Reserved * deprecated - Deprecated

attribute int? tenant_id=null
attribute netbox::common::vlan_id_t vid
Rel group:
rel site:
rel tenant:

relation netbox::resources::Interface tagged_vlan_interfaces [0:*]

other end: netbox::resources::Interface.tagged_vlans [0:*]

relation netbox::resources::Interface untagged_vlan_interfaces [0:*]

other end: netbox::resources::Interface.untagged_vlan [0:1]

relation netbox::resources::Prefix prefixes [0:*]

other end: netbox::resources::Prefix.vlan [0:1]

relation netbox::resources::VMInterface tagged_vlan_vminterfaces [0:*]

other end: netbox::resources::VMInterface.tagged_vlans [0:*]

relation netbox::resources::VMInterface untagged_vlan_vminterfaces [0:*]

other end: netbox::resources::VMInterface.untagged_vlan [0:1]

relation netbox::resources::VlanGroup group [1]

other end: netbox::resources::VlanGroup.vlans [0:*]

relation netbox::resources::Site site [0:1]

other end: netbox::resources::Site.vlans [0:*]

relation netbox::resources::Tenant tenant [0:1]

other end: netbox::resources::Tenant.vlans [0:*]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::VlanGroup

Parents: netbox::Resource

Adds support for custom fields and tags.

attribute dict? custom_fields=null
attribute netbox::common::string_200_t? description=null
attribute netbox::common::vlan_id_t? max_vid=null
attribute netbox::common::vlan_id_t? min_vid=null
attribute netbox::common::name_1_100_t? name=null
attribute netbox::common::slug_t slug
Rel scope:

relation netbox::resources::Vlan vlans [0:*]

other end: netbox::resources::Vlan.group [1]

relation netbox::resources::IVlanGroup_scope scope [1]

other end: netbox::resources::IVlanGroup_scope.vlan_group [0:*]

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity netbox::resources::device_role_request::ConfigTemplate

Parents: netbox::common::NestedConfigTemplateRequest

The following implements statements select implementations for this entity:

Implementations

implementation netbox::device_primary_ip
implementation netbox::ip_implementation
implementation netbox::netbox_agent_autostart
implementation netbox::checks::interface_mode_check
implementation netbox::checks::virtual_machine_site_and_cluster_check
implementation netbox::checks::virtual_machine_site_or_cluster_check
implementation netbox::checks::vminterface_mode_check
implementation netbox::resources::cluster_group
implementation netbox::resources::cluster_site
implementation netbox::resources::cluster_tenant
implementation netbox::resources::cluster_type
implementation netbox::resources::device_cluster
implementation netbox::resources::device_device_type
implementation netbox::resources::device_rack
implementation netbox::resources::device_role
implementation netbox::resources::device_site
implementation netbox::resources::device_tenant
implementation netbox::resources::devicetype_manufacturer
implementation netbox::resources::interface_bridge
implementation netbox::resources::interface_device
implementation netbox::resources::interface_lag
implementation netbox::resources::interface_parent
implementation netbox::resources::interface_tagged_vlans
implementation netbox::resources::interface_untagged_vlan
implementation netbox::resources::interface_vrf
implementation netbox::resources::interfacecable_a_terminations
implementation netbox::resources::interfacecable_b_terminations
implementation netbox::resources::interfacecable_tenant
implementation netbox::resources::ipaddress_assigned_object
implementation netbox::resources::ipaddress_tenant
implementation netbox::resources::ipaddress_vrf
implementation netbox::resources::l2vpn_tenant
implementation netbox::resources::l2vpntermination_assigned_object
implementation netbox::resources::l2vpntermination_l2vpn
implementation netbox::resources::prefix_site
implementation netbox::resources::prefix_tenant
implementation netbox::resources::prefix_vlan
implementation netbox::resources::prefix_vrf
implementation netbox::resources::rack_site
implementation netbox::resources::rack_tenant
implementation netbox::resources::site_tenant
implementation netbox::resources::tenant_group
implementation netbox::resources::tenantgroup_parent
implementation netbox::resources::virtualmachine_cluster
implementation netbox::resources::virtualmachine_device
implementation netbox::resources::virtualmachine_role
implementation netbox::resources::virtualmachine_site
implementation netbox::resources::virtualmachine_tenant
implementation netbox::resources::vlan_group
implementation netbox::resources::vlan_site
implementation netbox::resources::vlan_tenant
implementation netbox::resources::vlangroup_scope
implementation netbox::resources::vminterface_bridge
implementation netbox::resources::vminterface_parent
implementation netbox::resources::vminterface_tagged_vlans
implementation netbox::resources::vminterface_untagged_vlan
implementation netbox::resources::vminterface_virtual_machine
implementation netbox::resources::vminterface_vrf
implementation netbox::resources::vrf_tenant

Plugins

netbox.build_secret_reference(netbox_resource: 'netbox::Resource', role: 'string', method_to_override_secret: 'string', name: 'string?' = None, method_to_override_name_secret: 'string?' = None) → 'dict'

Generate from the netbox resource, the query needed to retrieve the netbox object

Parameters:

  • netbox_resource – netbox resource that we need to query

  • role – the role used in the secret. It could be a description on where this secret will be used, e.g. ‘esxi’, ‘juniper’, … or on how it would be used, e.g. ‘administrator’, ‘SSH key’, …

  • method_to_override_secret – the method related to the secret (usually the password) to override in the handler

  • name – the name of the secret. It could be the name of a field such as ‘username’, ‘password’, … or something else

  • method_to_override_name_secret – the method related to the secret’s name (usually the username) to override in the handler

Returns:

Dictionary containing the necessary query to retrieve the netbox object and its secret {

”url”: “The url to reach to get the Netbox object” , “query”: {“name”: “The name of the Netbox resource”}, “secret”: {

”name”: “The name of the secret”, [OPTIONAL FIELD] “role”: “The role of the secret”, “method_to_override_secret”: “The name of the method to override in the handler that will use the secret value”, “method_to_override_name_secret”: “The name of the method to override in the handler that will use

the secret name”, [OPTIONAL FIELD]

},

}

netbox.get(credentials: 'netbox::Credentials', application: 'string', model: 'string', query: 'dict') → 'dict'

Get single object of specified type application.model matching query parameters. Exception will be raised when multiple objects have been found, or if there is no matching object.

Parameters:

  • credentials – credentials object required to establish connection

  • application – ipam, dcim, circuits, …

  • model – ip_addresses, devices, interfaces, …

  • query – dict of object attributes

netbox.get_by_id(credentials: 'netbox::Credentials', application: 'string', model: 'string', resource_id: 'number') → 'dict'

Get single object of specified type application.model type with resource_id id. Exception will be raised when there is no matching object.

Parameters:

  • credentials – credentials object required to establish connection

  • application – ipam, dcim, circuits, …

  • model – ip_addresses, devices, interfaces, …

  • resource_id – id of requested object

netbox.get_or_create_secret_role(netbox_url: 'string', path_key: 'string', rolename: 'string', slug: 'string?', description: 'string?', tags: 'string[]?') → 'string'

Create a new Secret role in Netbox-Secret

Parameters:

  • netbox_url – The URL of the Netbox instance

  • path_key – The path to an RSA key pair (linked to a Netbox user)

  • rolename – The role of the secret

  • slug – The slug (unique identifier for Netbox) of the secret role

  • description – The description of the secret role

  • tags – The tags of the secret role

netbox.get_or_generate_password(netbox_url: 'string', path_key: 'string', device_or_vm: 'netbox::Resource', secret_name: 'string', rolename: 'string', plaintext_secret: 'string?' = None, override_existing_entry: 'bool' = False) → 'string'

Retrieve or generate a password for the Netbox resource (either a VM or a Device)

Parameters:

  • netbox_url – The URL of the Netbox instance

  • path_key – The path to an RSA key pair (linked to a Netbox user)

  • device_or_vm – The entity to attach / retrieve this secret

  • secret_name – The name of the secret

  • rolename – The role of the secret

  • plaintext_secret – The secret in plaintext

  • override_existing_entry – if the secrets should be overridden if it already exists

netbox.list(credentials: 'netbox::Credentials', application: 'string', model: 'string', query: 'dict' = {}) → 'list'

List objects of specified type application.model matching query parameters. If query is not specified, all objects of requested type will be returned.

Returns a list of dictionaries

Parameters:

  • credentials – credentials object required to establish connection

  • application – ipam, dcim, circuits, …

  • model – ip_addresses, devices, interfaces, …

  • query – An optional query. If empty, all is used.

Resources

class netbox.resources.PrimaryIPResource
class netbox.resources.ClusterResource
class netbox.resources.ClusterGroupResource
class netbox.resources.ClusterTypeResource
class netbox.resources.CustomFieldResource
class netbox.resources.DeviceResource
class netbox.resources.DeviceRoleResource
class netbox.resources.DeviceTypeResource
class netbox.resources.IPAddressResource
class netbox.resources.InterfaceResource
class netbox.resources.InterfaceCableResource
class netbox.resources.L2VPNResource
class netbox.resources.L2VPNTerminationResource
class netbox.resources.ManufacturerResource
class netbox.resources.PrefixResource
class netbox.resources.RackResource
class netbox.resources.SiteResource
class netbox.resources.TenantResource
class netbox.resources.TenantGroupResource
class netbox.resources.VMInterfaceResource
class netbox.resources.VRFResource
class netbox.resources.VirtualMachineResource
class netbox.resources.VlanResource
class netbox.resources.VlanGroupResource

Handlers

class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.BaseNetboxHandler
class netbox.resources.SecretBaseNetboxHandler
class netbox.resources.SecretBaseNetboxHandler
class netbox.resources.InterfaceCableHandler
class netbox.resources.PrimaryIPHandler