Start-FsrmFileManagementJob

[アーティクル]
11/16/2015

Start-FsrmFileManagementJob

Starts a file management job.

構文

Parameter Set: Query (cdxml)
Start-FsrmFileManagementJob [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Queue] [-RunDuration <Int32> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Start-FsrmFileManagementJob -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Queue] [-RunDuration <Int32> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Start-FsrmFileManagementJob cmdlet attempts to start a file management job. If you specify the Queue parameter, the start is delayed by approximately 5 minutes to wait for other file management jobs that the server can run at the same time.

パラメーター

-AsJob

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-CimSession<CimSession[]>

リモートセッションまたはリモートコンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッションオブジェクトを入力します。既定値は、ローカルコンピューターで実行中の現在のセッションです。

エイリアス	Session
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-InputObject<CimInstance[]>

このコマンドレットへの入力を指定します。このパラメーターを使用するか、パイプを使用して入力をこのコマンドレットに渡すことができます。

エイリアス	なし
必須?	true
位置は?	named
既定値	なし
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-Name<String[]>

Specifies an array of names of file management jobs.

エイリアス	なし
必須?	true
位置は?	2
既定値	なし
パイプライン入力を許可する	True (ByPropertyName)
ワイルドカード文字を許可する	false

-Queue

Indicates that the server adds the file management job to a queue and the task should run the next 5 minutes. Any tasks that the server queues during the next 5 minutes are run together. If you do not specify this parameter, the server runs the file management job immediately.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-RunDuration<Int32>

Specifies the number of hours that the server runs the task before canceling it. The value 0 indicates that the server runs the task to completion.

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-ThrottleLimit<Int32>

このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。

エイリアス	なし
必須?	false
位置は?	named
既定値	なし
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

必須?	false
位置は?	named
既定値	false
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

必須?	false
位置は?	named
既定値	false
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileManagementJob

例

Example 1: Start a file management job

This command starts the file management job named "Expire stale Data" immediately.

PS C:\> Start-FsrmFileManagementJob -Name "Expire stale Data"

Example 2: Queue a file management job and set the run duration

This command queues the file management job named "Expire stale Data" to start in the next 5 minutes and specifies that the server does not run the job any longer than 4 hours.

PS C:\> Start-FsrmFileManagementJob -Name "Expire stale Data" -Queue -RunDuration 4

Start-FsrmFileManagementJob