Skip to content

SoftwarePackages.adoc

Latest commit

 

History

History
206 lines (170 loc) · 4.09 KB

SoftwarePackages.adoc

File metadata and controls

206 lines (170 loc) · 4.09 KB

DSC Resource 'SoftwarePackages'

SoftwarePackages installs software packages (MSI or EXE) from local or network paths.

When to use 'SoftwarePackages'

Use this resource when you need to install software from MSI or EXE installer packages on target nodes. It ensures software is installed by checking product codes and supports arguments, credentials, and return code validation. For Chocolatey-based installations, use ChocolateyPackages instead.

Source

DSC Resource

Documentation
Table 1. Attributes of category 'SoftwarePackages'
Parameter Attribute DataType Description Allowed Values

Packages

Mandatory

Hashtable[]

List of software packages
Table 2. Attributes of category 'SoftwarePackages/Packages'
Parameter Attribute DataType Description Allowed Values

Name

Key

String

The name of the package.

ProductId

Key

String

The product ID of the package (usually a GUID).

Ensure

String

Ensures that the package is Present or Absent.

  • Present (default)

  • Absent

Path

String

The source path of the package.

Arguments

String

Command line arguments passed on the installation command line.
When installing MSI packages, the /quiet and /norestart arguments are automatically applied.

IgnoreReboot

Boolean

Ignore a pending reboot if requested by package installation.

  • True

  • False (default)

Credential

PSCredential

PSCredential needed to access Path.

ReturnCode

Uint32[]

An array of return codes that are returned after a successful installation.
Some special return codes of MsiExec can be found online.

LogPath

String

The destination path of the log.

FileHash

String

The hash that should match the hash of the package file.

HashAlgorithm

String

The algorithm to use to get the hash of the package file.

  • SHA1

  • SHA256

  • SHA384

  • SHA512

  • MD5

  • RIPEMD160

SignerSubject

String

The certificate subject that should match that of the package file’s signing certificate.

SignerThumbprint

String

The certificate thumbprint that should match that of the package file’s signing certificate.

ServerCertificateValidationCallback

String

A callback function to validate the server certificate.

RunAsCredential

PSCredential

Credential used to install the package on the local system.

CreateCheckRegValue

Boolean

If a registry value should be created.

  • True

  • False

InstalledCheckRegHive

String

The hive in which to create the registry key.

  • LocalMachine (default)

  • CurrentUser

InstalledCheckRegKey

String

That path in the registry where the value should be created.

InstalledCheckRegValueName

String

The name of the registry value to create.

InstalledCheckRegValueData

String

The data that should be set to the registry value.
Example
SoftwarePackages:
  Packages:
    - Name: Software One
      Path: \\Server\Share\SoftwareOne\SoftwareOne.msi
      ProductId: aa859ee6-4f64-439a-85c0-bc1207886cb6
      ReturnCode: 0
    - Name: Software Two
      Path: \\Server\Share\SoftwareOne\SoftwareTwo.msi
      ProductId: 734f1912-01b1-4f50-8bba-9c3f8912ee8d
      ReturnCode:
        - 0
        - 1641
        - 3010