Configuration Manager でタスクシーケンス変数を使用する方法

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

Configuration Manager (現在のブランチ) に適用

Configuration Manager の OS 展開機能のタスクシーケンスエンジンでは、多くの変数を使用してその動作を制御します。次の変数を使用して、次の手順を実行します。

ステップに条件を設定する
特定の手順の動作を変更する
より複雑なアクションのスクリプトで使用する

使用可能なすべてのタスクシーケンス変数のリファレンスについては、「タスクシーケンス変数」を参照してください。

変数の種類

変数にはいくつかの種類があります。

ビルトイン
操作
Custom
読み取り専用
Array

組み込み変数

組み込み変数は、タスクシーケンスが実行される環境に関する情報を提供します。これらの値は、タスクシーケンス全体で使用できます。通常、タスクシーケンスエンジンは、ステップを実行する前に組み込み変数を初期化します。

たとえば、 _SMSTSLogPath は、Configuration Manager コンポーネントがログファイルを書き込むパスを指定する環境変数です。どのタスクシーケンスステップでも、この環境変数にアクセスできます。

タスクシーケンスは、各ステップの前にいくつかの変数を評価します。たとえば、 _SMSTSCurrentActionName は現在のステップの名前を一覧表示します。

アクション変数

タスクシーケンスアクション変数は、1 つのタスクシーケンスステップで使用する構成設定を指定します。既定では、ステップは実行前にその設定を初期化します。これらの設定は、関連付けられているタスクシーケンスステップの実行中にのみ使用できます。タスクシーケンスは、ステップを実行する前に、アクション変数の値を環境に追加します。その後、ステップの実行後に環境から値が削除されます。

たとえば、コマンド ラインの実行 ステップをタスクシーケンスに追加します。この手順には、 Start In プロパティが含まれています。タスクシーケンスは、このプロパティの既定値を WorkingDirectory 変数として格納します。タスクシーケンスは、 コマンドラインの実行 ステップを実行する前に、この値を初期化します。この手順の実行中は、WorkingDirectory値から Start In プロパティの値にアクセスします。ステップが完了すると、タスクシーケンスによって WorkingDirectory 変数の値が環境から削除されます。タスクシーケンスに別の コマンドラインの実行 ステップが含まれている場合は、新しい WorkingDirectory 変数を初期化します。その時点で、タスクシーケンスは変数を現在のステップの開始値に設定します。詳細については、「 WorkingDirectory」を参照してください。

アクション変数の 既定値 は、ステップの実行時に存在します。新しい値を設定すると、タスクシーケンス内の複数のステップで使用できます。既定値をオーバーライドした場合、新しい値は環境内に留まります。この新しい値は、タスクシーケンス内の他の手順の既定値をオーバーライドします。たとえば、[ タスクシーケンス変数の設定 ] ステップをタスクシーケンスの最初のステップとして追加します。この手順では、 WorkingDirectory 変数を C:\に設定します。タスクシーケンス内の コマンドラインの実行 ステップでは、新しい開始ディレクトリ値が使用されます。

一部のタスクシーケンスステップでは、特定のアクション変数が出力としてマーク されます。タスクシーケンスの後の手順では、これらの出力変数を読み取ります。

注:

すべてのタスクシーケンスステップにアクション変数があるわけではありません。たとえば、 BitLocker の有効化 アクションに関連付けられている変数は存在しますが、 BitLocker の無効化 アクションに関連付けられている変数はありません。

カスタム変数

これらの変数は、Configuration Manager で作成されない変数です。条件、コマンドライン、またはスクリプトで使用する独自の変数を初期化します。

新しいタスクシーケンス変数の名前を指定する場合は、次のガイドラインに従います。

タスクシーケンスの変数名には、文字、数字、アンダースコア文字 (_)、ハイフン (-) を含めることができます。
タスクシーケンス変数名の最小長は 1 文字、最大長は 256 文字です。
ユーザー定義変数は、文字 (A-Z または a-z) で始まる必要があります。
ユーザー定義変数名はアンダースコア文字で始めることはできません。読み取り専用タスクシーケンス変数の前にアンダースコア文字が付きます。
タスクシーケンスの変数名では、大文字と小文字は区別されません。たとえば、 OSDVAR と osdvar は同じタスクシーケンス変数です。
タスクシーケンス変数名は、スペースで開始または終了できません。また、埋め込みスペースを持つこともできます。タスクシーケンスは、変数名の先頭または末尾にあるスペースを無視します。

作成できるタスクシーケンス変数の数に制限はありません。ただし、変数の数は、タスクシーケンス環境のサイズによって制限されます。タスクシーケンス環境の合計サイズ制限は 8 KB です。詳細については、「タスクシーケンスポリシーのサイズを小さくする」を参照してください。

読み取り専用変数

読み取り専用の一部の変数の値を変更することはできません。通常、名前はアンダースコア文字 (_) で始まります。タスクシーケンスでは、その操作に使用されます。読み取り専用変数は、タスクシーケンス環境で表示されます。

これらの変数は、スクリプトまたはコマンドラインで役立ちます。たとえば、コマンドラインを実行し、出力を他のログファイルと _SMSTSLogPath のログファイルにパイプ処理します。

注:

読み取り専用タスクシーケンス変数は、タスクシーケンス内の手順で読み取ることができますが、設定することはできません。たとえば、コマンド ラインの実行 ステップのコマンドラインの一部として、読み取り専用変数を使用します。 [タスクシーケンス変数の設定] ステップを使用して、読み取り専用 変数を設定 することはできません。

配列変数

タスクシーケンスでは、いくつかの変数が配列として格納されます。配列内の各要素は、1 つのオブジェクトの設定を表します。デバイスに構成するオブジェクトが複数ある場合は、これらの変数を使用します。次のタスクシーケンス手順では、配列変数を使用します。

変数を設定する方法

読み取り専用ではないカスタム変数または変数の場合、変数の値を初期化して設定するためのメソッドがいくつかあります。

タスクシーケンス変数の設定ステップ
動的変数の設定ステップ
PowerShell スクリプトステップを実行する
コレクション変数とデバイス変数
TSEnvironment COM オブジェクト
Prestart コマンド
タスクシーケンスウィザード
タスクシーケンスメディアウィザード

変数の作成と同じメソッドを使用して、環境から変数を削除します。変数を削除するには、変数の値を空の文字列に設定します。

メソッドを組み合わせて、タスクシーケンス変数を同じシーケンスの異なる値に設定できます。たとえば、タスクシーケンスエディターを使用して既定値を設定し、スクリプトを使用してカスタム値を設定します。

異なるメソッドで同じ変数を設定した場合、タスクシーケンスエンジンは次の順序を使用します。

最初にコレクション変数を評価します。
デバイス固有の変数は、コレクション上の同じ変数セットをオーバーライドします。
タスクシーケンス中に任意のメソッドによって設定された変数は、コレクション変数またはデバイス変数よりも優先されます。

タスクシーケンス変数の値に関する一般的な制限事項

タスクシーケンス変数の値は、4,000 文字を超えることはできません。
読み取り専用タスクシーケンス変数を変更することはできません。読み取り専用変数には、アンダースコア文字 (_) で始まる名前があります。
タスクシーケンス変数の値は、値の使用状況に応じて大文字と小文字を区別できます。ほとんどの場合、タスクシーケンス変数の値では大文字と小文字は区別されません。パスワードを含む変数では、大文字と小文字が区別されます。

タスクシーケンス変数を設定する

タスクシーケンスでこの手順を使用して、1 つの変数を 1 つの値に設定します。

詳細については、「タスクシーケンス変数の設定」を参照してください。

動的変数を設定する

タスクシーケンスでこの手順を使用して、1 つ以上のタスクシーケンス変数を設定します。この手順では、使用する変数と値を決定するルールを定義します。

詳細については、「動的変数の設定」を参照してください。

PowerShell スクリプトを実行する

タスクシーケンスのこの手順を使用して、PowerShell スクリプトを使用してタスクシーケンス変数を設定します。

パッケージからスクリプト名を指定することも、手順で PowerShell スクリプトを直接入力することもできます。次に、step プロパティを使用して タスクシーケンス変数に出力 し、スクリプト出力をカスタムタスクシーケンス変数に保存します。

この手順の詳細については、「 PowerShell スクリプトの実行」を参照してください。

注:

PowerShell スクリプトを使用して、 TSEnvironment オブジェクトを使用して 1 つ以上の変数を設定することもできます。詳細については、「Configuration Manager SDK で実行中のタスクシーケンスで変数を使用する方法」を参照してください。

PowerShell スクリプトの実行ステップでのシナリオの例

環境には複数の国/地域にユーザーがいます。そのため、OS 言語を照会して、複数の言語固有の Apply OS ステップの条件として設定する必要があります。

[OS の適用] 手順の前に、PowerShell スクリプトの実行のインスタンスをタスクシーケンスに追加します。
次のコマンドを指定するには、オプションを使用して PowerShell スクリプトを入力 します。
```
(Get-Culture).TwoLetterISOLanguageName
```
コマンドレットの詳細については、「 Get-Culture」を参照してください。 2 文字の ISO 言語名の詳細については、「 ISO 639-1 コードの一覧」を参照してください。
タスクシーケンス変数に出力するオプションには、CurrentOSLanguageを指定します。
英語イメージの [OS の適用 ] ステップで、次の条件を作成します。 Task Sequence Variable CurrentOSLanguage equals "en"

ヒント

ステップで条件を作成する方法の詳細については、「変数にアクセスする方法 - ステップ条件」を参照してください。
タスクシーケンスを保存してデプロイします。

PowerShell スクリプトの実行ステップが英語バージョンの Windows のデバイスで実行されると、コマンドは値enを返します。その後、その値をカスタム変数に保存します。英語イメージの [OS の適用] ステップが同じデバイスで実行されると、条件は true と評価されます。異なる言語の [OS の適用 ] ステップのインスタンスが複数ある場合、タスクシーケンスは OS 言語に一致するステップを動的に実行します。

コレクション変数とデバイス変数

デバイスとコレクションのカスタムタスクシーケンス変数を定義できます。デバイスに対して定義する変数は、デバイスごとのタスクシーケンス変数と呼ばれます。コレクションに対して定義された変数は、コレクションごとのタスクシーケンス変数と呼ばれます。競合がある場合は、デバイスごとの変数がコレクションごとの変数よりも優先されます。この動作は、特定のデバイスに割り当てられたタスクシーケンス変数の優先度が、デバイスを含むコレクションに割り当てられている変数よりも自動的に高いことを意味します。

たとえば、デバイス XYZ はコレクション ABC のメンバーです。値が 1 のコレクション ABC に MyVariable を割り当てます。値が 2 のデバイス XYZ にも MyVariable を割り当てます。 XYZ に割り当てられている変数の優先度は、コレクション ABC に割り当てられている変数よりも高くなります。この変数を持つタスクシーケンスが XYZ で実行されると、MyVariable の値は 2 になります。

デバイスごとの変数とコレクションごとの変数を非表示にして、Configuration Manager コンソールに表示されないようにすることができます。 Configuration Manager コンソールで [この値を表示しない] オプションを使用すると、変数の値はコンソールに表示されません。タスクシーケンスログファイル (smsts.log) またはタスクシーケンスデバッガーにも変数値が表示されません。変数は、実行時にタスクシーケンスで引き続き使用できます。これらの変数を非表示にしない場合は、最初に削除します。次に、変数を非表示にするオプションを選択せずに、変数を再定義します。

警告

コマンドラインの実行ステップのコマンドラインに変数を含めると、変数値を含む完全なコマンドラインがタスクシーケンスログファイルに表示されます。潜在的に機密性の高いデータがログファイルに表示されないようにするには、タスクシーケンス変数 OSDDoNotLogCommand を TRUEに設定します。

デバイスごとの変数は、プライマリサイトまたは中央管理サイトで管理できます。 Configuration Manager では、デバイスに対して 1,000 を超える割り当て変数がサポートされていません。

重要

タスクシーケンスにコレクションごとの変数を使用する場合は、次の動作を考慮してください。

コレクションに対する変更は、常に階層全体にレプリケートされます。コレクション変数に加えた変更は、現在のサイトのメンバーだけでなく、階層全体のコレクションのすべてのメンバーにも適用されます。
コレクションを削除すると、コレクション用に構成したタスクシーケンス変数も削除されます。

デバイスのタスクシーケンス変数を作成する

Configuration Manager コンソールで、[ 資産とコンプライアンス ] ワークスペースに移動し、[ デバイス ] ノードを選択します。
ターゲットデバイスを選択し、[ プロパティ] を選択します。
[ プロパティ ] ダイアログボックスで、[ 変数 ] タブに切り替えます。
作成する変数ごとに、[ 新規 ] アイコンを選択します。タスクシーケンス変数の [名前] と [値] を 指定します。 Configuration Manager コンソールに表示されないように変数を非表示にする場合は、[ Configuration Manager コンソールにこの値を表示しない] オプションを選択します。
すべての変数をデバイスのプロパティに追加したら、[OK] を選択 します。

コレクションのタスクシーケンス変数を作成する

Configuration Manager コンソールで、[ 資産とコンプライアンス ] ワークスペースに移動し、[ デバイスコレクション ] ノードを選択します。ターゲットコレクションを選択し、[ プロパティ] を選択します。
[ プロパティ ] ダイアログボックスで、[ コレクション変数 ] タブに切り替えます。
作成する変数ごとに、[ 新規 ] アイコンを選択します。タスクシーケンス変数の [名前] と [値] を 指定します。 Configuration Manager コンソールに表示されないように変数を非表示にする場合は、[ Configuration Manager コンソールにこの値を表示しない] オプションを選択します。
必要に応じて、タスクシーケンス変数を評価するときに使用する Configuration Manager の優先順位を指定します。
すべての変数をコレクションプロパティに追加したら、[ OK] を選択します。

TSEnvironment COM オブジェクト

スクリプトの変数を操作するには、 TSEnvironment オブジェクトを使用します。

詳細については、「Configuration Manager SDK で実行中のタスクシーケンスで変数を使用する方法」を参照してください。

Prestart コマンド

事前開始コマンドは、ユーザーがタスクシーケンスを選択する前に Windows PE で実行されるスクリプトまたは実行可能ファイルです。 prestart コマンドを使用すると、変数に対してクエリを実行したり、ユーザーに情報の入力を求めたりして、環境に保存することができます。事前開始コマンドから変数を読み書きするには、 TSEnvironment COM オブジェクトを使用します。

詳細については、「タスクシーケンスメディアの事前開始コマンド」を参照してください。

タスクシーケンスウィザード

タスクシーケンスウィザードウィンドウでタスクシーケンスを選択すると、タスクシーケンス変数を編集するページに [編集] ボタンが含まれます。アクセシビリティ対応のキーボードショートカットを使用して、変数を編集できます。この変更は、マウスが使用できない場合に役立ちます。

タスクシーケンスメディアウィザード

メディアから実行されるタスクシーケンスの変数を指定します。メディアを使用して OS を展開する場合は、メディアの作成時にタスクシーケンス変数を追加し、その値を指定します。変数とその値はメディアに格納されます。

注:

タスクシーケンスは、スタンドアロンメディアに格納されます。ただし、事前設定されたメディアなど、他のすべての種類のメディアは、管理ポイントからタスクシーケンスを取得します。

メディアからタスクシーケンスを実行すると、ウィザードの [カスタマイズ ] ページで変数を追加できます。

コレクションごとの変数またはコンピューターごとの変数の代わりにメディア変数を使用します。タスクシーケンスがメディアから実行されている場合、コンピューターごとの変数とコレクションごとの変数は適用されず、使用されません。

ヒント

タスクシーケンスは、パッケージ ID と事前開始コマンドラインを、Configuration Manager コンソールを実行するコンピューター上の CreateTSMedia.log ファイルに書き込みます。このログファイルには、任意のタスクシーケンス変数の値が含まれます。このログファイルを確認して、タスクシーケンス変数の値を確認します。

詳細については、「タスクシーケンスメディアの作成」を参照してください。

変数にアクセスする方法

前のセクションのいずれかのメソッドを使用して変数とその値を指定した後、タスクシーケンスで使用します。たとえば、組み込みのタスクシーケンス変数の既定値にアクセスしたり、変数の値を条件としてステップを実行したりします。

タスクシーケンス環境の変数値にアクセスするには、次のメソッドを使用します。

手順で使用する
ステップ条件
カスタムスクリプト
Windows セットアップ応答ファイル

手順で使用する

タスクシーケンスステップの設定に変数値を指定します。タスクシーケンスエディターで、ステップを編集し、フィールド値として変数名を指定します。変数名をパーセント記号 (%) で囲みます。

たとえば、コマンド ラインの実行ステップのコマンドライン フィールドの一部として変数名を使用します。次のコマンドラインは、コンピューター名をテキストファイルに書き込みます。

cmd.exe /c echo %_SMSTSMachineName% > C:\File.txt

ステップ条件

ステップまたはグループの条件の一部として、組み込みのタスクシーケンス変数またはカスタムタスクシーケンス変数を使用します。タスクシーケンスは、ステップまたはグループを実行する前に変数の値を評価します。

変数値を評価する条件を追加するには、次の手順を実行します。

タスクシーケンスエディターで、条件を追加するステップまたはグループを選択します。
ステップまたはグループの [ オプション ] タブに切り替えます。 [ 条件の追加] をクリックし、[ タスクシーケンス変数] を選択します。
[ タスクシーケンス変数 ] ダイアログボックスで、次の設定を指定します。
- 変数: 変数の名前。たとえば、「 _SMSTSInWinPE 」のように入力します。
- 条件: 変数値を評価する条件。次の条件を使用できます。
  - Exists
  - 存在しない
  - 等しい
  - 等しくない
  - より大きい
  - より大きいか等しい
  - より少ない
  - より小さいか等しい
  - Like ( * と ? のワイルドカードをサポート)
  - 好きではない (バージョン 2103 以降)
- 値: 確認する変数の値。たとえば、「 false 」のように入力します。

上記の 3 つの例は、タスクシーケンスが Windows PE のブートイメージから実行されているかどうかをテストするための一般的な条件を形成します。

タスクシーケンス変数_SMSTSInWinPE equals "false"

既存の OS イメージをインストールするには、既定のタスクシーケンステンプレートの [ファイルと設定のキャプチャ] グループでこの条件を参照してください。

条件の詳細については、「タスクシーケンスエディター - 条件」を参照してください。

カスタムスクリプト

タスクシーケンスの実行中に Microsoft.SMS.TSEnvironment COM オブジェクトを使用して、変数の読み取りと書き込みを行います。

次の Windows PowerShell の例では、 _SMSTSLogPath 変数に対してクエリを実行して、現在のログの場所を取得します。スクリプトでは、カスタム変数も設定されます。

# Create an object to access the task sequence environment
$tsenv = New-Object -ComObject Microsoft.SMS.TSEnvironment

# Query the environment to get an existing variable
# Set a variable for the task sequence log path
$LogPath = $tsenv.Value("_SMSTSLogPath")

# Or, convert all of the variables currently in the environment to PowerShell variables
$tsenv.GetVariables() | % { Set-Variable -Name "$_" -Value "$($tsenv.Value($_))" }

# Write a message to a log file
Write-Output "Hello world!" | Out-File -FilePath "$LogPath\mylog.log" -Encoding "Default" -Append

# Set a custom variable "startTime" to the current time
$tsenv.Value("startTime") = (Get-Date -Format HH:mm:ss) + ".000+000"

Windows セットアップ応答ファイル

指定した Windows セットアップ応答ファイルには、タスクシーケンス変数を埋め込むことができます。 %varname%フォームを使用します。ここで、varname は変数の名前です。 [Windows と ConfigMgr のセットアップ] ステップでは、実際の変数値の変数名文字列が置き換えられます。これらの埋め込みタスクシーケンス変数は、unattend.xml 応答ファイルの数値のみのフィールドでは使用できません。

詳細については、「 Windows と ConfigMgr のセットアップ」を参照してください。

次の方法で共有

Configuration Manager でタスクシーケンス変数を使用する方法

変数の種類

組み込み変数

アクション変数

カスタム変数

読み取り専用変数

配列変数

変数を設定する方法

タスクシーケンス変数の値に関する一般的な制限事項

タスクシーケンス変数を設定する

動的変数を設定する

PowerShell スクリプトを実行する

PowerShell スクリプトの実行ステップでのシナリオの例

コレクション変数とデバイス変数

デバイスのタスクシーケンス変数を作成する

コレクションのタスクシーケンス変数を作成する

TSEnvironment COM オブジェクト

Prestart コマンド

タスクシーケンスウィザード

タスクシーケンスメディアウィザード

変数にアクセスする方法

手順で使用する

ステップ条件

カスタムスクリプト

Windows セットアップ応答ファイル

関連項目

フィードバック

その他のリソース

次の方法で共有

Configuration Manager でタスク シーケンス変数を使用する方法

変数の種類

組み込み変数

アクション変数

カスタム変数

読み取り専用変数

配列変数

変数を設定する方法

タスク シーケンス変数の値に関する一般的な制限事項

タスク シーケンス変数を設定する

動的変数を設定する

PowerShell スクリプトを実行する

PowerShell スクリプトの実行ステップでのシナリオの例

コレクション変数とデバイス変数

デバイスのタスク シーケンス変数を作成する

コレクションのタスク シーケンス変数を作成する

TSEnvironment COM オブジェクト

Prestart コマンド

タスク シーケンス ウィザード

タスク シーケンス メディア ウィザード

変数にアクセスする方法

手順で使用する

ステップ条件

カスタム スクリプト

Windows セットアップ応答ファイル

関連項目

フィードバック

その他のリソース

Configuration Manager でタスクシーケンス変数を使用する方法

タスクシーケンス変数の値に関する一般的な制限事項

タスクシーケンス変数を設定する

デバイスのタスクシーケンス変数を作成する

コレクションのタスクシーケンス変数を作成する

タスクシーケンスウィザード

タスクシーケンスメディアウィザード

カスタムスクリプト