mirror of
git://git.proxmox.com/git/pve-docs.git
synced 2025-03-11 16:58:18 +03:00
add pveproxy man page
This commit is contained in:
parent
6b295b6e25
commit
96f2beeb13
9
Makefile
9
Makefile
@ -13,7 +13,14 @@ DEB=${PACKAGE}_${DOCRELEASE}-${PKGREL}_amd64.deb
|
|||||||
|
|
||||||
COMMAND_LIST=pvecm qm qmrestore pct pveam pvesm pveum vzdump ha-manager
|
COMMAND_LIST=pvecm qm qmrestore pct pveam pvesm pveum vzdump ha-manager
|
||||||
|
|
||||||
SERVICE_LIST=pve-firewall pve-ha-crm pve-ha-lrm pvestatd pmxcfs pvedaemon
|
SERVICE_LIST= \
|
||||||
|
pve-firewall \
|
||||||
|
pve-ha-crm \
|
||||||
|
pve-ha-lrm \
|
||||||
|
pvestatd \
|
||||||
|
pmxcfs \
|
||||||
|
pveproxy \
|
||||||
|
pvedaemon
|
||||||
|
|
||||||
CONFIG_LIST=datacenter.cfg qm.conf pct.conf
|
CONFIG_LIST=datacenter.cfg qm.conf pct.conf
|
||||||
|
|
||||||
|
@ -43,6 +43,7 @@ Service Daemons
|
|||||||
|===========================================================
|
|===========================================================
|
||||||
| Command name |'systemd' Service | Download link
|
| Command name |'systemd' Service | Download link
|
||||||
| pvedaemon | pvedaemon.service |link:pvedaemon.8.html[pvedaemon.8]
|
| pvedaemon | pvedaemon.service |link:pvedaemon.8.html[pvedaemon.8]
|
||||||
|
| pveproxy | pveproxy.service |link:pveproxy.8.html[pveproxy.8]
|
||||||
| pvestatd | pvestatd.service |link:pvestatd.8.html[pvestatd.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-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]
|
| pve-ha-lrm | pve-ha-lrm.service |link:pve-ha-lrm.8.html[pve-ha-lrm.8]
|
||||||
|
@ -41,6 +41,7 @@ Important Service Daemons
|
|||||||
:leveloffset: 2
|
:leveloffset: 2
|
||||||
include::pvedaemon.adoc[]
|
include::pvedaemon.adoc[]
|
||||||
|
|
||||||
|
include::pveproxy.adoc[]
|
||||||
|
|
||||||
include::pvestatd.adoc[]
|
include::pvestatd.adoc[]
|
||||||
|
|
||||||
@ -149,6 +150,14 @@ include::pvedaemon.8-synopsis.adoc[]
|
|||||||
|
|
||||||
:leveloffset: 0
|
:leveloffset: 0
|
||||||
|
|
||||||
|
*pveproxy* - {pve} API Proxy Daemon
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
:leveloffset: 1
|
||||||
|
include::pveproxy.8-synopsis.adoc[]
|
||||||
|
|
||||||
|
:leveloffset: 0
|
||||||
|
|
||||||
*pvestatd* - {pve} Status Daemon
|
*pvestatd* - {pve} Status Daemon
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
@ -98,6 +98,11 @@ PVEDAEMON_MAN8_SOURCES= \
|
|||||||
pvedaemon.8-synopsis.adoc \
|
pvedaemon.8-synopsis.adoc \
|
||||||
${PVE_COMMON_DOC_SOURCES}
|
${PVE_COMMON_DOC_SOURCES}
|
||||||
|
|
||||||
|
PVEPROXY_MAN8_SOURCES= \
|
||||||
|
pveproxy.adoc \
|
||||||
|
pveproxy.8-synopsis.adoc \
|
||||||
|
${PVE_COMMON_DOC_SOURCES}
|
||||||
|
|
||||||
PMXCFS_MAN8_SOURCES= \
|
PMXCFS_MAN8_SOURCES= \
|
||||||
pmxcfs.adoc \
|
pmxcfs.adoc \
|
||||||
pmxcfs.8-cli.adoc \
|
pmxcfs.8-cli.adoc \
|
||||||
@ -182,6 +187,10 @@ pvedaemon.8: ${PVEDAEMON_MAN8_SOURCES}
|
|||||||
a2x ${A2X_MAN8_OPTIONS} pvedaemon.adoc
|
a2x ${A2X_MAN8_OPTIONS} pvedaemon.adoc
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
test -n "$${NOVIEW}" || man -l $@
|
||||||
|
|
||||||
|
pveproxy.8: ${PVEPROXY_MAN8_SOURCES}
|
||||||
|
a2x ${A2X_MAN8_OPTIONS} pveproxy.adoc
|
||||||
|
test -n "$${NOVIEW}" || man -l $@
|
||||||
|
|
||||||
pmxcfs.8: ${PMXCFS_MAN8_SOURCES}
|
pmxcfs.8: ${PMXCFS_MAN8_SOURCES}
|
||||||
a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc
|
a2x ${A2X_MAN8_OPTIONS} pmxcfs.adoc
|
||||||
test -n "$${NOVIEW}" || man -l $@
|
test -n "$${NOVIEW}" || man -l $@
|
||||||
|
46
pveproxy.8-synopsis.adoc
Normal file
46
pveproxy.8-synopsis.adoc
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
*pveproxy* `<COMMAND> [ARGS] [OPTIONS]`
|
||||||
|
|
||||||
|
*pveproxy help* `[<cmd>]` `[OPTIONS]`
|
||||||
|
|
||||||
|
Get help about specified command.
|
||||||
|
|
||||||
|
`<cmd>` `string` ::
|
||||||
|
|
||||||
|
Command name
|
||||||
|
|
||||||
|
`-verbose` `boolean` ::
|
||||||
|
|
||||||
|
Verbose output format.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
*pveproxy restart*
|
||||||
|
|
||||||
|
Restart the daemon (or start if not running).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
*pveproxy start* `[OPTIONS]`
|
||||||
|
|
||||||
|
Start the daemon.
|
||||||
|
|
||||||
|
`-debug` `boolean` (default=`0`)::
|
||||||
|
|
||||||
|
Debug mode - stay in foreground
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
*pveproxy status*
|
||||||
|
|
||||||
|
Get daemon status.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
*pveproxy stop*
|
||||||
|
|
||||||
|
Stop the daemon.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
39
pveproxy.adoc
Normal file
39
pveproxy.adoc
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
ifdef::manvolnum[]
|
||||||
|
PVE({manvolnum})
|
||||||
|
================
|
||||||
|
include::attributes.txt[]
|
||||||
|
|
||||||
|
NAME
|
||||||
|
----
|
||||||
|
|
||||||
|
pveproxy - PVE API Proxy Daemon
|
||||||
|
|
||||||
|
|
||||||
|
SYNOPSYS
|
||||||
|
--------
|
||||||
|
|
||||||
|
include::pveproxy.8-synopsis.adoc[]
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
endif::manvolnum[]
|
||||||
|
|
||||||
|
ifndef::manvolnum[]
|
||||||
|
{pve} API Proxy Daemon
|
||||||
|
================
|
||||||
|
include::attributes.txt[]
|
||||||
|
endif::manvolnum[]
|
||||||
|
|
||||||
|
This daemon exposes the whole {pve} API on TCP port 8006 using
|
||||||
|
HTTPS. It runs as user 'www-data' and has very limited permissions.
|
||||||
|
Operation requiring more permissions are forwarded to the local
|
||||||
|
'pvedaemon'.
|
||||||
|
|
||||||
|
Request targeted for other nodes are automatically forwarded to that
|
||||||
|
node. This means that you can manage your whole cluster by connecting
|
||||||
|
to a single {pve} node.
|
||||||
|
|
||||||
|
|
||||||
|
ifdef::manvolnum[]
|
||||||
|
include::pve-copyright.adoc[]
|
||||||
|
endif::manvolnum[]
|
Loading…
x
Reference in New Issue
Block a user