Resource Type: dsc_xremotefile

Defined in:

lib/puppet/type/dsc_xremotefile.rb

Providers:

powershell

Overview

The DSC xRemoteFile resource type. Automatically generated from ‘xPSDesiredStateConfiguration/DSCResources/MSFT_xRemoteFile/MSFT_xRemoteFile.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_credential

  Credential - Specifies a user account that has permission to send the request.

• dsc_destinationpath

  DestinationPath - Path under which downloaded or copied file should be accessible after operation.

• dsc_ensure

  Ensure - Says whether DestinationPath exists on the machine Valid values are Present, Absent.

• dsc_headers

  Headers - Headers of the web request.

• dsc_matchsource

  MatchSource - A boolean value to indicate whether the remote file should be re-downloaded if the file in the DestinationPath was modified locally.

  Supported values:

  • true
  • false
• dsc_proxy

  Proxy - Uses a proxy server for the request, rather than connecting directly to the Internet resource. Should be the URI of a network proxy server (e.g ‘10.20.30.1’).

• dsc_proxycredential

  ProxyCredential - Specifies a user account that has permission to use the proxy server that is specified by the Proxy parameter.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_timeoutsec

  TimeoutSec - Specifies how long the request can be pending before it times out.

• dsc_uri

  Uri - Uri of a file which should be copied or downloaded. This parameter supports HTTP and HTTPS values.

• dsc_useragent

  UserAgent - User agent for the web request.

• name (namevar)
• provider

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