次の方法で共有

DSCコンフィグ

概要

設定ドキュメントを適用します。

構文

dsc config [Options] <COMMAND>

説明

dsc config コマンドには、DSC 設定ドキュメントで定義されたリソース・インスタンスを管理するためのサブコマンドが含まれています。 リソースを直接管理するには、 dsc resource コマンドを参照してください。

コマンド

エクスポート

export コマンドは、一連のリソースの既存のインスタンスを定義する構成ドキュメントを生成します。 詳細については、「 dsc config export」を参照してください。

バージョン変更

get コマンドは、設定ドキュメント内のリソース・インスタンスの現在の状態を取得します。 詳細については、 dsc config getを参照してください。

セット

set コマンドは、設定ドキュメント内のリソース・インスタンスの望ましい状態を強制します。 詳細については、「 dsc config set」を参照してください。

テスト

test コマンドは、設定ドキュメント内のリソース・インスタンスが目的の状態にあるかどうかを確認します。 詳細については、「 dsc config test」を参照してください。

助けて

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

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

dsc config help [<SUBCOMMAND>]

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

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

オプション

-f, --parameters-file

JSON または YAML として設定に渡すパラメータを含むデータファイルへのパスを指定します。 このオプションを指定すると、DSC はデータ ファイル内のキーをパラメーターとして解釈し、指定した値を使用します。 データ・ファイル内の値は、構成自体で定義されたデフォルトをオーバーライドします。

データファイルには、 parameters キーを持つオブジェクトが含まれている必要があります。 parameters キーの値は、各キーが定義されたパラメーターの名前であり、各値がそのパラメーターの有効な値であるオブジェクトである必要があります。

このオプションは、 --parameters オプションと相互に排他的です。

DSC バージョン 3.1.0 以降では、stdin を介してパラメーター データをサブコマンドに渡すことができます。 その場合は、設定ドキュメントを入力文字列として渡すか、システム上のファイルへのパスを渡す必要があります。 パラメータファイルと設定ドキュメントの両方を stdin からコマンドに渡すことはできません。

設定ドキュメントでのパラメータの定義の詳細については、「 DSC 設定ドキュメントのパラメータ スキーマ」を参照してください。 設定ドキュメントでのパラメーターの使用の詳細については、 parameters 関数リファレンスを参照してください。

Type        : string
Mandatory   : false
LongSyntax  : --parameters-file <PARAMETERS_FILE>
ShortSyntax : -f <PARAMETERS_FILE>

-p, --parameters

設定ドキュメントに渡すパラメータを、JSON または YAML 形式のデータの文字列として指定します。 このオプションを指定すると、DSC はデータ文字列内のキーをパラメーターとして解釈し、指定した値を使用します。 データ文字列の値は、設定ドキュメント自体で定義されているデフォルトを上書きします。

データ文字列には、 parameters キーを持つオブジェクトが含まれている必要があります。 parameters キーの値は、各キーが定義されたパラメーターの名前であり、各値がそのパラメーターの有効な値であるオブジェクトである必要があります。

このオプションは、 --parameters_file オプションと相互に排他的です。

設定ドキュメントでのパラメータの定義の詳細については、「 DSC 設定ドキュメントのパラメータ スキーマ」を参照してください。 設定ドキュメントでのパラメーターの使用の詳細については、 parameters 関数リファレンスを参照してください。

Type        : string
Mandatory   : false
LongSyntax  : --parameters <PARAMETERS>
ShortSyntax : -p <PARAMETERS>

-r, --system-root

このオプションを使用して、現在実行中の OS を対象としていない場合に、オペレーティング システムのルートへのパスを指定します。

Type        : string
Mandatory   : false
LongSyntax  : --system-root <SYSTEM_ROOT>
ShortSyntax : -r <SYSTEM_ROOT>

-h、--help

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

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

環境変数

dsc config * サブコマンドは、--path オプションを指定してコマンドを呼び出し、コマンドに使用する構成文書を指定するときに、DSC_CONFIG_ROOT環境変数を作成します。 DSC は、 DSC_CONFIG_ROOT 環境変数の値を、指定した設定ドキュメントを含むフォルダのフルパスに設定します。

注

DSC_CONFIG_ROOT 変数を DSC の外部で定義すると、DSC は操作の既存の環境変数の値をオーバーライドするときに警告を発生させます。

envvar 構成関数を使用して、構成内のリソース・インスタンスのそのフォルダー・パスを参照できます。

  • Last updated on