Welcome to my Veeam-vSphere-Interactions Module¶
This is the basic documentation for the ‘Veeam-vSphere-Interactions’ PowerShell Module.
The main documentation for this PowerShell Module is organized into a couple of sections:
Add Commands¶
This page contains details on Add commands.
Add-VeeamJobObject¶
- NAME
- Add-VeeamJobObject
SYNOPSIS
- SYNTAX
- Add-VeeamJobObject [-myVMs] <InventoryItemImpl[]> [-JobName] <String> [<CommonParameters>]
- DESCRIPTION
This Function adds VMware vSphere VMs to an existing Veeam Backup & Replication Backup Job.
Only VMs can be added at the moment.
- PARAMETERS
-myVMs <InventoryItemImpl[]>
-JobName <String>
- <CommonParameters>
- This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
————————– EXAMPLE 1 ————————–
PS C:>Get-VM -Name test3 | Add-VeeamJobObject -JobName “Backup Job 1”
Requires -Version 4 Requires -Modules VMware.VimAutomation.Core, @{ModuleName=”VMware.VimAutomation.Core”;ModuleVersion=”6.3.0.0”} Requires -PSSnapin VeeamPssnapin
- REMARKS
- To see the examples, type: “get-help Add-VeeamJobObject -examples”. For more information, type: “get-help Add-VeeamJobObject -detailed”. For technical information, type: “get-help Add-VeeamJobObject -full”.
Get Commands¶
This page contains details on Get commands.
Get-VeeamProtection¶
- NAME
- Get-VeeamProtection
SYNOPSIS
- SYNTAX
- Get-VeeamProtection [-myVMs] <InventoryItemImpl[]> [<CommonParameters>]
- DESCRIPTION
This Function checks the protection state of VMware vSphere VMs in Veeam Backup & Replication.
Protection state is gathred by existing Backup SavePoints.
- PARAMETERS
-myVMs <InventoryItemImpl[]>
- <CommonParameters>
- This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
————————– EXAMPLE 1 ————————–
PS C:>Get-VM | Get-VeeamProtection | Format-Table -AutoSize
Requires -Version 4 Requires -Modules VMware.VimAutomation.Core, @{ModuleName=”VMware.VimAutomation.Core”;ModuleVersion=”6.3.0.0”} Requires -PSSnapin VeeamPssnapin
- REMARKS
- To see the examples, type: “get-help Get-VeeamProtection -examples”. For more information, type: “get-help Get-VeeamProtection -detailed”. For technical information, type: “get-help Get-VeeamProtection -full”.
Remove Commands¶
This page contains details on Remove commands.
Remove-VeeamJobObject¶
- NAME
- Remove-VeeamJobObject
SYNOPSIS
- SYNTAX
- Remove-VeeamJobObject [-myVMs] <InventoryItemImpl[]> [-JobName] <String> [<CommonParameters>]
- DESCRIPTION
This Function removes VMware vSphere VMs to an existing Veeam Backup & Replication Backup Job.
Only VMs can be removed at the moment.
- PARAMETERS
-myVMs <InventoryItemImpl[]>
-JobName <String>
- <CommonParameters>
- This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
————————– EXAMPLE 1 ————————–
PS C:>Get-VM -Name test3 | Remove-VeeamJobObject -JobName “Backup Job 1”
Requires -Version 4 Requires -Modules VMware.VimAutomation.Core, @{ModuleName=”VMware.VimAutomation.Core”;ModuleVersion=”6.3.0.0”} Requires -PSSnapin VeeamPssnapin
- REMARKS
- To see the examples, type: “get-help Remove-VeeamJobObject -examples”. For more information, type: “get-help Remove-VeeamJobObject -detailed”. For technical information, type: “get-help Remove-VeeamJobObject -full”.
Start Commands¶
This page contains details on Start commands.
Start-VeeamQuickBackup¶
- NAME
- Start-VeeamQuickBackup
SYNOPSIS
- SYNTAX
- Start-VeeamQuickBackup [-myVMs] <InventoryItemImpl[]> [<CommonParameters>]
- DESCRIPTION
This Function starts a Quick Backup for VMware vSphere VMs.
For a Quick Backup the VM must be added to a Backup Job and at least one Full Backup must exist.
- PARAMETERS
-myVMs <InventoryItemImpl[]>
- <CommonParameters>
- This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
————————– EXAMPLE 1 ————————–
PS C:>Get-VM -Name test | Start-VeeamQuickBackup
Requires -Version 4 Requires -Modules VMware.VimAutomation.Core, @{ModuleName=”VMware.VimAutomation.Core”;ModuleVersion=”6.3.0.0”} Requires -PSSnapin VeeamPssnapin
- REMARKS
- To see the examples, type: “get-help Start-VeeamQuickBackup -examples”. For more information, type: “get-help Start-VeeamQuickBackup -detailed”. For technical information, type: “get-help Start-VeeamQuickBackup -full”.
Start-VeeamRestore¶
- NAME
- Start-VeeamRestore
SYNOPSIS
- SYNTAX
- Start-VeeamRestore [-myVMs] <InventoryItemImpl[]> [<CommonParameters>]
- DESCRIPTION
This Function restores VMware vSphere VMs to the original location.
RestorePoint is the lastest one. You will have to power up the VM manually.
- PARAMETERS
-myVMs <InventoryItemImpl[]>
- <CommonParameters>
- This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
————————– EXAMPLE 1 ————————–
PS C:>Get-VM | Start-VeeamRestore
Requires -Version 4 Requires -Modules VMware.VimAutomation.Core, @{ModuleName=”VMware.VimAutomation.Core”;ModuleVersion=”6.3.0.0”} Requires -PSSnapin VeeamPssnapin
- REMARKS
- To see the examples, type: “get-help Start-VeeamRestore -examples”. For more information, type: “get-help Start-VeeamRestore -detailed”. For technical information, type: “get-help Start-VeeamRestore -full”.