5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-01-06 13:17:48 +03:00
pve-docs/pvesh.adoc
Thomas Lamprecht ddaf578490 use datacenter consitently
we almost always use 'datacenter', but had three places where we used
'data center and while both are fine to use, keep it consistent.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2023-04-18 12:28:13 +02:00

57 lines
919 B
Plaintext

ifdef::manvolnum[]
pvesh(1)
========
:pve-toplevel:
NAME
----
pvesh - Shell interface for the Proxmox VE API
SYNOPSIS
--------
include::pvesh.1-synopsis.adoc[]
DESCRIPTION
-----------
endif::manvolnum[]
ifndef::manvolnum[]
Shell interface for the Proxmox VE API
======================================
:pve-toplevel:
endif::manvolnum[]
The {PVE} management tool (`pvesh`) allows to directly invoke API
function, without using the REST/HTTPS server.
NOTE: Only 'root' is allowed to do that.
ifdef::manvolnum[]
include::output-format.adoc[]
endif::manvolnum[]
EXAMPLES
--------
Get the list of nodes in my cluster
# pvesh get /nodes
Get a list of available options for the datacenter
# pvesh usage cluster/options -v
Set the HTMl5 NoVNC console as the default console for the datacenter
# pvesh set cluster/options -console html5
ifdef::manvolnum[]
include::pve-copyright.adoc[]
endif::manvolnum[]