Proxmox VE Documentation
========================
-include::attributes.txt[]
We try to generate high quality documentation for
{website}[{pve}], and choose to use
make deb
-Common Macro definition in link:attributes.txt[]
-------------------------------------------------
+Common Macro definition in link:asciidoc/asciidoc-pve.conf[]
+------------------------------------------------------------
'asciidoc' allows us to define common macros, which can then be
referred to using `{macro}`. We try to use this mechanism to improve
For example, the macro `{forum-url}` expands to {forum-url}, and the macro
`{forum}` expands to {forum}.
-The plan is to add more such definitions for terms which are used more than once.
+The plan is to add more such definitions for terms which are used more
+than once.
-WARNING: When asciidoc encounters a misspelled macro name, it will silently drop
-the containing line!
+WARNING: When asciidoc encounters a misspelled macro name, it will
+silently drop the containing line!
-WARNING: Never use macros in document titles or the ``NAME'' section of man pages,
-as these get parsed before the `attributes.txt` file gets included.
Autogenerated CLI Command Synopsis
----------------------------------
+++ /dev/null
-:proxmoxGmbh: Proxmox Server Solutions Gmbh
-:copyright: {proxmoxGmbh}
-:pve: Proxmox VE
-:website: http://www.proxmox.com/
-:forum-url: https://forum.proxmox.com/
-:forum: https://forum.proxmox.com/[{pve} Community Forum]
-:webwiki-url: https://pve.proxmox.com/wiki/
-:webwiki: https://pve.proxmox.com/wiki/[{pve} Wiki]
-:manmanual: {pve} Documentation
-:max-width: 55em
-ifndef::docinfo1[]
-:author: {proxmoxGmbh}
-:email: support@proxmox.com
-endif::docinfo1[]
ifdef::manvolnum[]
datacenter.cfg(5)
=================
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
Datacenter Configuration
========================
-include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:title: Manual: datacenter.cfg
[[getting_help]]
Getting Help
------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
ifdef::manvolnum[]
ha-manager(1)
=============
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
High Availability
=================
-include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]
[[howto_improve_pve_docs]]
Improving the Proxmox VE Documentation
--------------------------------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
image:./images/proxmox-logo.svg[] pass:[<br>] {pve} Documentation Index
========================================================================
-include::attributes.txt[]
:data-uri:
:icons:
:title: {pve} Documentation Index
Logical Volume Manager (LVM)
----------------------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
ZFS on Linux
------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
ifdef::manvolnum[]
pct(1)
======
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
Proxmox Container Toolkit
=========================
-include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]
ifdef::wiki[]
ifdef::manvolnum[]
pct.conf(5)
===========
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
Container Configuration
=======================
-include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:
ifdef::manvolnum[]
pmxcfs(8)
=========
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
Proxmox Cluster File System (pmxcfs)
====================================
-include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]
Proxmox VE Administration Guide
===============================
endif::pvelogo[]
-include::attributes.txt[]
:doctype: book
:title: Proxmox VE Administration Guide
:toc:
[bibliography]
Bibliography
============
-include::attributes.txt[]
ifndef::manvolnum[]
:pve-toplevel:
endif::manvolnum[]
Disk Health Monitoring
----------------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
PVE_COMMON_DOC_SOURCES= \
${ASCIIDOC_PVE} \
- attributes.txt \
pve-copyright.adoc \
docinfo.xml
.PHONY: cleanup-docgen
cleanup-docgen:
- rm -f *.xml.tmp *.1 *.5 *.8 *.adoc attributes.txt docinfo.xml
+ rm -f *.xml.tmp *.1 *.5 *.8 *.adoc docinfo.xml
External Metric Server
----------------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Frequently Asked Questions
==========================
-include::attributes.txt[]
ifndef::manvolnum[]
:pve-toplevel:
endif::manvolnum[]
ifdef::manvolnum[]
pve-firewall(8)
===============
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
{pve} Firewall
==============
-include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]
ifdef::wiki[]
ifdef::manvolnum[]
pve-ha-crm(8)
=============
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
Cluster Resource Manager Daemon
================================
-include::attributes.txt[]
endif::manvolnum[]
This is the Cluster Resource Manager Daemon.
ifdef::manvolnum[]
pve-ha-lrm(8)
=============
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
Local Resource Manager Daemon
==============================
-include::attributes.txt[]
endif::manvolnum[]
This is the Local Resource Manager Daemon.
Installing Proxmox VE
=====================
-include::attributes.txt[]
ifndef::manvolnum[]
:pve-toplevel:
endif::manvolnum[]
[[sysadmin_network_configuration]]
Network Configuration
---------------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
[[sysadmin_package_repositories]]
Package Repositories
--------------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Directory Backend
-----------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: Directory
GlusterFS Backend
-----------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: GlusterFS
http://www.open-iscsi.org/[Open-iSCSI] initiator
------------------------------------------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: iSCSI
User Mode iSCSI Backend
-----------------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: User Mode iSCSI
LVM Backend
-----------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: LVM
LVM thin Backend
----------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: LVM Thin
NFS Backend
-----------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: NFS
Ceph RADOS Block Devices (RBD)
------------------------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: RBD
Local ZFS Pool Backend
----------------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
:title: Storage: ZFS
System Requirements
-------------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Install from USB Stick
----------------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
ifdef::manvolnum[]
pveam(1)
========
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
Container Images
================
-include::attributes.txt[]
endif::manvolnum[]
Command line tool to manage container images. See `man pct` for usage
ifdef::manvolnum[]
pveceph(1)
==========
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
pveceph - Manage CEPH Services on Proxmox VE Nodes
==================================================
-include::attributes.txt[]
endif::manvolnum[]
Tool to manage http://ceph.com[CEPH] services on {pve} nodes.
ifdef::manvolnum[]
pvecm(1)
========
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
Cluster Manager
===============
-include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]
ifdef::manvolnum[]
pvedaemon(8)
============
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
pvedaemon - Proxmox VE API Daemon
=================================
-include::attributes.txt[]
endif::manvolnum[]
This daemon exposes the whole {pve} API on `127.0.0.1:85`. It runs as
ifdef::manvolnum[]
pveperf(1)
==========
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
pveperf - Proxmox VE Benchmark Script
=====================================
-include::attributes.txt[]
endif::manvolnum[]
Tries to gather some CPU/hard disk performance data on the hard disk
ifdef::manvolnum[]
pveproxy(8)
===========
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
pveproxy - Proxmox VE API Proxy Daemon
======================================
-include::attributes.txt[]
endif::manvolnum[]
This daemon exposes the whole {pve} API on TCP port 8006 using
ifdef::manvolnum[]
pvesm(1)
========
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
{pve} Storage
=============
-include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]
ifdef::wiki[]
ifdef::manvolnum[]
pvestatd(8)
===========
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
pvestatd - Proxmox VE Status Daemon
===================================
-include::attributes.txt[]
endif::manvolnum[]
This daemon queries the status of VMs, storages and containers at
ifdef::manvolnum[]
pvesubscription(1)
==================
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
pvesubscription - Subscription Management
=========================================
-include::attributes.txt[]
endif::manvolnum[]
This tool is used to handle {pve} subscriptions.
ifdef::manvolnum[]
pveum(1)
========
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
User Management
===============
-include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]
ifdef::manvolnum[]
qm(1)
=====
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
Qemu/KVM Virtual Machines
=========================
-include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]
ifdef::manvolnum[]
qm.conf(5)
==========
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
Virtual Machine Configuration
=============================
-include::attributes.txt[]
endif::manvolnum[]
ifdef::wiki[]
:pve-toplevel:
ifdef::manvolnum[]
qmrestore(1)
============
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
Restore Virtual Machines
========================
-include::attributes.txt[]
endif::manvolnum[]
my $filelist = $fileinfo->{outfile}->{$e};
foreach my $sourcefile (sort keys %$filelist) {
my $varname = $depend_varname_hash->{$sourcefile};
+ next if !defined($varname);
my $target = $filelist->{$sourcefile};
my $dep = "\$\{$varname\}";
$make_targets->{$target} = $dep;
ifdef::manvolnum[]
spiceproxy(8)
=============
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
spiceproxy - SPICE Proxy Service
================================
-include::attributes.txt[]
endif::manvolnum[]
http://www.spice-space.org[SPICE] (the Simple Protocol for Independent
[[chapter_system_administration]]
Host System Administration
==========================
-include::attributes.txt[]
ifndef::manvolnum[]
:pve-toplevel:
endif::manvolnum[]
System Software Updates
-----------------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
Time Synchronization
--------------------
-include::attributes.txt[]
ifdef::wiki[]
:pve-toplevel:
endif::wiki[]
ifdef::manvolnum[]
vzdump(1)
=========
-include::attributes.txt[]
:pve-toplevel:
NAME
ifndef::manvolnum[]
Backup and Restore
==================
-include::attributes.txt[]
:pve-toplevel:
endif::manvolnum[]