From 9ddb9dc3350ef6ae9bf02a08234c54298281fe4a Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Sun, 10 Apr 2016 09:51:11 +0200 Subject: [PATCH] add pvedaemon man page --- Makefile | 2 +- index.adoc | 1 + pve-admin-guide.adoc | 41 ++++++++++++++++++++++------------ pve-doc-generator.mk | 9 ++++++++ pvedaemon.8-synopsis.adoc | 46 +++++++++++++++++++++++++++++++++++++++ pvedaemon.adoc | 36 ++++++++++++++++++++++++++++++ 6 files changed, 120 insertions(+), 15 deletions(-) create mode 100644 pvedaemon.8-synopsis.adoc create mode 100644 pvedaemon.adoc diff --git a/Makefile b/Makefile index a927829..2ae2ad4 100644 --- a/Makefile +++ b/Makefile @@ -13,7 +13,7 @@ DEB=${PACKAGE}_${DOCRELEASE}-${PKGREL}_amd64.deb COMMAND_LIST=pvecm qm qmrestore pct pveam pvesm pveum vzdump ha-manager -SERVICE_LIST=pve-firewall pve-ha-crm pve-ha-lrm pvestatd pmxcfs +SERVICE_LIST=pve-firewall pve-ha-crm pve-ha-lrm pvestatd pmxcfs pvedaemon CONFIG_LIST=datacenter.cfg qm.conf pct.conf diff --git a/index.adoc b/index.adoc index 7b9b434..6bea872 100644 --- a/index.adoc +++ b/index.adoc @@ -42,6 +42,7 @@ Service Daemons [width="100%",options="header"] |=========================================================== | Command name |'systemd' Service | Download link +| pvedaemon | pvedaemon.service |link:pvedaemon.8.html[pvedaemon.8] | pvestatd | pvestatd.service |link:pvestatd.8.html[pvestatd.8] | pve-ha-crm | pve-ha-crm.service |link:pve-ha-crm.8.html[pve-ha-crm.8] | pve-ha-lrm | pve-ha-lrm.service |link:pve-ha-lrm.8.html[pve-ha-lrm.8] diff --git a/pve-admin-guide.adoc b/pve-admin-guide.adoc index d0d3037..fc88233 100644 --- a/pve-admin-guide.adoc +++ b/pve-admin-guide.adoc @@ -108,14 +108,6 @@ include::vzdump.1-synopsis.adoc[] :leveloffset: 0 -*pve-firewall* - The {pve} Firewall Daemon -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -:leveloffset: 1 -include::pve-firewall.8-synopsis.adoc[] - -:leveloffset: 0 - *ha-manager* - Proxmox VE HA Manager ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -124,19 +116,24 @@ include::ha-manager.1-synopsis.adoc[] :leveloffset: 0 -*pve-ha-crm* - Cluster Ressource Manager Daemon -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +[appendix] +Service Daemons +--------------- + +*pve-firewall* - The {pve} Firewall Daemon +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :leveloffset: 1 -include::pve-ha-crm.8-synopsis.adoc[] +include::pve-firewall.8-synopsis.adoc[] :leveloffset: 0 -*pve-ha-lrm* - Local Ressource Manager Daemon -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +*pvedaemon* - {PVE} API Daemon +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :leveloffset: 1 -include::pve-ha-lrm.8-synopsis.adoc[] +include::pvedaemon.8-synopsis.adoc[] :leveloffset: 0 @@ -156,6 +153,22 @@ include::pmxcfs.8-cli.adoc[] :leveloffset: 0 +*pve-ha-crm* - Cluster Ressource Manager Daemon +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:leveloffset: 1 +include::pve-ha-crm.8-synopsis.adoc[] + +:leveloffset: 0 + +*pve-ha-lrm* - Local Ressource Manager Daemon +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:leveloffset: 1 +include::pve-ha-lrm.8-synopsis.adoc[] + +:leveloffset: 0 + [appendix] Configuration Files diff --git a/pve-doc-generator.mk b/pve-doc-generator.mk index f324f75..ac3d44d 100644 --- a/pve-doc-generator.mk +++ b/pve-doc-generator.mk @@ -93,6 +93,11 @@ PVESTATD_MAN8_SOURCES= \ pvestatd.8-synopsis.adoc \ ${PVE_COMMON_DOC_SOURCES} +PVEDAEMON_MAN8_SOURCES= \ + pvedaemon.adoc \ + pvedaemon.8-synopsis.adoc \ + ${PVE_COMMON_DOC_SOURCES} + PMXCFS_MAN8_SOURCES= \ pmxcfs.adoc \ pmxcfs.8-cli.adoc \ @@ -173,6 +178,10 @@ pvestatd.8: ${PVESTATD_MAN8_SOURCES} a2x ${A2X_MAN8_OPTIONS} pvestatd.adoc test -n "$${NOVIEW}" || man -l $@ +pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES} + a2x ${A2X_MAN8_OPTIONS} pvedaemon.adoc + test -n "$${NOVIEW}" || man -l $@ + pmxcfs.8: ${PMXCFS_MAN8_SOURCES} a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc test -n "$${NOVIEW}" || man -l $@ diff --git a/pvedaemon.8-synopsis.adoc b/pvedaemon.8-synopsis.adoc new file mode 100644 index 0000000..85fce6f --- /dev/null +++ b/pvedaemon.8-synopsis.adoc @@ -0,0 +1,46 @@ +*pvedaemon* ` [ARGS] [OPTIONS]` + +*pvedaemon help* `[]` `[OPTIONS]` + +Get help about specified command. + +`` `string` :: + +Command name + +`-verbose` `boolean` :: + +Verbose output format. + + + + +*pvedaemon restart* + +Restart the daemon (or start if not running). + + + +*pvedaemon start* `[OPTIONS]` + +Start the daemon. + +`-debug` `boolean` (default=`0`):: + +Debug mode - stay in foreground + + + +*pvedaemon status* + +Get daemon status. + + + +*pvedaemon stop* + +Stop the daemon. + + + + diff --git a/pvedaemon.adoc b/pvedaemon.adoc new file mode 100644 index 0000000..a739fc0 --- /dev/null +++ b/pvedaemon.adoc @@ -0,0 +1,36 @@ +ifdef::manvolnum[] +PVE({manvolnum}) +================ +include::attributes.txt[] + +NAME +---- + +pvedaemon - PVE API Daemon + +SYNOPSYS +-------- + +include::pvedaemon.8-synopsis.adoc[] + +DESCRIPTION +----------- +endif::manvolnum[] + +ifndef::manvolnum[] +{pve} API Daemon +============================== +include::attributes.txt[] +endif::manvolnum[] + +This daemom exposes the whole {PVE} API on 127.0.0.1:85. It runs as +'root' and has permission to do all priviledged operations. + +NOTE: The daemon listens to a local address only, so you cannot access +it from outside. The 'pveproxy' daemon exposes the API to the outside +world. + + +ifdef::manvolnum[] +include::pve-copyright.adoc[] +endif::manvolnum[] -- 2.39.2