Resource Type: dsc_xpackage

Properties

dsc_arguments

The arguments to be passed to the package during addition or removal. When installing MSI packages, the ‘/quiet’ and ‘/norestart’ arguments are automatically applied.
dsc_createcheckregvalue

Specifies if a registry value should be created when the packages is installed.
dsc_ensure

Indicates whether to Ensure that the package is ‘Present’ or ‘Absent’. Defaults to ‘Present’.
dsc_filehash

The expected hash value of the file found in the Path location.
dsc_hashalgorithm

The algorithm used to generate the FileHash value. Defaults to ‘SHA256’.
dsc_ignorereboot

Ignore a pending reboot if requested by package installation. The default value is $false and DSC will try to reboot the system.
dsc_installed

Whether the identified package is installed.
dsc_installedcheckreghive

The hive in which to create the registry key. Defaults to ‘LocalMachine’.
dsc_installedcheckregkey

The registry key to validate the package is installed.
dsc_installedcheckregvaluedata

The registry value to validate the package is installed.
dsc_installedcheckregvaluename

The registry value name to validate the package is installed.
dsc_installedon

The date that the identified package was last serviced or its install date, whichever is later.
dsc_logpath

The path to log the output of the MSI or EXE.
dsc_packagedescription

The description of the identified package.
dsc_path

The path, URL or UNC path to the package.
dsc_publisher

The publisher for the identified package.
dsc_returncode

The list of possible valid return codes for this install or removal.
dsc_servercertificatevalidationcallback

PowerShell code used to validate SSL certificates of HTTPS url assigned to Path.
dsc_signersubject

The subject that must match the signer certificate of the digital signature. Wildcards are allowed.
dsc_signerthumbprint

The certificate thumbprint which must match the signer certificate of the digital signature.
dsc_size

The size of the identified package.
dsc_version

The version number of the identified package.

Parameters

dsc_credential

The credentials to be used for mounting the UNC path (if applicable).
dsc_name (namevar)

The name of the package to be added or removed.
dsc_productid (namevar)

The identifying number used to uniquely identify this package.
dsc_psdscrunascredential
dsc_runascredential

The credentials under which to run the installation.
dsc_timeout

The maximum time in seconds to wait for the DSC resource to complete.
name (namevar)

Description of the purpose for this resource declaration.
validation_mode (defaults to: property)

Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).

Overview