Get-WssClientBackupVolumeJob

Get-WssClientBackupVolumeJob

Gets backup information for a backup volume job.

Syntax

Parameter Set: ByName
Get-WssClientBackupVolumeJob [-ComputerName] <String> [-BackupIndex] <Int32> [ <CommonParameters>]

Parameter Set: BySid
Get-WssClientBackupVolumeJob [-ComputerSid] <String> [-BackupIndex] <Int32> [ <CommonParameters>]

Detailed Description

The Get-WssClientBackupVolumeJob cmdlet gets backup information for a backup volume job. Specify a computer by name or security identifier (SID). Specify a job by using its index.

Parameters

-BackupIndex<Int32>

Specifies the index for a backup volume job.

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ComputerName<String>

Specifies the name of a computer.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-ComputerSid<String>

Specifies the SID of a computer.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.WindowsServerSolutions.DataProtection.PCBackup.BackupUtil.WcfContracts.VolumeJobInfo

Examples

Example 1: Get backup volume job information

This command gets information for a backup volume job for the computer named Workstation073. The command specifies the backup index of the job.

PS C:\> Get-WssClientBackupVolumeJob -ComputerName "Workstation073" -BackupIndex 1 

Disable-WssClientBackupVolume

Enable-WssClientBackupVolume

Get-WssClientBackupVolume