mirror of
https://github.com/MacRimi/ProxMenux.git
synced 2026-11-02 19:02:31 +00:00
docs: review command references in all seven translations
This commit is contained in:
Jonatan
@@ -14,7 +14,7 @@
|
||||
},
|
||||
"intro": {
|
||||
"title": "Three backup modes",
|
||||
"body": "<strong>snapshot</strong> uses a live snapshot — guest stays running, briefly pauses I/O. <strong>suspend</strong> freezes the VM during backup (safer than snapshot for non-snapshot-aware FS). <strong>stop</strong> shuts down the VM, backs up cold, restarts. Pick by guest tolerance and storage capability."
|
||||
"body": "For VMs, <strong>snapshot</strong> is a live backup and does not require storage snapshots. <strong>suspend</strong> pauses the VM before the live backup and does not necessarily improve consistency. <strong>stop</strong> shuts the VM down first; a previously running VM can resume once backup has started. LXC differs: snapshot mode requires snapshot-capable storage, suspend uses two rsync passes, and stop keeps the container stopped during backup."
|
||||
},
|
||||
"commandGroups": [
|
||||
{
|
||||
@@ -34,18 +34,18 @@
|
||||
},
|
||||
{
|
||||
"command": "vzdump <vmid> --mode suspend",
|
||||
"description": "Suspend VM during backup"
|
||||
"description": "Pause VM before the live backup (legacy suspend mode)"
|
||||
},
|
||||
{
|
||||
"command": "vzdump <vmid> --mode stop",
|
||||
"description": "Stop VM during backup"
|
||||
"description": "Shut down VM before starting the backup"
|
||||
},
|
||||
{
|
||||
"command": "vzdump --all",
|
||||
"description": "Backup all VMs and containers"
|
||||
},
|
||||
{
|
||||
"command": "vzdump --exclude <vmid1>,<vmid2>",
|
||||
"command": "vzdump --all --exclude <vmid1>,<vmid2>",
|
||||
"description": "Backup all except specified VMs"
|
||||
}
|
||||
]
|
||||
@@ -58,11 +58,11 @@
|
||||
"description": "Use zstd compression for backup"
|
||||
},
|
||||
{
|
||||
"command": "vzdump <vmid> --pigz <threads>",
|
||||
"command": "vzdump <vmid> --compress gzip --pigz <threads>",
|
||||
"description": "Use pigz with multiple threads"
|
||||
},
|
||||
{
|
||||
"command": "vzdump <vmid> --notes <text>",
|
||||
"command": "vzdump <vmid> --storage <storage> --notes-template <text>",
|
||||
"description": "Add notes to backup"
|
||||
},
|
||||
{
|
||||
@@ -70,7 +70,7 @@
|
||||
"description": "Send notification email"
|
||||
},
|
||||
{
|
||||
"command": "vzdump <vmid> --maxfiles <n>",
|
||||
"command": "vzdump <vmid> --prune-backups keep-last=<n>",
|
||||
"description": "Keep only n backups per VM"
|
||||
},
|
||||
{
|
||||
@@ -96,7 +96,7 @@
|
||||
},
|
||||
{
|
||||
"command": "qmrestore <backup-file> <vmid> --unique",
|
||||
"description": "Create a VM with unique ID"
|
||||
"description": "Restore VM with newly generated random MAC addresses"
|
||||
},
|
||||
{
|
||||
"command": "pct restore <vmid> <backup-file>",
|
||||
@@ -107,8 +107,8 @@
|
||||
"description": "Restore container to specific storage"
|
||||
},
|
||||
{
|
||||
"command": "pct restore <vmid> <backup-file> --rootfs <storage>",
|
||||
"description": "Restore to specific rootfs"
|
||||
"command": "pct restore <vmid> <backup-file> --rootfs <storage>:<size-GiB>",
|
||||
"description": "Restore with a root disk allocated on the chosen storage and size"
|
||||
},
|
||||
{
|
||||
"command": "pct restore <vmid> <backup-file> --unprivileged 1",
|
||||
@@ -132,7 +132,7 @@
|
||||
"description": "Find container backups"
|
||||
},
|
||||
{
|
||||
"command": "pvesm list <storage>",
|
||||
"command": "pvesm list <storage> --content backup",
|
||||
"description": "List backups in specific storage"
|
||||
},
|
||||
{
|
||||
@@ -149,7 +149,7 @@
|
||||
"title": "Scheduled Backups",
|
||||
"commands": [
|
||||
{
|
||||
"command": "cat /etc/cron.d/vzdump",
|
||||
"command": "cat /etc/pve/jobs.cfg",
|
||||
"description": "Show backup schedule"
|
||||
},
|
||||
{
|
||||
@@ -158,19 +158,19 @@
|
||||
},
|
||||
{
|
||||
"command": "systemctl list-timers",
|
||||
"description": "List all scheduled tasks"
|
||||
"description": "List systemd timers"
|
||||
},
|
||||
{
|
||||
"command": "systemctl status cron",
|
||||
"description": "Check cron service status"
|
||||
},
|
||||
{
|
||||
"command": "grep vzdump /var/log/syslog",
|
||||
"description": "Check backup logs in syslog"
|
||||
"command": "pvenode task list --typefilter vzdump",
|
||||
"description": "List completed backup tasks"
|
||||
},
|
||||
{
|
||||
"command": "tail -f /var/log/vzdump.log",
|
||||
"description": "Monitor backup log in real-time"
|
||||
"command": "pvenode task log <upid>",
|
||||
"description": "Show the log for a backup task UPID"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -202,15 +202,15 @@
|
||||
"description": "Wait for lock"
|
||||
},
|
||||
{
|
||||
"command": "qm importdisk <vmid> <backup> <storage>",
|
||||
"description": "Import disk from backup"
|
||||
"command": "qm importdisk <vmid> <disk-image> <storage>",
|
||||
"description": "Import an extracted raw or qcow2 disk image, not a backup archive"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"testRestores": {
|
||||
"title": "Test your restores",
|
||||
"bodyRich": "A backup you've never restored isn't a backup. Periodically pick a backup, restore it to a test VMID with <code>qmrestore --unique</code>, boot the resulting VM and confirm the contents are intact. Same idea for containers via <code>pct restore</code>."
|
||||
"bodyRich": "Periodically restore a backup to an unused test VMID with <code>qmrestore --unique</code>, start the VM on an isolated test network and check its contents. The unique option generates new MAC addresses; it does not change static IPs or application settings. Test container restores with <code>pct restore</code> in the same way."
|
||||
},
|
||||
"related": {
|
||||
"heading": "Related",
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
},
|
||||
"intro": {
|
||||
"title": "IOMMU must be enabled in BIOS / UEFI",
|
||||
"body": "Before any of these commands matter, IOMMU has to be enabled at the firmware level (look for <em>VT-d</em>, <em>AMD-Vi</em> or <em>IOMMU</em> in BIOS / UEFI). Common GRUB parameters to enable it on the Linux side: <code>intel_iommu=on</code> (Intel) or <code>amd_iommu=on</code> (AMD), often combined with <code>iommu=pt video=efifb:off video=vesa:off</code>."
|
||||
"body": "Enable IOMMU in firmware first: look for <em>VT-d</em>, <em>AMD-Vi</em> or <em>IOMMU</em> in BIOS/UEFI. AMD enables IOMMU by default on the Linux side, as do Intel systems with Proxmox kernels 6.8 and newer. Older Intel kernels may need <code>intel_iommu=on</code>. The optional <code>iommu=pt</code> setting controls IOMMU passthrough mode; it is not a reason to disable the host framebuffer indiscriminately."
|
||||
},
|
||||
"commandGroups": [
|
||||
{
|
||||
@@ -130,14 +130,14 @@
|
||||
},
|
||||
{
|
||||
"command": "qm set <vmid> -bios ovmf",
|
||||
"description": "Set VM to use UEFI/OVMF (required for GPU passthrough)"
|
||||
"description": "Set VM to UEFI/OVMF (recommended when the GPU ROM supports UEFI)"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"afterChangesTip": {
|
||||
"title": "After changing GRUB or modprobe configs",
|
||||
"bodyRich": "Run <code>update-grub</code> + <code>update-initramfs -u</code>, then reboot. Verify with <code>cat /proc/cmdline</code> (kernel parameters), <code>dmesg | grep -i iommu</code> (IOMMU initialised) and <code>find /sys/kernel/iommu_groups/ -type l | sort -V</code> (groups present)."
|
||||
"bodyRich": "On hosts using GRUB, apply boot-option changes with <code>update-grub</code>. Refresh module changes with <code>update-initramfs -u -k all</code>, then reboot. Other bootloaders require their own configuration procedure. Verify with <code>cat /proc/cmdline</code> (kernel parameters), <code>dmesg | grep -i iommu</code> (IOMMU initialised) and <code>find /sys/kernel/iommu_groups/ -type l | sort -V</code> (groups present)."
|
||||
},
|
||||
"related": {
|
||||
"heading": "Related",
|
||||
@@ -150,7 +150,7 @@
|
||||
{
|
||||
"href": "/docs/hardware/igpu-acceleration-lxc",
|
||||
"label": "Add GPU to LXC",
|
||||
"tail": " — passthrough to a container instead of a VM."
|
||||
"tail": " — share host GPU device access with an LXC container."
|
||||
},
|
||||
{
|
||||
"href": "/docs/help-info",
|
||||
|
||||
@@ -149,7 +149,7 @@
|
||||
],
|
||||
"iptablesTip": {
|
||||
"title": "iptables vs nftables",
|
||||
"bodyRich": "Modern Debian / Proxmox uses <strong>nftables</strong> as the underlying firewall engine. The classic <code>iptables -L -n -v</code> command still works as a translation layer, but the source of truth is <code>nft list ruleset</code>. <code>pve-firewall</code> commands are Proxmox's wrapper that emits nftables rules from the cluster firewall config."
|
||||
"bodyRich": "The classic <code>pve-firewall</code> service generates iptables rules. The alternative proxmox-firewall service uses <strong>nftables</strong>. Inspect the iptables-based backend with <code>iptables -L -n -v</code> and the nftables backend with <code>nft list ruleset</code>. Use the tools for the enabled backend; do not assume these listings are interchangeable."
|
||||
},
|
||||
"related": {
|
||||
"heading": "Related",
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
},
|
||||
"intro": {
|
||||
"title": "Quick disk inventory",
|
||||
"body": "<code>lsblk</code> is the fastest way to see all block devices and their partitions in a tree view. For persistent identifiers (which survive between boots and hardware changes) use <code>ls -lh /dev/disk/by-id/</code>."
|
||||
"body": "<code>lsblk</code> shows block devices and partitions in a tree. Inspect persistent identifiers with <code>ls -lh /dev/disk/by-id/</code>: these normally remain stable across reboots and device reordering for the same disk. Replacing a disk or changing the way a controller exposes its identity can change its by-id path."
|
||||
},
|
||||
"commandGroups": [
|
||||
{
|
||||
@@ -104,16 +104,16 @@
|
||||
"description": "Show status of all storage pools"
|
||||
},
|
||||
{
|
||||
"command": "pvesm list",
|
||||
"description": "List all available storage"
|
||||
"command": "pvesm status --enabled 1",
|
||||
"description": "List enabled configured storage"
|
||||
},
|
||||
{
|
||||
"command": "pvesm list <storage>",
|
||||
"description": "List content of specific storage"
|
||||
},
|
||||
{
|
||||
"command": "pvesm scan <storage>",
|
||||
"description": "Scan storage for new content"
|
||||
"command": "pvesm scan nfs <server>",
|
||||
"description": "Discover NFS exports on a server"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -122,7 +122,7 @@
|
||||
"commands": [
|
||||
{
|
||||
"command": "qm importdisk <vmid> <image_path> <storage>",
|
||||
"description": "Attach disk image to VM"
|
||||
"description": "Import disk image as an unused disk for the VM; attach it separately"
|
||||
},
|
||||
{
|
||||
"command": "qm set <vmid> -<bus><index> <disk_path>",
|
||||
@@ -130,7 +130,7 @@
|
||||
},
|
||||
{
|
||||
"command": "qemu-img convert -O <format> <input> <output>",
|
||||
"description": "Convert disk image format"
|
||||
"description": "Convert an offline disk image format"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -199,15 +199,15 @@
|
||||
],
|
||||
"lvmTip": {
|
||||
"title": "LVM short vs long commands",
|
||||
"bodyRich": "Both forms exist for compatibility. <code>pvs</code> / <code>vgs</code> / <code>lvs</code> give a clean single-line-per-volume table; <code>pvdisplay</code> / <code>vgdisplay</code> / <code>lvdisplay</code> give a verbose multi-line dump per volume. For day-to-day use prefer the short versions."
|
||||
"bodyRich": "Both forms are available. <code>pvs</code> / <code>vgs</code> / <code>lvs</code> produce compact tables with one row per physical volume, volume group or logical volume respectively. <code>pvdisplay</code> / <code>vgdisplay</code> / <code>lvdisplay</code> provide more detailed multi-line output. The short forms are convenient for everyday checks."
|
||||
},
|
||||
"smartInfo": {
|
||||
"title": "SMART for spinning disks vs NVMe",
|
||||
"bodyRich": "<strong>Spinning / SATA / SAS disks</strong> use the <code>smartctl</code> family from <code>smartmontools</code> (installed by default on Proxmox). Pass the device as <code>/dev/sda</code>, <code>/dev/sdb</code>, etc. <strong>NVMe disks</strong> have their own native protocol — <code>smartctl</code> works against them (passes most data through), but the <code>nvme</code> tool from <code>nvme-cli</code> reports more NVMe-specific fields (wear levelling, media errors, namespace info). Install with <code>apt install nvme-cli</code> if not present."
|
||||
"title": "SMART for SATA/SAS vs NVMe",
|
||||
"bodyRich": "<strong>SATA / SAS disks, including SSDs,</strong> can be inspected with <code>smartctl</code> from <code>smartmontools</code> (installed by default on Proxmox). Specify the device, for example <code>/dev/sda</code> or <code>/dev/sdb</code>. <strong>NVMe disks</strong> use a different native protocol. <code>smartctl</code> also supports them, while <code>nvme</code> from <code>nvme-cli</code> provides NVMe-specific controller, namespace and health queries. Install it with <code>apt install nvme-cli</code> if absent."
|
||||
},
|
||||
"selfTestWarn": {
|
||||
"title": "Self-tests run in the background",
|
||||
"bodyRich": "<code>smartctl -t short</code> and <code>-t long</code> return immediately — the disk runs the test on its own. Check progress with <code>smartctl -a /dev/<disk></code> (look for the \"Self-test routine in progress\" line) or wait for completion and read <code>smartctl -l selftest /dev/<disk></code>. Short tests take ~2 min; long tests can take hours on large spinners. The disk stays usable during the test, but I/O performance drops."
|
||||
"bodyRich": "On supported drives, <code>smartctl -t short /dev/<disk></code> and <code>smartctl -t long /dev/<disk></code> start background tests and return immediately. Check progress with <code>smartctl -a /dev/<disk></code> (look for \"Self-test routine in progress\") or wait and read <code>smartctl -l selftest /dev/<disk></code>. Short tests commonly take about two minutes; long tests can take hours. The disk remains usable, but testing can reduce I/O performance."
|
||||
},
|
||||
"related": {
|
||||
"heading": "Related",
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
{
|
||||
"meta": {
|
||||
"title": "Proxmox VE System Commands — pveversion, uptime, journalctl, systemctl | ProxMenux",
|
||||
"description": "Reference of essential Proxmox VE and Linux system commands: pveversion, pveperf, uptime, journalctl, systemctl, lscpu, lsblk, df, free, last, who. All read-only and safe to run on any host.",
|
||||
"description": "Proxmox VE and Linux system commands for versions, uptime, memory, services, logs and users, plus auditing and summary tools. Includes a service restart command; not every example is read-only.",
|
||||
"ogTitle": "Proxmox VE System Commands — pveversion, uptime, journalctl, systemctl",
|
||||
"ogDescription": "Reference of essential Proxmox VE and Linux system commands — version, uptime, services, logs, user info, hardware probes. All read-only.",
|
||||
"ogDescription": "Proxmox VE and Linux system commands for version, uptime, services, logs and user information, including service management and auditing tools.",
|
||||
"twitterTitle": "Proxmox VE System Commands | ProxMenux",
|
||||
"twitterDescription": "Essential system inspection commands for Proxmox VE — version, status, services, logs, user info."
|
||||
},
|
||||
"header": {
|
||||
"title": "Useful System Commands",
|
||||
"description": "Read-only commands to look at the Proxmox host: version, kernel, uptime, memory, web UI status, recent log lines, who's logged in, and a couple of audit / summary tools. None of them modifies the system.",
|
||||
"description": "Commands for inspecting the Proxmox host: version, kernel, uptime, memory, web UI status, recent logs and logged-in users, plus auditing and summary tools. Most inspect state, but systemctl restart pveproxy restarts the web UI proxy, and audit tools can write reports and logs.",
|
||||
"section": "Help and Info"
|
||||
},
|
||||
"intro": {
|
||||
|
||||
@@ -251,7 +251,7 @@
|
||||
],
|
||||
"tmuxTip": {
|
||||
"title": "Use tmux / screen for long-running commands",
|
||||
"bodyRich": "Anything that takes longer than a coffee break — a backup, a long upgrade, a big rsync — should run inside <code>tmux</code> or <code>screen</code>. SSH disconnects don't kill the session, and you can re-attach from anywhere with <code>tmux attach</code>."
|
||||
"bodyRich": "Long-running work — a backup, a lengthy upgrade or a large rsync transfer — should run inside <code>tmux</code> or <code>screen</code> so an SSH disconnect does not end the terminal session. For a tmux session, reconnect to the same host as the same user and run <code>tmux attach</code>. Screen sessions use their own reattachment command."
|
||||
},
|
||||
"related": {
|
||||
"heading": "Related",
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
"commands": [
|
||||
{
|
||||
"command": "apt update && apt upgrade -y",
|
||||
"description": "Update and upgrade all system packages"
|
||||
"description": "Refresh package lists and upgrade installed packages (apt upgrade)"
|
||||
},
|
||||
{
|
||||
"command": "apt dist-upgrade -y",
|
||||
@@ -51,15 +51,15 @@
|
||||
},
|
||||
{
|
||||
"command": "pveupgrade",
|
||||
"description": "Show available Proxmox upgrades"
|
||||
"description": "Start the interactive Proxmox package upgrade"
|
||||
},
|
||||
{
|
||||
"command": "pve-upgrade",
|
||||
"description": "Perform Proxmox VE upgrade"
|
||||
"command": "pve8to9 --full",
|
||||
"description": "Check readiness for the PVE 8 to 9 upgrade (does not perform it)"
|
||||
},
|
||||
{
|
||||
"command": "pveceph upgrade",
|
||||
"description": "Upgrade Ceph packages (if Ceph is installed)"
|
||||
"command": "ceph versions",
|
||||
"description": "Show Ceph daemon versions before planning a Ceph upgrade"
|
||||
}
|
||||
]
|
||||
},
|
||||
@@ -134,18 +134,18 @@
|
||||
},
|
||||
{
|
||||
"command": "cat /etc/apt/sources.list.d/pve-enterprise.list",
|
||||
"description": "Show Proxmox Enterprise repo config"
|
||||
"description": "Show Proxmox Enterprise repository configuration in the PVE 8 .list file"
|
||||
},
|
||||
{
|
||||
"command": "apt-key list",
|
||||
"description": "List repository signing keys"
|
||||
"description": "List legacy repository signing keys where apt-key is available"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"backupWarn": {
|
||||
"title": "Take a backup before major upgrades",
|
||||
"bodyRich": "For point releases (8.4.1 → 8.4.5) the standard <code>apt update && apt upgrade</code> is safe. For <strong>major version upgrades</strong> (PVE 8 → 9) use the dedicated ProxMenux flow: <upgradeLink>Upgrade PVE 8 to PVE 9</upgradeLink> — it adds pre-flight checks, repository migration and post-upgrade validation."
|
||||
"bodyRich": "For routine updates, Proxmox recommends <code>apt update && apt full-upgrade</code>; review the proposed package changes before confirming. For <strong>major version upgrades</strong> (PVE 8 → 9), use the dedicated ProxMenux flow: <upgradeLink>Upgrade PVE 8 to PVE 9</upgradeLink>. It adds readiness checks, repository migration and post-upgrade validation. Back up first."
|
||||
},
|
||||
"related": {
|
||||
"heading": "Related",
|
||||
|
||||
@@ -116,7 +116,7 @@
|
||||
"description": "Gracefully shutdown a container"
|
||||
},
|
||||
{
|
||||
"command": "pct restart <ctid>",
|
||||
"command": "pct reboot <ctid>",
|
||||
"description": "Restart a container"
|
||||
},
|
||||
{
|
||||
@@ -153,11 +153,11 @@
|
||||
],
|
||||
"destroyWarn": {
|
||||
"title": "Destroy is irreversible",
|
||||
"bodyRich": "<code>qm destroy</code> and <code>pct destroy</code> delete the VM / CT and all its disks. There is no confirmation prompt by default. Take a backup first if there's any chance you might want the data back — see <backupLink>Backup and Restore</backupLink>."
|
||||
"bodyRich": "<code>qm destroy</code> and <code>pct destroy</code> remove the guest configuration and its managed disk volumes. Do not assume that external or bind-mounted data is deleted. The CLI has no confirmation prompt by default. Back up any data you may need before running it; see <backupLink>Backup and Restore</backupLink>."
|
||||
},
|
||||
"qmConfigTip": {
|
||||
"title": "qm config vs editing the .conf file directly",
|
||||
"bodyRich": "<code>qm config <vmid></code> and <code>pct config <ctid></code> read the file through Proxmox's own parser — output is normalised, comments stripped, pending changes shown separately. Editing <code>/etc/pve/qemu-server/<vmid>.conf</code> or <code>/etc/pve/lxc/<ctid>.conf</code> directly bypasses the parser. Useful for fixing a corrupted config or applying a setting <code>qm set</code> won't accept, but stop the guest first to avoid races. The cluster filesystem (<code>pmxcfs</code>) takes care of propagating the change to other nodes."
|
||||
"bodyRich": "<code>qm config <vmid></code> and <code>pct config <ctid></code> display configuration through Proxmox’s parsers. For normal changes, prefer <code>qm set</code> or the corresponding pct setter. Direct edits to <code>/etc/pve/qemu-server/<vmid>.conf</code> or <code>/etc/pve/lxc/<ctid>.conf</code> bypass the validation and locking in management commands; the file must still remain parseable. Stop the guest and keep a copy before manual repair. <code>pmxcfs</code> synchronises configuration across cluster nodes, not guest disk contents."
|
||||
},
|
||||
"related": {
|
||||
"heading": "Related",
|
||||
|
||||
@@ -202,7 +202,7 @@
|
||||
],
|
||||
"bestPractices": {
|
||||
"title": "Operational best practices",
|
||||
"bodyRich": "Run <code>zpool scrub</code> weekly or monthly to detect silent corruption. Keep at least 10-15% of pool space free — ZFS performance degrades sharply over 80% full. Always replace failed devices with <code>zpool replace</code> (in-place) rather than detach + add (which loses redundancy temporarily)."
|
||||
"bodyRich": "Schedule <code>zpool scrub</code> regularly to verify checksums and inspect its results. Keep free capacity: the impact of a nearly full pool depends on workload and layout. Use <code>zpool replace</code> for a failed device and follow the procedure for its vdev type. Detach + add is not an equivalent replacement procedure and can alter topology or remove redundancy."
|
||||
},
|
||||
"related": {
|
||||
"heading": "Related",
|
||||
|
||||
Reference in New Issue
Block a user