psdscresources

This module contains the standard DSC resources.

21,178 downloads

2,629 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 2.12.0-0-9 (latest)
  • 2.12.0-0-8
  • 2.12.0-0-7
  • 2.12.0-0-6
  • 2.12.0-0-5
  • 2.12.0-0-4
  • 2.12.0-0-3
  • 2.12.0-0-2
  • 2.12.0-0-14
  • 2.12.0-0-13
  • 2.12.0-0-12
  • 2.12.0-0-11
  • 2.12.0-0-10
  • 2.12.0-0-1
  • 2.12.0-0-0
  • 2.11.0-0-3
  • 2.11.0-0-2
  • 2.11.0-0-1
  • 2.11.0-0-0
  • 2.10.0-0-3
  • 2.10.0-0-2
  • 2.10.0-0-1
  • 2.10.0-0-0
  • 2.9.0-0-3
  • 2.9.0-0-2
  • 2.9.0-0-1
  • 2.9.0-0-0
  • 2.8.0-0-3
  • 2.8.0-0-2
  • 2.8.0-0-1
  • 2.8.0-0-0
  • 2.7.0-0-3
  • 2.7.0-0-2
  • 2.7.0-0-1
  • 2.7.0-0-0
  • 2.6.0-0-3
  • 2.6.0-0-2
  • 2.6.0-0-1
  • 2.6.0-0-0
  • 2.5.0-0-3
  • 2.5.0-0-2
  • 2.5.0-0-1
  • 2.5.0-0-0
  • 2.4.0-0-3
  • 2.4.0-0-2
  • 2.4.0-0-1
  • 2.4.0-0-0
  • 2.3.0-0-3
  • 2.3.0-0-2
  • 2.3.0-0-1
  • 2.3.0-0-0
  • 2.2.0-0-3
  • 2.2.0-0-2
  • 2.2.0-0-1
  • 2.2.0-0-0
  • 2.1.0-0-3
  • 2.1.0-0-2
  • 2.1.0-0-1
  • 2.1.0-0-0
  • 2.0.0-0-3
  • 2.0.0-0-2
  • 2.0.0-0-1
  • 2.0.0-0-0
released Nov 13th 2023
This version is compatible with:
  • Puppet Enterprise 2025.3.x, 2025.2.x, 2025.1.x, 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
  • Puppet >= 7.0.0 < 9.0.0

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'dsc-psdscresources', '2.12.0-0-9'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add dsc-psdscresources
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install dsc-psdscresources --version 2.12.0-0-9

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

dsc/psdscresources — version 2.12.0-0-9 Nov 13th 2023

Reference

Table of Contents

Resource types

  • dsc_archive: The DSC Archive resource type. Automatically generated from version 2.12.0.0
  • dsc_environment: The DSC Environment resource type. Automatically generated from version 2.12.0.0
  • dsc_group: The DSC Group resource type. Automatically generated from version 2.12.0.0
  • dsc_groupset: The DSC resource type. Automatically generated from version 2.12.0.0
  • dsc_msipackage: The DSC MsiPackage resource type. Automatically generated from version 2.12.0.0
  • dsc_processset: The DSC resource type. Automatically generated from version 2.12.0.0
  • dsc_registry: The DSC Registry resource type. Automatically generated from version 2.12.0.0
  • dsc_script: The DSC Script resource type. Automatically generated from version 2.12.0.0
  • dsc_service: The DSC Service resource type. Automatically generated from version 2.12.0.0
  • dsc_serviceset: The DSC resource type. Automatically generated from version 2.12.0.0
  • dsc_user: The DSC User resource type. Automatically generated from version 2.12.0.0
  • dsc_windowsfeature: The DSC WindowsFeature resource type. Automatically generated from version 2.12.0.0
  • dsc_windowsfeatureset: The DSC resource type. Automatically generated from version 2.12.0.0
  • dsc_windowsoptionalfeature: The DSC WindowsOptionalFeature resource type. Automatically generated from version 2.12.0.0
  • dsc_windowsoptionalfeatureset: The DSC resource type. Automatically generated from version 2.12.0.0
  • dsc_windowspackagecab: The DSC WindowsPackageCab resource type. Automatically generated from version 2.12.0.0
  • dsc_windowsprocess: The DSC WindowsProcess resource type. Automatically generated from version 2.12.0.0

Resource types

dsc_archive

The DSC Archive resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_archive type.

dsc_checksum

Data type: Optional[Enum['SHA-1', 'sha-1', 'SHA-256', 'sha-256', 'SHA-512', 'sha-512', 'CreatedDate', 'createddate', 'ModifiedDate', 'modifieddate']]

The Checksum method to use to validate whether or not a file at the destination with the same name as a file in the archive actually matches that corresponding file in the archive. An invalid argument exception will be thrown if Checksum is specified while Validate is specified as false. ModifiedDate will check that the LastWriteTime property of the file at the destination matches the LastWriteTime property of the file in the archive. CreatedDate will check that the CreationTime property of the file at the destination matches the CreationTime property of the file in the archive. SHA-1, SHA-256, and SHA-512 will check that the hash of the file at the destination by the specified SHA method matches the hash of the file in the archive by the specified SHA method. The default value is ModifiedDate.

dsc_ensure

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

Specifies whether or not the expanded content of the archive file at the specified path should exist at the specified destination. To update the specified destination to have the expanded content of the archive file at the specified path, specify this property as Present. To remove the expanded content of the archive file at the specified path from the specified destination, specify this property as Absent. The default value is Present.

Parameters

The following parameters are available in the dsc_archive type.

dsc_credential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

The credential of a user account with permissions to access the specified archive path and destination if needed.

dsc_destination

namevar

Data type: String

The path where the specified archive file should be expanded to or removed from.

dsc_force

Data type: Optional[Boolean]

Specifies whether or not any existing files or directories at the destination with the same name as a file or directory in the archive should be overwritten to match the file or directory in the archive. When this property is false, an error will be thrown if an item at the destination needs to be overwritten. The default value is false.

dsc_path

namevar

Data type: String

The path to the archive file that should be expanded to or removed from the specified destination.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

dsc_validate

Data type: Optional[Boolean]

Specifies whether or not to validate that a file at the destination with the same name as a file in the archive actually matches that corresponding file in the archive by the specified checksum method. If the file does not match and Ensure is specified as Present and Force is not specified, the resource will throw an error that the file at the desintation cannot be overwritten. If the file does not match and Ensure is specified as Present and Force is specified, the file at the desintation will be overwritten. If the file does not match and Ensure is specified as Absent, the file at the desintation will not be removed. The default value is false.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_environment

The DSC Environment resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_environment type.

dsc_ensure

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

Specifies if the environment varaible should exist.

dsc_path

Data type: Optional[Boolean]

Indicates whether or not the environment variable is the Path variable.

dsc_target

Data type: Optional[Array[Enum['Process', 'process', 'Machine', 'machine']]]

Indicates the target where the environment variable should be set.

dsc_value

Data type: Optional[String]

The desired value for the environment variable.

Parameters

The following parameters are available in the dsc_environment type.

dsc_name

namevar

Data type: String

The name of the environment variable for which you want to ensure a specific state.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_group

The DSC Group resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_group type.

dsc_description

Data type: Optional[String]

The description the group should have.

dsc_ensure

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

Indicates if the group should exist or not.

dsc_members

Data type: Optional[Array[String]]

The members the group should have.

dsc_memberstoexclude

Data type: Optional[Array[String]]

The members the group should exclude.

dsc_memberstoinclude

Data type: Optional[Array[String]]

The members the group should include.

Parameters

The following parameters are available in the dsc_group type.

dsc_credential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

A credential to resolve non-local group members.

dsc_groupname

namevar

Data type: String

The name of the group to create, modify, or remove.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_groupset

The DSC resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_groupset type.

dsc_credential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

dsc_ensure

Data type: Optional[String]

dsc_memberstoexclude

Data type: Optional[Array[String]]

dsc_memberstoinclude

Data type: Optional[Array[String]]

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

Parameters

The following parameters are available in the dsc_groupset type.

dsc_groupname

namevar

Data type: Array[String]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_msipackage

The DSC MsiPackage resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_msipackage type.

dsc_arguments

Data type: Optional[String]

The arguments to be passed to the MSI package during installation or uninstallation.

dsc_ensure

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

Specifies whether or not the MSI file should be installed or uninstalled.

dsc_filehash

Data type: Optional[String]

The expected hash value of the MSI file at the given path.

dsc_hashalgorithm

Data type: Optional[Enum['SHA1', 'sha1', 'SHA256', 'sha256', 'SHA384', 'sha384', 'SHA512', 'sha512', 'MD5', 'md5', 'RIPEMD160', 'ripemd160']]

The algorithm used to generate the given hash value.

dsc_installedon

Data type: Optional[String]

The date that the MSI package was installed on or serviced on, whichever is later.

dsc_installsource

Data type: Optional[String]

The path to the MSI package.

dsc_logpath

Data type: Optional[String]

The path to the log file to log the output from the MSI execution.

dsc_name

Data type: Optional[String]

The display name of the MSI package.

dsc_packagedescription

Data type: Optional[String]

The description of the MSI package.

dsc_path

Data type: String

The path to the MSI file that should be installed or uninstalled.

dsc_publisher

Data type: Optional[String]

The publisher of the MSI package.

dsc_servercertificatevalidationcallback

Data type: Optional[String]

PowerShell code that should be used to validate SSL certificates for paths using HTTPS.

dsc_signersubject

Data type: Optional[String]

The subject that should match the signer certificate of the digital signature of the MSI file.

dsc_signerthumbprint

Data type: Optional[String]

The certificate thumbprint that should match the signer certificate of the digital signature of the MSI file.

dsc_size

Data type: Optional[Integer[0, 4294967295]]

The size of the MSI package in MB.

dsc_version

Data type: Optional[String]

The version number of the MSI package.

Parameters

The following parameters are available in the dsc_msipackage type.

dsc_credential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

The credential of a user account to be used to mount a UNC path if needed.

dsc_productid

namevar

Data type: String

The identifying number used to find the package, usually a GUID.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

dsc_runascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

The credential of a user account under which to run the installation or uninstallation of the MSI package.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_processset

The DSC resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_processset type.

dsc_credential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

dsc_ensure

Data type: Optional[String]

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

dsc_standarderrorpath

Data type: Optional[String]

dsc_standardinputpath

Data type: Optional[String]

dsc_standardoutputpath

Data type: Optional[String]

dsc_workingdirectory

Data type: Optional[String]

Parameters

The following parameters are available in the dsc_processset type.

dsc_path

namevar

Data type: Array[String]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_registry

The DSC Registry resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_registry type.

dsc_ensure

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

Specifies whether or not the registry key or value should exist. To add or modify a registry key or value, set this property to Present. To remove a registry key or value, set the property to Absent.

dsc_hex

Data type: Optional[Boolean]

Specifies whether or not the specified DWord or QWord registry key data is provided in a hexadecimal format. Not valid for types other than DWord and QWord. The default value is $false.

dsc_valuedata

Data type: Optional[Array[String]]

The data the specified registry key value should have as a string or an array of strings (MultiString only).

dsc_valuetype

Data type: Optional[Enum['String', 'string', 'Binary', 'binary', 'DWord', 'dword', 'QWord', 'qword', 'MultiString', 'multistring', 'ExpandString', 'expandstring']]

The type the specified registry key value should have.

Parameters

The following parameters are available in the dsc_registry type.

dsc_force

Data type: Optional[Boolean]

Specifies whether or not to overwrite the specified registry key value if it already has a value or whether or not to delete a registry key that has subkeys. The default value is $false.

dsc_key

namevar

Data type: String

The path of the registry key to add, modify, or remove. This path must include the registry hive/drive.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

dsc_valuename

namevar

Data type: String

The name of the registry value. To add or remove a registry key, specify this property as an empty string without specifying ValueType or ValueData. To modify or remove the default value of a registry key, specify this property as an empty string while also specifying ValueType or ValueData.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_script

The DSC Script resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_script type.

dsc_result

Data type: Optional[String]

The result from the GetScript script block.

ensurable

Data type: Boolean[false]

Default attribute added to all dsc types without an ensure property. This resource is not ensurable.

Parameters

The following parameters are available in the dsc_script type.

dsc_credential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

The credential of the user account to run the script under if needed.

dsc_getscript

namevar

Data type: String

A string that can be used to create a PowerShell script block that retrieves the current state of the resource.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

dsc_setscript

namevar

Data type: String

A string that can be used to create a PowerShell script block that sets the resource to the desired state.

dsc_testscript

namevar

Data type: String

A string that can be used to create a PowerShell script block that validates whether or not the resource is in the desired state.

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_service

The DSC Service resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_service type.

dsc_builtinaccount

Data type: Optional[Enum['LocalSystem', 'localsystem', 'LocalService', 'localservice', 'NetworkService', 'networkservice']]

Indicates the sign-in account to use for the service.

dsc_dependencies

Data type: Optional[Array[String]]

An array of strings indicating the names of the dependencies of the service.

dsc_description

Data type: Optional[String]

The description of the service.

dsc_desktopinteract

Data type: Optional[Boolean]

The service can create or communicate with a window on the desktop. Must be false for services not running as LocalSystem. Defaults to False.

dsc_displayname

Data type: Optional[String]

The display name of the service.

dsc_ensure

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

Ensures that the service is present or absent. Defaults to Present.

dsc_path

Data type: Optional[String]

The path to the service executable file.

dsc_startuptimeout

Data type: Optional[Integer[0, 4294967295]]

The time to wait for the service to start in milliseconds. Defaults to 30000.

dsc_startuptype

Data type: Optional[Enum['Automatic', 'automatic', 'Manual', 'manual', 'Disabled', 'disabled']]

Indicates the startup type for the service.

dsc_state

Data type: Optional[Enum['Running', 'running', 'Stopped', 'stopped', 'Ignore', 'ignore']]

Indicates the state you want to ensure for the service. Defaults to Running.

dsc_terminatetimeout

Data type: Optional[Integer[0, 4294967295]]

The time to wait for the service to stop in milliseconds. Defaults to 30000.

Parameters

The following parameters are available in the dsc_service type.

dsc_credential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

The credential to run the service under.

dsc_name

namevar

Data type: String

Indicates the service name. Note that sometimes this is different from the display name. You can get a list of the services and their current state with the Get-Service cmdlet.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_serviceset

The DSC resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_serviceset type.

dsc_builtinaccount

Data type: Optional[String]

dsc_credential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

dsc_ensure

Data type: Optional[String]

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

dsc_startuptype

Data type: Optional[String]

dsc_state

Data type: Optional[String]

Parameters

The following parameters are available in the dsc_serviceset type.

dsc_name

namevar

Data type: Array[String]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_user

The DSC User resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_user type.

dsc_description

Data type: Optional[String]

A description for the user

dsc_disabled

Data type: Optional[Boolean]

Value used to disable/enable a user account

dsc_ensure

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

An enumerated value that describes if the user is expected to exist on the machine

dsc_fullname

Data type: Optional[String]

The display name of the user

dsc_passwordchangenotallowed

Data type: Optional[Boolean]

Value used to set whether a user can/cannot change their password

dsc_passwordchangerequired

Data type: Optional[Boolean]

Value used to require a user to change their password

dsc_passwordneverexpires

Data type: Optional[Boolean]

Value used to set whether a user's password expires or not

Parameters

The following parameters are available in the dsc_user type.

dsc_password

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

The password for the user

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

dsc_username

namevar

Data type: String

The name of the User to Create/Modify/Delete

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_windowsfeature

The DSC WindowsFeature resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_windowsfeature type.

dsc_displayname

Data type: Optional[String]

The display name of the retrieved role or feature.

dsc_ensure

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

Specifies whether the role or feature should be installed or uninstalled. To install the feature, set this property to Present. To uninstall the feature, set the property to Absent.

dsc_includeallsubfeature

Data type: Optional[Boolean]

Specifies whether the subfeatures of the main feature should also be installed.

dsc_logpath

Data type: Optional[String]

The path to the log file to log this operation.

Parameters

The following parameters are available in the dsc_windowsfeature type.

dsc_credential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

A credential, if needed, to install or uninstall the role or feature.

dsc_name

namevar

Data type: String

The name of the role or feature to install or uninstall.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_windowsfeatureset

The DSC resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_windowsfeatureset type.

dsc_credential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

dsc_ensure

Data type: Optional[String]

dsc_includeallsubfeature

Data type: Optional[Boolean]

dsc_logpath

Data type: Optional[String]

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

dsc_source

Data type: Optional[String]

Parameters

The following parameters are available in the dsc_windowsfeatureset type.

dsc_name

namevar

Data type: Array[String]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_windowsoptionalfeature

The DSC WindowsOptionalFeature resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_windowsoptionalfeature type.

dsc_customproperties

Data type: Optional[Array[String]]

The custom properties retrieved from the Windows optional feature as an array of strings.

dsc_description

Data type: Optional[String]

The description retrieved from the Windows optional feature.

dsc_displayname

Data type: Optional[String]

The display name retrieved from the Windows optional feature.

dsc_ensure

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

Specifies whether the feature should be enabled or disabled. To enable the feature, set this property to Present. To disable the feature, set the property to Absent.

dsc_loglevel

Data type: Optional[Enum['ErrorsOnly', 'errorsonly', 'ErrorsAndWarning', 'errorsandwarning', 'ErrorsAndWarningAndInformation', 'errorsandwarningandinformation']]

The maximum output level to show in the log. Accepted values are: ErrorsOnly (only errors are logged), ErrorsAndWarning (errors and warnings are logged), and ErrorsAndWarningAndInformation (errors, warnings, and debug information are logged).

dsc_logpath

Data type: Optional[String]

The path to the log file to log this operation.

dsc_nowindowsupdatecheck

Data type: Optional[Boolean]

Specifies whether or not DISM contacts Windows Update (WU) when searching for the source files to enable the feature. If $true, DISM will not contact WU.

dsc_removefilesondisable

Data type: Optional[Boolean]

Specifies that all files associated with the feature should be removed if the feature is being disabled.

Parameters

The following parameters are available in the dsc_windowsoptionalfeature type.

dsc_name

namevar

Data type: String

The name of the feature to enable or disable.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_windowsoptionalfeatureset

The DSC resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_windowsoptionalfeatureset type.

dsc_loglevel

Data type: Optional[String]

dsc_logpath

Data type: Optional[String]

dsc_nowindowsupdatecheck

Data type: Optional[Boolean]

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

dsc_removefilesondisable

Data type: Optional[Boolean]

Parameters

The following parameters are available in the dsc_windowsoptionalfeatureset type.

dsc_ensure

namevar

Data type: String

dsc_name

namevar

Data type: Array[String]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_windowspackagecab

The DSC WindowsPackageCab resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_windowspackagecab type.

dsc_ensure

Data type: Enum['Present', 'present', 'Absent', 'absent']

Specifies whether the package should be installed or uninstalled. To install the package, set this property to Present. To uninstall the package, set the property to Absent.

dsc_logpath

Data type: Optional[String]

The path to a file to log the operation to.

dsc_sourcepath

Data type: String

The path to the cab file to install or uninstall the package from.

Parameters

The following parameters are available in the dsc_windowspackagecab type.

dsc_name

namevar

Data type: String

The name of the package to install or uninstall.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property

dsc_windowsprocess

The DSC WindowsProcess resource type. Automatically generated from version 2.12.0.0

Properties

The following properties are available in the dsc_windowsprocess type.

dsc_ensure

Data type: Optional[Enum['Present', 'present', 'Absent', 'absent']]

Indicates whether the process is present (running) or absent (not running).

dsc_handlecount

Data type: Optional[Integer[-2147483648, 2147483647]]

The number of handles opened by the process.

dsc_nonpagedmemorysize

Data type: Optional[Integer[0, 18446744073709551615]]

The amount of nonpaged memory, in bytes, allocated for the process.

dsc_pagedmemorysize

Data type: Optional[Integer[0, 18446744073709551615]]

The amount of paged memory, in bytes, allocated for the process.

dsc_processcount

Data type: Optional[Integer[-2147483648, 2147483647]]

The number of instances of the given process that are currently running.

dsc_processid

Data type: Optional[Integer[-2147483648, 2147483647]]

The unique identifier of the process.

dsc_standarderrorpath

Data type: Optional[String]

The path to write the standard error stream to.

dsc_standardinputpath

Data type: Optional[String]

The path to receive standard input from.

dsc_standardoutputpath

Data type: Optional[String]

The path to write the standard output stream to.

dsc_virtualmemorysize

Data type: Optional[Integer[0, 18446744073709551615]]

The amount of virtual memory, in bytes, allocated for the process.

dsc_workingdirectory

Data type: Optional[String]

The directory to run the processes under.

Parameters

The following parameters are available in the dsc_windowsprocess type.

dsc_arguments

namevar

Data type: String

A string of arguments to pass to the process executable. Pass in an empty string if no arguments are needed.

dsc_credential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

The credential to run the process under.

dsc_path

namevar

Data type: String

The full path or file name to the process executable to start or stop.

dsc_psdscrunascredential

Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]

name

namevar

Data type: String

Description of the purpose for this resource declaration.

validation_mode

Data type: Enum[property, resource]

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

Default value: property