Set-MgmtSvcPassphrase

Sets the passphrase for a configuration database.

Syntax

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

Parameter Set: ConnectionString
Set-MgmtSvcPassphrase -Passphrase <String> [-ConnectionString <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed 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.

Parameters

-ConnectionString<String>

Specifies an SQL connection string.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Database<String>

Specifies a database name.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Passphrase<String>

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.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Password<String>

Specifies a password.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Server<String>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-UserName<String>

Specifies the name of a user account.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before executing the command.

Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Examples

Example 1: Set a passphrase

This command sets the passphrase for the configuration store on the computer named Contoso01.

PS C:\> Set-MgmtSvcPassphrase -Server "Contoso01" -UserName "sa" -Password '********' -Passphrase '*********'

Set-MgmtSvcPassphrase