download_file
Version information
This version is compatible with:
Start using this module
Add this module to your Puppetfile:
mod 'puppet-download_file', '1.3.0'
Learn more about managing modules with a PuppetfileDocumentation
puppet-download_file
####Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with download_file
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- 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
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
###Classes and Defined Types
####Defined Type: download_file
Parameters within download_file
:
#####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.
#####proxy_address
The optional http proxy address to use when downloading the file
##Reference
###Defined Types ####Public Types
download_file
: Download a give file
##Limitations
This module is tested on the following platforms:
- Windows 2008
- Windows 2008 R2
- Windows 2012
- Windows 2012 R2
It is tested with the OSS version of Puppet only.
###Contributing
Please read CONTRIBUTING.md for full details on contributing to this project.
##2016-01-18 - Release 1.3.0 ###Summary
This release fixes the default timeout value for exec and also deprecates the proxyAddress variable in favor of proxy_address
##2015-04-17 - Release 1.2.1 ###Summary
This release contains various changes needed after the move to the puppet-community namespace
##2014-10-17 - Release 1.1.1 ###Summary
This releases fixes a bug where duplicate resources can occur
####Bugfixes
- fixes (#10) where C:\Temp and C:/Temp throws duplicate resource error
##2014-10-17 - Release 1.1.0 ###Summary
This release adds support to provide the file location
####Features
- Adds new parameter
destination_file
to provide the name of the file to download onto the system.
##2014-10-10 - Release 1.0.0 ###Summary
This release has some bug fixes but is mostly improving the documentation and testing to bring it up to a higher quality standard.
####Bug Fixes
- adding condition to check if C:\temp has already been defined
##2014-02-24 - Release 0.0.2 ###Summary
Minor update to include improved documentation of the proxy parameters
##2013-11-29 - Release 0.0.1 ###Summary
Initial public release of the module
Dependencies
- puppetlabs/stdlib (>=3.0.0 <5.0.0)
- puppetlabs/powershell (>= 1.0.1)
Copyright (c) 2014 OpenTable, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.