bgp_sessions
Read-onlyIdempotent
Retrieve BGP sessions from LibreNMS with filters for ASN, hostname, state, and address family to monitor peering status.
Instructions
List BGP sessions from LibreNMS with optional filters.
Returns: dict: The JSON response from the API.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| asn | No | Filter by local ASN | |
| limit | No | Maximum number of results to return | |
| offset | No | Number of results to skip (offset) for pagination | |
| hostname | No | Filter by device hostname | |
| bgp_descr | No | Filter by BGP description (SQL LIKE) | |
| bgp_state | No | Filter by BGP state (e.g., established) | |
| bgp_family | No | Filter by address family: 4 (IPv4) or 6 (IPv6) | |
| remote_asn | No | Filter by remote ASN | |
| local_address | No | Filter by local IP address | |
| bgp_adminstate | No | Filter by admin state (start, stop, running) | |
| remote_address | No | Filter by remote IP address |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||