App::Netdisco::Util::Device
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.
:all
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.
$ip
DBIx::Class
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.
Given an IP address, deletes the device from Netdisco, including all related data such as logs and nodes. If the $archive parameter is true, then nodes will be maintained in an archive state.
$archive
Returns true if the transaction completes, else returns false.
Will update all records in Netdisco referring to the device with $current_ip to use $new_ip instead, followed by renumbering the device iteself.
$current_ip
$new_ip
Given a $type (which may be any text value), returns true if any of the list of regular expressions in $setting_name is matched, otherwise returns false.
$type
$setting_name
Given an IP address, returns true if Netdisco on this host is permitted by the local configuration to discover the device.
true
The configuration items discover_no and discover_only are checked against the given IP.
discover_no
discover_only
If $device_type is also given, then discover_no_type will also be checked.
$device_type
discover_no_type
Returns false if the host is not permitted to discover the target device.
Same as is_discoverable, but also checks the last_discover field if the device is in storage, and returns false if that host has been too recently discovered.
is_discoverable
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.
arpnip_no
arpnip_only
Returns false if the host is not permitted to arpnip the target device.
Same as is_arpnipable, but also checks the last_arpnip field if the device is in storage, and returns false if that host has been too recently arpnipped.
is_arpnipable
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.
macsuck_no
macsuck_only
Returns false if the host is not permitted to macsuck the target device.
Same as is_macsuckable, but also checks the last_macsuck field if the device is in storage, and returns false if that host has been too recently macsucked.
is_macsuckable
To install App::Netdisco, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::Netdisco
CPAN shell
perl -MCPAN -e shell install App::Netdisco
For more information on module installation, please visit the detailed CPAN module installation guide.