Add-CMDeploymentTypeReturnCode
サポートされているアプリケーション展開の種類に戻りコードを追加します。
構文
Add-CMDeploymentTypeReturnCode
-InputObject <IResultObject>
-ReturnCode <Int32>
[-CodeType <ExitCodeClass>]
[-Name <String>]
[-Description <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
バージョン 2107 から、このコマンドレットを使用して、サポートされているアプリケーション展開の種類に戻りコードを追加します。 詳細については、「展開の種類 の戻りコード」を参照してください。
注意
Configuration Manager サイト ドライブから Configuration Manager コマンドレットを実行します PS XYZ:\> 。 詳細については 、「Getting started」を参照してください。
例
例 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: 展開の種類は正常にインストールされましたが、デバイスの再起動を要求します。 その他のインストールは、デバイスが再起動する前に発生する可能性があります。
| Type: | ExitCodeClass |
| Accepted values: | Failure, Success, FastRetry, HardReboot, SoftReboot |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
コマンドレットを実行する前に確認メッセージを表示します。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
この戻りコードを識別して説明するのに役立つオプションの説明を指定します。
| Type: | String |
| Aliases: | ReturnCodeDescription |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableWildcardHandling
このパラメーターは、ワイルドカード文字をリテラル文字値として扱います。 ForceWildcardHandling と組み合わせは使用できない。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForceWildcardHandling
このパラメーターはワイルドカード文字を処理し、予期しない動作を引き起こします (推奨されません)。 DisableWildcardHandling と組み合わせは使用できない。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
戻りコードを追加する展開の種類オブジェクトを指定します。 このオブジェクトを取得するには 、Get-CMDeploymentType コマンドレットを使用 します。
| Type: | IResultObject |
| Aliases: | DeploymentType |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
この戻りコードを記述するオプションの名前を指定します。
| Type: | String |
| Aliases: | ReturnCodeName |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReturnCode
この展開の種類から期待される戻りコードの整数値を指定します。 この値は、 と の間の正または負の -2147483648 整数です 2147483647 。
| Type: | Int32 |
| Aliases: | ReturnCodeValue |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットが実行されるとどうなるかを示します。 コマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
出力
IResultObject
メモ
この戻り値オブジェクトとそのプロパティの詳細については、「SMS_Application WMI クラス」を参照してください。