You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

pvesh.adoc 921B

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