構成の作成、コンパイル、適用

[アーティクル]
05/05/2023

適用先:Windows PowerShell 4.0、Windows PowerShell 5.0

この演習では、Desired State Configuration (DSC) の構成の作成と適用について最初から最後まで説明します。次の例では、非常に単純な構成を作成して適用する方法について学習します。この構成により、"HelloWorld.txt" ファイルがローカルコンピューターに存在していることが確保されます。ファイルを削除する場合は、次に更新されるときに DSC によってファイルが再作成されます。

DSC の概要としくみついては、開発者向けの Desired State Configuration の概要に関するページをご覧ください。

必要条件

このサンプルを実行するには、PowerShell 4.0 以降が動作しているコンピューターが必要です。

構成を記述する

DSC 構成は、1 つ以上のターゲットコンピューター (ノード) を構成する方法を定義する特別な PowerShell 関数です。

PowerShell ISE、またはその他の PowerShell エディターで、次のように入力します。

Configuration HelloWorld {

    # Import the module that contains the File resource.
    Import-DscResource -ModuleName PsDesiredStateConfiguration

    # The Node statement specifies which targets to compile MOF files for, when
    # this configuration is executed.
    Node 'localhost' {

        # The File resource can ensure the state of files, or copy them from a
        # source to a destination with persistent updates.
        File HelloWorld {
            DestinationPath = "C:\Temp\HelloWorld.txt"
            Ensure = "Present"
            Contents   = "Hello World from DSC!"
        }
    }
}

重要

多くの DSC リソースを同じ構成で操作できるように複数のモジュールをインポートすることが必要な、より高度なシナリオの場合は、Import-DscResource を使って各モジュールを別々の行に配置するようにしてください。こちらの方がソース管理で管理しやすく、また Azure State Configuration の DSC を使用する場合に必要になります。

 Configuration HelloWorld {

  # Import the module that contains the File resource.
  Import-DscResource -ModuleName PsDesiredStateConfiguration
  Import-DscResource -ModuleName xWebAdministration

ファイルを "HelloWorld.ps1" という名前で保存します。

構成を定義するのは、関数の定義と似ています。 localhost 場合、ノードブロックは構成するターゲットノードを指定します。

構成では、1 つのリソース (File リソース) を呼び出します。リソースは、ターゲットノードが構成によって定義された状態になっているか確認します。

構成のコンパイル

DSC 構成をノードに適用するには、最初にコンパイルを行い、MOF ファイルを出力する必要があります。関数のように構成を実行すると、Node ブロックで定義されたノードごとに、.mof ファイルが 1 つコンパイルされます。構成を実行するには、現在の範囲で HelloWorld.ps1 スクリプトを "ドットソース" で実行する必要があります。詳細については、スクリプトに関するページを参照してください。

HelloWorld.ps1 スクリプトを "ドットソース" で実行するには、. (ドット、スペース) の後で、それを保存した場所のパス内に入力します。その後、関数のように呼び出すことで、構成を実行することができます。また、スクリプトの一番下にある構成関数を呼び出すと、ドットソースで実行する必要がなくなります。

. C:\Scripts\HelloWorld.ps1
HelloWorld

これにより、次の出力が生成されます。

Directory: C:\Scripts\HelloWorld


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        3/13/2017   5:20 PM           2746 localhost.mof

構成を適用する

コンパイル済みの MOF があるため、Start-DscConfiguration コマンドレットを呼び出すことで、ターゲットノード (今回の場合はローカルコンピューター) に構成を適用できます。

Start-DscConfiguration コマンドレットからローカル構成マネージャー (LCM) (DSC のエンジン) に対して構成の適用を指示します。 LCM はDSC リソースを呼び出し、構成を適用します。

以下のコードを使用して、Start-DSCConfiguration コマンドレットを実行します。 localhost.mof が保存されているディレクトリパスを Path パラメーターに指定します。 Start-DSCConfiguration コマンドレットは、任意の <computername>.mof ファイルに対して指定されたディレクトリが対象になります。 Start-DSCConfiguration コマンドレットでは、見つかった各 .mof ファイルを、ファイル名 ("localhost"、"server01"、"dc-02" など) で指定された computername に適用する試みが行われます。

Note

-Wait パラメーターが指定されていない場合、Start-DSCConfiguration では操作を実行するためにバックグラウンドジョブが作成されます。 -Verbose パラメーターを指定すると、操作の詳細出力を確認できます。 -Wait および -Verbose は、どちらも省略可能なパラメーターです。

Start-DscConfiguration -Path C:\Scripts\HelloWorld -Verbose -Wait

構成をテストする

Start-DSCConfiguration コマンドレットが完了すると、指定した場所に HelloWorld.txt ファイルが表示されます。 Get-Content コマンドレットを使用して、コンテンツを確認できます。

Test-DSCConfiguration を使用して、現在の状態をテストすることもできます。

現在、ノードが適用された構成に準拠している場合、出力は True になります。

Test-DSCConfiguration

True

Get-Content -Path C:\Temp\HelloWorld.txt

Hello World from DSC!

構成を再適用する

もう一度構成が適用されることを確認するには、自分の構成で作成されたテキストファイルを削除します。 Start-DSCConfiguration コマンドレットを -UseExisting パラメーターを指定して使用します。 -UseExisting パラメーターによって、Start-DSCConfiguration に対して、最後に正常に適用された構成を表す、"current.mof" を再適用するように指示されます。

Remove-Item -Path C:\Temp\HelloWorld.txt

次のステップ

「DSC 構成」で DSC 構成の詳細を確認する。
「DSC リソース」で利用可能な DSC リソースとカスタム DSC リソースの作成方法を確認する。
「PowerShell ギャラリー」で DSC の構成とリソースを検索する。

次の方法で共有