86 lines
6.4 KiB
Markdown
86 lines
6.4 KiB
Markdown
# API Proxmox VE 9.x utilisée par pve-confsync
|
|
|
|
Vérifiée le 2026-10-13 dans les sources Proxmox (miroirs GitHub officiels), faute d'accès
|
|
à l'API viewer (https://pve.proxmox.com/pve-docs/api-viewer/) depuis l'environnement de
|
|
développement. Versions lues : pve-manager 9.2.21, libpve-network-perl 1.6.7, pve-cluster 9.1.6.
|
|
**À recouper avec l'API viewer et les deux clusters de labo avant la phase 1.**
|
|
|
|
Toutes les routes sont relatives à `/api2/json`. Authentification : en-tête
|
|
`Authorization: PVEAPIToken=USER@REALM!TOKENID=SECRET`. Écritures en
|
|
`application/x-www-form-urlencoded` (tableaux = paramètre répété), suppression de champs
|
|
via le paramètre `delete=a,b`.
|
|
|
|
## Version et cluster
|
|
|
|
| Méthode | Chemin | Usage | Droit |
|
|
|---|---|---|---|
|
|
| GET | `/cluster/status` | nœuds en ligne | Sys.Audit sur / |
|
|
| GET | `/nodes/{node}/version` | `version` (9.2.21), `release` (9.2) : refus si majeur ≠ 9 | — |
|
|
| GET | `/version` | repli pour un nœud isolé ([API2.pm](https://github.com/proxmox/pve-manager/blob/9c3f5e5258f73f31e273493232a79d615fd9e072/PVE/API2.pm#L86)) | — |
|
|
| GET | `/access/permissions` | droits effectifs du token (`check`) ([AccessControl.pm](https://github.com/proxmox/pve-access-control/blob/master/src/PVE/API2/AccessControl.pm#L510)) | — |
|
|
| GET | `/nodes/{node}/tasks/{upid}/status` | suivi de la tâche de rechargement SDN | — |
|
|
|
|
## Options datacenter (`datacenter.cfg`)
|
|
|
|
| Méthode | Chemin | Droit |
|
|
|---|---|---|
|
|
| GET | `/cluster/options` ([Cluster.pm](https://github.com/proxmox/pve-manager/blob/9c3f5e5258f73f31e273493232a79d615fd9e072/PVE/API2/Cluster.pm#L775)) | Sys.Audit sur / (sinon seuls console et tag-style) |
|
|
| PUT | `/cluster/options` ([Cluster.pm](https://github.com/proxmox/pve-manager/blob/9c3f5e5258f73f31e273493232a79d615fd9e072/PVE/API2/Cluster.pm#L830)) | Sys.Modify sur / |
|
|
|
|
Points d'attention ([DataCenterConfig.pm](https://github.com/proxmox/pve-cluster/blob/7091d92e594952dba65c1e57568b3d7cc244e960/src/PVE/DataCenterConfig.pm#L560)) :
|
|
|
|
- le GET renvoie des valeurs **déjà analysées** : `tag-style`, `next-id`, `user-tag-access`,
|
|
`migration`, `ha`, `crs`, `notify`, `webauthn`, `u2f` sous forme d'objets,
|
|
`registered-tags` et `user-tag-access.user-allow-list` sous forme de tableaux ;
|
|
le PUT attend des *property strings* (`shape=full,color-map=a:ff0000`, listes séparées par `;`).
|
|
L'adaptateur stocke la forme canonique « property string, clés triées ».
|
|
- le GET ajoute toujours `description` (vide possible), `mac_prefix` (`BC:24:11` par défaut,
|
|
[L11](https://github.com/proxmox/pve-cluster/blob/7091d92e594952dba65c1e57568b3d7cc244e960/src/PVE/DataCenterConfig.pm#L11)) et `allowed-tags` (lecture seule) : retirés à la normalisation.
|
|
- formats : `tag-style` [L286](https://github.com/proxmox/pve-cluster/blob/7091d92e594952dba65c1e57568b3d7cc244e960/src/PVE/DataCenterConfig.pm#L286),
|
|
`user-tag-access` [L321](https://github.com/proxmox/pve-cluster/blob/7091d92e594952dba65c1e57568b3d7cc244e960/src/PVE/DataCenterConfig.pm#L321),
|
|
`next-id` [L203](https://github.com/proxmox/pve-cluster/blob/7091d92e594952dba65c1e57568b3d7cc244e960/src/PVE/DataCenterConfig.pm#L203).
|
|
|
|
## SDN ([SDN.pm](https://github.com/proxmox/pve-network/blob/ce388c5eec2376576d62a6be708439a64cf7fb62/src/PVE/API2/Network/SDN.pm))
|
|
|
|
| Méthode | Chemin | Usage | Droit |
|
|
|---|---|---|---|
|
|
| POST | `/cluster/sdn/lock` | verrou global, renvoie le `lock-token` ; refusé s'il existe des changements en attente (sauf `allow-pending=1`) | SDN.Allocate sur /sdn |
|
|
| DELETE | `/cluster/sdn/lock` | libère le verrou (`lock-token` ou `force=1`) | SDN.Allocate |
|
|
| POST | `/cluster/sdn/rollback` | annule les changements en attente (`lock-token`, `release-lock`) | SDN.Allocate |
|
|
| PUT | `/cluster/sdn` | commit + rechargement réseau de tous les nœuds, renvoie un UPID (`lock-token`, `release-lock`) | SDN.Allocate |
|
|
| GET | `/cluster/sdn/dry-run?node=` | diff frr / interfaces.d/sdn (libpve-network-perl ≥ 1.3.0, mars 2026) : non utilisé en phase 0 | Sys.Audit sur /nodes/{node} |
|
|
| GET | `/nodes/{node}/sdn/zones` | statut des zones par nœud (`available`, `pending`, `error`) | SDN.Audit |
|
|
|
|
Le verrou et le paramètre `lock-token` sur toutes les écritures existent depuis
|
|
libpve-network-perl 1.1.3 (juillet 2025, avant PVE 9.0) : disponibles sur tout PVE 9.x.
|
|
|
|
### Zones, VNets, subnets
|
|
|
|
| Objet | Liste / création | Élément | Notes |
|
|
|---|---|---|---|
|
|
| zone | `/cluster/sdn/zones` | `/cluster/sdn/zones/{zone}` | GET d'un élément = SDN.**Allocate** : on lit donc la liste (SDN.Audit suffit) |
|
|
| vnet | `/cluster/sdn/vnets` | `/cluster/sdn/vnets/{vnet}` | |
|
|
| subnet | `/cluster/sdn/vnets/{vnet}/subnets` | `.../subnets/{zone}-{ip}-{masque}` | création : `subnet=<cidr>`, `type=subnet` ; id calculé ([SubnetPlugin.pm](https://github.com/proxmox/pve-network/blob/ce388c5eec2376576d62a6be708439a64cf7fb62/src/PVE/Network/SDN/SubnetPlugin.pm#L42)) |
|
|
|
|
Les GET acceptent `running=1` (configuration appliquée) ou `pending=1` ; sans paramètre,
|
|
la configuration courante, en attente comprise. La référence est lue en `running=1`,
|
|
les clients sans paramètre.
|
|
|
|
Champs (schémas : [VlanPlugin.pm](https://github.com/proxmox/pve-network/blob/ce388c5eec2376576d62a6be708439a64cf7fb62/src/PVE/Network/SDN/Zones/VlanPlugin.pm),
|
|
[VxlanPlugin.pm](https://github.com/proxmox/pve-network/blob/ce388c5eec2376576d62a6be708439a64cf7fb62/src/PVE/Network/SDN/Zones/VxlanPlugin.pm),
|
|
[VnetPlugin.pm](https://github.com/proxmox/pve-network/blob/ce388c5eec2376576d62a6be708439a64cf7fb62/src/PVE/Network/SDN/VnetPlugin.pm),
|
|
[SubnetPlugin.pm](https://github.com/proxmox/pve-network/blob/ce388c5eec2376576d62a6be708439a64cf7fb62/src/PVE/Network/SDN/SubnetPlugin.pm)) :
|
|
|
|
- zone vlan : `bridge` (obligatoire), `bridge-disable-mac-learning`, `nodes`, `mtu`, `dns`, `reversedns`, `dnszone`, `ipam`
|
|
- zone vxlan : `peers`, `vxlan-port` (4789), `fabric`, `nodes`, `mtu`, `dns`, `reversedns`, `dnszone`, `ipam`
|
|
- vnet : `zone` (obligatoire), `tag`, `alias`, `vlanaware`, `isolate-ports`
|
|
- subnet : `vnet`, `gateway`, `snat`, `dnszoneprefix`, `dhcp-range` (tableau), `dhcp-dns-server`
|
|
- calculés par PVE, ignorés : `digest`, `state`, `pending`, et pour les subnets `cidr`, `network`, `mask`, `zone`
|
|
|
|
## Droits minimaux
|
|
|
|
- **Référence** (lecture seule) : rôle avec `Sys.Audit` + `SDN.Audit` sur `/`.
|
|
- **Clients** : `Sys.Audit` + `SDN.Audit` + `SDN.Allocate` sur `/` (ou `/sdn`) ;
|
|
`Sys.Modify` sur `/` uniquement si les options datacenter sont synchronisées
|
|
(`PUT /cluster/options` n'a pas de droit plus fin).
|