Resource Type: dsc_file

Defined in:
lib/puppet/type/dsc_file.rb
Providers:
powershell

Overview

The DSC File resource type. Automatically generated from ‘PSDesiredStateConfiguration/DSCResources/MSFT_FileDirectoryConfiguration/MSFT_FileDirectoryConfiguration.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_attributes

    Attributes - Valid values are ReadOnly, Hidden, System, Archive.

  • dsc_checksum

    Checksum - Valid values are SHA-1, SHA-256, SHA-512, CreatedDate, ModifiedDate.

  • dsc_contents

    Contents

  • dsc_credential

    Credential

  • dsc_dependson

    DependsOn

  • dsc_destinationpath

    DestinationPath

  • dsc_ensure

    Ensure - Valid values are Present, Absent.

  • dsc_force

    Force

    Supported values:
    • true
    • false
  • dsc_matchsource

    MatchSource

    Supported values:
    • true
    • false
  • dsc_psdscrunascredential

    PsDscRunAsCredential

  • dsc_recurse

    Recurse

    Supported values:
    • true
    • false
  • dsc_sourcepath

    SourcePath

  • dsc_type

    Type - Valid values are File, Directory.

  • name (namevar)
  • provider

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