Stop-VEPSQLInstancePublish

Short Description

Unpublishes a PostgreSQL instance from the target server.

Applies to

Veeam Backup & Replication

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

Syntax

Stop-VEPSQLInstancePublish [-InstancePublish] <VEPSQLInstancePublish> [-Force <SwitchParameter>] [<CommonParameters>]

Detailed Description

This cmdlet unpublishes a PostgreSQL instance from the target server.

Stop-VEPSQLInstancePublish Note:

  • The cmdlet stops publishing sessions initiated in the PowerShell console only.
  • Publishing sessions will not stop automatically if you close the PowerShell console. To stop a publishing session, you must run the Stop-VEPSQLInstancePublish cmdlet.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

InstancePublish

Specifies the publishing process for a PostgreSQL instance. The cmdlet will stop the process and unpublish the instance from the target PostgreSQL server.

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

True

0

True

Force

Defines that the cmdlet will show no prompt before executing the command.

SwitchParameter

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.

Example

Stopping Publishing Process for a PostgreSQL Instance

This example shows how to unpublish a PostgreSQL instance.

$publish = Get-VEPSQLInstancePublish -InstanceName "rhel01:5433"

Stop-VEPSQLInstancePublish -InstancePublish $publish

Perform the following steps:

  1. Run the Get-VEPSQLInstancePublish cmdlet. Specify the InstanceName parameter value and save the result to the $publish variable.
  2. Run the Stop-VEPSQLInstancePublish cmdlet. Set the $publish variable as the InstancePublish parameter value.

Related Commands

Get-VEPSQLInstancePublish

Page updated 9/27/2023

Page content applies to build 12.1.1.56