Test-VMNetworkAdapter
Test-VMNetworkAdapter
Tests connectivity between virtual machines.
Syntax
Parameter Set: VMName
Test-VMNetworkAdapter [-VMName] <String> -ReceiverIPAddress <String> -SenderIPAddress <String> -SequenceNumber <Int32> [-ComputerName <String[]> ] [-IsolationId <Int32> ] [-Name <String> ] [-NextHopMacAddress <String> ] [-Passthru] [-Receiver] [-Sender] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ManagementOS
Test-VMNetworkAdapter -ManagementOS -ReceiverIPAddress <String> -SenderIPAddress <String> -SequenceNumber <Int32> [-ComputerName <String[]> ] [-IsolationId <Int32> ] [-Name <String> ] [-NextHopMacAddress <String> ] [-Passthru] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ResourceObject
Test-VMNetworkAdapter [-VMNetworkAdapter] <VMNetworkAdapterBase> -ReceiverIPAddress <String> -SenderIPAddress <String> -SequenceNumber <Int32> [-IsolationId <Int32> ] [-NextHopMacAddress <String> ] [-Passthru] [-Receiver] [-Sender] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: VMObject
Test-VMNetworkAdapter [-VM] <VirtualMachine> -ReceiverIPAddress <String> -SenderIPAddress <String> -SequenceNumber <Int32> [-IsolationId <Int32> ] [-Name <String> ] [-NextHopMacAddress <String> ] [-Passthru] [-Receiver] [-Sender] [-VMNetworkAdapterName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Test-VMNetworkAdapter cmdlet tests connectivity between virtual machines by using Internet Control Message Protocol (ICMP) Ping packets. Ping verifies IP-level connectivity to another TCP/IP computer by sending ICMP Echo Request messages.
Parameters
-ComputerName<String[]>
Specifies an array of Hyper-V hosts. The cmdlet tests connectivity for virtual machines hosted by the computers that you specify.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-IsolationId<Int32>
Specifies an ID of a virtual subnet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ManagementOS
Indicates that the cmdlet operates on the parent or host operating system.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the virtual machine.
Aliases |
VMNetworkAdapterName |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NextHopMacAddress<String>
Specified the MAC address for the next hop VM required for non-HNV (non Hyper-V Network Virtualization) configurations.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Passthru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Receiver
Indicates that the cmdlet targets the receiver virtual machine.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ReceiverIPAddress<String>
Specifies the IP address of the receiver virtual machine.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Sender
Indicates that the cmdlet targets the sender virtual machine.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SenderIPAddress<String>
Specifies the IP address of the sender virtual machine.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SequenceNumber<Int32>
Specifies the sequence number to use to generate ICMP Ping packets. The default value is 100.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VM<VirtualMachine>
Specifies a virtual machine. The cmdlet tests connectivity for adapters that belong to the virtual machines that you specify.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMName<String>
Specifies the name of a virtual machine.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMNetworkAdapter<VMNetworkAdapterBase>
Specifies a virtual machine network adapter as a VMNetworkAdapterBase object. The cmdlet tests connectivity for the adapters that you specify. To obtain a network adapter, use the Get-VMNetworkAdapter cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMNetworkAdapterName<String>
Specifies the name of a virtual network adapter. The cmdlet tests connectivity for the adapters that you specify.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Test connectivity
This command tests connectivity by using the virtual network adapter named ContosoNic01. The command targets the receiver virtual machine.
PS C:\> Test-VMNetworkAdapter –VMName "ContosoVM01" –Receiver –SenderIPAddress "10.20.20.5" –ReceiverIPAddress "10.20.20.6" –VMNetworkAdapterName "ContosoNic01"