dsc

概要

構成を適用したり、特定のリソースを呼び出してソフトウェアコンポーネントを管理しましょう。

Syntax

dsc [Options] <COMMAND>

Commands

コンプリート

completerコマンドはシェルスクリプトを返し、実行すると指定されたシェルの完了を登録します。 詳細は dsc completerをご覧ください。

config

configコマンドはDSC設定文書を管理します。 これを使用すると、次のことができます。

  • 構成の現状を確認してください。
  • 構成が望ましい状態にあるかどうかをテストします。
  • 設定を希望の状態に設定します。

詳細は dsc設定をご覧ください。

リソース

resourceコマンドはDSCリソースを管理します。 これを使用すると、次のことができます。

  • 利用可能なリソースをリストアップしましょう。
  • リソースのインスタンスのJSONスキーマを取得してください。
  • リソースインスタンスの現在の状態を取得しましょう。
  • リソースインスタンスが望ましい状態にあるかどうかをテストします。
  • リソースインスタンスを希望の状態に設定します。

詳細については、dscリソースをご覧ください。

スキーマ

schemaコマンドは特定のDSCタイプのJSONスキーマを返します。 詳細は dscスキーマを参照してください。

ヘルプ

helpコマンドは、dsc、コマンド、またはサブコマンドのヘルプ情報を返します。

コマンドやサブコマンドの助けを得るには、以下の構文を使います:

dsc help <COMMAND> [<SUBCOMMAND>]

例えば、 dsc help config は config サブコマンドの助けを受けます。 dsc help config set config setサブコマンドの助けを得る。

また、コマンドの --help オプションを使ってヘルプ情報を表示することもできます。 たとえば、dsc config --help または dsc config set --help です。

オプション

-l、--トレースレベル

操作中にDSCが送信すべき最小メッセージレベルを定義します。 DSCのメッセージはレベルごとに分類されます。

以下のリストは、有効なメッセージレベルを最高レベルから最低レベルまで示しています。 このオプションがリスト内の任意の値に設定されている場合、DSCはそのレベル以上のメッセージを発信します。

  • error
  • warn (既定値)
  • info
  • debug
  • trace

Warning

traceレベルの出力は、実行中にDSCが処理するすべてのJSON入出力を出力します。 DSCはJSONを発行する前にサニティ処理しません。 このトレースレベルは開発者専用です。 traceレベルの出力は機密情報が含まれている可能性があるため、絶対にストレージにリダイレクトしないでください。

例えば、ログレベルが debugされている場合、DSCは traceを除くすべてのログレベルに対してメッセージを送信します。 ログレベルが errorされると、DSCはエラーメッセージのみを発します。 DSCはログレベルが低いすべてのメッセージを無視します。

Type         : string
Mandatory    : false
DefaultValue : warn
ValidValues  : [error, warn, info, debug, trace]
LongSyntax   : --trace-level <TRACE_LEVEL>
ShortSyntax  : -l <TRACE_LEVEL>

-f, --trace-format(トレースフォーマット)

stderr上でトレースメッセージを出す際に使用される出力フォーマットを定義します。 DSCは以下のフォーマットをサポートしています:

  • default - タイムスタンプ、メッセージレベル、行番号に対してANSIコンソールカラーでメッセージを送信します。
  • plaintext - default は同じですが、コンソールカラーは一切ありません。
  • json - 各メッセージを圧縮されたJSONオブジェクトとして送信し、タイムスタンプ、レベル、メッセージ、行番号をプロパティとして設定します。
Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, plaintext, json]
LongSyntax   : --trace-format <TRACE_FORMAT>
ShortSyntax  : -f <TRACE_FORMAT>

-p, --progress-format(プログレスフォーマット)

stderrで進捗メッセージを発信する際に使う進行状況の形式を定義しています。 DSCは以下のフォーマットをサポートしています:

  • default - DSCがインタラクティブに呼び出していると検知した場合、進行バーが表示されます。 それ以外は、DSCには進展が見られません。
  • none - 進展は見られない。
  • json - 進行状況を圧縮されたJSONオブジェクトとして送信し、タイムスタンプ、レベル、メッセージ、行番号をプロパティとして使います。
Type         : string
Mandatory    : false
DefaultValue : default
ValidValues  : [default, none, json]
LongSyntax   : --progress-format <PROGRESS_FORMAT>
ShortSyntax  : -p <PROGRESS_FORMAT>

-V、--バージョン

アプリケーションのバージョンを表示します。 このオプションを指定すると、 アプリケーションは--help以外のすべてのオプションと引数を無視し、--helpはこのオプションを上書きします。

Type        : boolean
Mandatory   : false
LongSyntax  : --version
ShortSyntax : -V

-h、--help

現在のコマンドまたはサブコマンドのヘルプを表示します。 このオプションを指定すると、アプリケーションは他のすべてのオプションと引数を無視します。

Type        : boolean
Mandatory   : false
LongSyntax  : --help
ShortSyntax : -h

環境変数

デフォルトでは、 dsc コマンドは PATH 環境変数で定義されたフォルダ内のDSCリソースマニフェストを検索します。 DSC_RESOURCE_PATH環境変数が定義されている場合、dscはPATHではなくDSC_RESOURCE_PATHのフォルダを検索します。

DSC_RESOURCE_PATH環境は、オペレーティングシステムのPATH環境変数と同じ慣例に従う環境変数でなければなりません。 フォルダパスは別々で、Windowsにはセミコロン(;)、他のプラットフォームにはコロン(:)を付けます。

終了コード

dscコマンドは意味的な退出コードを使用します。 各出口コードはコマンド実行の異なる結果を表します。

終了コード Meaning
0 コマンドはエラーなく正常に実行されました。
1 コマンドは無効な引数を受け取ったため失敗しました。
2 コマンドはリソースがエラーを出したため失敗しました。
3 コマンドが失敗したのは、値をJSONにシリアライズしたり、逆直列化したりできなかったからです。
4 コマンドは、入力が有効なYAMLやJSONでなかったため失敗しました。
5 コマンドが失敗したのは、リソース定義やインスタンス値がJSONスキーマに対して無効だったためです。
6 このコマンドは Ctrl+C の中断によってキャンセルされました。

メモ

DSCは入力文字列にUTF-8エンコーディングを期待しています。 スタンディンから入力を渡す際やパスをファイルに渡す際は、その入力がUTF-8でエンコードされていることを確認してください。

  • Last updated on