[pve-devel] [PATCH pve-manager] pvesh man page

Emmanuel Kasper e.kasper at proxmox.com
Thu Sep 10 12:00:25 CEST 2015


---
 bin/Makefile |  8 +++++++-
 bin/pvesh    | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 53 insertions(+), 1 deletion(-)

diff --git a/bin/Makefile b/bin/Makefile
index 56c9f1a..fd865ca 100644
--- a/bin/Makefile
+++ b/bin/Makefile
@@ -26,7 +26,9 @@ CLI_MANS = 				\
 	pveceph.1			\
 	pveversion.1			\
 	pveupgrade.1			\
-	pveperf.1
+	pveperf.1				\
+	pvesh.1
+
 CLI_PODS = $(addsuffix .pod, ${CLI_MANS})
 
 
@@ -62,6 +64,10 @@ pveperf.1.pod: pveperf
 	podselect $< > $@.tmp
 	mv $@.tmp $@
 
+pvesh.1.pod: pvesh
+	podselect $< > $@.tmp
+	mv $@.tmp $@
+
 %.service-bash-completion:
 	perl -I.. -T -e "use PVE::Service::$*; PVE::Service::$*->generate_bash_completions();" >$@.tmp
 	mv $@.tmp $@
diff --git a/bin/pvesh b/bin/pvesh
index 50d610c..6df044b 100755
--- a/bin/pvesh
+++ b/bin/pvesh
@@ -562,3 +562,49 @@ while (defined ($input = $term->readline("pve:/$cdir> "))) {
     };
     warn $@ if $@;
 }
+
+__END__
+
+=head1 NAME
+
+pvesh - shell interface to the Promox VE API
+
+=head1 SYNOPSIS
+
+pvesh [get|set|create|delete|help] [REST API path] [--verbose]
+
+=head1 DESCRIPTION
+
+pvesh provides a shell-like interface to the Proxmox VE REST API, in two different modes:
+
+=over
+
+=item interactive
+
+when called without parameters, pvesh starts an interactive client, where you can navigate
+in the different parts of the API
+
+=item command line
+
+when started with parameters pvesh will send a command to the corresponding REST url, and will
+return the JSON formatted output
+
+=back
+
+=head1 EXAMPLES
+
+get the list of nodes in my cluster
+
+pvesh get /nodes
+
+get a list of available options for the datacenter
+
+pvesh help cluster/options -v
+
+set the HTMl5 NoVNC console as the default console for the datacenter
+
+pvesh set cluster/options -console html5
+
+=head1 SEE ALSO
+
+qm(1), pct(1)
-- 
2.1.4




More information about the pve-devel mailing list