pve_metrics_server_set
Create or update a PVE metrics server definition. Dry-run returns a plan; set confirm=true to execute and apply new metrics forwarding settings immediately.
Instructions
MUTATION: create-or-update a PVE metrics server definition. Dry-run by default (returns a PLAN); confirm=True executes and returns {"status": "ok", "result": null} (no further payload). Config-only — metrics forwarding adjusts to the new settings immediately; no snapshot primitive, so re-apply this same tool to revert. To remove it use pve_metrics_server_delete.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| port | No | TCP/UDP port the metrics server listens on | |
| server | No | Hostname or IP address of the metrics server | |
| comment | No | Optional free-text comment stored with the metrics server definition | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the create/update | |
| disable | No | True disables forwarding to this metrics server without deleting the definition | |
| metrics_id | Yes | Unique ID of the metrics server definition to create or update | |
| metrics_type | No | Metrics backend type, e.g. 'influxdb' or 'graphite' | |
| proximo_target | No | Which configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |