Skip to main content

pandoraPlugintoolsBasic

pandoraPlugintoolsBasic is a lightweight, dependency-free version of pandoraPlugintools for Pandora FMS plugin development.

It is designed as a drop-in replacement for the most commonly used functionality, with a smaller footprint and simpler deployment.

Install

pip install pandoraPlugintools-basic

Migration from pandoraPlugintools

If your plugin only uses the basic features included in this package, migrate with:

pip uninstall pandoraPlugintools
pip install pandoraPlugintools-basic

Important:

  • This package does not include all features from the full pandoraPlugintools package.
  • If your current code depends on advanced modules (for example SNMP or encryption helpers), keep using the standard package.

What is included

The package exports the following modules:

  • general: General-purpose helper functions for plugin development.
  • threads: Utilities for running functions in parallel.
  • agents: Functions to build Pandora FMS agent payloads.
  • modules: Functions to build Pandora FMS module payloads.
  • transfer: File transfer and data sending helpers.
  • discovery: Helpers for Pandora FMS discovery plugins.
  • output: Output formatting and return helpers.

Reference documentation: PluginTools Reference Documentation

For a full, runnable example per function, see docs/examples.md.

Most used functions

The README stays focused on the quick path. For a complete function list and full details, use the reference documentation link above.

Module Common functions
general generate_md5, safe_input, safe_output, parse_configuration, parse_csv_file, translate_macros, now
agents init_agent, print_agent, get_os
modules init_module, print_module, init_log_module, print_log_module
transfer write_xml, transfer_xml, tentacle_xml
threads run_threads, run_processes, set_shared_dict_value, get_shared_dict_value
discovery set_disco_summary, add_disco_summary_value, add_disco_info_value, add_disco_monitoring_data, disco_output
output print_stdout, print_stderr, print_debug, logger

Quick example

import pandoraPlugintools as ppt

# Define agent
server_name = "WIN-SERV"

agent = ppt.init_agent(
    {
        "agent_name": ppt.generate_md5(server_name),
        "agent_alias": server_name,
        "description": "Default Windows server",
    }
)

# Define modules
modules = []
data = 10

modules.append(
    {
        "name": "CPU usage",
        "type": "generic_data",
        "value": data,
        "desc": "Percentage of CPU utilization",
        "unit": "%",
    }
)

# Generate and transfer XML
xml_content = ppt.print_agent(agent, modules)
xml_file = ppt.write_xml(xml_content, agent["agent_name"])

ppt.transfer_xml(
    xml_file,
    transfer_mode="tentacle",
    tentacle_ip="192.168.1.20",
    tentacle_port="41121",
)

Metadata

Release files for pandoraPlugintools-basic 1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pandoraPlugintools-basic 1.1.1
File Size Uploaded Provenance Actions
pandoraplugintools_basic-1.1.1.tar.gz 22.7 kB Without provenance Details for pandoraplugintools_basic-1.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pandoraPlugintools-basic 1.1.1
File Interpreter ABI Platform Actions
pandoraplugintools_basic-1.1.1-py3-none-any.whl Python 3 none any Details for pandoraplugintools_basic-1.1.1-py3-none-any.whl

Total release size: 47.7 kB

Release files / pandoraplugintools_basic-1.1.1.tar.gz

Download URL pandoraplugintools_basic-1.1.1.tar.gz
Size 22.7 kB
Tags Source
SHA-256 checksum
How to use checksums
2526e0856bcf80b53307751296d9ea8ac2d829c5d6c4ac8da7d921926a59a22b
BLAKE2b-256 checksum
How to use checksums
e41aedfd3621c640d7df638e1e49c83319adfb32b8dae17e68b12b0e52941b9a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.13

Release files / pandoraplugintools_basic-1.1.1-py3-none-any.whl

Download URL pandoraplugintools_basic-1.1.1-py3-none-any.whl
Size 25.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ee8dcd539f799823c085c1d9a7886deaa5a9565e7116e0bd9fbe07070d372c26
BLAKE2b-256 checksum
How to use checksums
4d178d20bacdfe8f65db355c17309738ff2f501332817490e99b8f9a016a3c59
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.13

Security for pandoraPlugintools-basic 1.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page