Get-VEPSQLInstance
Short Description
Returns backed-up PostgreSQL instances.
Applies to
Veeam Backup & Replication
Product Edition: Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Get-VEPSQLInstance [-Session] <VEPSQLRestoreSession> [-DataDirectory <string>] [<CommonParameters>] |
Detailed Description
This cmdlet returns an array of backed-up PostgreSQL instances.
After you get backed-up PostgreSQL instances, you can perform the following operations with these instances:
- Run the Start-VEPSQLInstanceRestore cmdlet to restore PostgreSQL instances.
- Run the Start-VEPSQLInstancePublish cmdlet to publish PostgreSQL instances.
- Run the Start-VEPSQLInstanceInstantRecovery cmdlet to instantly recover PostgreSQL instances.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Session | Specifies an active restore session. The cmdlet will return an array of PostgreSQL instances within the specified restore session. | Accepts the VEPSQLRestoreSession object. To get this object, run the Get-VEPSQLRestoreSession cmdlet. | True | 0 | True (ByValue) |
DataDirectory | Specifies a path to the data directory of the backed-up PostgreSQL instance. The cmdlet will return the PostgreSQL instance with the specified data directory. | 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 VEPSQLInstance[] object that contains an array of backed-up PostgreSQL instances.
Examples
Example 1. Getting PostgreSQL Instances Within Specified Restore Session
This example shows how to get all PostgreSQL instances included in a PostgreSQL restore session.
Perform the following steps:
The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session. In our example, it is the first restore session in the array.
|
Example 2. Getting PostgreSQL Instance With Specified Data Directory
This example shows how to get a specific PostgreSQL instance included in a PostgreSQL restore session.
Perform the following steps:
The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session. In our example, it is the first restore session in the array.
|
Related Commands