Set-CMOrchestrationGroup
オーケストレーション グループを構成します。
構文
Set-CMOrchestrationGroup
[-InputObject] <IResultObject>
[-NewName <String>]
[-Description <String>]
[-OrchestrationType <OrchestrationTypeValue>]
[-OrchestrationValue <Int32>]
[-OrchestrationTimeOutMin <Int32>]
[-MaxLockTimeOutMin <Int32>]
[-PreScript <String>]
[-PreScriptTimeoutSec <Int32>]
[-PostScript <String>]
[-PostScriptTimeoutSec <Int32>]
[-MemberResourceIds <Int32[]>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMOrchestrationGroup
[-Id] <Int32>
[-NewName <String>]
[-Description <String>]
[-OrchestrationType <OrchestrationTypeValue>]
[-OrchestrationValue <Int32>]
[-OrchestrationTimeOutMin <Int32>]
[-MaxLockTimeOutMin <Int32>]
[-PreScript <String>]
[-PreScriptTimeoutSec <Int32>]
[-PostScript <String>]
[-PostScriptTimeoutSec <Int32>]
[-MemberResourceIds <Int32[]>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMOrchestrationGroup
[-Name] <String>
[-NewName <String>]
[-Description <String>]
[-OrchestrationType <OrchestrationTypeValue>]
[-OrchestrationValue <Int32>]
[-OrchestrationTimeOutMin <Int32>]
[-MaxLockTimeOutMin <Int32>]
[-PreScript <String>]
[-PreScriptTimeoutSec <Int32>]
[-PostScript <String>]
[-PostScriptTimeoutSec <Int32>]
[-MemberResourceIds <Int32[]>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
このコマンドレットを使用して、オーケストレーション グループを構成します。
オーケストレーション グループを使用して、デバイスへのソフトウェア更新プログラムの展開をより適切に制御します。 特定のワークロードの更新プログラムを慎重に管理するか、間の動作を自動化する必要がある場合があります。 詳細については、「Create and use オーケストレーション グループ in Configuration Manager」を参照してください。
注意
Configuration Manager サイト ドライブから Configuration Manager コマンドレットを実行します PS XYZ:\> 。 詳細については 、「Getting started」を参照してください。
例
例 1: 型を変更し、シーケンスを指定する
この例では、 まず Get-CMOrchestrationGroup コマンドレットを使用して、IT サーバーという名前のオーケストレーション グループのオブジェクト を取得します。 このオブジェクトは og 変数に 格納 されます。
次のコマンドは、devices という名前の配列を 定義します。 IT サーバーオーケストレーション グループ ( ) の各 メンバーをループ処理し、メンバーの ID を $og.MOGMembers Get-CMDevice コマンドレットに渡 します。 返されたデバイス オブジェクトが devices 配列に 追加 されます。
次のコマンドは、配列をデバイス名で並べ替え、デバイス リソースの ID を sortedIDs 変数に返 します。
その後 、コマンドレット パラメーター を parameters 変数に スプラット します。 パラメーターをスプラットする必要はありません。このような長いコマンド ラインのパラメーターを読みやすくします。
最後のコマンドは、シーケンスの順序を定義して、指定したオーケストレーション グループを構成します。 MemberResourceIds パラメーターを使用して、メンバーの追加や削除ではなく、シーケンスを設定します。
$og = Get-CMOrchestrationGroup -Name "IT servers"
$devices = @()
foreach ( $id in $og.MOGMembers ) {
$devices += Get-CMDevice -Id $id -Fast
}
$sortedIDs = ( $devices | Sort-Object -Property Name | Select-Object ResourceId ).ResourceId
$parameters = @{
InputObject = $og
Description = "Change type and sequence"
OrchestrationType = "Sequence"
MemberResourceIds = $sortedIDs
}
Set-CMOrchestrationGroup @parameters次の使用例は、既存のメンバーのプログラムによる並べ替えを行う方法を示しています。 オーケストレーション グループのメンバーシップが変更しない場合は、次の一般的なプロセスを使用します。
- 既存のメンバー リソースの ID を使用します。
- 各リソースの詳細を取得します。
- その情報のリストを並べ替える。
- 新しく並べ替えたリストのリソースの ID を返します。
この例では 、Get-CMDevice を使用して詳細を取得しますが、デバイス リソース ID を入力として使用するコマンドレットに置き換えられます。 並べ替えメカニズムを別の関数に置き換えできます。
例 2: ファイルからスクリプト コンテンツを取得する
この例では、組み込みの Get-Content コマンドレットを使用して、ローカル ファイルからスクリプト テキストを読み取る。 スクリプト テキストは postScript 変数に格納 されます。 2 番目のコマンドは、新しいポスト スクリプトを使用してオーケストレーション グループを構成します。
$postScript - Get-Content -Path "D:\Scripts\OG\Post1.ps1"
Set-CMOrchestrationGroup -InputObject $og -PostScript $postScriptパラメーター
コマンドレットを実行する前に確認メッセージを表示します。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
オーケストレーション グループを識別するためのオプションの説明を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
このパラメーターは、ワイルドカード文字をリテラル文字値として扱います。 ForceWildcardHandling と組み合わせは使用できない。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
このパラメーターはワイルドカード文字を処理し、予期しない動作を引き起こします (推奨されません)。 DisableWildcardHandling と組み合わせは使用できない。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
構成するオーケストレーション グループの ID を指定します。 この値は 、整数である MOGID プロパティです。 たとえば、「 16777217 」のように入力します。
| Type: | Int32 |
| Aliases: | MOGID |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
構成するオーケストレーション グループのオブジェクトを指定します。 このオブジェクトを取得するには 、Get-CMOrchestrationGroup コマンドレットを使用 します。
| Type: | IResultObject |
| Aliases: | OrchestrationGroup |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
オーケストレーション グループ メンバーのタイムアウトの整数値を分で指定します。 この値は、グループ内の 1 つのデバイスが更新プログラムをインストールする時間制限です。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
このオーケストレーション グループのメンバーとして追加するデバイスのリソース ID の配列を指定します。 リソース ID は、たとえば、整数です 16777220 。 デバイスまたはリソース オブジェクトの ResourceId プロパティです。 デバイス オブジェクトを取得するには 、Get-CMDevice コマンドレットまたは Get-CMResource コマンドレットを 使用します。
OrchestrationType パラメーターを に設定する 場合 Sequence は、このパラメーターを使用して順序を決定します。
| Type: | Int32[] |
| Aliases: | MogMembers |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
構成するオーケストレーション グループの名前を指定します。
| Type: | String |
| Aliases: | OrchestrationGroupName |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
このオーケストレーション グループの新しい名前を指定します。 このパラメーターを使用して、オーケストレーション グループの名前を変更します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
展開の実行後に各デバイスで実行する__ PowerShell スクリプトを指定し、必要に応じてデバイスを再起動します。
この文字列値は、スクリプト自体のテキストです。 使用するファイルにスクリプトがある場合は、まず変数に読み込む必要があります。 たとえば、組み込みの Get-Content コマンドレットを使用 します。
スクリプトは成功の値を 0 返す必要があります。 ゼロ以外の値は、スクリプトエラーと見なされます。 パラメーターを使用してスクリプトを使用することはできません。 スクリプトの最大長は 50,000 文字です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
ポスト スクリプトがタイム アウトする前に実行する許可された時間の整数値を秒で指定します。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
展開を実行する前に、各デバイスで実行する PowerShell スクリプト を指定します。
この文字列値は、スクリプト自体のテキストです。 使用するファイルにスクリプトがある場合は、まず変数に読み込む必要があります。 たとえば、組み込みの Get-Content コマンドレットを使用 します。
スクリプトは成功の値を 0 返す必要があります。 ゼロ以外の値は、スクリプトエラーと見なされます。 パラメーターを使用してスクリプトを使用することはできません。 スクリプトの最大長は 50,000 文字です。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
事前スクリプトを実行してからタイム アウトする前に、許可された時間の整数値を秒で指定します。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
コマンドレットが実行されるとどうなるかを示します。 コマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
オーケストレーション グループのタイムアウトの整数値を分で指定します。 この値は、すべてのグループ メンバーが更新プログラムをインストールする時間制限です。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
オーケストレーション グループの種類に対して、次のいずれかの値を指定します。
Number: 複数のデバイスを同時に更新できます。 オーケストレーション グループの全体的なサイズに関して、常に特定の数のデバイスに制限するには、この設定を使用します。 デバイスの数を指定するには、 オーケストレーション値パラメーターを使用 します。Percentage: デバイスの割合を同時に更新できます。 この設定は、オーケストレーション グループのサイズの将来の柔軟性を実現するために使用します。 割合を指定するには、 オーケストレーション値パラメーターを使用 します。Sequence: デバイスがソフトウェア更新プログラムの展開を実行する順序を明示的に定義します。 順序は 、MemberResourceIds パラメーター内のデバイス リソース ID の並べ替えによって決まります。
| Type: | OrchestrationTypeValue |
| Accepted values: | Number, Percentage, Sequence |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
同時に更新するデバイスの数または割合の整数を指定します。 このパラメーターは、オーケストレーションの種類パラメーターを に設定する 場合または Number に設定する場合に使用します Percentage 。
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
出力
IResultObject
メモ
このコマンドレットは、WMI クラスのオブジェクトを SMS_MachineOrchestrationGroup します。