3.6.4. 管理 CLI を使用した操作説明の表示
前提条件
手順3.13 管理 CLI でのコマンドの実行
read-operation-description
操作の実行管理 CLI で、read-operation-description
を使用して、操作に関する情報を表示します。操作ではキーと値のペアの形式でパラメーターを追加して、表示する操作を示す必要があります。操作結果の詳細については、「管理 CLI での操作およびコマンドの使用」 を参照してください。[standalone@localhost:9999 /]
:read-operation-description(name=name-of-operation)
例3.9 list-snapshots 操作の説明表示
次の例は、
list-snapshots
操作を説明する方法を示しています。
[standalone@localhost:9999 /] :read-operation-description(name=list-snapshots) { "outcome" => "success", "result" => { "operation-name" => "list-snapshots", "description" => "Lists the snapshots", "request-properties" => {}, "reply-properties" => { "type" => OBJECT, "value-type" => { "directory" => { "type" => STRING, "description" => "The directory where the snapshots are stored", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L }, "names" => { "type" => LIST, "description" => "The names of the snapshots within the snapshots directory", "expressions-allowed" => false, "required" => true, "nillable" => false, "value-type" => STRING } } }, "access-constraints" => {"sensitive" => {"snapshots" => {"type" => "core"}}}, "read-only" => false } }
結果
選択した操作に関する説明が表示されます。