view release on metacpan or  search on metacpan

README.pod  view on Meta::CPAN

=head1 NAME

App::Netsync - network/database synchronization utility/library

=begin HTML

<a href="https://travis-ci.org/dmtucker/netsync"><img src="https://img.shields.io/travis/dmtucker/netsync.svg" alt="Build Status"></a>&nbsp;<a href="https://metacpan.org/pod/App::Netsync"><img src="https://img.shields.io/cpan/v/App-Netsync.svg" alt="...

=end HTML

=head1 DESCRIPTION

netsync is a network synchronization tool that:

 - maps network interfaces to their respective (potentially stacked) devices
 - gathers interface-specific information from an asset management database
 - sends the information it gathers to each device
 - provides ways of producing useful information about the network

I<Note: All communication with network nodes is done using SNMP.>

B<Overview>

In a typical run, execution begins by parsing a configuration file (-c).
Next, Netsync searches for active network devices at each node.
Nodes may be specified by filename, DNS (-D), or the keyboard (STDIN).
Furthermore, nodes may be required to match a hostname pattern (-m).
Gathered information may be used to identify each device in a database.
A database may be specified using Database (-d) or DB in the configuration file.
Identified devices may then be updated (-u) with interface-specific information.

See F<doc/algorithm.svg> for corresponding visual guidance
(F</usr/share/netsync/algorithm.svg> after installation).

=head2 0 Installation

 $ cpan App::Netsync

or

 $ perl Makefile.PL
 $ make
 $ make test
 $ make install

B<Modules>

=over 4

=item App::Netsync::Configurator

configuration file support

=item App::Netsync::Network

methods for manipulating network structures

=item App::Netsync::Scribe

I/O framework

=item App::Netsync::SNMP

SNMP framework

=back

=head2 1 Invocation

After installation, netsync may be invoked by name:

 $ netsync

If installation is skipped, netsync may be manually invoked as follows:

 $ perl -I lib script/netsync

B<Options>

=over 4

=item -h --help

Help. Print usage and options.

I<Note: Help and Version print information and exit.
        Normal execution is skipped when either of these options are used.>

=item -V