Using WinRM Windows PowerShell Cmdlets to Manage BITS Transfer Jobs

Windows Remote Management PowerShell cmdlets can manage Background Intelligent Transfer Service (BITS) transfer jobs. For more information about BITS remote management, see BITS provider and BITS provider classes.

The following examples require the BITS provider. The BITS provider is available after the BITS Compact server is installed. For information about installing the Compact server, see the BITS Compact Server documentation.

  1. Create a BITS transfer job.

    
    
    # Get the credentials to connect to the remote client computer
    $cred = Get-Credential
    $result = Invoke-WsmanAction -Action CreateJob –Resourceuri wmi/root/microsoft/bits/BitsClientJob `
    –Valueset @{DisplayName="TestJob"; RemoteUrl="http://Server01/servertestdir/testfile1.txt"; LocalFile="C:\clienttestdir\testfile1.txt";Type=0} `
    –ComputerName Client1  -Credential $cred
    
    
    

    The Get-Credential cmdlet requests the user's credentials to connect to the remote computer and assigns the credentials to the $cred object.

    The Invoke-WsmanAction cmdlet creates the BITS transfer job on Client1 by creating an instance of the BitsClientJob class and using the information in the hash table defined in the Valueset parameter. The Valueset parameter specifies the information needed to populate the parameters of the CreateJob method. In the preceding example, the user is sets the Type parameter to 0 (download). The user also specifies the name of both the remote and local files for the download job. For more information about creating BITS transfer jobs and for detailed information about parameters, see CreateJob method.

    The Invoke-WsmanAction cmdlet assigns the result to the $result variable.

    Note  The grave-accent character (`) is used to indicate a line break.

  2. Set the Priority of the BITS transfer job.

    
    
    Set-WsmanInstance  -ResourceURI  wmi/root/microsoft/bits/BitsClientJob -SelectorSet @{JobId=$result.JobId} `
    -ValueSet @{Priority=0} –ComputerName Client1  -Credential $cred
    
    

    The Set-WsmanInstance cmdlet changes the new BITS transfer job priority to 0 (BG_JOB_PRIORITY_FOREGROUND). For more information about the priority levels, see the BG_JOB_PRIORITY enumeration.

  3. Resume the BITS transfer job.

    
    
    Invoke-WsmanAction -Action SetJobState -ResourceUri wmi/root/microsoft/bits/BitsClientJob  -selectorset @{JobId=$result.JobId}  `
    -valueset @{JobState= 2} –ComputerName Client1  -Credential $cred
    
    

    The Invoke-WsmanAction cmdlet calls the SetJobState method, which sets the job state to 2 (Resume the Job).

  4. Manage the BITS transfer job.

    
    
    $IsPprocessing = $TRUE
    while ($IsPprocessing)
    {
    	$result = Get-WsmanInstance  -ResourceURI  wmi/root/microsoft/bits/BitsClientJob -selectorset @{JobId = $result.JobId} `
               –ComputerName Client1  -Credential $cred
    	if ($result.State -eq 6)
    	{
    
    #Complete the job			
    		Invoke-WsmanAction -action SetJobState -resourceuri wmi/root/microsoft/bits/BitsClientJob  -selectorset @{JobId=$result.JobId}  `
                          -valueset @{JobState= 1} –ComputerName Client1  -Credential $cred
    		"Job Successfully Transferred"
    		$IsPprocessing = $FALSE;
    	}
    	elseif (($result.State -eq 4) -or ($result.State -eq 5))
    	{
    
    #Cancel the job
    		"Job is in Error " 
    		Invoke-WsmanAction -action SetJobState -resourceuri wmi/root/microsoft/bits/BitsClientJob  -selectorset @{JobId=$result.JobId}  `
                         -valueset @{JobState= 0} –ComputerName Client1  -Credential $cred
    		# You can troubleshoot or delete the job
    		$IsPprocessing = $FALSE;
    	}
    	else
    	{
    	"Job is processing\n" 
    	}
    
    # Perform other action or poll in a tight loop. This example sleeps for 5 seconds
    sleep 5
    }
    
    
    

    The preceding example is a script to poll the status of the job and take an action based on the status. The following actions are possible:

    For more information about job states, see the BG_JOB_STATE enumeration.

Related topics

Get-Credential
Invoke-WsmanAction
Set-WsmanInstance

 

 

Community Additions

ADD
Show:
© 2014 Microsoft