NetCmdlets 2016
NetCmdlets 2016
Questions / Feedback?

Get-TFTP Cmdlet

Parameters   Output Objects   Configuration Settings  

The Get-TFTP cmdlet is used to download files from TFTP servers.

Syntax

Get-TFTP [parameters]

Remarks

To use the cmdlet, specify the Server, LocalFile and RemoteFile parameters. The cmdlet, will return a TFTPFile object if the transmission is successful.

Potential transmission errors and packet loss are managed by the Timeout parameter, which controls the maximum time to wait for a response from the server, and the MaxTransmits parameter, which specifies how many times to resend a failed packet before giving up.

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.


# Download a file
get-tftp -server myserver -remotefile test.txt -localfile C:\test.txt

Parameter List


The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.

LogFileThe location of a file to which debug information is written.
ConfigSpecifies one or more configuration settings.
LocalFileThe local file to download to.
LocalIPThe IP address of the local interface to use.
LogFileThe location of a file to which debug information is written.
MaxTransmitsThe number of times to retry sending a failed packet before disconnecting.
PortThe TCP port in the remote host to which to connect.
RemoteFileThe name of the remote file to download.
ServerThe address of the Server.
TimeoutThe maximum time allowed for the operation.

Output Objects


The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.

TFTPFileThis object is created after a file has finished transferring.

Configuration Settings


The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.

TransferModeDetermines the transfer mode that will be used when transferring a file.
CaptureIPPacketInfoUsed to capture the packet information.
DestinationAddressUsed to get the destination address from the packet information.
DontFragmentUsed to set the Don't Fragment flag of outgoing packets.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the cmdlet binds.
MaxPacketSizeThe maximum length of the packets that can be received.
ShareLocalPortIf set to True, allows more than one instance of the cmdlet to be active on the same local port.
UseConnectionDetermines whether to use a connected socket.
QOSDSCPValueUsed to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficTypeUsed to specify QOS/DSCP settings (optional).
UseIPv6Whether or not to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
NetCmdlets 2016 - Version 16.0 [Build 6335]