New-CMOrchestrationGroup
新しいオーケストレーション グループを作成します。
構文
New-CMOrchestrationGroup
[-Name] <String>
-SiteCode <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>] 説明
このコマンドレットを使用して、新しいオーケストレーション グループを作成します。
オーケストレーション グループを使用して、デバイスへのソフトウェア更新プログラムの展開をより適切に制御します。 特定のワークロードの更新プログラムを慎重に管理したり、その間の動作を自動化したりする必要がある場合があります。 詳細については、「 Configuration Manager でオーケストレーション グループを作成して使用する」を参照してください。
注:
PS XYZ:\>など、Configuration Manager サイト ドライブから Configuration Manager コマンドレットを実行します。 詳細については、「作業の 開始」を参照してください。
例
例 1
この例では、最初にコマンドレット パラメーターを parameters 変数にスプラットします。 パラメーターをスプラッタする必要はありません。これにより、このような長いコマンド ラインのパラメーターを読みやすくなります。
デバイス 変数の オーケストレーション グループに追加するデバイスのオブジェクトがあることを前提としています。
コマンドは、テスト目的で既定の設定と単純なスクリプトを使用してオーケストレーション グループを作成します。
$parameters = @{
Name = "IT servers"
SiteCode = "XYZ"
Description = "An OG for IT servers with default settings"
OrchestrationType = "Number"
OrchestrationValue = 1
OrchestrationTimeOutMin = 720
MaxLockTimeOutMin = 60
PreScript = "Write-Host 'Pre-install script'"
PreScriptTimeoutSec = 120
PostScript = "Write-Host 'POST-install script'"
PostScriptTimeoutSec = 120
MemberResourceIds = $device1.ResourceID, $device2.ResourceID
}
New-CMOrchestrationGroup @parametersパラメーター
-Confirm
コマンドレットを実行する前に確認メッセージを表示します。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Description
オーケストレーション グループを識別するために、省略可能な説明を指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DisableWildcardHandling
このパラメーターは、ワイルドカード文字をリテラル文字の値として扱います。 ForceWildcardHandling と組み合わせることはできません。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ForceWildcardHandling
このパラメーターはワイルドカード文字を処理し、予期しない動作が発生する可能性があります (推奨されません)。 DisableWildcardHandling と組み合わせることはできません。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-MaxLockTimeOutMin
オーケストレーション グループ メンバーのタイムアウトの整数値を分単位で指定します。 この値は、更新プログラムをインストールするグループ内の 1 つのデバイスの時間制限です。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-MemberResourceIds
このオーケストレーション グループのメンバーとして追加するデバイスのリソース ID の配列を指定します。 リソース ID は整数です (たとえば、 16777220)。 これは、デバイスまたはリソース オブジェクトの ResourceId プロパティです。 デバイス オブジェクトを取得するには、 Get-CMDevice コマンドレットまたは Get-CMResource コマンドレットを使用します。
OrchestrationType パラメーターを Sequence に設定する場合は、このパラメーターを使用して順序を決定します。
| 型: | Int32[] |
| Aliases: | MogMembers |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Name
オーケストレーション グループの名前を指定します。
| 型: | String |
| Aliases: | OrchestrationGroupName |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-OrchestrationTimeOutMin
オーケストレーション グループのタイムアウトの整数値を分単位で指定します。 この値は、すべてのグループ メンバーが更新プログラムをインストールするための時間制限です。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-OrchestrationType
オーケストレーション グループの種類に対して、次のいずれかの値を指定します。
Number: 多数のデバイスが同時に更新されるようにします。 オーケストレーション グループの全体的なサイズに関係なく、常に特定の数のデバイスに制限するには、この設定を使用します。 デバイスの数を指定するには、 OrchestrationValue パラメーターを使用します。Percentage: デバイスの割合が同時に更新されるようにします。 この設定を使用して、オーケストレーション グループのサイズの将来の柔軟性を確保します。 割合を指定するには、 OrchestrationValue パラメーターを使用します。Sequence: デバイスがソフトウェア更新プログラムの展開を実行する順序を明示的に定義します。 順序は、 MemberResourceIds パラメーター内のデバイス リソース ID の並べ替えによって決まります。
| 型: | OrchestrationTypeValue |
| 指定可能な値: | Number, Percentage, Sequence |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-OrchestrationValue
同時に更新するデバイスの数または割合の整数を指定します。
OrchestrationType パラメーターを Number または Percentage に設定する場合は、このパラメーターを使用します。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-PostScript
展開の実行 後 に各デバイスで実行する PowerShell スクリプトを指定し、必要に応じてデバイスを再起動します。
この文字列値は、スクリプト自体のテキストです。 使用するファイルにスクリプトがある場合は、最初に変数に読み込みます。 たとえば、組み込みの Get-Content コマンドレットを 使用します。
スクリプトは、成功のために 0 の値を返す必要があります。 0 以外の値は、スクリプトエラーと見なされます。 パラメーターでスクリプトを使用することはできません。 スクリプトの最大長は 50,000 文字です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-PostScriptTimeoutSec
ポストスクリプトがタイムアウトする前に実行できる時間の整数値を秒単位で指定します。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-PreScript
デプロイを実行する 前 に、各デバイスで実行する PowerShell スクリプトを指定します。
この文字列値は、スクリプト自体のテキストです。 使用するファイルにスクリプトがある場合は、最初に変数に読み込みます。 たとえば、組み込みの Get-Content コマンドレットを 使用します。
スクリプトは、成功のために 0 の値を返す必要があります。 0 以外の値は、スクリプトエラーと見なされます。 パラメーターでスクリプトを使用することはできません。 スクリプトの最大長は 50,000 文字です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-PreScriptTimeoutSec
事前スクリプトがタイムアウトする前に実行できる時間の整数値を秒単位で指定します。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-SiteCode
このオーケストレーション グループとそのメンバーのサイト コードを指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットが実行されるとどうなるかを示します。 コマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
None
出力
IResultObject
メモ
このコマンドレットは、 SMS_MachineOrchestrationGroup WMI クラスの オブジェクトを返します。