Share via

Set-DPMCredentials

  • Reference
Module:
DataProtectionManager

Configures authentication for computers in untrusted domains.

Syntax

Set-DPMCredentials
   [[-DPMServerName] <String>]
   [-Type] <AuthenticationType>
   [-Action] <Action>
   [-OutputFilePath] <String>
   [[-Thumbprint] <String>]
   [[-AuthCAThumbprint] <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-DPMCredentials cmdlet configures certificate-based authentication for computers for System Center - Data Protection Manager (DPM) to protect that are in untrusted domains.

Examples

Example 1: Configure authentication with a new certificate

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

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.

Example 2: Configure authentication with a regenerated configuration file

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

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

Parameters

-Action

Specifies the action to perform.

The acceptable values for this parameter are:

  • Configure. Use a new certificate.
  • Regenerate. Regenerate the output metadata file.
Type:Action
Accepted values:Configure, Regenerate
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-AuthCAThumbprint

Specifies the thumbprint of a certifying authority in the trust chain of the certificate. If you do not specify this parameter, DPM uses the value Root.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DPMServerName

Specifies the name of the DPM server on which this cmdlet acts.

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

-OutputFilePath

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.

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

-Thumbprint

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.

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

-Type

Specifies the type of credential that this cmdlet adds. This parameter accepts only the value Certificate.

Type:AuthenticationType
Accepted values:Certificate
Position:2
Default value:None
Required:True
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
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False