add pvesh.adoc
[pve-docs.git] / pvesh.adoc
1 ifdef::manvolnum[]
2 pvesh(1)
3 ========
4 :pve-toplevel:
5
6 NAME
7 ----
8
9 pvesh - Shell interface for the Proxmox VE API
10
11 SYNOPSIS
12 --------
13
14 include::pvesh.1-synopsis.adoc[]
15
16 DESCRIPTION
17 -----------
18 endif::manvolnum[]
19
20 ifndef::manvolnum[]
21 Shell interface for the Proxmox VE API
22 ======================================
23 :pve-toplevel:
24 endif::manvolnum[]
25
26
27 The {PVE} management tool (`pvesh`) allows to directly invoke API
28 function, without using the REST/HTTPS server.
29
30 NOTE: Only 'root' is allowed to do that.
31
32
33 EXAMPLES
34 --------
35
36 Get the list of nodes in my cluster
37
38  # pvesh get /nodes
39
40 Get a list of available options for the data center
41
42  # pvesh usage cluster/options -v
43
44 Set the HTMl5 NoVNC console as the default console for the data center
45
46  # pvesh set cluster/options -console html5
47
48
49 ifdef::manvolnum[]
50 include::pve-copyright.adoc[]
51 endif::manvolnum[]