LCMの設定例を見つけても、利用中のPowerShellで実行できるか、どの操作で端末の設定が変わるか迷うことがあります。この記事ではWindows PowerShell 5.1とDSC 1.1を対象に、設定ファイルの作成と実機への適用を分けて説明します。
練習で行うのは、一時フォルダーにLCM用のメタMOFを作り、指定値を読み戻すところまでです。LCMの設定は変更しません。監視・自動修正の違いと、Push/Pullによる取得方法の違いも整理できます。
必要なのはWindows PowerShell 5.1の64ビット版と、ファイル作成を許可された練習環境です。PowerShell 7、DSC 2.0、Microsoft DSC 3向けの手順ではありません。
先に結論
- 対象はWindows PowerShell 5.1とDSC 1.1です。DSC 2.0やMicrosoft DSC 3にはLCMが含まれないため、同じ手順を持ち込みません。
- メタMOFの生成とLCMへの設定適用は別の工程です。この記事ではファイルを作成して読み取り、設定適用は行いません。
- ApplyAndMonitorは初回適用後のずれを監視し、ApplyAndAutoCorrectは再適用も行います。Push/Pullは、それとは別に構成の取得方法を表します。
1. Windows PowerShell 5.1とコマンドの存在を確認する
最初に実行環境を確認します。コマンドが存在することと、現在のLCM設定を取得できることは別です。
DSC(Desired State Configuration)は、管理対象に求める状態を定義する仕組みです。LCM(Local Configuration Manager)は、従来のWindows PowerShell DSCで構成を受け取り、適用や定期確認を担当します。
最初のコードで調べるのは、PowerShellの版・種類・ビット数と、LCMを読み取るコマンド、設定するコマンドの存在です。この記事の3つのコード欄は、すべて同じWindows PowerShellの画面で順に実行します。
スマートフォンなどでコードの行末が見えないときは、コード欄だけを左右へスクロールして確認します。ページ全体を横へ動かす必要はありません。
- Windowsのスタートで「Windows PowerShell」を検索し、64ビット版を開きます。「PowerShell 7」や「Windows PowerShell (x86)」とは区別します。
- 次のコード欄を先頭から末尾のSelect-Objectの行まで貼り付け、Enterを押します。表示結果が対象環境と一致してから次へ進みます。
1. Windows PowerShellとコマンドの存在を確認
'{0}.{1} {2} {3}bit' -f $PSVersionTable.PSVersion.Major, $PSVersionTable.PSVersion.Minor, $PSVersionTable.PSEdition, ([IntPtr]::Size * 8)
Get-Command Get-DscLocalConfigurationManager, Set-DscLocalConfigurationManager |
Select-Object -ExpandProperty Name
実行結果
5.1 Desktop 64bit
Get-DscLocalConfigurationManager
Set-DscLocalConfigurationManager
出力の先頭が「5.1 Desktop 64bit」なら、対象の環境と一致します。5.1は版、DesktopはWindows PowerShellの種類、64bitは起動したPowerShellが64ビット版であることを表します。
続く2行にコマンド名が表示されれば、存在を確認できています。Get-Commandは存在を調べるだけで、現在のLCM設定の取得や変更は行いません。
先頭行の-fは値を文字列へ埋める演算子です。パイプ記号は左の結果を右へ渡します。Select-Objectの-ExpandProperty Nameは、確認したコマンドから名前だけを取り出す指定です。
7など別の版や32bitが表示された場合は、その画面では続けず、対象のWindows PowerShellを開き直します。コマンドが見つからない場合も中断し、管理者へDSC 1.1の利用可否を確認してください。
Windows PowerShell 5.1にはDSC 1.1が付属します。DSC 2.0ではLCMとその取得・設定コマンドが除かれ、Microsoft DSC 3にもLCMは含まれません。解決策として無条件に最新版へ入れ替えないでください。
2. メタMOFを一時フォルダーへ作る
ここではファイルを生成して読み取ります。LCMへ設定を適用するコマンドは含めていません。
MOF(Managed Object Format)は、DSCが読み取る構成ファイルの形式です。そのうちLCM自体の設定を記したファイルを、ここではメタMOFと呼びます。定義からファイルを生成する処理がコンパイルです。
次のコードは専用の一時フォルダーにlocalhost.meta.mofを作り、ファイル名と4つの設定項目を表示します。会社などの管理端末でファイル作成や構成管理が制限されている場合は、管理者が認めた練習環境を使ってください。
- 手順1で環境を確認したWindows PowerShellの画面を、そのまま使います。
- 次のコード欄全体を、末尾のForEach-Objectの行まで貼り付けてEnterを押します。先頭の構成定義だけで止めず、生成と読取りの部分も実行します。
2. 同じ画面でメタMOFを作成
[DSCLocalConfigurationManager()]
configuration LcmPreview {
param(
[ValidateSet('ApplyOnly', 'ApplyAndMonitor', 'ApplyAndAutoCorrect')]
[string]$Mode = 'ApplyAndMonitor'
)
Node localhost {
Settings {
RefreshMode = 'Push'
ConfigurationMode = $Mode
ConfigurationModeFrequencyMins = 30
RebootNodeIfNeeded = $false
}
}
}
$work = Join-Path $env:TEMP ('lcm-preview-' + [guid]::NewGuid().ToString('N'))
LcmPreview -OutputPath $work | Out-Null
$mof = Join-Path $work 'localhost.meta.mof'
Get-Item -LiteralPath $mof | Select-Object -ExpandProperty Name
Select-String -LiteralPath $mof -Pattern '^\s*(ConfigurationMode|ConfigurationModeFrequencyMins|RefreshMode|RebootNodeIfNeeded)\s*=' |
ForEach-Object { $_.Line.Trim() }
実行結果
localhost.meta.mof
RefreshMode = "Push";
ConfigurationModeFrequencyMins = 30;
ConfigurationMode = "ApplyAndMonitor";
RebootNodeIfNeeded = False;
出力の先頭がlocalhost.meta.mofで、続いて4つの設定行が表示されれば、ファイルの生成と読取りを確認できています。行の順番は生成側によって変わるため、次節で項目名と値を照合します。
定義部分のLcmPreviewは、今回付けた構成名です。先頭の属性はLCM向けの定義であることを示します。Node localhostはこのコンピューター、SettingsはLCMの設定項目を表します。
Modeは生成時に渡せる文字列の引数です。ValidateSetは受け付ける値を3種類に限定し、指定を省くとApplyAndMonitorになります。この段階で決まるのは、生成するファイルに書き込む値です。
$work変数には、TEMP環境変数が示す一時フォルダーの下へ、重複しにくい名前を付けた保存先が入ります。-OutputPathで生成先を指定し、Out-Nullで生成処理の一覧表示を抑えています。
Select-Stringはファイル内の行を検索します。-LiteralPathは対象ファイル、-Patternは検索条件の指定です。この条件は、行頭の空白に続く4項目の名前と等号を探します。
最後のForEach-Objectは一致した行を1行ずつ処理します。Lineで行の文字列を取り出し、Trimで前後の空白を除いて表示します。生成成功は、現在のLCM設定を取得できたことや、設定適用の成功を意味しません。
3. 出力された4項目を役割ごとに読む
構成の取得方法、ずれへの対処、確認間隔、再起動の許可は、それぞれ別の設定です。
前節の出力は、生成ファイルに書かれた設定値です。現在の端末で、その設定が動作しているという意味ではありません。ここでは、各項目を適用した場合の役割を整理します。
Pushは外から構成を送る方式、Pullは管理対象側が配布元へ取りにいく方式です。一方、構成の「ずれ」とは、定義した状態と実際の状態が異なることです。Pushでも、受け取った構成のずれを定期確認するかどうかは別に指定します。
- RefreshModeのPush:構成を外から送る方式です。構成を取得する方法を指定します。
- ConfigurationModeのApplyAndMonitor:初回の構成適用後、ずれを確認してログへ記録します。ログは処理の記録であり、このモードではずれを自動修正しません。
- ConfigurationModeFrequencyMinsの30:現在の構成を確認・適用する間隔を分単位で指定します。ApplyOnlyでは無視されます。
- RebootNodeIfNeededのFalse:ファイルやサービスなどを扱うDSCの部品から要求された、自動再起動を許可しません。OS更新など、他の理由による再起動を止める設定ではありません。
取得確認に関わるRefreshFrequencyMinsと、今回のConfigurationModeFrequencyMinsは別の項目です。RefreshFrequencyMinsはPullでの取得確認などに関わり、Pushでは無視されるため、今回の例には指定していません。
30分は「30分以内にすべてのずれが直る」という保証ではありません。他の処理などで周期が遅れる場合があります。この検証ではファイル内の値だけを確認し、30分周期の動作は測定していません。
4. 3つのモードは初回適用後の動きで比べる
ApplyAndMonitorも最初の構成適用は行います。「監視だから端末を変更しない」とは判断できません。
ConfigurationModeは、構成の初回適用が成功した後、ずれをどう扱うかを決めます。3つのモードを選ぶときは、「定期確認するか」と「ずれを自動修正するか」を分けて比べると整理できます。
比較表は公式の設定仕様をまとめたものです。今回の検証で、実機にずれを作って監視や自動修正を測定した結果ではありません。どのモードでも、適用する構成の中身と変更の影響を先に確認する必要があります。
| 設定値 | 初回の構成適用に成功した後 | 差異の自動修正 |
|---|---|---|
| ApplyOnly | 同じ構成の定期確認をしない | しない |
| ApplyAndMonitor | 現在の構成との差異を確認しログへ記録 | しない |
| ApplyAndAutoCorrect | 差異を記録して現在の構成を再適用 | する(定義された範囲) |
ApplyOnlyは、新しい構成を受け取って適用することまで禁止する設定ではありません。初回適用の成功後、同じ構成のずれを定期確認しない、という範囲で読みます。
ApplyAndAutoCorrectが再適用するのは、現在の構成で定義された範囲です。端末のすべての設定を監視し、あらゆる問題を自動で修復する機能ではありません。
5. 3モードを別々のファイルへ生成して比べる
ここで確認するのは、指定したモード名とファイル内の値が一致することです。実機のモードは切り替えません。
手順2が成功した同じ画面で、次のコード欄を末尾まで貼り付けて実行します。foreachは3つのモード名を順に処理する繰返しです。前に定義したLcmPreviewと、保存先を入れた$work変数を使います。
モード別の保存先を$path変数へ入れ、-Modeで生成時の値を変えます。その後、各ファイルからConfigurationModeの行だけを読み取ります。比較表は、生成時の指定とファイルから読み取った値を対応させたものです。
| 生成時のMode | メタMOFから読み取ったConfigurationMode |
|---|---|
| ApplyOnly | ApplyOnly |
| ApplyAndMonitor | ApplyAndMonitor |
| ApplyAndAutoCorrect | ApplyAndAutoCorrect |
3. 作成したメタMOFのモードを読み比べる
foreach ($mode in 'ApplyOnly', 'ApplyAndMonitor', 'ApplyAndAutoCorrect') {
$path = Join-Path $work $mode
LcmPreview -Mode $mode -OutputPath $path | Out-Null
$file = Join-Path $path 'localhost.meta.mof'
Select-String -LiteralPath $file -Pattern '^\s*ConfigurationMode\s*=' |
ForEach-Object { $_.Line.Trim() }
}
実行結果
ConfigurationMode = "ApplyOnly";
ConfigurationMode = "ApplyAndMonitor";
ConfigurationMode = "ApplyAndAutoCorrect";
出力はApplyOnly、ApplyAndMonitor、ApplyAndAutoCorrectに対応する3行です。入力したモード名と、各行のConfigurationModeの値を照合します。最初の生成を含め、専用フォルダー以下に合計4個のメタMOFを作成しています。
値が一致しない場合や途中でエラーが出た場合は、その段階で止め、生成コードとエラー内容を確認してください。確認を通すために設定適用のコマンドを追加しないでください。
$work変数やLcmPreviewが見つからない場合は、画面を変えたか、前のコード欄が未完了の可能性があります。手順1から同じ画面で確認し直し、生成と読取りが完了したことを確かめます。
6. 現在のLCM設定を取得できないときの切り分け
今回の検証では現在のLCM設定を取得できていません。生成ファイルの値で現在値を補いません。
現在のLCM設定を調べるコマンドはGet-DscLocalConfigurationManagerです。ただし、この検証環境では取得時にCimExceptionとなり、実際のモードは未取得でした。CimExceptionは、その取得処理で出た例外の型名です。
例外は処理が正常に完了しなかったことを示しますが、型名だけでは原因を決められません。メタMOFにApplyAndMonitorと書かれていても、それを現在のLCM設定とは扱えません。
- 取得に失敗した場合は、表示されたエラー内容を保存します。
- Windows PowerShell 5.1で実行しているかを確認し、必要な権限と端末の管理方針を管理者へ確認します。
- 原因と現在の設定を確認できるまで、設定の置換へ進みません。接続や権限の制限をまとめて解除して通す操作も避けます。
今回実測できたのは、Windows PowerShell 5.1 Desktop 64bitでのコマンドの存在確認と、4個のメタMOFの生成・読取りです。掲載した3つのコード例には、現在値を取得する呼出しや設定適用の呼出しは含めていません。
実機への設定適用、ずれの検出、自動修正、30分周期の動作は確認していません。PowerShell 7やMicrosoft DSC 3での同等操作も未検証です。ファイル生成の成功と、実際に運用できるかの判断を分けてください。
7. 実機への適用前に確認すること
LCM自体の設定適用と、管理対象の構成適用ではコマンドが異なります。この記事ではどちらも実行しません。
LCM自体の設定を反映するコマンドはSet-DscLocalConfigurationManagerです。ファイルやサービスなど、管理対象に求める状態を適用するStart-DscConfigurationとは用途が異なります。
実機への適用を検討するときは、管理者が現在のLCM設定と、その設定を作った管理元の定義を確認します。変更前のメタ構成、構成の配布元、復旧手順を確保し、練習環境で影響と適用後の取得結果を確認してから判断します。
- 管理対象と既存の構成を特定し、自動再適用が他の管理手段と競合しないか確認します。
- 変更前のLCM設定に対応する定義と配布元を確保し、管理元で変更を戻す手順と確認担当を決めます。
- LCMの設定を戻す操作と、対象のファイルやサービスを元へ戻す操作を別々に検討します。
現在の設定を取得できないまま、新しいメタMOFで置き換えることは避けます。また、適用済みのメタMOFを削除しても、LCMの設定や変更された管理対象が元に戻るわけではありません。
8. 保存先を確かめて練習用ファイルを片付ける
削除するのは、自分で作成した専用フォルダーだけです。TEMP全体は削除しません。
この練習では、専用の一時フォルダーと、その下に作成した4個のメタMOFが残ります。生成と読取りが終わり、保存が不要になったら、実際の保存先を確認して片付けます。
LCMへ設定を適用していないため、この練習に伴うLCMの復元操作はありません。作成ファイルを片付けることと、実機の設定を戻すことは区別してください。
- 同じWindows PowerShellの画面に、$workと入力し、Enterを押して保存先を表示します。
- 表示されたフォルダーの場所をコピーし、エクスプローラーのアドレスバーへ貼り付けて開きます。
- lcm-preview-で始まる、自分が今回作成したフォルダーであることを確認します。保存が不要なら、その専用フォルダーと配下の生成ファイルだけを削除します。
コードを別のファイルへ保存した場合は、そちらにも内容が残ります。必要性を確認し、一時フォルダーとは別に整理してください。実機への適用は、この練習とは分けて管理者と検討します。
