Set-DPMCredentials

Article
07/28/2015

Set-DPMCredentials

Configures certificate-based authentication for computers on untrusted domains.

Syntax

Parameter Set: Default
Set-DPMCredentials [[-DPMServerName] <String> ] [-Type] <AuthenticationType> {Certificate} [-Action] <Action> {Configure | Regenerate} [-OutputFilePath] <String> [[-Thumbprint] <String> ] [[-AuthCAThumbprint] <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-DPMCredentials cmdlet configures certificate-based authentication for computers that you want to protect but that are in untrusted domains.

Parameters

-Action<Action>

Specifies the action to perform. Valid values for this parameter are:

-- Configure: the configuration uses a new certificate
-- Regenerate: the configuration regenerates the output metadata file

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

-AuthCAThumbprint<String>

Specifies the thumbprint of a certifying authority in the trust chain of the certificate. If you do not specify this parameter, System Center 2012 – Data Protection Manager (DPM) uses the value Root.

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

-DPMServerName<String>

Specifies 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>

Specifies the location of the output file. Specify this path by using the Set-DPMServer tool to complete configuration for protection agents on the DPM server.

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

-Thumbprint<String>

Specifies the thumbprint to use when you search for the certificate. You must specify this parameter if you specify Configure as the value for the Action parameter.

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

-Type<AuthenticationType>

Specifies the type of credential that you are adding. This parameter only accepts the single 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 running the cmdlet.

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

-WhatIf

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

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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).

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: Configure authentication with a new certificate

This command configures authentication for the DPM server named Dpmserver.Contoso.com. The command creates a file in the folder C:\CertMetaData\ with the name CertificateConfiguration_<DPM-server-FQDN>.bin.

PS C:\> Set-DPMCredentials -DPMServerName "Dpmserver.Contoso.com" -Type Certificate -Action Configure -OutputFilePath "C:\CertMetaData\" –Thumbprint "cf822d9ba1c801ef40d4b31de0cfcb200a8a2496"

Example 2: Configure authentication with a regenerated configuration file

This cmdlet configures the DPM server named Dpmserver.Contoso.com by regenerating the lost configuration file in the folder C:\CertMetaData\.

PS C:\> Set-DPMCredentials -DPMServerName "Dpmserver.Contoso.com" -Type Certificate -OutputFilePath "C:\CertMetaData\" -Action Regenerate

Set-DPMCredentials