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

New-VBRPostgreSQLProcessingOptions

Short Description

Defines settings for processing backed-up PostgreSQL databases on Linux computers.

Applies to:

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

Syntax

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

Detailed Description

This cmdlet applies to Veeam Agent jobs that back up Linux computers.

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

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
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.	VBRPostgreSQLUserType	False	Named	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

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.

VBRPostgreSQLUserType

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

Defining Settings for Processing Backed-up PostgreSQL Databases

This example shows how to define settings for processing backed-up PostgreSQL databases.

$creds = Get-VBRCredentials -Name *Administrator*

New-VBRPostgreSQLProcessingOptions -Credentials $creds

Perform the following steps:

Run the Get-VBRCredentials cmdlet. Specify the Name parameter value. Save the result to the $creds variable.
Run the New-VBRPostgreSQLProcessingOptions cmdlet. Set the $creds variable as the Credentials parameter value.

Related Commands

Get-VBRCredentials