Get-VBRCDPTaskSession

Short Description

Returns VMs processed during CDP policy sessions.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

Session (Default)

Get-VBRCDPTaskSession -Session <VBRCDPSession> [-Last] [<CommonParameters>]
Id

Get-VBRCDPTaskSession [-Id <Guid>] [<CommonParameters>]
ObjectId

Get-VBRCDPTaskSession [-Last] [-ObjectId <Guid>] [<CommonParameters>]
ObjectName

Get-VBRCDPTaskSession [-Last] [-ObjectName <String>] [<CommonParameters>]

Detailed Description

This cmdlet returns VMs performed during CDP policy sessions.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Id	Specifies an ID of a session that you want to get.	`Guid`	False	Named	True (ByPropertyName)
Last	Defines that the cmdlet will return the last VMs that were processed during a CDP policy session.	`SwitchParameter`	False	Named	False
ObjectId	Specifies an ID of VMs that processed during a CDP policy session.	`Guid`	False	Named	False
ObjectName	Specifies a name of VMs that processed during a CDP policy session.	`String`	False	Named	False
Session	Specifies a CDP policy session that processes VMs. The cmdlet will return these VMs. Accepts the `VBRCDPSession` object. To create this object, run the `Get-VBRCDPSession` cmdlet.	`VBRCDPSession`	True	Named	True (ByPropertyName, ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBRCDPTaskSession object that contains information on VMs performed during CDP policy sessions.

Examples

Get-VBRCDPTaskSession Example 1. Getting VMs Processed During Specific CDP Policy Session

This example shows how to get VMs processed during the CDP policy session.

$policy = Get-VBRCDPPolicy -Name "VM079"

$session = Get-VBRCDPSession -Policy $policy -Last

Get-VBRCDPTaskSession -Session $session

Perform the following steps:

Run the Get-VBRCDPPolicy cmdlet. Specify the Name parameter value. Save the result to the $policy variable.
Run the Get-VBRCDPSession cmdlet. Set the $policy variable as the Policy parameter value. Provide the Last parameter. Save the result to the $session variable.
Run the Get-VBRCDPTaskSession cmdlet. Set the $session variable as the Session parameter value.

Get-VBRCDPTaskSession Example 2. Getting VMs Processed During CDP Policy Session by Session ID

This command returns the VMs processed during the 402e082c-4a6d-4a9b-86c8-3330f35e9773 CDP policy session.

Get-VBRCDPTaskSession -Id "402e082c-4a6d-4a9b-86c8-3330f35e9773"

Get-VBRCDPTaskSession Example 3. Getting VM Processed During CDP Policy Session by VMs ID

This command returns the 15e56946-b75c-444a-9022-99f15ee0b9a2 VM processed during a CDP policy session.

Get-VBRCDPTaskSession -ObjectId "15e56946-b75c-444a-9022-99f15ee0b9a2"

Get-VBRCDPTaskSession Example 4. Getting Last VM Processed During CDP Policy Session

This command returns the last VMs processed during a CDP policy session.

Get-VBRCDPTaskSession -Last