Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 3.0
PowerShell Reference

Set-VBOTenantAuthenticationSettings

Short Description

Modifies Veeam Backup for Microsoft Office 365 tenant authentication settings.

Syntax

Set-VBOTenantAuthenticationSettings [-EnableAuthentication] [-CertificateFilePath <string>] [-CertificatePassword <securestring>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies tenant authentication settings configured for Veeam Backup for Microsoft Office 365.

Set-VBOTenantAuthenticationSettings Note:

This cmdlet accepts SecureString type. Use Microsoft PowerShell standard capabilities to convert your password into the SecureString.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Enable
Authentication

Indicates that the cmdlet will enable tenant authentication for Veeam Backup for Microsoft Office 365 server.

False

Named

False

False

CertificateFilePath

Specifies the path to the tenant authentication certificate file.

False

Named

False

False

Certificate
Password

Specifies the password for the tenant authentication certificate.

False

Named

False

False

<CommonParameters>

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

Example

This example shows how to modify tenant authentication settings.

  1. Assign your certificate password to the $plainpassword variable.
  2. Run ConvertTo-SecureString with the $plainpassword variable to turn the password into SecureString type. Save the result to the $securepassword variable.
  3. Run Set-VBOTenantAuthenticationSettings with the $securepassword variable and EnableAuthentication parameter.

The password is turned into a SecureString by running ConvertTo-SecureString and assigned to the $securepassword variable.

$plainpassword = "Password1234plain"

$securepassword = $plainpassword | ConvertTo-SecureString -AsPlainText -Force

Set-VBOTenantAuthenticationSettings -EnableAuthentication -CertificateFilePath "C:\cert.pfx" -CertificatePassword $securepassword

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference