projects / pve-docs.git / blame
| Commit | Line | Data |
|---|---|---|
| 17eb42a2 DM |
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 | ||
| ed53a3e6 | 33 | ifdef::manvolnum[] |
| 2c5571e3 | 34 | include::output-format.adoc[] |
| ed53a3e6 | 35 | endif::manvolnum[] |
| 2c5571e3 DM |
36 | |
| 37 | ||
| 17eb42a2 DM |
38 | EXAMPLES |
| 39 | -------- | |
| 40 | ||
| 41 | Get the list of nodes in my cluster | |
| 42 | ||
| 43 | # pvesh get /nodes | |
| 44 | ||
| 45 | Get a list of available options for the data center | |
| 46 | ||
| 47 | # pvesh usage cluster/options -v | |
| 48 | ||
| 49 | Set the HTMl5 NoVNC console as the default console for the data center | |
| 50 | ||
| 51 | # pvesh set cluster/options -console html5 | |
| 52 | ||
| 53 | ||
| 54 | ifdef::manvolnum[] | |
| 55 | include::pve-copyright.adoc[] | |
| 56 | endif::manvolnum[] |