Set-VBOSecuritySettings

In this article

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 connection with backup proxy servers in a workgroup.

To modify settings, you need to enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Set-VBOSecuritySettings 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
CertificateFilePath	Specifies a path to the SSL certificate file.	String	True	Named	False	False
CertificatePassword	Specifies a password for the SSL certificate.	SecureString	False	Named	False	False
Force	Defines that the cmdlet will change security settings without prompting the user to confirm the operation.	SwitchParameter	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

Set-VBOSecuritySettings Example 1. Installing New SSL Certificate

This example shows how to modify security settings, that is, install a new SSL certificate to be used by workgroup backup proxy servers.

$plainpassword = "Password1234plain"

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

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

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.

Related Commands

ConvertTo-SecureString