pvesh(1)

名前

pvesh - Proxmox VE API 用シェルインターフェイス

SYNOPSIS

pvesh <COMMAND> [ARGS] [OPTIONS].

pvesh create <api_path> [OPTIONS] [FORMAT_OPTIONS] です。

<api_path>でAPI POSTを呼び出します。

<api_path>: <文字列: APIパス。
--noproxy <ブール値: 自動プロキシを無効にします。

pvesh delete <api_path> [OPTIONS] [FORMAT_OPTIONS].

<api_path>でAPI DELETEを呼び出します。

<api_path>: <文字列: APIパス。
--noproxy <ブール値: 自動プロキシを無効にします。

pvesh get <api_path> [OPTIONS] [FORMAT_OPTIONS].

<api_path>でAPI GETを呼び出します。

<api_path>: <文字列: APIパス。
--noproxy <ブール値: 自動プロキシを無効にします。

pvesh help [OPTIONS］

指定したコマンドに関するヘルプを表示します。

--extra-args <array> です。: 特定のコマンドのヘルプを表示します。
--verbose <ブール値: 冗長出力フォーマット。

pvesh ls <api_path> [OPTIONS] [FORMAT_OPTIONS].

<api_path>上の子オブジェクトを一覧表示します。

<api_path>: <文字列: APIパス。
--noproxy <ブール値: 自動プロキシを無効にします。

pvesh set <api_path> [OPTIONS] [FORMAT_OPTIONS].

<api_path>でAPI PUTを呼び出します。

<api_path>: <文字列: APIパス。
--noproxy <ブール値: 自動プロキシを無効にします。

pvesh usage <api_path> [OPTIONS]を使用します。

<api_path> の API 使用情報を表示します。

<api_path>: <文字列: APIパス。
--コマンド <create | delete | get | set>.: APIコマンド。
<boolean>を返します。: 返されたデータのスキーマを含みます。
--verbose <ブール値: 冗長出力フォーマット。

説明

Proxmox VE管理ツール(pvesh)を使用すると、REST/HTTPSサーバを使用せずにAPI関数を直接呼び出すことができます。

それができるのはrootだけです。

format_options

出力形式は--output-formatパラメータで指定できます。デフォルトのフォーマット・テキストは、ASCII-artを使用して表の周囲にきれいな枠線を描きます。さらに、いくつかの値を人間が読めるテキストに変換します：

Unix epoch は ISO 8601 日付文字列として表示されます。
期間は週/日/時/分/秒のカウントで表示されます。
バイトサイズの値には単位（B、KiB、MiB、GiB、TiB、PiB）が含まれます。
分数はパーセントで表示されます。つまり、1.0は100%として表示されます。

オプション--quietを使えば、出力を完全に抑制することもできます。

--human-readable <boolean>(デフォルト = 1): 出力レンダリング関数を呼び出して、人間が読めるテキストを生成します。
--noborder <boolean>(デフォルト = 0): ボーダーを描画しません（テキスト形式の場合）。
--noheader <boolean>(デフォルト = 0): カラムヘッダを表示しない（テキスト形式の場合）。
--output-format <json | json-pretty | text | yaml>(default = text): 出力フォーマット
--quiet <ブール値: 印刷結果を抑制します。

例

クラスタ内のノードのリストを取得

# pvesh get /nodes

データセンターで利用可能なオプションのリストを取得します。

# pvesh usage cluster/options -v

HTMl5 NoVNCコンソールをデータセンターのデフォルトコンソールに設定

# pvesh set cluster/options -console html5

著作権および免責事項

このプログラムはフリー・ソフトウェアです。あなたは、Free Software Foundationによって発行されたGNU Affero General Public Licenseのバージョン3、またはそれ以降のバージョンのいずれかに従って、このプログラムを再配布したり、変更したりすることができます。

このプログラムは有用であることを期待して配布されていますが、商品性や特定の目的への適合性についての暗黙の保証もなく、いかなる保証もありません。詳細はGNU Affero General Public Licenseをご覧ください。

あなたはこのプログラムとともにGNU Affero General Public Licenseのコピーを受け取っているはずです。そうでない場合は、https://www.gnu.org/licenses/をご覧ください。