/ 
GeNUScreen-Config-v0.0.11
River stage zero No dependents
/ GeNUScreen::Config

NAME

GeNUScreen::Config - work with GeNUScreen configuration files

VERSION

This document describes GeNUScreen::Config version v0.0.11

SYNOPSIS

use GeNUScreen::Config;

my $thiscfg = GeNUScreen::Config->new();

$thiscfg->read_config($thisfile);

foreach ($thiscfg->get_keys()) {
  printf "%s = %s\n", $_, $thiscfg->get_value($_);
}

my $thatcfg = GeNUScreen::Config->new();

$thatcfg->read_config($thatfile);

my $cfgdiff = $thiscfg->diff($thatcfg);

print "Configurations are identical\n" if ($cfgdiff->is_empty());

foreach ($cfgdiff->get_keys()) {
  print "%s\n", $_;
  print " this = %s\n", $cfgdiff->get_this_value($_);
  print " that = %s\n", $cfgdiff->get_that_value($_);
}

DESCRIPTION

INTERFACE

Methods

new()

Returns a new GeNUScreen::Config object.

my $thiscfg = GeNUScreen::Config->new();
read_config($filename)

Reads the configuration either from a file that was exported from the GeNUScreen firewall via the web interface or from the config.hdf obtained via SSH or Console.

After calling read_config() the object contains only the configuration read from the last file. Any configuration that was held before is lost.

$thiscfg->read_config($thisfile);
get_keys()

Returns a list of all keys currently in the configuration.

my @keys = $thiscfg->get_keys();
get_value($key)

Returns the value for the given key.

foreach ($thiscfg->get_keys()) {
  printf "%s = %s\n", $_, $thiscfg->get_value($_);
}
diff($thatcfg)

Takes another GeNUScreen::Config object as argument and returns a GeNUScreen::Config::Diff object holding the differences between this and that object.

my $cfgdiff = $thiscfg->diff($thatcfg);

print "Configurations are identical\n" if ($cfgdiff->is_empty());

foreach ($cfgdiff->get_keys()) {
  print "%s\n", $_;
  print " this = %s\n", $cfgdiff_get_this_value($_);
  print " that = %s\n", $cfgdiff_get_that_value($_);
}

DIAGNOSTICS

Could not open %s for reading

This message is returned with croak when a configuration file could not be read.

read_config could not parse line %d in file %s: %s

CONFIGURATION AND ENVIRONMENT

GeNUScreen::Config requires no configuration files or environment variables.

DEPENDENCIES

None.

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-genuscreen-config@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Mathias Weidner <mamawe@cpan.org>

LICENCE AND COPYRIGHT

Copyright (c) 2010, Mathias Weidner <mamawe@cpan.org>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.