pvesh.1-synopsis.adoc

   1 *pvesh* `<COMMAND> [ARGS] [OPTIONS]`
   2
   3 *pvesh create* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
   4
   5 Call API POST on <api_path>.
   6
   7 `<api_path>`: `<string>` ::
   8
   9 API path.
  10
  11 `--noproxy` `<boolean>` ::
  12
  13 Disable automatic proxying.
  14
  15 *pvesh delete* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
  16
  17 Call API DELETE on <api_path>.
  18
  19 `<api_path>`: `<string>` ::
  20
  21 API path.
  22
  23 `--noproxy` `<boolean>` ::
  24
  25 Disable automatic proxying.
  26
  27 *pvesh get* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
  28
  29 Call API GET on <api_path>.
  30
  31 `<api_path>`: `<string>` ::
  32
  33 API path.
  34
  35 `--noproxy` `<boolean>` ::
  36
  37 Disable automatic proxying.
  38
  39 *pvesh help* `[OPTIONS]`
  40
  41 Get help about specified command.
  42
  43 `--extra-args` `<array>` ::
  44
  45 Shows help for a specific command
  46
  47 `--verbose` `<boolean>` ::
  48
  49 Verbose output format.
  50
  51 *pvesh ls* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
  52
  53 List child objects on <api_path>.
  54
  55 `<api_path>`: `<string>` ::
  56
  57 API path.
  58
  59 `--noproxy` `<boolean>` ::
  60
  61 Disable automatic proxying.
  62
  63 *pvesh set* `<api_path>` `[OPTIONS]` `[FORMAT_OPTIONS]`
  64
  65 Call API PUT on <api_path>.
  66
  67 `<api_path>`: `<string>` ::
  68
  69 API path.
  70
  71 `--noproxy` `<boolean>` ::
  72
  73 Disable automatic proxying.
  74
  75 *pvesh usage* `<api_path>` `[OPTIONS]`
  76
  77 print API usage information for <api_path>.
  78
  79 `<api_path>`: `<string>` ::
  80
  81 API path.
  82
  83 `--command` `<create | delete | get | set>` ::
  84
  85 API command.
  86
  87 `--returns` `<boolean>` ::
  88
  89 Including schema for returned data.
  90
  91 `--verbose` `<boolean>` ::
  92
  93 Verbose output format.
  94
  95