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 fileget-tftp -server myserver -remotefile test.txt -localfile C:\test.txtParameter List
The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.
| LogFile | The location of a file to which debug information is written. |
| Config | Specifies one or more configuration settings. |
| LocalFile | The local file to download to. |
| LocalIP | The IP address of the local interface to use. |
| LogFile | The location of a file to which debug information is written. |
| MaxTransmits | The number of times to retry sending a failed packet before disconnecting. |
| Port | The TCP port in the remote host to which to connect. |
| RemoteFile | The name of the remote file to download. |
| Server | The address of the Server. |
| Timeout | The 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.
| TFTPFile | This 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.
| TransferMode | Determines the transfer mode that will be used when transferring a file. |
| CaptureIPPacketInfo | Used to capture the packet information. |
| DestinationAddress | Used to get the destination address from the packet information. |
| DontFragment | Used to set the Don't Fragment flag of outgoing packets. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The port in the local host where the cmdlet binds. |
| MaxPacketSize | The maximum length of the packets that can be received. |
| ShareLocalPort | If set to True, allows more than one instance of the cmdlet to be active on the same local port. |
| UseConnection | Determines whether to use a connected socket. |
| QOSDSCPValue | Used to specify an arbitrary QOS/DSCP setting (optional). |
| QOSTrafficType | Used to specify QOS/DSCP settings (optional). |
| UseIPv6 | Whether or not to use IPv6. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| UseBackgroundThread | Whether threads created by the cmdlet are background threads. |
| UseInternalSecurityAPI | Tells the cmdlet whether or not to use the system security libraries or an internal implementation. |