PowerShell Desired State Configuration の部分構成

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

適用先: Windows PowerShell 5.0 以降。

PowerShell 5.0 では、Desired State Configuration (DSC) によって、複数のソースからフラグメントで構成を配信できます。ターゲットノード上のローカル構成マネージャー (LCM) によって、フラグメントがまとめられ、1 つの構成として適用されます。この機能により、チームまたは個人間で構成の制御を共有できます。たとえば、2 つ以上開発者のチームがサービスで共同作業を行っている場合、それぞれがサービスの自身の一部を管理する構成を作成する可能性があります。これらの構成は、それぞれ異なるプルサーバーからプルされ、開発の異なる段階で追加される可能性があります。部分構成では、1 つの構成ドキュメントの編集を調整することなく、さまざまな個人またはチームが構成ノードのさまざまな側面を制御することもできます。たとえば、1 つのチームが VM とオペレーティングシステムの展開を担当し、別のチームがその VM に別のアプリケーションとサービスを展開する場合があります。部分構成を使用すると、各チームが、不必要に複雑になることなく、独自の構成を作成できます。

プッシュモード、プルモード、または 2 つの組み合わせで部分構成を使用することができます。

プッシュモードでの部分構成

部分構成をプッシュモードで使用するには、ターゲットノードで、部分構成を受信する LCM を構成します。各部分構成は、Publish-DSCConfiguration コマンドレットを使用して、ターゲットにプッシュされる必要があります。その後、ターゲットノードによって、部分構成が 1 つの構成に結合されます。また、Start-DscConfiguration コマンドレットを呼び出して、構成を適用することができます。

プッシュモードの部分構成用の LCM の構成

プッシュモードの部分構成用の LCM を構成するには、各部分構成に 1 つの PartialConfiguration ブロックを使用して DSCLocalConfigurationManager 構成を作成します。 LCM の構成の詳細については、「ローカル構成マネージャーの構成」をご覧ください。次の例では、OS を展開する部分構成と SharePoint を展開および構成する部分構成の 2 つの部分構成が必要な LCM 構成を示しています。

[DSCLocalConfigurationManager()]
configuration PartialConfigDemo
{
    Node localhost
    {

        PartialConfiguration ServiceAccountConfig
        {
            Description = 'Configuration to add the SharePoint service account to the Administrators group.'
            RefreshMode = 'Push'
        }
           PartialConfiguration SharePointConfig
        {
            Description = 'Configuration for the SharePoint server'
            RefreshMode = 'Push'
        }
    }
}

PartialConfigDemo

各部分構成の RefreshMode は、"Push" に設定されています。 PartialConfiguration ブロックの名前 (この例では "ServiceAccountConfig" と "SharePointConfig") はターゲットノードにプッシュされる構成の名前と正確に一致する必要があります。

Note

各 PartialConfiguration ブロックの名前は、構成スクリプトに指定されているように、構成の実際の名前と一致する必要があります。MOF ファイルの名前ではなく、ターゲットノードまたは localhost の名前でなければなりません。

プッシュモードの部分構成の公開および開始

次に構成ごとに Publish-DSCConfiguration を呼び出して、構成ドキュメントを含むフォルダーを Path パラメーターとして渡します。 Publish-DSCConfiguration は、構成 MOF ファイルをターゲットノードに配置します。両方の構成の発行後に、ターゲットノードで Start-DSCConfiguration –UseExisting を呼び出すことができます。

たとえば、オーサリングノードで以下の構成 MOF ドキュメントをコンパイルした場合は、次のようにします。

Get-ChildItem -Recurse

    Directory: C:\PartialConfigTest

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-----        8/11/2016   1:55 PM                ServiceAccountConfig
d-----       11/17/2016   4:14 PM                SharePointConfig

    Directory: C:\PartialConfigTest\ServiceAccountConfig

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        8/11/2016   2:02 PM           2034 TestVM.mof

    Directory: C:\PartialConfigTest\SharePointConfig

Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----       11/17/2016   4:14 PM           1930 TestVM.mof

次のように構成を公開し、実行します。

Publish-DscConfiguration .\ServiceAccountConfig -ComputerName 'TestVM'
Publish-DscConfiguration .\SharePointConfig -ComputerName 'TestVM'
Start-DscConfiguration -UseExisting -ComputerName 'TestVM'

Id     Name            PSJobTypeName   State         HasMoreData     Location             Command
--     ----            -------------   -----         -----------     --------             -------
17     Job17           Configuratio... Running       True            TestVM            Start-DscConfiguration...

Note

Publish-DSCConfiguration コマンドレットを実行しているユーザーには、ターゲットノードに対する管理者特権が必要です。

プルモードでの部分構成

部分構成は、1 つ以上のプルサーバーからプルできます。プルサーバーの詳細については、「DSC Web プルサーバーのセットアップ」をご覧ください。これを行うには、ターゲットノードで、部分構成をプルし、プルサーバーで構成ドキュメントを適切に名前付けおよび配置する LCM を構成する必要があります。

プルノード構成用の LCM の構成

プルサーバーから部分構成をプルする LCM を構成するには、ConfigurationRepositoryWeb (HTTP プルサーバーの場合) ブロックまたは ConfigurationRepositoryShare (SMB プルサーバーの場合) ブロックのいずれかでプルサーバーを定義します。その後、ConfigurationSource プロパティを使用して、プルサーバーを参照する PartialConfiguration ブロックを作成します。また、LCM がプルモードを使用することを指定する Settings ブロックを作成し、プルサーバーとターゲットノードで構成の識別に使用される ConfigurationNames または ConfigurationID を指定する必要もあります。次のメタ構成では、CONTOSO-PullSrv という HTTP プルサーバーとこのプルサーバーを使用する 2 つの部分構成が定義されています。

ConfigurationNames を使用した LCM の構成については、「構成名を使用したプルクライアントのセットアップ」をご覧ください。 ConfigurationID を使用した LCM の構成については、「構成 ID を使用したプルクライアントのセットアップ」をご覧ください。

構成名を使用したプルモードの構成用の LCM の構成

[DscLocalConfigurationManager()]
Configuration PartialConfigDemoConfigNames
{
        Settings
        {
            RefreshFrequencyMins            = 30;
            RefreshMode                     = "PULL";
            ConfigurationMode               ="ApplyAndAutocorrect";
            AllowModuleOverwrite            = $true;
            RebootNodeIfNeeded              = $true;
            ConfigurationModeFrequencyMins  = 60;
        }
        ConfigurationRepositoryWeb CONTOSO-PullSrv
        {
            ServerURL                       = 'https://CONTOSO-PullSrv:8080/PSDSCPullServer.svc'
            RegistrationKey                 = 5b41f4e6-5e6d-45f5-8102-f2227468ef38
            ConfigurationNames              = @("ServiceAccountConfig", "SharePointConfig")
        }

        PartialConfiguration ServiceAccountConfig
        {
            Description                     = "ServiceAccountConfig"
            ConfigurationSource             = @("[ConfigurationRepositoryWeb]CONTOSO-PullSrv")
        }

        PartialConfiguration SharePointConfig
        {
            Description                     = "SharePointConfig"
            ConfigurationSource             = @("[ConfigurationRepositoryWeb]CONTOSO-PullSrv")
            DependsOn                       = '[PartialConfiguration]ServiceAccountConfig'
        }
}

構成 ID を使用したプルモードの構成用の LCM の構成

[DSCLocalConfigurationManager()]
configuration PartialConfigDemoConfigID
{
    Node localhost
    {
        Settings
        {
            RefreshMode                     = 'Pull'
            ConfigurationID                 = '1d545e3b-60c3-47a0-bf65-5afc05182fd0'
            RefreshFrequencyMins            = 30
            RebootNodeIfNeeded              = $true
        }
        ConfigurationRepositoryWeb CONTOSO-PullSrv
        {
            ServerURL                       = 'https://CONTOSO-PullSrv:8080/PSDSCPullServer.svc'

        }

           PartialConfiguration ServiceAccountConfig
        {
            Description                     = 'Configuration for the Base OS'
            ConfigurationSource             = '[ConfigurationRepositoryWeb]CONTOSO-PullSrv'
            RefreshMode                     = 'Pull'
        }
           PartialConfiguration SharePointConfig
        {
            Description                     = 'Configuration for the Sharepoint Server'
            ConfigurationSource             = '[ConfigurationRepositoryWeb]CONTOSO-PullSrv'
            DependsOn                       = '[PartialConfiguration]ServiceAccountConfig'
            RefreshMode                     = 'Pull'
        }
    }
}
PartialConfigDemo

複数のプルサーバーから部分構成をプルすることができます。このためには、各プルサーバーを定義し、各 PartialConfiguration ブロックで適切なプルサーバーを参照することのみが必要となります。

メタ構成を作成したら、それを実行して構成ドキュメント (MOF ファイル) を作成し、Set-DscLocalConfigurationManager を呼び出して LCM を構成する必要があります。

プルサーバーでの構成ドキュメントの名前付けおよび配置 (ConfigurationNames)

部分構成ドキュメントは、プルサーバーの web.config ファイルで ConfigurationPath として指定されたフォルダーに配置する必要があります (通常 C:\Program Files\WindowsPowerShell\DscService\Configuration)。

PowerShell 5.1 のプルサーバーでの構成ドキュメントの名前付け

個々のプルサーバーから部分構成を 1 つだけプルする場合、構成ドキュメントに任意の名前を付けることができます。プルサーバーから複数の部分構成をプルする場合、構成ドキュメントの名前は <ConfigurationName>.mof (ConfigurationName は部分構成の名前)、または <ConfigurationName>.<NodeName>.mof (ConfigurationName は部分構成の名前、NodeName はターゲットノードの名前) のどちらかにすることができます。これにより、Azure Automation DSC プルサーバーから構成をプルすることができます。

PowerShell 5.0 のプルサーバーでの構成ドキュメントの名前付け

構成ドキュメントは次のように名前を付ける必要があります。ConfigurationName が部分構成の名前である場合、ConfigurationName.mof です。この例では、構成ドキュメントの名前は次のようになります。

ServiceAccountConfig.mof
ServiceAccountConfig.mof.checksum
SharePointConfig.mof
SharePointConfig.mof.checksum

プルサーバーでの構成ドキュメントの名前付けおよび配置 (ConfigurationID)

部分構成ドキュメントは、プルサーバーの web.config ファイルで ConfigurationPath として指定されたフォルダーに配置する必要があります (通常 C:\Program Files\WindowsPowerShell\DscService\Configuration)。構成ドキュメントの名前は <ConfigurationName>.<ConfigurationID>.mof のようになっている必要があります。ConfigurationName は部分構成の名前であり、ConfigurationID はターゲットノードの LCM で定義されている構成 ID です。この例では、構成ドキュメントの名前は次のようになります。

ServiceAccountConfig.1d545e3b-60c3-47a0-bf65-5afc05182fd0.mof
ServiceAccountConfig.1d545e3b-60c3-47a0-bf65-5afc05182fd0.mof.checksum
SharePointConfig.1d545e3b-60c3-47a0-bf65-5afc05182fd0.mof
SharePointConfig.1d545e3b-60c3-47a0-bf65-5afc05182fd0.mof.checksum

プルサーバーからの部分構成の実行

ターゲットノードで LCM を構成し、プルサーバーで構成ドキュメントを作成して適切に名前を付けた後に、ターゲットノードによって、部分構成がプルされ、それらが結合されて、LCM の RefreshFrequencyMins プロパティによって指定されているように定期的に結果の構成が適用されます。強制的に更新する場合は、 Update-DscConfiguration コマンドレットを呼び出して、構成をプルして適用できます。

プッシュとプルの混在モードでの部分構成

部分構成のプッシュモードとプルモードを混在させることができます。つまり、プルサーバーからプルされた部分構成とプッシュされた別の部分構成を持つことができます。前のセクションで説明したように、それぞれの部分構成に対して更新モードを指定します。たとえば、次のメタ構成では、プルモードの ServiceAccountConfig 部分構成とプッシュモードの SharePointConfig 部分構成がある同じ例が記述されています。

ConfigurationNames を使用したプッシュとプルの混在モード

[DscLocalConfigurationManager()]
Configuration PartialConfigDemoConfigNames
{
        Settings
        {
            RefreshFrequencyMins            = 30;
            RefreshMode                     = "PULL";
            ConfigurationMode               = "ApplyAndAutocorrect";
            AllowModuleOverwrite            = $true;
            RebootNodeIfNeeded              = $true;
            ConfigurationModeFrequencyMins  = 60;
        }
        ConfigurationRepositoryWeb CONTOSO-PullSrv
        {
            ServerURL                       = 'https://CONTOSO-PullSrv:8080/PSDSCPullServer.svc'
            RegistrationKey                 = 5b41f4e6-5e6d-45f5-8102-f2227468ef38
            ConfigurationNames              = @("ServiceAccountConfig", "SharePointConfig")
        }

        PartialConfiguration ServiceAccountConfig
        {
            Description                     = "ServiceAccountConfig"
            ConfigurationSource             = @("[ConfigurationRepositoryWeb]CONTOSO-PullSrv")
            RefreshMode                     = 'Pull'
        }

        PartialConfiguration SharePointConfig
        {
            Description                     = "SharePointConfig"
            DependsOn                       = '[PartialConfiguration]ServiceAccountConfig'
            RefreshMode                     = 'Push'
        }

}

ConfigurationID を使用したプッシュとプルの混在モード

[DSCLocalConfigurationManager()]
configuration PartialConfigDemo
{
    Node localhost
    {
        Settings
        {
            RefreshMode             = 'Pull'
            ConfigurationID         = '1d545e3b-60c3-47a0-bf65-5afc05182fd0'
            RefreshFrequencyMins    = 30
            RebootNodeIfNeeded      = $true
        }
        ConfigurationRepositoryWeb CONTOSO-PullSrv
        {
            ServerURL               = 'https://CONTOSO-PullSrv:8080/PSDSCPullServer.svc'

        }

           PartialConfiguration ServiceAccountConfig
        {
            Description             = 'Configuration for the Base OS'
            ConfigurationSource     = '[ConfigurationRepositoryWeb]CONTOSO-PullSrv'
            RefreshMode             = 'Pull'
        }
           PartialConfiguration SharePointConfig
        {
            Description             = 'Configuration for the Sharepoint Server'
            DependsOn               = '[PartialConfiguration]ServiceAccountConfig'
            RefreshMode             = 'Push'
        }
    }
}
PartialConfigDemo

なお、Settings ブロックで指定されている RefreshMode は "Pull" ですが、SharePointConfig 部分構成の RefreshMode は "Push" です。

それぞれの更新モードの前述の説明に従って、構成 MOF ファイルの名前付けおよび配置を行います。 Publish-DSCConfiguration を呼び出して、SharePointConfig 部分構成を公開し、ServiceAccountConfig 構成がプルサーバーからプルされることを待機するか、または Update-DscConfiguration を呼び出して強制的に更新します。

ServiceAccountConfig 部分構成の例

Configuration ServiceAccountConfig
{
    Param (
        [Parameter(Mandatory,
                   HelpMessage="Domain credentials required to add domain\sharepoint_svc to the local Administrators group.")]
        [ValidateNotNullOrEmpty()]
        [pscredential]$Credential
    )

    Import-DscResource -ModuleName PSDesiredStateConfiguration

    Node localhost
    {
        Group LocalAdmins
        {
            GroupName           = 'Administrators'
            MembersToInclude    = 'domain\sharepoint_svc',
                                  'admins@example.domain'
            Ensure              = 'Present'
            Credential          = $Credential
        }

        WindowsFeature Telnet
        {
            Name                = 'Telnet-Server'
            Ensure              = 'Absent'
        }
    }
}
ServiceAccountConfig

SharePointConfig 部分構成の例

Configuration SharePointConfig
{
    Param (
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [pscredential]$ProductKey
    )

    Import-DscResource -ModuleName xSharePoint

    Node localhost
    {
        xSPInstall SharePointDefault
        {
            Ensure      = 'Present'
            BinaryDir   = '\\FileServer\Installers\Sharepoint\'
            ProductKey  = $ProductKey
        }
    }
}
SharePointConfig

参照

Windows PowerShell Desired State Configuration プルサーバー

ローカル構成マネージャーの構成

次の方法で共有

PowerShell Desired State Configuration の部分構成

プッシュモードでの部分構成

プッシュモードの部分構成用の LCM の構成

プッシュモードの部分構成の公開および開始

プルモードでの部分構成

プルノード構成用の LCM の構成

構成名を使用したプルモードの構成用の LCM の構成

構成 ID を使用したプルモードの構成用の LCM の構成

プルサーバーでの構成ドキュメントの名前付けおよび配置 (ConfigurationNames)

PowerShell 5.1 のプルサーバーでの構成ドキュメントの名前付け

PowerShell 5.0 のプルサーバーでの構成ドキュメントの名前付け

プルサーバーでの構成ドキュメントの名前付けおよび配置 (ConfigurationID)

プルサーバーからの部分構成の実行

プッシュとプルの混在モードでの部分構成

ConfigurationNames を使用したプッシュとプルの混在モード

ConfigurationID を使用したプッシュとプルの混在モード

ServiceAccountConfig 部分構成の例

SharePointConfig 部分構成の例

参照

その他のリソース

次の方法で共有

PowerShell Desired State Configuration の部分構成

プッシュ モードでの部分構成

プッシュ モードの部分構成用の LCM の構成

プッシュ モードの部分構成の公開および開始

プル モードでの部分構成

プル ノード構成用の LCM の構成

構成名を使用したプル モードの構成用の LCM の構成

構成 ID を使用したプル モードの構成用の LCM の構成

プル サーバーでの構成ドキュメントの名前付けおよび配置 (ConfigurationNames)

PowerShell 5.1 のプル サーバーでの構成ドキュメントの名前付け

PowerShell 5.0 のプル サーバーでの構成ドキュメントの名前付け

プル サーバーでの構成ドキュメントの名前付けおよび配置 (ConfigurationID)

プル サーバーからの部分構成の実行

プッシュとプルの混在モードでの部分構成

ConfigurationNames を使用したプッシュとプルの混在モード

ConfigurationID を使用したプッシュとプルの混在モード

ServiceAccountConfig 部分構成の例

SharePointConfig 部分構成の例

参照

その他のリソース

プッシュモードでの部分構成

プッシュモードの部分構成用の LCM の構成

プッシュモードの部分構成の公開および開始

プルモードでの部分構成

プルノード構成用の LCM の構成

構成名を使用したプルモードの構成用の LCM の構成

構成 ID を使用したプルモードの構成用の LCM の構成

プルサーバーでの構成ドキュメントの名前付けおよび配置 (ConfigurationNames)

PowerShell 5.1 のプルサーバーでの構成ドキュメントの名前付け

PowerShell 5.0 のプルサーバーでの構成ドキュメントの名前付け

プルサーバーでの構成ドキュメントの名前付けおよび配置 (ConfigurationID)

プルサーバーからの部分構成の実行