Veeam Backup for Microsoft Office 365 4.0
PowerShell Reference
Related documents

Set-VBOBackupApplication

Short Description

Modifies backup application settings that are added to Microsoft organizations.

Syntax

Set-VBOBackupApplication -BackupApplication <VBOBackupApplication> -ApplicationCertificatePath <string> [-ApplicationCertificatePassword <securestring>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies backup application settings that are added to Microsoft organizations. The backup application represents settings of an Azure AD application. You may want to use these settings to reduce throttling when you back up SharePoint and OneDrive for Business data.

Set-VBOBackupApplication Important!

  • This cmdlet is available only in Veeam Backup for Microsoft Office 365 version 4c.
  • This cmdlet will run only for Microsoft organizations that are added to the Veeam Backup for Microsoft Office 365 infrastructure with the Multi-factor authentication method.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

BackupApplication

Specifies backup application settings. The cmdlet will modify these settings.

Accepts the VBOBackupApp  lication object. To get this object, run the Get-VBOBackupApplication cmdlet.

True

Named

False

ApplicationCertificatePath

Specifies a path to the folder where the certificate is located. The cmdlet will modify the path to the certificate in the backup application settings.

String

False

Named

False

ApplicationCertificatePassword

Specifies the certificate password. The cmdlet will modify the password in the backup application settings.

SecureStrig

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the VBOBackupApplication object that contains backup application settings that are added to Microsoft organizations.

Examples

Set-VBOBackupApplicationExample 1. Modifying Path to Backup Application Certificate

This examples shows how to modify the path to the folder where the certificate is located. The cmdlet will change it to the C:\NewCertificate\cert.pfx value.

$securepassword = Read-Host "Enter your password" -AsSecureString

Enter your password: **********

$app = Get-VBOBackupApplication

Set-VBOBackupApplication -BackupApplication $app -ApplicationCertificatePath "C:\NewCertificate\cert.pfx"

Perform the following steps:

  1. Specify the secure password.
  1. Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
  2. Enter the password.
  1. Run the Get-VBOBackupApplication cmdlet. Save the result to the $app variable.
  2. Run the Set-VBOBackupApplication cmdlet. Specify the following settings:
  • Set the $app variable as the BackupApplication parameter value.
  • Specify the ApplicationCertificatePath parameter value.
  • Set the $securepassword variable as the ApplicationCertificatePassword parameter value.

Set-VBOBackupApplicationExample 2. Modifying Certificate Password of Backup Application

This examples shows how to modify the certificate password of the backup application.

$securepassword = Read-Host "Enter your password" -AsSecureString

Enter your password: **********

$app = Get-VBOBackupApplication

Set-VBOBackupApplication -BackupApplication $app -ApplicationCertificatePath "C:\certificate\cert.pfx" -ApplicationCertificatePassword $securepassword

Perform the following steps:

  1. Specify the secure password.
  1. Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
  2. Enter the password.
  1. Run the Get-VBOBackupApplication cmdlet. Save the result to the $app variable.
  2. Run the Set-VBOBackupApplication cmdlet. Specify the following settings:
  • Set the $app variable as the BackupApplication parameter value.
  • Specify the ApplicationCertificatePath parameter value.
  • Set the $securepassword variable as the ApplicationCertificatePassword parameter value.

Related Commands

This Document Help Center
User GuideRESTful API ReferencePowerShell ReferenceVeeam Explorers User GuideVeeam Explorers PowerShell Reference
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.