Resource Type: dsc_xrobocopy

Defined in:

lib/puppet/type/dsc_xrobocopy.rb

Providers:

powershell

Overview

The DSC xRobocopy resource type. Automatically generated from ‘xRobocopy/DSCResources/MSFT_xRobocopy/MSFT_xRobocopy.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_additionalargs

  AdditionalArgs - Robocopy has MANY configuration options. Too many to present them all as DSC parameters effectively. Use this option to set additional parameters. Each parameter should be a separate array member. This array will be combined with main argument array. For a list of options run Robocopy /??? in a shell window.

• dsc_appendlog

  AppendLog - Determine whether to overwrite log file or append.

  Supported values:

  • true
  • false
• dsc_destination

  Destination - Destination Dir, Drive or UNC path.

• dsc_ensure

  Ensure - Will indicate whether Destination is in sync with Source Valid values are Present, Absent.

• dsc_excludefiles

  ExcludeFiles - Exclude Files matching given names/paths/wildcards.

• dsc_files

  Files - File(s) to copy (names/wildcards: default is all files).

• dsc_logoutput

  LogOutput - Output status to LOG file.

• dsc_multithreaded

  MultiThreaded - Do multi-threaded copies with n threads (default 8). N must be at least 1 and not greater than 128. This option is incompatible with the /IPG and /EFSRAW options. Redirect output using /LOG option for better performance.

  Supported values:

  • true
  • false
• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_restartable

  Restartable - Copy files in restartable mode.

  Supported values:

  • true
  • false
• dsc_retry

  Retry - Number of Retries on failed copies: default 1 million.

• dsc_source

  Source - Source Directory, Drive or UNC path.

• dsc_subdirectoriesincludingempty

  SubdirectoriesIncludingEmpty - Copy subdirectories, including Empty ones.

  Supported values:

  • true
  • false
• dsc_wait

  Wait - Wait time between retries: default is 30 seconds.

• name (namevar)
• provider

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