pvesh.1-synopsis.adoc

   1 *pvesh* `<COMMAND> [ARGS] [OPTIONS]`
   2
   3 *pvesh create* `<api_path>` `[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]`
  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]`
  28
  29 Call API GET on <api_path>.
  30
  31 `<api_path>`: `<string>` ::
  32
  33 API path.
  34
  35 `--human-readable` `<boolean>` ('default =' `1`)::
  36
  37 Call output rendering functions to produce human readable text.
  38
  39 `--noborder` `<boolean>` ('default =' `1`)::
  40
  41 Do not draw borders (for 'text' format).
  42
  43 `--noheader` `<boolean>` ('default =' `1`)::
  44
  45 Do not show column headers (for 'text' format).
  46
  47 `--noproxy` `<boolean>` ::
  48
  49 Disable automatic proxying.
  50
  51 `--output-format` `<json | json-pretty | text | yaml>` ('default =' `text`)::
  52
  53 Output format.
  54
  55 `--quiet` `<boolean>` ::
  56
  57 Suppress printing results.
  58
  59 *pvesh help* `[OPTIONS]`
  60
  61 Get help about specified command.
  62
  63 `--extra-args` `<array>` ::
  64
  65 Shows help for a specific command
  66
  67 `--verbose` `<boolean>` ::
  68
  69 Verbose output format.
  70
  71 *pvesh ls* `<api_path>` `[OPTIONS]`
  72
  73 List child objects on <api_path>.
  74
  75 `<api_path>`: `<string>` ::
  76
  77 API path.
  78
  79 `--human-readable` `<boolean>` ('default =' `1`)::
  80
  81 Call output rendering functions to produce human readable text.
  82
  83 `--noborder` `<boolean>` ('default =' `1`)::
  84
  85 Do not draw borders (for 'text' format).
  86
  87 `--noheader` `<boolean>` ('default =' `1`)::
  88
  89 Do not show column headers (for 'text' format).
  90
  91 `--noproxy` `<boolean>` ::
  92
  93 Disable automatic proxying.
  94
  95 `--output-format` `<json | json-pretty | text | yaml>` ('default =' `text`)::
  96
  97 Output format.
  98
  99 `--quiet` `<boolean>` ::
 100
 101 Suppress printing results.
 102
 103 *pvesh set* `<api_path>` `[OPTIONS]`
 104
 105 Call API PUT on <api_path>.
 106
 107 `<api_path>`: `<string>` ::
 108
 109 API path.
 110
 111 `--noproxy` `<boolean>` ::
 112
 113 Disable automatic proxying.
 114
 115 *pvesh usage* `<api_path>` `[OPTIONS]`
 116
 117 print API usage information for <api_path>.
 118
 119 `<api_path>`: `<string>` ::
 120
 121 API path.
 122
 123 `--command` `<create | delete | get | set>` ::
 124
 125 API command.
 126
 127 `--returns` `<boolean>` ::
 128
 129 Including schema for returned data.
 130
 131 `--verbose` `<boolean>` ::
 132
 133 Verbose output format.
 134
 135