Get-FtpFile

Get-FtpFile

Get-FtpFile

Downloads a file from a File Transfer Protocol (FTP) location.

Syntax

Get-FtpFile `
  [-Url <String>] `
  -FileName <String> `
  [-Username <String>] `
  [-Password <String>] `
  [-Quiet] `
  [-IgnoredArguments <Object[]>] [<CommonParameters>]

Description

This will download a file from an FTP location, saving the file to the FileName location specified.

Notes

This is a low-level function and not recommended for use in package scripts. It is recommended you call Get-ChocolateyWebFile instead.

Will automatically call Set-PowerShellExitCode to set the package exit code to 404 if the resource is not found.

Aliases

None

Inputs

None

Outputs

None

Parameters

-Url [<String>]

PropertyValue
Aliases
Required?false
Position?1
Default Value
Accept Pipeline Input?false

-FileName <String>

PropertyValue
Aliases
Required?true
Position?2
Default Value
Accept Pipeline Input?false

-Username [<String>]

PropertyValue
Aliases
Required?false
Position?3
Default Value
Accept Pipeline Input?false

-Password [<String>]

PropertyValue
Aliases
Required?false
Position?4
Default Value
Accept Pipeline Input?false

-Quiet

PropertyValue
Aliases
Required?false
Position?named
Default ValueFalse
Accept Pipeline Input?false

-IgnoredArguments [<Object[]>]

PropertyValue
Aliases
Required?false
Position?named
Default Value
Accept Pipeline Input?false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters http://go.microsoft.com/fwlink/p/?LinkID=113216 .

Function Reference

:choco-info: NOTE

This documentation has been automatically generated from Import-Module "$env:ChocolateyInstall\helpers\chocolateyInstaller.psm1" -Force; Get-Help Get-FtpFile -Full.

View the source for Get-FtpFile