NAME
Device::PaloAlto:Firewall::Return - Return values for Device::PaloAlto::Firewall methods.
VERSION
version 0.071
DESCRIPTION
The Device::PaloAlto::Firewall package has methods which make API calls against the firewall. The return values from these methods are either hash or array references where appropriate.
Apart from some data structure re-organisation and/or simplification, the values returned are verbatim what was receveied from the firewall in the API response.
Both the hash keys and example values are documented for each method to provide more context.
RETURN VALUES
METHODS
PLATFORM
system_info
{
'wildfire-release-date' => 'unknown',
'vm-license' => 'VM-100',
'wildfire-version' => '0',
'default-gateway' => '10.47.67.126',
'wf-private-release-date' => 'unknown',
'ipv6-default-gateway' => {},
'multi-vsys' => 'off',
'wf-private-version' => '0',
'global-protect-datafile-version' => '0',
'av-release-date' => 'unknown',
'global-protect-client-package-version' => '0.0.0',
'netmask' => '255.255.255.192',
'ipv6-address' => 'unknown',
'vm-mode' => 'VMWare ESXi',
'platform-family' => 'vm',
'global-protect-datafile-release-date' => 'unknown',
'av-version' => '0',
'threat-version' => '0',
'url-db' => 'paloaltonetworks',
'vpn-disable-mode' => 'off',
'devicename' => 'PA-VM',
'model' => 'PA-VM',
'ip-address' => '10.47.67.69',
'time' => 'Fri Aug 25 10:32:03 2017\n'
'mac-address' => '00:50:56:97:e1:bd',
'family' => 'vm',
'threat-release-date' => 'unknown',
'app-release-date' => 'unknown',
'app-version' => '564-3168',
'vm-uuid' => '4217C1F1-986E-10E7-375E-664A93CF453A',
'operational-mode' => 'normal',
'vm-mac-base' => 'D4:1D:71:D8:8D:00',
'ipv6-link-local-address' => 'fe80::250:56ff:fe97:e1bd/64',
'serial' => '007000000025137',
'is-dhcp' => 'no',
'sw-version' => '7.1.11',
'vm-mac-count' => '256',
'url-filtering-version' => '0000.00.00.000',
'hostname' => 'PA-VM',
'uptime' => '34 days, 21:56:18',
'vm-cpuid' => 'E4060300FFFBAB1F',
'logdb-version' => '7.0.9'
};environmentals
If the device is a VM, there are no environmentals an an empty HASHREF is returned.
{
'fantray' => {
'Slot1' => [
{
'min' => '1',
'Inserted' => 'True',
'description' => 'Fan Tray',
'slot' => '1',
'alarm' => 'False'
}
]
},
'power-supply' => {
'Slot1' => [
{
'slot' => '1',
'alarm' => 'False',
'Inserted' => 'True',
'min' => 'True',
'description' => 'Power Supply #1 (left)'
},
]
},
'thermal' => {
'Slot1' => [
{
'min' => '5.0',
'description' => 'Temperature @ 10G Phys [U171]',
'DegreesC' => '34.5',
'max' => '60.0',
'slot' => '1',
'alarm' => 'False'
},
]
},
'fan' => {
'Slot1' => [
{
'min' => '2500',
'description' => 'Fan #1 RPM',
'RPMs' => '6136',
'slot' => '1',
'alarm' => 'False'
},
]
},
'power' => {
'Slot1' => [
{
'description' => '1.0V Power Rail',
'min' => '0.9',
'max' => '1.1',
'slot' => '1',
'Volts' => '1.00066666667',
'alarm' => 'False'
}
]
}
};high_availability
NETWORK
interfaces
interface_counters_logical
routing_table
bgp_peers
bgp_rib
[
{
'nexthop' => '192.168.122.30',
'received-from' => 'c1000v.local',
'as-path' => '65001',
'prefix' => '9.9.9.0/24',
'flag' => '*',
'flap-stat' => {
'flap-count' => '0'
},
'attr' => {
'local-preference' => '100',
'med' => '0',
'origin' => 'IGP',
'originator-id' => '0.0.0.0',
'weight' => '0'
}
},
];pim_neighbours
[
{
'Address' => '192.168.122.30',
'IfIndex' => 'ethernet1/1',
'DRPriority' => '1',
'sec' => {},
'ExpiryTime' => '94.06',
'UpTime' => '44.97',
'GenerationIDPresent' => 'yes',
'GenerationIDValue' => '1410841443'
}
]bfd_peers
MANAGEMENT
ntp
panorama_status
[
{
'ip' => '1.1.1.1',
'ha_state' => 'disconnected',
'connected' => 'no',
'id' => '1'
},
{
'ha_state' => 'disconnected',
'id' => '2',
'connected' => 'no',
'ip' => '1.1.1.2'
}
];SECURITY
ip_user_mapping
userid_server_monitor
ike_peers
[
{
'mode' => 'Main',
'name' => 'c1000v',
'expires' => 'Aug.29 02:02:49',
'created' => 'Aug.28 18:02:49',
'algo' => 'PSK/ DH5/ AES/SHA512',
'gwid' => '1',
'role' => 'Resp'
}
];ipsec_peers
[ { 'i_spi' => '-6187583', 'o_spi' => '-623460235', 'life' => '2847', 'proto' => 'ESP', 'tid' => '1', 'remote' => '192.168.122.30 ', 'hash' => 'MD5', 'enc' => '3DES', 'kb' => '4608000', 'name' => 'c1000v(c1000v)', 'gwid' => '1' } ];
vpn_tunnels
[
{
'natt' => 'False',
'pkt-decap' => '5',
'sid' => '208',
'pkt-replay' => '0',
'type' => 'IPSec',
'anti-replay' => 'False',
'state' => 'active',
'proto' => 'ESP',
'auth' => 'md5',
'monitor' => {
'pkt-seen' => '0',
'threshold' => '0',
'on' => 'False',
'pkt-reply' => '0',
'status' => 'False',
'interval' => '0',
'pkt-recv' => '0',
'pkt-sent' => '0'
},
'pkt-lifesize' => '0',
'inner-if' => 'tunnel.1',
'remain' => '2568',
'id' => '1',
'natt-lp' => '0',
'auth-err' => '0',
'context' => '4',
'copy-tos' => 'False',
'owner' => '1',
'dec-err' => '0',
'byte-encap' => '600',
'acquire' => '0',
'owner-state' => '0',
'timestamp' => '2531',
'remote-spi' => 'DAD6C075',
'byte-decap' => '600',
'gwid' => '1',
'pkt-lifetime' => '0',
'name' => 'c1000v',
'local-spi' => 'FFA195C1',
'natt-rp' => '0',
'seq-recv' => '0',
'mtu' => '1436',
'subtype' => 'None',
'peerip' => '192.168.122.30',
'keytype' => 'auto key',
'last-rekey' => '1032',
'pkt-encap' => '5',
'seq-send' => '5',
'start' => '2531',
'inner-warn' => '0',
'outer-if' => 'ethernet1/1',
'owner-cpuid' => '0',
'localip' => '192.168.122.19',
'enc' => '3des'
}
];