Resource Type: dsc_xregistry

Defined in:

lib/puppet/type/dsc_xregistry.rb

Providers:

powershell

Overview

The DSC xRegistry resource type. Automatically generated from ‘xPSDesiredStateConfiguration/DSCResources/MSFT_xRegistryResource/MSFT_xRegistryResource.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present
  • absent

Parameters

• dsc_ensure

  Ensure - 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. Valid values are Present, Absent.

• dsc_force

  Force - 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.

  Supported values:

  • true
  • false
• dsc_hex

  Hex - 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.

  Supported values:

  • true
  • false
• dsc_key

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

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_valuedata

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

• dsc_valuename

  ValueName - 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.

• dsc_valuetype

  ValueType - The type the specified registry key value should have. Valid values are String, Binary, DWord, QWord, MultiString, ExpandString.

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_xregistry` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.