Edit

Share via

New-DscChecksum

  • Reference
Module:
PSDesiredStateConfiguration

Creates checksum files for DSC documents and DSC resources.

Syntax

New-DscChecksum
   [-Path] <String[]>
   [[-OutPath] <String>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-DSCCheckSum cmdlet generates checksum files for PowerShell Desired State Configuration (DSC) documents and compressed DSC resources. This cmdlet generates a checksum file for each configuration and resource to be used in pull mode. The DSC service uses the checksums to make sure that the correct configuration and resources exist on the target node. Place the checksums together with the associated DSC documents and compressed DSC resources in the DSC service store.

Examples

Example 1: Create checksum files for all configurations in a specific path

PS C:\> New-DscCheckSum -Path "C:\DSC\Configurations\"

This command creates checksum files for all configurations in the path C:\DSC\Configurations. Any checksum files that already exist are skipped.

Example 2: Create checksum files for all configurations in a specific path and overwrite the existing checksum files

PS C:\> New-DscCheckSum -Path "C:\DSC\Configurations\" -Force

This command creates new checksum files for all configurations in the path C:\DSC\Configurations. Specifying the Force parameter causes the command to overwrite any checksum files that already exist.

Parameters

-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

-Force

Indicates that the cmdlet overwrites the specified output file if it already exists.

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

-OutPath

Specifies the path and file name of the output checksum file.

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

-Path

Specifies the path of the input file.

Type:String[]
Aliases:ConfigurationPath
Position:0
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

Inputs

None

Outputs

Object