Set-VBOSecuritySettings

Short Description

Modifies security settings.

Syntax

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

Detailed Description

This cmdlet modifies security settings. These settings specify a TLS 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.

Note

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
CertificateFilePath	Specifies a path to the TLS certificate file.	`String`	True	Named	False
CertificatePassword	Specifies a password for the TLS certificate.	`SecureString`	False	Named	False
Force	Defines that the cmdlet will change security settings without prompting the user to confirm the operation. Default: False	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Output Object

The cmdlet returns the VBOSecuritySettings object that contains security settings.

Examples

Installing New TLS Certificate

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

$plainpassword = "Password1234plain"

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

Set-VBOSecuritySettings -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. Specify the CertificateFilePath parameter value. Provide the Force parameter.

ConvertTo-SecureString