Add-SCScriptCommand

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

アプリケーション プロファイル、アプリケーション展開、またはホスト プロファイルにスクリプト コマンドを追加します。

構文

Add-SCScriptCommand
   -ApplicationProfile <ApplicationProfile>
   [-Executable <String>]
   [-CommandParameters <String>]
   [-ScriptCommandSetting <SCScriptCommandSetting>]
   -ScriptType <ScriptCommandType>
   [-TimeoutSeconds <Int32>]
   [-StandardInput <String>]
   [-LibraryResource <CustomResource>]
   [-RunAsAccount <VMMCredential>]
   [-VMMServer <ServerConnection>]
   [-DeploymentOrder <Int32>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Add-SCScriptCommand
   -ApplicationDeployment <ApplicationDeployment>
   [-Executable <String>]
   [-CommandParameters <String>]
   [-ScriptCommandSetting <SCScriptCommandSetting>]
   -ScriptType <ScriptCommandType>
   [-TimeoutSeconds <Int32>]
   [-StandardInput <String>]
   [-LibraryResource <CustomResource>]
   [-RunAsAccount <VMMCredential>]
   [-VMMServer <ServerConnection>]
   [-DeploymentOrder <Int32>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Add-SCScriptCommand
   -PhysicalComputerProfile <PhysicalComputerProfile>
   [-Executable <String>]
   [-CommandParameters <String>]
   [-ScriptCommandSetting <SCScriptCommandSetting>]
   -ScriptType <ScriptCommandType>
   [-TimeoutSeconds <Int32>]
   [-StandardInput <String>]
   [-LibraryResource <CustomResource>]
   [-RunAsAccount <VMMCredential>]
   [-VMMServer <ServerConnection>]
   [-JobGroup <Guid>]
   [-DeploymentOrder <Int32>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]
Add-SCScriptCommand
   [-Executable <String>]
   [-CommandParameters <String>]
   [-ScriptCommandSetting <SCScriptCommandSetting>]
   -ScriptType <ScriptCommandType>
   [-TimeoutSeconds <Int32>]
   [-StandardInput <String>]
   [-LibraryResource <CustomResource>]
   [-RunAsAccount <VMMCredential>]
   [-VMMServer <ServerConnection>]
   [-JobGroup <Guid>]
   [-DeploymentOrder <Int32>]
   [-RunAsynchronously]
   [-PROTipID <Guid>]
   [-JobVariable <String>]
   [<CommonParameters>]

説明

Add-SCScriptCommand コマンドレットは、アプリケーション プロファイル、アプリケーションデプロイ、またはホスト プロファイルにスクリプト コマンドを追加します。 スクリプト コマンドを使用すると、管理者はデプロイ操作とサービス操作中にコードを実行できます。

例

例 1: アプリケーション プロファイルにスクリプト コマンドを追加する

PS C:\> $AppProfile = Get-SCApplicationProfile -Name "SvcWebAppProfile01"
PS C:\> $ScriptSetting = New-SCScriptCommandSetting -WorkingDirectory "Working_Folder_01"
PS C:\> Add-SCScriptCommand -ApplicationProfile $AppProfile -Executable "Startup.ps1" -ScriptType "PreInstall" -ScriptCommandSetting $ScriptSetting -TimeoutSeconds 120

最初のコマンドは、SvcWebAppProfile01 という名前のアプリケーション プロファイル オブジェクトを取得し、$AppProfile変数にオブジェクトを格納します。

2 番目のコマンドは、作業ディレクトリを Payload に設定するスクリプト コマンド設定オブジェクトを作成し、そのオブジェクトを $ScriptSetting 変数に格納します。

最後のコマンドは、$AppProfileに格納されているアプリケーション プロファイルにプレインストール スクリプト コマンドを追加します。

パラメーター

-ApplicationDeployment

アプリケーション展開オブジェクトを指定します。

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

-ApplicationProfile

アプリケーション プロファイル オブジェクトを指定します。

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

-CommandParameters

スクリプトまたは実行可能プログラムのパラメーターを指定します。

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

-DeploymentOrder

コンピューター層、アプリケーション ホスト、またはアプリケーションを展開する順序を指定します。

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

-Executable

実行可能プログラムの名前を指定します。

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

-JobGroup

同じジョブ グループ識別子を含む最後のコマンドが実行される直前に一括して実行される、一連のコマンドの識別子を指定します。

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

-JobVariable

ジョブの進行状況を追跡して、このパラメーターで示す名前の変数に保管するように指定します。

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

-LibraryResource

仮想マシン マネージャー (VMM) ライブラリに格納されているリソースを指定します。

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

-PhysicalComputerProfile

オペレーティング システムをコンピューターに展開するために使用するプロファイルを指定します。

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

-PROTipID

このアクションをトリガーしたパフォーマンスとリソース最適化のヒント (PRO ヒント) の ID を指定します。 このパラメーターを使用すると、PRO のヒントを監査できます。

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

-RunAsAccount

このアクションを実行するアクセス許可を持つ資格情報を含む実行アカウントを指定します。

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

-RunAsynchronously

コントロールがコマンド シェルに直ちに戻るように、ジョブが非同期的に実行されることを示します。

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

-ScriptCommandSetting

スクリプト コマンド設定オブジェクトを指定します。

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

-ScriptType

スクリプトの種類を指定します。 このパラメーターの有効値は、次のとおりです。

  • プレインストール
  • PostInstall
  • Savestate
  • RestoreState
  • PreService
  • PostService
  • PreUninstall
  • PostUninstall
  • OrderedCommand
  • BareMetalPostWinPERegistration
  • OnProvisionFirst
  • OnProvisionRest
  • OnDeleteLast
  • OnDeleteRest
  • インストール
  • BareMetalPostDeployment
Type:ScriptCommandType
Accepted values:PreService, PostService, SaveState, RestoreState, PreInstall, PostInstall, PreUninstall, PostUninstall, OrderedCommand, BareMetalPostWinPERegistration, OnProvisionFirst, OnProvisionRest, OnDeleteLast, OnDeleteRest, Install, BareMetalPostConfiguration, BareMetalPostUnattend
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-StandardInput

スクリプト コマンドで使用する標準入力情報を含むファイルへのパスを指定します。

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

-TimeoutSeconds

プロセスがタイムアウトするまで待機する時間を秒単位で指定します。

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

-VMMServer

仮想マシン マネージャー (VMM) サーバー オブジェクトを指定します。

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

出力

ScriptCommand

このコマンドレットは 、ScriptCommand オブジェクトを 返します。