New-DSCCheckSum

New-DSCCheckSum

Creates checksum files for DSC documents and DSC resources.

Syntax

Parameter Set: Default
New-DSCCheckSum [-Path] <String[]> [[-OutPath] <String> ] [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The New-DSCCheckSum cmdlet generates checksum files for Windows 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.

Parameters

-Force

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-OutPath<String>

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


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Path<String[]>

Specifies the path of the input file.


Aliases

ConfigurationPath

Required?

true

Position?

1

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: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

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: Create checksum files for all configurations in a specific path

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


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

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

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.


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

Related topics

Community Additions

ADD
Show: