New-VEMDBCollectionRestoreOptions

Short Description

Defines the restore options that you can apply to a restore job.

Applies to

Veeam Backup & Replication

Product Edition: Enterprise Plus, Veeam Universal License

Syntax

New-VEMDBCollectionRestoreOptions [-Collection] <VEMDBCollection> [-NewCollectionName <String>] [-NewDatabaseName <String>] [<CommonParameters>]

Detailed Description

This cmdlet creates restore options that you can use in a restore job of MongoDB collections. You can use it to specify the collection you want to restore, the new name for the restored collection, and the name of the database to which the collection will be restored.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Collection

Specifies a backed-up MongoDB collection to which the settings will apply.

Accepts the VEMDBCollection object. To get this object, run the Get-VEMDBCollection cmdlet.

True

1

True (ByValue)

NewDatabaseName

Specifies the name of the database to which the collection will be restored.

String

False

Named

False

NewCollectionName

Specifies the new name of the restored collection.

String

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 VEMDBCollectionRestoreOptions object that contains the restore options for the specified collection.

Examples

New-VEMDBCollectionRestoreOptionsExample 1. Specifying Default Restore Options

New-VEMDBCollectionRestoreOptionsExample 2. Specifying New Name for Restored Collection

New-VEMDBCollectionRestoreOptionsExample 3. Specifying New Name for Target Database

Related Commands

Page updated 3/6/2025

Page content applies to build 12.3.1.1139