proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-04-29 20:02:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

pvesh.1-synopsis.adoc: update

Browse Source
This commit is contained in:
Dietmar Maurer 2018-07-27 07:54:29 +02:00
parent a3eeb58fc8
commit 676bbd4a5f
1 changed files with 5 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
pvesh.1-synopsis.adoc
View File

@ -1,6 +1,6 @@
*pvesh* `<COMMAND> [ARGS] [OPTIONS]` *pvesh* `<COMMAND> [ARGS] [OPTIONS]`
*pvesh create* `<api_path>` `[OPTIONS]` *pvesh create* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Call API POST on <api_path>. Call API POST on <api_path>.
@ -12,7 +12,7 @@ API path.
Disable automatic proxying. Disable automatic proxying.
*pvesh delete* `<api_path>` `[OPTIONS]` *pvesh delete* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Call API DELETE on <api_path>. Call API DELETE on <api_path>.
@ -24,7 +24,7 @@ API path.
Disable automatic proxying. Disable automatic proxying.
*pvesh get* `<api_path>` `[OPTIONS]` *pvesh get* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Call API GET on <api_path>. Call API GET on <api_path>.
@ -32,30 +32,10 @@ Call API GET on <api_path>.
API path. 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>` :: `--noproxy` `<boolean>` ::
Disable automatic proxying. Disable automatic proxying.
`--output-format` `<json | json-pretty | text | yaml>` ('default =' `text`)::
Output format.
`--quiet` `<boolean>` ::
Suppress printing results.
*pvesh help* `[OPTIONS]` *pvesh help* `[OPTIONS]`
Get help about specified command. Get help about specified command.
@ -68,7 +48,7 @@ Shows help for a specific command
Verbose output format. Verbose output format.
*pvesh ls* `<api_path>` `[OPTIONS]` *pvesh ls* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
List child objects on <api_path>. List child objects on <api_path>.
@ -76,31 +56,11 @@ List child objects on <api_path>.
API path. 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>` :: `--noproxy` `<boolean>` ::
Disable automatic proxying. Disable automatic proxying.
`--output-format` `<json | json-pretty | text | yaml>` ('default =' `text`):: *pvesh set* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Output format.
`--quiet` `<boolean>` ::
Suppress printing results.
*pvesh set* `<api_path>` `[OPTIONS]`
Call API PUT on <api_path>. Call API PUT on <api_path>.