NAME
App::Netdisco::Util::Device
DESCRIPTION
A set of helper subroutines to support parts of the Netdisco application.
There are no default exports, however the :all
tag will export all subroutines.
EXPORT_OK
get_device( $ip )
Given an IP address, returns a DBIx::Class::Row object for the Device in the Netdisco database. The IP can be for any interface on the device.
If for any reason $ip
is already a DBIx::Class
Device object, then it is simply returned.
If the device or interface IP is not known to Netdisco a new Device object is created for the IP, and returned. This object is in-memory only and not yet stored to the database.
check_acl( $ip, \@prefixes )
Given the IP address of a device, returns true if any of the IP prefixes in \@prefixes
contains that device, otherwise returns false.
Normally you use check_no
and check_only
, passing the name of the configuration setting to load. This helper instead requires not the name of the setting, but its value.
check_no( $ip, $setting_name )
Given the IP address of a device, returns true if the configuration setting $setting_name
matches that device, else returns false.
print "rejected!" if check_no($ip, 'discover_no');
There are several options for what $setting_name
can contain:
Hostname, IP address, IP prefix
"model:regex"
- matched against the device model"vendor:regex"
- matched against the device vendor
To simply match all devices, use "any
" or IP Prefix "0.0.0.0/0
". All regular expressions are anchored (that is, they must match the whole string). To match no devices we recommend an entry of "localhost
" in the setting.
check_only( $ip, $setting_name )
Given the IP address of a device, returns false if the configuration setting $setting_name
matches that device, else returns true.
print "rejected!" unless check_only($ip, 'discover_only');
There are several options for what $setting_name
can contain:
Hostname, IP address, IP prefix
"model:regex"
- matched against the device model"vendor:regex"
- matched against the device vendor
To simply match all devices, use "any
" or IP Prefix "0.0.0.0/0
". All regular expressions are anchored (that is, they must match the whole string). To match no devices we recommend an entry of "localhost
" in the setting.
is_discoverable( $ip, $device_type? )
Given an IP address, returns true
if Netdisco on this host is permitted by the local configuration to discover the device.
The configuration items discover_no
and discover_only
are checked against the given IP.
If $device_type
is also given, then discover_no_type
will also be checked.
Returns false if the host is not permitted to discover the target device.
is_arpnipable( $ip )
Given an IP address, returns true
if Netdisco on this host is permitted by the local configuration to arpnip the device.
The configuration items arpnip_no
and arpnip_only
are checked against the given IP.
Returns false if the host is not permitted to arpnip the target device.
is_macsuckable( $ip )
Given an IP address, returns true
if Netdisco on this host is permitted by the local configuration to macsuck the device.
The configuration items macsuck_no
and macsuck_only
are checked against the given IP.
Returns false if the host is not permitted to macsuck the target device.