/ 
Firewall-PaloAlto-0.01
River stage zero No dependents
/ Firewall::PaloAlto

NAME

Firewall::PaloAlto - Interact with a Palo Alto firewall's API through Perl.

VERSION

Version 0.01

SYNOPSIS

Quick summary of what the module does.

Perhaps a little code snippet.

use Firewall::PaloAlto;

my $foo = Firewall::PaloAlto->new();
...

EXPORT

A list of functions that can be exported. You can delete this section if you don't export anything, such as for a purely object-oriented module.

SUBROUTINES/METHODS

OBJECT METHODS

commit([vsys_id => $num], [poll => $seconds])

The commit function commits the current candidate configuration to the Palo Alto firewall.

The 'vsys_id' argument takes the virtual system ID (which ranges from [1 - 225]). If it is defined, a partial commit is performed on that vsys. i If no vsys is defined, the firewall performs a complete commit.

The 'poll' argument takes an integer number of seconds. The script will check on the status of the commit job and return information every poll interval. If poll is not specified, the poll interval defaults to 5 seconds.

$pa_firewall->commit(vsys_id => 10, poll => 10);

connect(host => $hostname, username => $user, password => $pass, [ssl => 0|1], [debug => 0|1])

This function connects to the Palo Alto with the credentials specified.

Host, username and password are mandatory. If not specified SSL is used, but it can be disabled using the argument ssl => 0

Detailed debugging can be turned on using the debu => 1 argument. It is off by default.

vsys($action, vsys_id => $id, display-name => $name)

vsys_import($action, vsys_id => $id, interface => [ $int1, $int2 ], virtual-router => [ $vr1, $vr2 ])

l3_subinterface($action, parent => $interface, tag => $vlan, comment => $description)

virtual_router($action, vr_name => $name, interface => [ $int1, $int2 ])

zone($action, vsys_id => $id, zone => $name, layer3 => [ $int1, $int2 ])

ipv4_static_route($action, vr_name => $vr_name, route_name => $rt_name, desintation => $route, nexthop => { ip-address => $ip | interface => $egress_int })

ipv6_static_route($action, vr_name => $vr_name, route_name => $rt_name, desintation => $route, nexthop => { ipv6-address => $ip | interface => $egress_int })

address($action, vsys_id => $id, name => $address_name, ip-netmask => $ipnet | ip-range => $range)

address_group($action, vsys_id => $id, name => $group_name, member => [ $addr1, $addr2 ])

security_rule($action, vsys_id => $id, name => $rulename, [from => $zone_frm, to => $zone_to, source => [ $addr1, ... ], $destination => [ $addr2, ... ], application => [ $app1, ... ], source-user => [ $user1, ... ], hip-profiles => [ $profile1, ... ], action => 'allow'|'deny')

AUTHOR

Greg Foletta, <greg at foletta.org>

BUGS

Please report any bugs or feature requests to bug-firewall-paloalto at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Firewall-PaloAlto. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Firewall::PaloAlto

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2015 Greg Foletta.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.