| Dir : /proc/self/root/opt/saltstack/salt/extras-3.10/pynetbox/models/ |
| Server: Linux ngx353.inmotionhosting.com 4.18.0-553.22.1.lve.1.el8.x86_64 #1 SMP Tue Oct 8 15:52:54 UTC 2024 x86_64 IP: 209.182.202.254 |
| Dir : //proc/self/root/opt/saltstack/salt/extras-3.10/pynetbox/models/dcim.py |
"""
(c) 2017 DigitalOcean
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
from six.moves.urllib.parse import urlsplit
from pynetbox.core.query import Request
from pynetbox.core.response import Record, JsonField
from pynetbox.core.endpoint import RODetailEndpoint
from pynetbox.models.ipam import IpAddresses
from pynetbox.models.circuits import Circuits
class TraceableRecord(Record):
def trace(self):
req = Request(
key=str(self.id) + "/trace",
base=self.endpoint.url,
token=self.api.token,
session_key=self.api.session_key,
http_session=self.api.http_session,
).get()
uri_to_obj_class_map = {
"dcim/cables": Cables,
"dcim/front-ports": FrontPorts,
"dcim/interfaces": Interfaces,
"dcim/rear-ports": RearPorts,
}
ret = []
for (termination_a_data, cable_data, termination_b_data) in req:
this_hop_ret = []
for hop_item_data in (termination_a_data, cable_data, termination_b_data):
# if not fully terminated then some items will be None
if not hop_item_data:
this_hop_ret.append(hop_item_data)
continue
# the url for this item will be something like:
# https://netbox/api/dcim/rear-ports/12761/
# TODO: Move this to a more general function.
app_endpoint = "/".join(
urlsplit(hop_item_data["url"])
.path[len(urlsplit(self.api.base_url).path) :]
.split("/")[1:3]
)
return_obj_class = uri_to_obj_class_map.get(app_endpoint, Record,)
this_hop_ret.append(
return_obj_class(hop_item_data, self.endpoint.api, self.endpoint)
)
ret.append(this_hop_ret)
return ret
class DeviceTypes(Record):
def __str__(self):
return self.model
class Devices(Record):
"""Devices Object
Represents a device response from netbox.
Attributes:
primary_ip, ip4, ip6 (list): Tells __init__ in Record() to
take the `primary_ip` field's value from the API
response and return an initialized list of IpAddress
objects
device_type (obj): Tells __init__ in Record() to take the
`device_type` field's value from the API response and
return an initialized DeviceType object
"""
has_details = True
device_type = DeviceTypes
primary_ip = IpAddresses
primary_ip4 = IpAddresses
primary_ip6 = IpAddresses
local_context_data = JsonField
config_context = JsonField
@property
def napalm(self):
""" Represents the ``napalm`` detail endpoint.
Returns a DetailEndpoint object that is the interface for
viewing response from the napalm endpoint.
:returns: :py:class:`.DetailEndpoint`
:Examples:
>>> device = nb.ipam.devices.get(123)
>>> device.napalm.list(method='get_facts')
{"get_facts": {"interface_list": ["ge-0/0/0"]}}
"""
return RODetailEndpoint(self, "napalm")
class InterfaceConnections(Record):
def __str__(self):
return self.interface_a.name
class InterfaceConnection(Record):
def __str__(self):
return self.interface.name
class ConnectedEndpoint(Record):
device = Devices
class Interfaces(TraceableRecord):
interface_connection = InterfaceConnection
connected_endpoint = ConnectedEndpoint
class PowerOutlets(TraceableRecord):
device = Devices
class PowerPorts(TraceableRecord):
device = Devices
class ConsolePorts(TraceableRecord):
device = Devices
class ConsoleServerPorts(TraceableRecord):
device = Devices
class RackReservations(Record):
def __str__(self):
return self.description
class VirtualChassis(Record):
def __str__(self):
return self.master.display_name
class RUs(Record):
device = Devices
class FrontPorts(TraceableRecord):
device = Devices
class RearPorts(TraceableRecord):
device = Devices
class Racks(Record):
@property
def units(self):
""" Represents the ``units`` detail endpoint.
Returns a DetailEndpoint object that is the interface for
viewing response from the units endpoint.
:returns: :py:class:`.DetailEndpoint`
:Examples:
>>> rack = nb.dcim.racks.get(123)
>>> rack.units.list()
{"get_facts": {"interface_list": ["ge-0/0/0"]}}
"""
return RODetailEndpoint(self, "units", custom_return=RUs)
@property
def elevation(self):
""" Represents the ``elevation`` detail endpoint.
Returns a DetailEndpoint object that is the interface for
viewing response from the elevation endpoint updated in
Netbox version 2.8.
:returns: :py:class:`.DetailEndpoint`
:Examples:
>>> rack = nb.dcim.racks.get(123)
>>> rack.elevation.list()
{"get_facts": {"interface_list": ["ge-0/0/0"]}}
"""
return RODetailEndpoint(self, "elevation", custom_return=RUs)
class Termination(Record):
def __str__(self):
# hacky check to see if we're a circuit termination to
# avoid another call to NetBox because of a non-existent attr
# in self.name
if "circuit" in str(self.url):
return self.circuit.cid
return self.name
device = Devices
circuit = Circuits
class Cables(Record):
def __str__(self):
if all(
[
isinstance(i, Termination)
for i in (self.termination_a, self.termination_b)
]
):
return "{} <> {}".format(self.termination_a, self.termination_b)
return "Cable #{}".format(self.id)
termination_a = Termination
termination_b = Termination