Set-VBOTenantAuthenticationSettings

Short Description

Modifies Veeam Backup for Microsoft 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 365. To modify settings, you need to enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Set-VBOTenantAuthenticationSettings Note

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

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

EnableAuthentication

Defines that the cmdlet will enable tenant authentication to the Veeam Backup for Microsoft 365 server with organization credentials.

SwitchParameter

False

Named

False

False

CertificateFilePath

Specifies the path to the tenant authentication certificate file.

String

False

Named

False

False

CertificatePassword

Specifies the password for the tenant authentication certificate.

SecureString

False

Named

False

False

<CommonParameters>

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

Examples

Set-VBOTenantAuthenticationSettingsExample 1. Modifying Tenant Authentication Settings

This example shows how to modify tenant authentication settings.

$plainpassword = "Password1234plain"

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

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

Perform the following steps:

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

Related Commands

ConvertTo-SecureString