5
0
mirror of git://git.proxmox.com/git/pve-docs.git synced 2025-01-08 21:17:52 +03:00
pve-docs/pvesh.1-synopsis.adoc
2018-07-27 07:54:29 +02:00

96 lines
1.4 KiB
Plaintext

*pvesh* `<COMMAND> [ARGS] [OPTIONS]`
*pvesh create* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Call API POST on <api_path>.
`<api_path>`: `<string>` ::
API path.
`--noproxy` `<boolean>` ::
Disable automatic proxying.
*pvesh delete* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Call API DELETE on <api_path>.
`<api_path>`: `<string>` ::
API path.
`--noproxy` `<boolean>` ::
Disable automatic proxying.
*pvesh get* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Call API GET on <api_path>.
`<api_path>`: `<string>` ::
API path.
`--noproxy` `<boolean>` ::
Disable automatic proxying.
*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]` `[FORMAT_OPTIONS]`
List child objects on <api_path>.
`<api_path>`: `<string>` ::
API path.
`--noproxy` `<boolean>` ::
Disable automatic proxying.
*pvesh set* `<api_path>` `[OPTIONS]` `[FORMAT_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.