This is an archive version of the document. To get the most up-to-date information, see the current version.Get-VBRCDPSession
Short Description
Returns CDP policy sessions.
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Get a session for the specified CDP policy.
- Get a CDP policy session with a specific session ID.
- Get a specified CDP policy session.
- Get a CDP policy session with the specified result.
- Get a CDP policy session with the specified state.
Get-VBRCDPSession -Job <VBRJob> [-State {Stopped | Starting | Stopping | Working | Pausing | Resuming | WaitingTape | Idle | Postprocessing | WaitingRepository | Pending | WaitingSlot}] [<CommonParameters>] |
Detailed Description
This cmdlet returns CDP policy sessions.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Job | Specifies the CDP policy for which you want to get sessions. | Accepts the VBRJob object. To create this object, run the Get-VBRCDPPolicy cmdlet. | True | Named | True (ByPropertyName) |
Id | Specifies the ID of the session. The cmdlet will return the session with this ID. | Guid | True | Named | True (ByPropertyName) |
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. | False | Named | False |
Last | Defines that the command returns the last session of the specified CDP policy. | SwitchParameter | False | Named | False |
Result | Specifies the session result. The cmdlet will return sessions with the on of the following results:
| VBRSessionResult | False | Named | False |
State | Specifies the session state. The cmdlet will return sessions with the specified state. | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Output Object
The cmdlet returns the VBRCDPSession object that returns details on CDP policy sessions.
Examples
Example 1. Getting Session for Specified CDP Policy
Example 2. Getting CDP Policy Session with Specific ID
Example 3. Getting CDP Policy Session with Specific Result
Example 4. Getting CDP Policy Session with Specific State
Related Commands
