Get-VBRCDPSession

Short Description

Returns CDP policy sessions.

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

Syntax

This cmdlet provides the following parameter sets:

Job (Default)

Get-VBRCDPSession -Policy <VBRCDPPolicyBase> [-Last] [<CommonParameters>]
Id

Get-VBRCDPSession -Id <Guid> [<CommonParameters>]
Session

Get-VBRCDPSession -Session <VBRSession> [<CommonParameters>]
Result

Get-VBRCDPSession -Policy <VBRCDPPolicyBase> [-Result <VBRSessionResult>] [<CommonParameters>]
State

Get-VBRCDPSession -Policy <VBRCDPPolicyBase> [-State <VBRSessionState>] [<CommonParameters>]

Detailed Description

This cmdlet returns CDP policy sessions.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Id	Specifies the ID of the session. The cmdlet will return the session with this ID.	`Guid`	True	Named	True (ByPropertyName)
Last	Defines that the command returns the last session of the specified CDP policy.	`SwitchParameter`	False	Named	False
Policy	Specifies the CDP policy for which you want to get sessions. Accepts the `VBRCDPPolicyBase` object. To create this object, run the `Get-VBRCDPPolicy` cmdlet.	`VBRCDPPolicyBase`	True	Named	True (ByPropertyName)
Result	Specifies the session result. The cmdlet will return sessions with the on of the following results: `None` `Success` `Warning` `Failed`	`VBRSessionResult`	False	Named	False
Session	Specifies the CDP policy session for which you want to get an updated state. Accepts the `VBRSession` object. To create this object, run the `Get-VBRSession` cmdlet.	`VBRSession`	True	Named	True (ByPropertyName, ByValue)
State	Specifies the session state. The cmdlet will return sessions with the specified state.	`VBRSessionState`	False	Named	False

<CommonParameters>

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

Output Object

The cmdlet returns the VBRCDPSession object that returns details on CDP policy sessions.

Examples

Get-VBRCDPSession Example 1. Getting Session for Specified CDP Policy

This example shows how to get the session for the VM079 CDP policy.

$policy = Get-VBRCDPPolicy -Name "VM079"

Get-VBRCDPSession -Policy $policy

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.

Get-VBRCDPSession Example 2. Getting CDP Policy Session with Specific ID

This command returns the 8a3eec9a-1ff0-4594-a454-522c410f76ab CDP policy session.

Get-VBRCDPSession -Id "8a3eec9a-1ff0-4594-a454-522c410f76ab"

Get-VBRCDPSession Example 3. Getting CDP Policy Session with Specific Result

This example shows how to get a CDP policy session with the Failed result.

$policy = Get-VBRCDPPolicy -Name "VM079"

Get-VBRCDPSession -Policy $policy -Result Failed

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. Set the Failed option for the Result parameter.

Get-VBRCDPSession Example 4. Getting CDP Policy Session with Specific State

This example shows how get a CDP policy session with the Pending state.

$policy = Get-VBRCDPPolicy -Name "VM079"

Get-VBRCDPSession -Policy $policy -State Pending

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. Set the Pending option for the State parameter.