Set-MgmtSvcPassphrase

Sets the passphrase for a configuration database.

Syntax

Set-MgmtSvcPassphrase [-Confirm] [-ConnectionString <String>] -Passphrase <String> [-WhatIf]
 [<CommonParameters>]
Set-MgmtSvcPassphrase [-Confirm] [-Database <String>] -Passphrase <String> [-Password <String>]
 [-Server <String>] [-UserName <String>] [-WhatIf] [<CommonParameters>]

Description

The Set-MgmtSvcPassphrase cmdlet sets the passphrase that the management service uses to encrypt sensitive data in the configuration database.

A passphrase can only be set once.
To replace the passphrase, use the Reset-MgmtSvcPassPhrase cmdlet.

You can run this cmdlet from any computer in the deployment.
However, this cmdlet assumes that the database is on the local computer.
If the database is on another computer, you must use the Server, UserName, Password, and Database parameters, or a SQL connection string.
If you specify a connection string by using the ConnectionString parameter, that value takes precedence over the Server, UserName, Password, and Database parameters.

Examples

Example 1: Set a passphrase

PS C:\> Set-MgmtSvcPassphrase -Server "Contoso01" -UserName "sa" -Password '********' -Passphrase '*********'
This command sets the passphrase for the configuration store on the computer named Contoso01.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionString

Specifies an SQL connection string.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Database

Specifies a database name.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Passphrase

Specifies a passphrase.

The passphrase must contain at least eight characters and contain at least one non-alphanumeric character.
Remember to protect the passphrase.
You cannot recover the passphrase.

Type:String
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Password

Specifies a password.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-Server

Specifies the name of the computer on which the SQL database resides.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-UserName

Specifies the name of a user account.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs.
The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False