﻿---
title: Panw module
description: The panw Metricbeat module uses the Palo Alto pango package to extract metrics information from a firewall device via the XML API. The panw module configuration...
url: https://www.elastic.co/elastic/docs-builder/docs/2422/reference/beats/metricbeat/metricbeat-module-panw
---

# Panw module
<warning>
  This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
</warning>

<admonition title="Prefer to use Elastic Agent for this use case?">
  Refer to the [Elastic Integrations documentation](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/2422/reference/panw).
  <dropdown title="Learn more">
    Elastic Agent is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to the documentation for a detailed [comparison of Beats and Elastic Agent](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/2422/reference/fleet).
  </dropdown>
</admonition>

The panw Metricbeat module uses the Palo Alto [pango](https://pkg.go.dev/github.com/PaloAltoNetworks/pango#section-documentation) package to extract metrics information from a firewall device via the XML API.

### Dashboards


### Module-specific configuration notes

The panw module configuration requires the ip address of the target firewall device and an API Key generated from that firewall. It is assumed that network access to the firewall is available. All access by the panw module is read-only.
**Limitations** The current version of the module is configured to run against **exactly 1** firewall. Multiple firewalls will require multiple agent configurations. The module has also not been tested with Panorama, though it should work since it only relies on lower level Client.Op calls to send XML API commands to the server.
Required credentials for the `panw` module:
<definitions>
  <definition term="host_ip">
    IP address of the firewall - must be network accessible.
  </definition>
  <definition term="apiKey">
    An API Key generated via an XML API call to the firewall or via the management dashboard. This
  </definition>
</definitions>


## Metricsets


### `bgp_peers`

This metricset reports information on BGP Peers defined in the firewall.

### `certificates`

This metricset will capture certificates defined on the firewall including expiration dates.

### `fans`

This metricset will collect information from hardware fans (RPMS) and will report if an alarm is active for a given fan.

### `filesystem`

This metricset reports disk usage for filesystems defined on the device, based on df output.

### `globalprotect_sessions`

This metricset will collect metrics on current user sessions established on Global Protect gateways.

### `globalprotect_stats`

This metricset reports the number of user per GlobalProtect gateway and totals across all gateways.

### `ha_interfaces`

This metricset will collect metrics from the device on High Availabilty configuration for interfaces.

### `licenses`

This metricset reports on licenses for sofware features with expiration dates.

### `logical`

This metricset will collect metrics on logical interfaces in the device’s network.

### `power`

This metricset reports power usage and alarms.

### `system`

This metricset captures system informate such as uptime, user count, CPU, memory and swap: essentiallyl the first 5 lines of *top* output.

### `temperature`

This metricset reports temperature for various slots on the device and reports on alarm status.

### `tunnels`

This metricset enumerates ipsec tunnels and their status.

## Example configuration

The Panw module supports the standard configuration options that are described in [Modules](https://www.elastic.co/elastic/docs-builder/docs/2422/reference/beats/metricbeat/configuration-metricbeat). Here is an example configuration:
```yaml
metricbeat.modules:
- module: panw
  metricsets: ["licenses"]
  enabled: false
  period: 10s
  hosts: ["localhost"]
```


## Metricsets

The following metricsets are available:
- [interfaces](https://www.elastic.co/elastic/docs-builder/docs/2422/reference/beats/metricbeat/metricbeat-metricset-panw-interfaces)  `stack: beta`
- [routing](https://www.elastic.co/elastic/docs-builder/docs/2422/reference/beats/metricbeat/metricbeat-metricset-panw-routing)  `stack: beta`
- [system](https://www.elastic.co/elastic/docs-builder/docs/2422/reference/beats/metricbeat/metricbeat-metricset-panw-system)  `stack: beta`
- [vpn](https://www.elastic.co/elastic/docs-builder/docs/2422/reference/beats/metricbeat/metricbeat-metricset-panw-vpn)  `stack: beta`