New-DscChecksum
Creates checksum files for DSC documents and DSC resources.
Syntax
Default (Default)
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
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.
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 |
-Force
Indicates that the cmdlet overwrites the specified output file if it already exists.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-OutPath
Specifies the path and file name of the output checksum file.
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 |
-Path
Specifies the path of the input file.
Parameter properties
Type: | String[] |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | ConfigurationPath |
Parameter sets
(All)
Position: | 0 |
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.