Skip to content

README.md

Latest commit

 

History

History
95 lines (68 loc) · 2.51 KB

README.md

File metadata and controls

95 lines (68 loc) · 2.51 KB

clientapi_pbs

Python SDK for the Proxmox Backup Server API. Generated from the upstream apidoc.js from Proxmox Backup Server via openapi-generator-cli with custom Mustache template overrides.

Not an official Proxmox project. Community SDK derived from the upstream apidoc.js. Always verify against the upstream API viewer. https://pbs.proxmox.com/.

Requires Python ≥ 3.9.

Install

pip install clientapi-pbs

Or for development:

pip install -r requirements.txt

Usage

from clientapi_pbs import Configuration, Pve

cfg = Configuration(
    host='https://pbs1.example.com:8007/api2/json',
    api_key={'Authorization': 'PBSAPIToken=user@realm!tokenid:uuid-secret'},
)
pbs = Pbs(configuration=cfg)

# Per-tag properties are lazily instantiated and share the same ApiClient.
# `removeOperationIdPrefix=true` strips the tag prefix from method names,
# so the call is `pbs.qemu.vm_status(...)`, not `pbs.qemu.qemu_vm_status(...)` —
# you're already inside the `qemu` namespace.
status = pbs.qemu.vm_status(node='pbs1', vmid=100)
nodes = pbs.nodes.get_nodes()

Discovering available methods

Each per-tag API class lives at clientapi_pbs.api.<tag>_api.<Tag>Api. List its methods to see what's callable:

print([m for m in dir(pbs.qemu) if not m.startswith('_')])

Generated method-level docstrings explain parameters; the upstream endpoint reference is the upstream API viewer.

The unified Pbs class wraps each per-tag API class (QemuApi, LxcApi, ClusterApi, NodesApi, …) so consumers don't need to instantiate them individually.

Compound configs

PVE encodes many fields as CLI-style shorthand strings (net0=virtio,bridge=vmbr0,firewall=1). Round-trip helpers are emitted for every compound config schema:

from clientapi_pbs.models import PveQemuNetConfig

cfg = PveQemuNetConfig(model='virtio', bridge='vmbr0', firewall=1)
shorthand = cfg.to_shorthand()  # → 'virtio,bridge=vmbr0,firewall=1'

parsed = PveQemuNetConfig.from_shorthand(shorthand)

Indexed families

Numbered properties (net0..net31, mp0..mp255, …) are exposed on every model as a single collapsed nets / mps / … field:

req = QemuCreateVmRequest(
    nets={
        0: 'virtio,bridge=vmbr0',
        3: 'e1000,bridge=vmbr1',
    },
)
# Wire format: { 'net0': 'virtio,bridge=vmbr0', 'net3': 'e1000,bridge=vmbr1' }

License

Apache 2.0 — see LICENSE.