Set-CMDeploymentTypeReturnCode

  • リファレンス
モジュール:
ConfigurationManager

指定したアプリケーション展開の種類の戻りコードを変更します。

構文

Set-CMDeploymentTypeReturnCode
   -InputObject <IResultObject>
   -ReturnCode <Int32>
   [-CodeType <ExitCodeClass>]
   [-NewName <String>]
   [-Description <String>]
   [-PassThru]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

バージョン 2107 以降では、このコマンドレットを使用して、指定したアプリケーション展開の種類の戻りコードを変更します。 一般的な情報については、「 展開の種類のリターン コード」を参照してください。

注:

Configuration Manager サイト ドライブからConfiguration Managerコマンドレットを実行します (例: PS XYZ:\>)。 詳細については、「作業の 開始」を参照してください。

例

例 1: 3010 戻りコードの動作を変更する

次の使用例は、既定 3010 の戻りコードの動作を変更します。これは、既定では ソフト 再起動 の種類です。 ハード 再起動として構成し、名前と説明を変更します。

$appName = "CenterApp"
$dtName = "InterDept - Windows Installer (.msi file)"
$msi_dt = Get-CMDeploymentType -ApplicationName $appName -DeploymentTypeName $dtName

Add-CMDeploymentTypeReturnCode -InputObject $msi_dt -ReturnCode 3010 -Name "Always reboot" -CodeType HardReboot -Description "Change soft reboot to hard reboot"

パラメーター

-CodeType

戻りコードの種類を指定します。 この設定では、指定した戻りコードConfiguration Managerこのデプロイの種類から解釈する方法を定義します。 使用可能な種類は、デプロイの種類のテクノロジによって異なります。

  • Failure: デプロイの種類のインストールに失敗しました。

  • Success: デプロイの種類が正常にインストールされ、再起動は必要ありません。

  • FastRetry: デバイスで別のインストールが既に進行中です。 クライアントは 2 時間ごとに合計 10 回再試行します。

  • HardReboot: デプロイの種類は正常にインストールされましたが、デバイスを再起動する必要があります。 デバイスが再起動するまで、他の何もインストールできません。

  • SoftReboot: デプロイの種類は正常にインストールされましたが、デバイスの再起動を要求します。 その他のインストールは、デバイスの再起動前に発生する可能性があります。

Type:ExitCodeClass
Accepted values:Failure, Success, FastRetry, HardReboot, SoftReboot
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

コマンドレットを実行する前に確認メッセージを表示します。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

この戻りコードを識別して説明するのに役立つ省略可能な説明を指定します。

Type:String
Aliases:ReturnCodeDescription
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableWildcardHandling

このパラメーターは、ワイルドカード文字をリテラル文字の値として扱います。 ForceWildcardHandling と組み合わせることはできません。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForceWildcardHandling

このパラメーターはワイルドカード文字を処理し、予期しない動作が発生する可能性があります (推奨されません)。 DisableWildcardHandling と組み合わせることはできません。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

戻りコードを変更するデプロイの種類のオブジェクトを指定します。 このオブジェクトを取得するには、 Get-CMDeploymentType コマンドレットを使用します。

Type:IResultObject
Aliases:DeploymentType
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NewName

この戻りコードを記述する新しい名前を指定します。

Type:String
Aliases:ReturnCodeName
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

このパラメーターを追加して、作業中のアイテムを表すオブジェクトを返します。 既定では、このコマンドレットは出力を生成しない場合があります。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReturnCode

このデプロイの種類から予期される戻りコードの整数値を指定します。 この値は、 と 2147483647の間-2147483648の正または負の整数です。

Type:Int32
Aliases:ReturnCodeValue
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットが実行されるとどうなるかを示します。 コマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

出力

IResultObject

メモ

この戻りオブジェクトとそのプロパティの詳細については、「 サーバー WMI クラスSMS_Application」を参照してください。