add pvesh.adoc
authorDietmar Maurer <dietmar@proxmox.com>
Thu, 26 Jul 2018 13:18:45 +0000 (15:18 +0200)
committerDietmar Maurer <dietmar@proxmox.com>
Thu, 26 Jul 2018 13:18:45 +0000 (15:18 +0200)
pve-admin-guide.adoc
pvesh.1-synopsis.adoc [new file with mode: 0644]
pvesh.adoc [new file with mode: 0644]

index 6e9f19a..63a2718 100644 (file)
@@ -133,6 +133,14 @@ include::pvenode.1-synopsis.adoc[]
 
 :leveloffset: 0
 
+*pvesh* - Shell interface for the {pve} API
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+:leveloffset: 1
+include::pvesh.1-synopsis.adoc[]
+
+:leveloffset: 0
+
 *qm* - Qemu/KVM Virtual Machine Manager
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/pvesh.1-synopsis.adoc b/pvesh.1-synopsis.adoc
new file mode 100644 (file)
index 0000000..3c6eeef
--- /dev/null
@@ -0,0 +1,135 @@
+*pvesh* `<COMMAND> [ARGS] [OPTIONS]`
+
+*pvesh create* `<api_path>` `[OPTIONS]`
+
+Call API POST on <api_path>.
+
+`<api_path>`: `<string>` ::
+
+API path.
+
+`--noproxy` `<boolean>` ::
+
+Disable automatic proxying.
+
+*pvesh delete* `<api_path>` `[OPTIONS]`
+
+Call API DELETE on <api_path>.
+
+`<api_path>`: `<string>` ::
+
+API path.
+
+`--noproxy` `<boolean>` ::
+
+Disable automatic proxying.
+
+*pvesh get* `<api_path>` `[OPTIONS]`
+
+Call API GET on <api_path>.
+
+`<api_path>`: `<string>` ::
+
+API path.
+
+`--human-readable` `<boolean>` ('default =' `1`)::
+
+Call output rendering functions to produce human readable text.
+
+`--noborder` `<boolean>` ('default =' `1`)::
+
+Do not draw borders (for 'text' format).
+
+`--noheader` `<boolean>` ('default =' `1`)::
+
+Do not show column headers (for 'text' format).
+
+`--noproxy` `<boolean>` ::
+
+Disable automatic proxying.
+
+`--output-format` `<json | json-pretty | text | yaml>` ('default =' `text`)::
+
+Output format.
+
+`--quiet` `<boolean>` ::
+
+Suppress printing results.
+
+*pvesh help* `[OPTIONS]`
+
+Get help about specified command.
+
+`--extra-args` `<array>` ::
+
+Shows help for a specific command
+
+`--verbose` `<boolean>` ::
+
+Verbose output format.
+
+*pvesh ls* `<api_path>` `[OPTIONS]`
+
+List child objects on <api_path>.
+
+`<api_path>`: `<string>` ::
+
+API path.
+
+`--human-readable` `<boolean>` ('default =' `1`)::
+
+Call output rendering functions to produce human readable text.
+
+`--noborder` `<boolean>` ('default =' `1`)::
+
+Do not draw borders (for 'text' format).
+
+`--noheader` `<boolean>` ('default =' `1`)::
+
+Do not show column headers (for 'text' format).
+
+`--noproxy` `<boolean>` ::
+
+Disable automatic proxying.
+
+`--output-format` `<json | json-pretty | text | yaml>` ('default =' `text`)::
+
+Output format.
+
+`--quiet` `<boolean>` ::
+
+Suppress printing results.
+
+*pvesh set* `<api_path>` `[OPTIONS]`
+
+Call API PUT on <api_path>.
+
+`<api_path>`: `<string>` ::
+
+API path.
+
+`--noproxy` `<boolean>` ::
+
+Disable automatic proxying.
+
+*pvesh usage* `<api_path>` `[OPTIONS]`
+
+print API usage information for <api_path>.
+
+`<api_path>`: `<string>` ::
+
+API path.
+
+`--command` `<create | delete | get | set>` ::
+
+API command.
+
+`--returns` `<boolean>` ::
+
+Including schema for returned data.
+
+`--verbose` `<boolean>` ::
+
+Verbose output format.
+
+
diff --git a/pvesh.adoc b/pvesh.adoc
new file mode 100644 (file)
index 0000000..913bae0
--- /dev/null
@@ -0,0 +1,51 @@
+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.
+
+
+EXAMPLES
+--------
+
+Get the list of nodes in my cluster
+
+ # pvesh get /nodes
+
+Get a list of available options for the data center
+
+ # pvesh usage cluster/options -v
+
+Set the HTMl5 NoVNC console as the default console for the data center
+
+ # pvesh set cluster/options -console html5
+
+
+ifdef::manvolnum[]
+include::pve-copyright.adoc[]
+endif::manvolnum[]