A cmdlet is a specialized .NET class that interacts with Microsoft .NET Framework objects. Each cmdlet acts as a single-function command that can perform multiple operations with these objects. Objects represent instances of the Veeam backup infrastructure: jobs, databases, restore sessions and so on.
A cmdlet has parameters that pass additional object data to the command. Parameters can be either required or optional. You can not run a cmdlet without specifying the required parameters, while the optional parameters can be omitted. Parameters are organized into parameter sets that form a syntax of the cmdlet.
Cmdlets and their parameters are named after the Windows PowerShell naming conventions. Veeam cmdlets are developed to behave like other Microsoft Windows cmdlets.
This guide covers only basic information on how to work with Veeam Explorers cmdlets using Windows PowerShell. To learn more about Windows PowerShell, see this Microsoft KB article.
The Get-Help cmdlet is a Microsoft cmdlet. You can use it to get information about Microsoft cmdlets, as well as cmdlets that are added to Veeam Explorers PowerShell modules.
The online help for PowerShell on Veeam Help Center is always a more accurate source of information than the help reference that is integrated into the product. The online help is updated regularly and contains all fixes that are based on customers feedback.
To get full details about the necessary cmdlet, run the Get-Help <cmdletname> -full command from your PowerShell console. The Get-Help command will return the syntax that shows a whole set of parameters that are available for the cmdlet and an input type for each parameter.
For example, to get information about the Start-VBOSharePointItemRestoreSession cmdlet, run the following command:
PS C:\PS> Get-Help Start-VBOSharePointItemRestoreSession -full
The console will return the following syntax:
Start-VBOSharePointItemRestoreSession [-Job] <IVBOJob> [-Server <string>] [-Credential <pscredential>] [-Port <int>] [<CommonParameters>]
Start-VBOSharePointItemRestoreSession [-RestorePoint] <IVBORestorePoint> [-Server <string>] [-Credential <pscredential>] [-Port <int>] [<CommonParameters>]
Start-VBOSharePointItemRestoreSession [-Organization] <IVBOOrganization> [-Server <string>] [-Credential <pscredential>] [-Port <int>] [<CommonParameters>]
The syntax indicates that the cmdlet has three cmdlet sets per different types of restore: restore from the specified Veeam Backup for Microsoft Office 365 job, restore from the specified restore point or restore of backups for the specified organization.
To start a restore session of SharePoint items that were backed up with the Veeam Backup for Microsoft Office 365, you must specify the required cmdlet parameters and you can also use the optional parameters.
You must use one of the following required parameters from the cmdlet set, depending on the type of restore that you want to run:
- [-Job] <IVBOJob> — to specify the Veeam Backup for Microsoft Office 365 job, if you want to restore from the Veeam Backup for Microsoft Office 365 job.
- [-RestorePoint] <IVBORestorePoint> — to specify the Veeam Backup for Microsoft Office 365 restore point, if you want to restore from the restore point.
- [-Organization] <IVBOOrganization> — to specify a OneDrive organization, if you want to restore from the organization.
These parameters are optional, and you can use them to specify the following settings:
- [-Server <string>] — to specify the Veeam Backup for Microsoft Office 365 server to which you want to connect.
- [-Credential <pscredential>] — to specify credentials that you want to use to authenticate against the SharePoint server.
- [-Port <int>] — to specify the port number to connect to the SharePoint server.