RELATIONSHIPS
device
Returns the Device table entry to which the given Port is related.
port_vlans
Returns the set of device_port_vlan entries associated with this Port. These will be both tagged and untagged. Use this relation in search conditions.
nodes / active_nodes / nodes_with_age / active_nodes_with_age
Returns the set of Nodes whose MAC addresses are associated with this Device Port.
The active variants return only the subset of nodes currently in the switch MAC address table, that is the active ones.
The with_age variants add an additional column time_last_age, a preformatted value for the Node's time_last field, which reads as "X days/weeks/months/years".
logs
Returns the set of device_port_log entries associated with this Port.
power
Returns a row from the device_port_power table if one refers to this device port.
properties
Returns a row from the device_port_properties table if one refers to this device port.
ssid
Returns a row from the device_port_ssid table if one refers to this device port.
wireless
Returns a row from the device_port_wireless table if one refers to this device port.
native_vlan
Returns the row from the device_vlan table corresponding to the native vlan of this port.
agg_master
Returns another row from the device_port table if this port is slave to another in a link aggregate.
neighbor_alias
When a device port has an attached neighbor device, this relationship will return the IP address of the neighbor. See the neighbor helper method if what you really want is to retrieve the Device entry for that neighbor.
The JOIN is of type "LEFT" in case the neighbor device is known but has not been fully discovered by Netdisco and so does not exist itself in the database.
last_node
This relationship will return the last node that was seen on the port.
The JOIN is of type "LEFT" in case there isn't any such node.
vlans
As compared to port_vlans, this relationship returns a set of Device VLAN row objects for the VLANs on the given port, which might be more useful if you want to find out details such as the VLAN name.
See also vlan_count.
oui
DEPRECATED: USE MANUFACTURER INSTEAD
Returns the oui table entry matching this Port. You can then join on this relation and retrieve the Company name from the related table.
The JOIN is of type LEFT, in case the OUI table has not been populated.
manufacturer
Returns the manufacturer table entry matching this Port. You can then join on this relation and retrieve the Company name from the related table.
The JOIN is of type LEFT, in case the Manufacturer table has not been populated.
ADDITIONAL METHODS
neighbor
Returns the Device entry for the neighbour Device on the given port.
Might return an undefined value if there is no neighbor on the port, or if the neighbor has not been fully discovered by Netdisco and so does not exist in the database.
ADDITIONAL COLUMNS
native
An alias for the vlan column, which stores the PVID (that is, the VLAN ID assigned to untagged frames received on the port).
error_disable_cause
Returns the textual reason given by the device if the port is in an error state, or else `undef` if the port is not in an error state.
remote_is_discoverable
Returns true if Netdisco is permitted to discover the remote device with the configuration of the local poller doing the local device discovery.
remote_is_wap
Returns true if the remote LLDP neighbor has reported Wireless Access Point capability.
remote_is_phone
Returns true if the remote LLDP neighbor has reported Telephone capability.
ifindex
Returns the interface index (ifIndex) of the port.
pae_authsess_user
Returns the pae_authsess_user of the port.
pae_authsess_user_net_mac
Returns the pae_authsess_user of the port as a NetAddr::MAC instance.
pae_authconfig_port_control
Returns the pae_authconfig_port_control of the port.
pae_authconfig_state
Returns the pae_authconfig_state of the port.
pae_authconfig_port_status
Returns the pae_authconfig_port_status of the port.
pae_authsess_mab
Returns the pae_authsess_mab of the port.
pae_last_eapol_frame_source
Returns the pae_last_eapol_frame_source of the port.
remote_dns
Returns a hostname resolved from remote_ip column.
remote_inventory
Returns a synthesized description of the remote LLDP device if inventory information was given, including vendor, model, OS version, and serial number.
vlan_count
Returns the number of VLANs active on this device port. Enable this column by applying the with_vlan_count() modifier to search().
lastchange_stamp
Formatted version of the lastchange field, accurate to the minute. Enable this column by applying the with_times() modifier to search().
The format is somewhat like ISO 8601 or RFC3339 but without the middle T between the date stamp and time stamp. That is:
2012-02-06 12:49is_free
This method can be used to evaluate whether a device port could be considered unused, based on the last time it changed from the "up" state to a "down" state.
See the with_is_free and only_free_ports modifiers to search().
base64url_port
Returns a Base64 encoded version of the port column value suitable for use in a URL.
net_mac
Returns the mac column instantiated into a NetAddr::MAC object.
last_comment
Returns the most recent comment from the logs for this device port.