Set-VBOSecuritySettings

Short Description

Modifies security settings.

Syntax

Set-VBOSecuritySettings [-CertificateFilePath <String>] [-CertificatePassword <SecureString>] [-Force <SwitchParameter>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies security settings. These settings specify an SSL certificate used to establish a connection with backup proxy servers in a workgroup.

Set-VBOSecuritySettings 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

CertificateFilePath

Specifies a path to the SSL certificate file.

True

Named

False

False

CertificatePassword

Specifies the password for the SSL certificate.

False

Named

False

False

Force

Defines that the cmdlet will change security settings without prompting the userto confirm the operation.

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 security settings, that is, install a new SSL certificate to be used by workgroup backup proxy servers.

You must perform the following steps:

  1. Assign your certificate password to the $plainpassword variable.
  2. Run the ConvertTo-SecureString cmdlet with the $plainpassword variable to set the password to the SecureString type. Save the result to the $securepassword variable.
  3. Run the Set-VBOSecuritySettings cmdlet with the $securepassword variable.

$plainpassword = "Password1234plain"

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

Set-VBORestAPISettings -CertificateFilePath "C:\Certificates" -CertificatePassword $securepassword -Force

I want to report a typo

There is a misspelling right here:

 

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