Resource Type: dsc_xrobocopy

Defined in:
lib/puppet/type/dsc_xrobocopy.rb

Overview

The DSC xRobocopy resource type. Automatically generated from version 2.0.0.0

Properties

  • dsc_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

    Determine whether to overwrite log file or append.

  • dsc_ensure

    Will indicate whether Destination is in sync with Source

  • dsc_excludefiles

    Exclude Files matching given names/paths/wildcards.

  • dsc_files

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

  • dsc_logoutput

    Output status to LOG file.

  • dsc_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.

  • dsc_restartable

    Copy files in restartable mode.

  • dsc_retry

    Number of Retries on failed copies: default 1 million.

  • dsc_subdirectoriesincludingempty

    Copy subdirectories, including Empty ones.

  • dsc_wait

    Wait time between retries: default is 30 seconds.

Parameters

  • dsc_destination (namevar)

    Destination Dir, Drive or UNC path.

  • dsc_psdscrunascredential
  • dsc_source (namevar)

    Source Directory, Drive or UNC path.

  • name (namevar)

    Description of the purpose for this resource declaration.

  • validation_mode (defaults to: property)

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