Get-UDP Cmdlet
Parameters Output Objects Configuration Settings
The Get-UDP cmdlet is used to listen for UDP datagrams.
Syntax
Get-UDP [parameters]
Remarks
The get-udp cmdlet will bind to a specific local host address and listen for UDP datagrams received by the interface.
The cmdlet can be used by specifying a local port to listen to, and optionally you can set LocalIP to the IP address whose traffic you wish to monitor (if it is not the default), and set Time to the number of seconds you wish to monitor for UDP datagrams. For each packet that crosses the interface, the cmdlet will return a UDPData object.
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.
# listen for one hourget-udp -port 4444 -time 3600# listen on a specific interface indefinitelyget-udp -port 4000 -localip $ipaddrParameter 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. |
| LocalIP | The IP address of the local interface to use. |
| LocalPort | The local port that the cmdlet should use. |
| LogFile | The location of a file to which debug information is written. |
| Time | Specifies the time that the UDP daemon should wait for incoming UDP datagrams. |
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.
| UDPData | This object is created after a UDP packet is received. |
Configuration Settings
The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.
| 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. |