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

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 the 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

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

Examples

Example 1

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:

Assign your certificate password to the $plainpassword variable.
Run the ConvertTo-SecureString cmdlet with the $plainpassword variable to set the password to the SecureString type. Save the result to the $securepassword variable.
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