Set-DPMCredentials
Updated: January 14, 2013
Applies To: System Center 2012 - Data Protection Manager
Set-DPMCredentials
Syntax
Parameter Set: Default Set-DPMCredentials [[-DPMServerName] <String> ] [-Type] <AuthenticationType> [-Action] <Action> [-OutputFilePath] <String> [[-Thumbprint] <String> ] [[-AuthCAThumbprint] <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-DPMCredentials cmdlet allows you to configure certificate-based authentication for computers you want to protect but are on untrusted domains.
Parameters
-Action<Action>
Indicates the action being performed. This can take the values Configure or Regenerate. Use Configure when using a new certificate and Regenerate to regenerate the output metadata file.
|
Aliases |
none |
|
Required? |
true |
|
Position? |
3 |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-AuthCAThumbprint<String>
Specify the thumbprint of the certifying authority in the trust chain of the certificate. Optional. If not specified, Root will be used.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
6 |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-DPMServerName<String>
Provide the name of the DPM server.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
1 |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-OutputFilePath<String>
Specify the location of the output file (used in Set-DPMServer on protected computer)
|
Aliases |
none |
|
Required? |
true |
|
Position? |
4 |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Thumbprint<String>
Specify the thumbprint to search for the certificate by. Required parameter if Configure is specified as the action.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
5 |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Type<AuthenticationType>
Indicates the type of credential being added. It can take the value Certificate.
|
Aliases |
none |
|
Required? |
true |
|
Position? |
2 |
|
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 |
false |
|
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 |
false |
|
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.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1
This cmdlet will generate a file in c:\CertMetaData\ with name CertificateConfiguration_<DPM SEVER FQDN>.bin.
PS C:\>Set-DPMCredentials -DPMServerName dpmserver.contoso.com -Type Certificate -Action Configure -OutputFilePath c:\CertMetaData\ –Thumbprint “cf822d9ba1c801ef40d4b31de0cfcb200a8a2496”
Example 2
This cmdlet will regenerate the lost configuration file in the folder c:\CertMetaData\.
PS C:\>Set-DPMCredentials -DPMServerName dpmserver.contoso.com -Type Certificate “-OutputFilePath c:\CertMetaData\ -Action Regenerate
