dsc

  • [アーティクル]

概要

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

構文

dsc [Options] <COMMAND>

コマンド

completer

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

config

コマンドは config 、DSC 構成ドキュメントを管理します。 次の目的に使用できます。

  • 構成の現在の状態を取得します。
  • 構成が目的の状態であるかどうかをテストします。
  • 構成を目的の状態に設定します。

詳細については、「 config」を参照してください。

resource

コマンドは resource DSC リソースを管理します。 次の目的に使用できます。

  • 使用可能なリソースを一覧表示します。
  • リソースのインスタンスの JSON スキーマを取得します。
  • リソース インスタンスの現在の状態を取得します。
  • リソース インスタンスが目的の状態であるかどうかをテストします。
  • リソース インスタンスを目的の状態に設定します。

詳細については、リソースに関するページを参照してください。

schema

コマンドは schema 、特定の DSC 型の JSON スキーマを返します。 詳細については、「 スキーマ」を参照してください。

help

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

コマンドまたはサブコマンドのヘルプを表示するには、次の構文を使用します。

dsc help <COMMAND> [<SUBCOMMAND>]

たとえば、 dsc help config は サブコマンドのヘルプを config 取得します。 dsc help config set は サブコマンドのヘルプを config set 取得します。

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

オプション

-h, --help

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

Type:      Boolean
Mandatory: false

-l、--trace-level

操作中に DSC が出力する必要がある最小メッセージ レベルを定義します。 DSC 内のメッセージは、そのレベルによって分類されます。

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

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

警告

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

たとえば、ログ レベルが の場合、DSC は debugを除く traceすべてのログ レベルのメッセージを出力します。 ログ レベルが の場合、DSC は errorエラー メッセージのみを出力します。 DSC は、ログ レベルが低いすべてのメッセージを無視します。

Type:         String
Mandatory:    false
DefaultValue: warning
ValidValues:  [error, warning, info, debug, trace]

-f、--trace-format

stderr でトレース メッセージを出力するときに使用する出力形式を定義します。 DSC では、次の形式がサポートされています。

  • default - タイムスタンプ、メッセージ レベル、および行番号の ANSI コンソールの色分けでメッセージを出力します。
  • plaintextdefault- コンソールの色はありません。
  • json - タイムスタンプ、レベル、メッセージ、および行番号をプロパティとして使用して、各メッセージを圧縮された JSON オブジェクトとして出力します。
Type:         String
Mandatory:    false
DefaultValue: default
ValidValues:  [default, plaintext, json]

-V、--version

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

Type:      Boolean
Mandatory: false

環境変数

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

環境は DSC_RESOURCE_PATH 、オペレーティング システムの環境変数と同じ規則に PATH 従う環境変数である必要があります。 フォルダー パスは、Windows ではセミコロン (;) で区切り、他のプラットフォームではコロン (:) で区切ります。

終了コード

コマンドは dsc セマンティック終了コードを使用します。 各終了コードは、コマンドの実行に対して異なる結果を表します。

終了コード 意味
0 コマンドはエラーなしで正常に実行されました。
1 無効な引数を受け取ったため、コマンドは失敗しました。
2 リソースでエラーが発生したため、コマンドは失敗しました。
3 JSON に対して値をシリアル化したり、JSON から逆シリアル化したりできなかったため、コマンドは失敗しました。
4 コマンドの入力が有効な YAML または JSON でなかったため、コマンドは失敗しました。
5 JSON スキーマに対してリソース定義またはインスタンス値が無効であったため、コマンドは失敗しました。
6 コマンドは CtrlCの+中断によって取り消されました。