Share via

Set-DPMCredentials

Module:
DataProtectionManager Module

Configures authentication for computers in untrusted domains.

Syntax

Default (Default) 

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.

Parameter properties

Type:Action
Default value:None
Accepted values:Configure, Regenerate
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:6
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DPMServerName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:4
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:5
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Type

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

Parameter properties

Type:AuthenticationType
Default value:None
Accepted values:Certificate
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.