Test-MgmtSvcPassphrase

Test-MgmtSvcPassphrase

Validates the passphrase on a configuration database.

Syntax

Parameter Set: Default
Test-MgmtSvcPassphrase -Passphrase <String> [-ConnectionString <String> ] [-Database <String> ] [-Force] [-Password <String> ] [-Server <String> ] [-UserName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]


 

Detailed Description

The Test-MgmtSvcPassphrase cmdlet validates the passphrase that the management service uses to encrypt sensitive data in the configuration database. The passphrase is always valid if it doesn't exist and complies with the complexity requirements. The passphrase should have more than eight characters and contain at least one non-alphanumeric character. Additionally, Test-MgmtSvcPassphrase notifies you whether the passphrase was found.

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

 

-Force

Performs the action without a confirmation message.

 

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

-Passphrase<String>

Specifies a passphrase.

The passphrase should have more than eight characters and contain at least one non-alphanumeric character. Remember to protect the passphrase. You cannot recover the passphrase. You can use this cmdlet to set the passphrase for the first time in a deployment by specifying the Force parameter.

 

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: Validate a passphrase

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

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

 

Related topics

Get-MgmtSvcDatabaseSetting

Set-MgmtSvcDatabaseSetting

Reset-MgmtSvcPassphrase