Forge Home

download_file

A module that will download files for use on Windows servers. Requires the server to have PowerShell 2.0 and above

751,801 downloads

10,522 latest version

4.9 quality score

Version information

  • 4.0.0 (latest)
  • 3.2.0
  • 3.1.0
  • 3.0.0
  • 2.1.0
  • 2.0.0
  • 1.3.0
  • 1.2.1
released Apr 7th 2020
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x
  • Puppet >= 5.5.8 < 7.0.0
  • windows

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppet-download_file', '4.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppet-download_file
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppet-download_file --version 4.0.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

puppet/download_file — version 4.0.0 Apr 7th 2020

Download File module for Puppet

Build Status Code Coverage Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with download_file
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

Overview

The download_file module allows you to download files on Windows

Module Description

The download_file module introduced a small define download_file that will allow you to download a file over http(s) for usage during an installation. This was created because the package resource does not support http as a source for packages. It is only supported on Windows.

Setup

What download_file affects

  • Downloads files onto each node

Setup Requirements

  • download_file makes use of Powershell so you will need to have at least version 2.0 installed in order to use this module.

Beginning with download_file

To download dotnet 4.0

    download_file { "Download dotnet 4.0" :
      url                   => 'http://download.microsoft.com/download/9/5/A/95A9616B-7A37-4AF6-BC36-D6EA96C8DAAE/dotNetFx40_Full_x86_x64.exe',
      destination_directory => 'c:\temp'
    }

To download dotnet 4.0 using a proxy

    download_file { "Download dotnet 4.0" :
      url                   => 'http://download.microsoft.com/download/9/5/A/95A9616B-7A37-4AF6-BC36-D6EA96C8DAAE/dotNetFx40_Full_x86_x64.exe',
      destination_directory => 'c:\temp',
      proxy_address         => 'http://corporateproxy.net:8080'
    }

The proxy will be used as part of the download using PowerShell. This does not set a system wide proxy

Usage

Reference

Defined Types

Public Types

  • download_file: Download a give file

Parameters

url

The http(s) destination of the file that you are looking to download

destination_directory

The full path to the directory on the system where the file will be downloaded to

destination_file

The optional name of the file to download onto the system.

user

The optional userid is used when authenticating via Basic Auth with the server. user and password must be specified or this has no effect.

password

The optional password is used when authenticating via Basic Auth with the server. user and password must be specified or this has no effect.

proxy_address

The optional http proxy address to use when downloading the file

proxy_user

The optional http proxy user to use when downloading the file. proxy_address and proxy_password must be specified or this has no effect.

proxy_password

The optional http proxy password to use when downloading the file. proxy_address and proxy_user must be specified or this has no effect. By default this value accepts secure strings. A secure string is (unfortunately) tied to the machine that it is used for. To generate a secure string for a given machine, users should run the following powershell command on that machine (replacing PASSWORD with the desired password):

ConvertFrom-SecureString -securestring $(ConvertTo-SecureString "PASSWORD" -AsPlainText -Force)

It is possible to get this information then clear the command from history, but it's important to note that the -Force argument is there to suppress warnings that the plaintext password is in the history.

If this process sounds unappealing, you can send the password in plaintext (which sits in the download-<filename>.ps1 file on the machine being provisioned) by changing the is_password_secure variable to false.

is_password_secure

The optional switch to change the way that proxyPassword is interpreted from secure string to plaintext. This will send the password in plaintext to the machine being provisioned, which may be a security concern.

cookies

An optional array of cookies to add to the HTTP request for the download.

Limitations

This module is tested on the following platforms:

  • Windows 2008
  • Windows 2008 R2
  • Windows 2012
  • Windows 2012 R2
  • Windows 7
  • Windows 8

It is tested with the OSS version of Puppet only.

Contributing

Please read CONTRIBUTING.md for full details on contributing to this project.