---
title: "Start-VEPSQLInstancePublish"
description: "Publishes a backed-up PostgreSQL instance. Product: Veeam Backup & Replication Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License This cmdlet provides the following parameter sets: This cmdlet publishes a b"
canonical: "https://helpcenter.veeam.com/docs/vbr/explorers_powershell/start-vepsqlinstancepublish.html"
breadcrumb: "Veeam Explorers PowerShell Reference > Veeam Explorers PowerShell Reference > Veeam Explorer for PostgreSQL > Start-VEPSQLInstancePublish"
dateModified: "2026-08-18"
---

# Start-VEPSQLInstancePublish

## Short Description
Publishes a backed-up PostgreSQL instance.

**Product**: Veeam Backup & Replication

**Product Edition**: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

## Syntax

This cmdlet provides the following parameter sets:

<ul class="syntax-sets">
  <li>
    <p><code>PublishToLinuxTarget</code></p>

```
Start-VEPSQLInstancePublish [-Instance] <VEPSQLInstance> [[-ToPointInTimeUTC] <DateTime>]
 [-LinuxCredentials <VEPSQLLinuxCredential>] [-ServerName <String>] [-SshPort <Int32>] [-Force] [-Port <Int32>] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>PublishToWindowsTarget</code></p>

```
Start-VEPSQLInstancePublish [-Instance] <VEPSQLInstance> [[-ToPointInTimeUTC] <DateTime>]
 [-WindowsCredentials <PSCredential>] [-ServerName <String>] [-Force] [-Port <Int32>] [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
This cmdlet publishes a backed-up PostgreSQL instance.

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Force</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will replace the target PostgreSQL instance with the instance from the backup.</p><p><strong>Note</strong>: The cmdlet will show no prompt before executing the command.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Instance</span></p>
        </td>
        <td>
          <p>Specifies a PostgreSQL instance that the cmdlet will publish.</p><p>Accepts the <a href="vepsqlinstance.md"><code>VEPSQLInstance</code></a> object. To get this object, run the <a href="get-vepsqlinstance.md"><code>Get-VEPSQLInstance</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vepsqlinstance.md"><code>VEPSQLInstance</code></a></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>0</p>
        </td>
        <td style="width:10%;">
          <p>True (ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">LinuxCredentials</span></p>
        </td>
        <td>
          <p>Specifies Linux credentials that the cmdlet will use to connect to the Linux machine.</p><p>Accepts the <a href="vepsqllinuxcredential.md"><code>VEPSQLLinuxCredential</code></a> object. To get this object, run the <a href="new-vepsqllinuxcredential.md"><code>New-VEPSQLLinuxCredential</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vepsqllinuxcredential.md"><code>VEPSQLLinuxCredential</code></a></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Port</span></p>
        </td>
        <td>
          <p>Specifies the port to connect to the published PostgreSQL instance.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ServerName</span></p>
        </td>
        <td>
          <p>Specifies DNS name or IP address of the target PostgreSQL server. The cmdlet will publish a PostgreSQL instance to that server.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">SshPort</span></p>
        </td>
        <td>
          <p>Specifies the SSH port number. The cmdlet will use this port to connect to the Linux machine.</p><p>Default: <em>22</em></p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ToPointInTimeUTC</span></p>
        </td>
        <td>
          <p>Specifies a point in time in the UTC format within the restore interval of the PostgreSQL instance.</p><p>The cmdlet will publish the instance to the state of the specified point in time.</p>
        </td>
        <td style="width:10%;">
          <p><code>DateTime</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>1</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">WindowsCredentials</span></p>
        </td>
        <td>
          <p>Specifies Windows credentials that the cmdlet will use to connect to the Windows machine.</p><p>Accepts the <code>PSCredential</code> object. To get this object, run the[`Get-Credential`](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/get-credential?view=powershell-7.6) cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>PSCredential</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByValue)</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the [About Common Parameters](http://go.microsoft.com/fwlink/p/?LinkID=113216) section of Microsoft Docs.

## Output Object
The cmdlet returns the [`VEPSQLInstancePublish`](vepsqlinstancepublish.md)`[]` array that contains information about the publishing process for the PostgreSQL instance.

## Examples

::: example
### Example 1. Publishing PostgreSQL Instance to Linux Machine

This example shows how to publish a backed-up PostgreSQL instance to a Linux machine with PostgreSQL.

```
$session = Get-VEPSQLRestoreSession
$instance = Get-VEPSQLInstance -Session $session[0]
$securepassword = Read-Host -Prompt "Enter password" -AsSecureString
$linuxcreds = New-VEPSQLLinuxCredential -Account "root" -Password $securepassword
Start-VEPSQLInstancePublish -Instance $instance -LinuxCredentials $linuxcreds
```

Perform the following steps:

1. Get the restore session:

   1. Run the [`Get-VEPSQLRestoreSession`](get-vepsqlrestoresession.md) cmdlet. Save the result to the `$session` variable.

      The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session. In this example, it is the first restore session in the array.

   2. Run the [`Get-VEPSQLInstance`](get-vepsqlinstance.md) cmdlet. Set the `$session` variable as the `Session` parameter value. Save the result to the `$instance` variable.

2. Get Linux credentials:

   1. Run the [`Read-Host`](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/read-host?view=powershell-7.6) cmdlet. Specify the `Prompt` parameter value. Provide the `AsSecureString` parameter. Save the result to the `$securepassword` variable.
   2. Run the [`New-VEPSQLLinuxCredential`](new-vepsqllinuxcredential.md) cmdlet. Specify the `Account` parameter value. Set the `$securepassword` variable as the `Password` parameter value.

3. Run the `Start-VEPSQLInstancePublish` cmdlet. Specify the following settings:

   - Set the `$instance` variable as the `Instance` parameter value.
   - Set the `$linuxcreds` variable as the `LinuxCredentials` parameter value.

:::

::: example
### Example 2. Publishing PostgreSQL Instance to Windows Machine

This example shows how to publish a backed-up PostgreSQL instance to a Windows machine with PostgreSQL.

```
$session = Get-VEPSQLRestoreSession
$instance = Get-VEPSQLInstance -Session $session[0]
$windowscreds = Get-Credential
Start-VEPSQLInstancePublish -Instance $instance -WindowsCredentials $windowscreds
```

Perform the following steps:

1. Get the restore session:

   1. Run the [`Get-VEPSQLRestoreSession`](get-vepsqlrestoresession.md) cmdlet. Save the result to the `$session` variable.

      The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session. In this example, it is the first restore session in the array.

   2. Run the [`Get-VEPSQLInstance`](get-vepsqlinstance.md) cmdlet. Set the `$session` variable as the `Session` parameter value. Save the result to the `$instance` variable.

2. Run the [`Get-Credential`](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/get-credential?view=powershell-7.6) cmdlet to create a credential object. Enter credentials that will be used for authenticating to the target PostgreSQL machine. Save the result to the `$credential` variable.
3. Run the `Start-VEPSQLInstancePublish` cmdlet. Specify the following settings:

   - Set the `$instance` variable as the `Instance` parameter value.
   - Set the `$windowscreds` variable as the `WindowsCredentials` parameter value.

:::

## Related Commands

- [`Get-VEPSQLRestoreSession`](get-vepsqlrestoresession.md)
- [`Get-VEPSQLInstance`](get-vepsqlinstance.md)
- [``Read-Host``](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/read-host?view=powershell-7.6)
- [`New-VEPSQLLinuxCredential`](new-vepsqllinuxcredential.md)
- [``Get-Credential``](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/get-credential?view=powershell-7.6)