update API

[pve-docs.git] / pve-admin-guide.adoc

ifdef::pvelogo[]
image:./images/proxmox-logo.svg[] pass:[<br>] Proxmox VE Administration Guide
=============================================================================
endif::pvelogo[]
ifndef::pvelogo[]
Proxmox VE Administration Guide
===============================
endif::pvelogo[]
:doctype:   book
:title: Proxmox VE Administration Guide
:toc:
:numbered:
:data-uri:
:icons:
ifndef::wiki[]
ifndef::manvolnum[]
:pve-toplevel:

// Push titles down one level.
:leveloffset: 1

include::pve-intro.adoc[]

include::pve-installation.adoc[]

include::sysadmin.adoc[]

include::hyper-converged-infrastructure.adoc[]

:leveloffset: 2
include::pveceph.adoc[]
:leveloffset: 1

include::pve-gui.adoc[]

include::pvecm.adoc[]

include::pmxcfs.adoc[]

include::pvesm.adoc[]

include::pvesr.adoc[]

include::qm.adoc[]

include::pct.adoc[]

include::pve-firewall.adoc[]

include::pveum.adoc[]

include::ha-manager.adoc[]

include::vzdump.adoc[]

// Return to normal title levels.
:leveloffset: 0

Important Service Daemons
-------------------------

:leveloffset: 2
include::pvedaemon.adoc[]

include::pveproxy.adoc[]

include::pvestatd.adoc[]

include::spiceproxy.adoc[]

:leveloffset: 0


Useful Command Line Tools
-------------------------

:leveloffset: 2

include::pvesubscription.adoc[]

include::pveperf.adoc[]


:leveloffset: 1

include::pve-faq.adoc[]

include::pve-bibliography.adoc[]

:leveloffset: 0

[appendix]
Command Line Interface
----------------------

*pvesm* - {pve} Storage Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pvesm.1-synopsis.adoc[]

:leveloffset: 0

*pvesubscription* - {pve} Subscription Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pvesubscription.1-synopsis.adoc[]

:leveloffset: 0

*pveperf* - {pve} Benchmark Script
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pveperf.1-synopsis.adoc[]

:leveloffset: 0

*pveceph* - Manage CEPH Services on {pve} Nodes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pveceph.1-synopsis.adoc[]

:leveloffset: 0

*pvenode* - {pve} Node Management
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pvenode.1-synopsis.adoc[]

:leveloffset: 0

*qm* - Qemu/KVM Virtual Machine Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::qm.1-synopsis.adoc[]

:leveloffset: 0

*qmrestore* - Restore QemuServer `vzdump` Backups
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::qmrestore.1-synopsis.adoc[]

:leveloffset: 0

*pct* - Proxmox Container Toolkit
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pct.1-synopsis.adoc[]

:leveloffset: 0

*pveam* -  {pve} Appliance Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pveam.1-synopsis.adoc[]

:leveloffset: 0

*pvecm* - {pve} Cluster Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pvecm.1-synopsis.adoc[]

:leveloffset: 0

*pvesr* - {pve} Storage Replication
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pvesr.1-synopsis.adoc[]

:leveloffset: 0


*pveum* - {pve} User Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pveum.1-synopsis.adoc[]

:leveloffset: 0

*vzdump* - Backup Utility for VMs and Containers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::vzdump.1-synopsis.adoc[]

:leveloffset: 0

*ha-manager* - {pve} HA Manager
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::ha-manager.1-synopsis.adoc[]

:leveloffset: 0


[appendix]
Service Daemons
---------------

*pve-firewall* - {pve} Firewall Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pve-firewall.8-synopsis.adoc[]

:leveloffset: 0

*pvedaemon* - {pve} API Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pvedaemon.8-synopsis.adoc[]

:leveloffset: 0

*pveproxy* - {pve} API Proxy Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1

include::pveproxy.8-synopsis.adoc[]

:leveloffset: 0

*pvestatd* - {pve} Status Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pvestatd.8-synopsis.adoc[]

:leveloffset: 0

*spiceproxy* - SPICE Proxy Service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1

include::spiceproxy.8-synopsis.adoc[]

:leveloffset: 0

*pmxcfs* - Proxmox Cluster File System
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pmxcfs.8-synopsis.adoc[]

:leveloffset: 0

*pve-ha-crm* - Cluster Resource Manager Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pve-ha-crm.8-synopsis.adoc[]

:leveloffset: 0

*pve-ha-lrm* - Local Resource Manager Daemon
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:leveloffset: 1
include::pve-ha-lrm.8-synopsis.adoc[]

:leveloffset: 0


[appendix]
Configuration Files
-------------------

:leveloffset: 2
include::datacenter.cfg.adoc[]

:leveloffset: 0

[appendix]
Firewall Macro Definitions
--------------------------

include::pve-firewall-macros.adoc[]


:leveloffset: 1
[appendix]
include::GFDL.adoc[]

:leveloffset: 0

endif::manvolnum[]
endif::wiki[]