Resource Type: dsc_keyvaluepairfile

Defined in:

lib/puppet/type/dsc_keyvaluepairfile.rb

Providers:

powershell

Overview

The DSC KeyValuePairFile resource type. Automatically generated from ‘FileContentDsc/DSCResources/DSR_KeyValuePairFile/DSR_KeyValuePairFile.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_encoding

  Encoding - Specifies the file encoding. Defaults to ASCII Valid values are ASCII, BigEndianUnicode, BigEndianUTF32, UTF8, UTF32.

• dsc_ensure

  Ensure - Specifies the if the key value pair with the specified key should exist in the file. Valid values are Present, Absent.

• dsc_ignorenamecase

  IgnoreNameCase - Ignore the case of the name of the key. Defaults to $False.

  Supported values:

  • true
  • false
• dsc_ignorevaluecase

  IgnoreValueCase - Ignore the case of any text or secret when determining if it they need to be updated. Defaults to $False.

  Supported values:

  • true
  • false
• dsc_name

  Name - The name of the key.

• dsc_path

  Path - The path to the key value pair text file.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_secret

  Secret - The secret text to replace the value with in the identified key. Only used when Type is set to ‘Secret’.

• dsc_text

  Text - The text to replace the value with in the identified key. Only used when Type is set to ‘Text’.

• dsc_type

  Type - Specifies the value type to use as the replacement string. Defaults to ‘Text’. Valid values are Text, Secret.

• name (namevar)
• provider

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