Add-CMDeploymentTypeReturnCode
サポートされているアプリケーション展開の種類に戻りコードを追加します。
構文
Add-CMDeploymentTypeReturnCode
-InputObject <IResultObject>
-ReturnCode <Int32>
[-CodeType <ExitCodeClass>]
[-Name <String>]
[-Description <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
バージョン 2107 以降では、このコマンドレットを使用して、サポートされているアプリケーション展開の種類に戻りコードを追加します。 一般的な情報については、「 展開の種類のリターン コード」を参照してください。
注:
PS XYZ:\>など、Configuration Manager サイト ドライブから Configuration Manager コマンドレットを実行します。 詳細については、「作業の 開始」を参照してください。
例
例 1: MSI 展開の種類に戻りコード 1602 を追加する
次の使用例は、指定したアプリケーションデプロイの種類に 1602 戻りコードを追加します。
$appName = "CenterApp"
$dtName = "InterDept - Windows Installer (.msi file)"
$msi_dt = Get-CMDeploymentType -ApplicationName $appName -DeploymentTypeName $dtName
Add-CMDeploymentTypeReturnCode -InputObject $msi_dt -ReturnCode 1602 -Name "User cancel" -CodeType Failure -Description "The user cancelled the installation"パラメーター
-CodeType
戻りコードの種類を指定します。 この設定は、Configuration Manager がこの展開の種類から指定したリターン コードを解釈する方法を定義します。 使用可能な種類は、デプロイの種類のテクノロジによって異なります。
Failure: デプロイの種類のインストールに失敗しました。Success: デプロイの種類が正常にインストールされ、再起動は必要ありません。FastRetry: デバイスで別のインストールが既に進行中です。 クライアントは 2 時間ごとに合計 10 回再試行します。HardReboot: デプロイの種類は正常にインストールされましたが、デバイスを再起動する必要があります。 デバイスが再起動するまで、他の何もインストールできません。SoftReboot: デプロイの種類は正常にインストールされましたが、デバイスの再起動を要求します。 その他のインストールは、デバイスの再起動前に発生する可能性があります。
| 型: | ExitCodeClass |
| 指定可能な値: | Failure, Success, FastRetry, HardReboot, SoftReboot |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットを実行する前に確認メッセージを表示します。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Description
この戻りコードを識別して説明するのに役立つ省略可能な説明を指定します。
| 型: | String |
| Aliases: | ReturnCodeDescription |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DisableWildcardHandling
このパラメーターは、ワイルドカード文字をリテラル文字の値として扱います。 ForceWildcardHandling と組み合わせることはできません。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ForceWildcardHandling
このパラメーターはワイルドカード文字を処理し、予期しない動作が発生する可能性があります (推奨されません)。 DisableWildcardHandling と組み合わせることはできません。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-InputObject
リターン コードを追加するデプロイの種類のオブジェクトを指定します。 このオブジェクトを取得するには、 Get-CMDeploymentType コマンドレットを使用します。
| 型: | IResultObject |
| Aliases: | DeploymentType |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Name
この戻りコードを記述する省略可能な名前を指定します。
| 型: | String |
| Aliases: | ReturnCodeName |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ReturnCode
このデプロイの種類から予期される戻りコードの整数値を指定します。 この値は、 -2147483648 と 2147483647の間の正または負の整数です。
| 型: | Int32 |
| Aliases: | ReturnCodeValue |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットが実行されるとどうなるかを示します。 コマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
出力
IResultObject
メモ
この戻りオブジェクトとそのプロパティの詳細については、「 サーバー WMI クラスSMS_Application」を参照してください。