This is an archive version of the document. To get the most up-to-date information, see the current version.

Set-VBRPostgreSQLProcessingOptions

Short Description

Modifies settings for processing backed-up PostgreSQL databases.

Applies to: Veeam Agent jobs that back up Linux computers

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

Syntax

Set-VBRPostgreSQLProcessingOptions -Options <VBRPostgreSQLProcessingOptions> [-Credentials <CCredentials>] [-UserType {DBUserWithPassword | DBUserWithPasswordFile | SystemUserWithoutPassword}] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings for processing backed-up PostgreSQL database. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Options	Specifies settings for backed-up PostgreSQL database. The cmdlet will modify these settings.	Accepts the VBRPostgreSQLProcessingOptions object. To create this object, run the New-VBRPostgreSQLProcessingOptions cmdlet.	True	Named	True (ByValue)
Credentials	Specifies the PostgreSQL credentials that Veeam Agent will use to connect to the PostgreSQL server.	Accepts the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet.	False	Named	False
UserType	Specifies the PostgreSQL authentication options. You can specify either of the following types of authentication options: DBUserWithPassword: use this option for the password-based authentication. Veeam Agent will use the database login and password to authenticate against the PostgreSQL server. DBUserWithPasswordFile: use this option to authenticate against the PostgreSQL server with the password file. This password file must contain the user name and the password of the database user. SystemUserWithoutPassword: use this option for the peer authentication method. Veeam Agent will use the OS user name to authenticate against the PostgreSQL server. Default: DBUserWithPassword.		False	Named	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Options

Specifies settings for backed-up PostgreSQL database. The cmdlet will modify these settings.

Accepts the VBRPostgreSQLProcessingOptions object. To create this object, run the New-VBRPostgreSQLProcessingOptions cmdlet.

True

Named

True (ByValue)

Credentials

Specifies the PostgreSQL credentials that Veeam Agent will use to connect to the PostgreSQL server.

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

False

Named

False

UserType

Specifies the PostgreSQL authentication options. You can specify either of the following types of authentication options:

DBUserWithPassword: use this option for the password-based authentication. Veeam Agent will use the database login and password to authenticate against the PostgreSQL server.
DBUserWithPasswordFile: use this option to authenticate against the PostgreSQL server with the password file. This password file must contain the user name and the password of the database user.
SystemUserWithoutPassword: use this option for the peer authentication method. Veeam Agent will use the OS user name to authenticate against the PostgreSQL server.

Default: DBUserWithPassword.

False

Named

False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

This cmdlet returns the VBRPostgreSQLProcessingOptions object that contains settings for processing backed-up PostgreSQL databases.

Examples

Modifying PostgreSQL Authentication Options

This example shows how to modify the PostgreSQL authentication options. Veeam Agent will use the peer authentication option.

$options = New-VBRPostgreSQLProcessingOptions

Set-VBRPostgreSQLProcessingOptions -Options $options -UserType SystemUserWithoutPassword

Perform the following steps:

Run the New-VBRPostgreSQLProcessingOptions cmdlet. Save the result to the $options variable.
Run the Set-VBRPostgreSQLProcessingOptions cmdlet. Set the $options variable as the Options parameter value. Specify the UserType parameter value.

Related Commands

New-VBRPostgreSQLProcessingOptions