Test-VMNetwork Adapter

Module:
hyper-v
Tests connectivity between virtual machines.

Syntax 

Test-VMNetworkAdapter
    [-CimSession <CimSession[]>]
    [-ComputerName <String[]>]
    [-Credential <PSCredential[]>]
    [-VMName] <String>
    [-Name <String>]
    [-Sender]
    [-Receiver]
    -SenderIPAddress <String>
    -ReceiverIPAddress <String>
    [-NextHopMacAddress <String>]
    [-IsolationId <Int32>]
    -SequenceNumber <Int32>
    [-PayloadSize <Int32>]
    [-Passthru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Test-VMNetworkAdapter
    [-VMNetworkAdapter] <VMNetworkAdapter>
    [-Sender]
    [-Receiver]
    -SenderIPAddress <String>
    -ReceiverIPAddress <String>
    [-NextHopMacAddress <String>]
    [-IsolationId <Int32>]
    -SequenceNumber <Int32>
    [-PayloadSize <Int32>]
    [-Passthru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Test-VMNetworkAdapter
    [-VM] <VirtualMachine>
    [-Name <String>]
    [-Sender]
    [-Receiver]
    -SenderIPAddress <String>
    -ReceiverIPAddress <String>
    [-NextHopMacAddress <String>]
    [-IsolationId <Int32>]
    -SequenceNumber <Int32>
    [-PayloadSize <Int32>]
    [-Passthru]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

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.

Examples

Example 1: Test connectivity 

PS C:\> Test-VMNetworkAdapter -VMName "ContosoVM01" -Receiver -SenderIPAddress "10.20.20.5" -ReceiverIPAddress "10.20.20.6" -VMNetworkAdapterName "ContosoNic01"

This command tests connectivity by using the virtual network adapter named ContosoNic01. The command targets the receiver virtual machine.

Required Parameters

-ReceiverIPAddress

Specifies the IP address of the receiver virtual machine.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SenderIPAddress

Specifies the IP address of the sender virtual machine.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SequenceNumber

Specifies the sequence number to use to generate ICMP Ping packets. The default value is 100.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-VM

Specifies a virtual machine. The cmdlet tests connectivity for adapters that belong to the virtual machines that you specify.

Type: VirtualMachine
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-VMName

Specifies the name of a virtual machine.

Type: String
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-VMNetworkAdapter

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.

Type: VMNetworkAdapter
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Optional Parameters

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type: CimSession[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ComputerName

Specifies one or more Hyper-V hosts on which this cmdlet operates. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) to specify the local computer explicitly.

Type: String[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Credential

Specifies one or more user accounts that have permission to perform this action. The default is the current user.

Type: PSCredential[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-IsolationId

Specifies the ID of a virtual subnet.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name

Specifies the name of the virtual machine.

Type: String
Aliases: VMNetworkAdapterName
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NextHopMacAddress

Specified the MAC address for the next hop VM required for non-Hyper-V Network Virtualization configurations.

Type: String
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.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PayloadSize
Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Receiver

Indicates that the cmdlet targets the receiver virtual machine.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Sender

Indicates that the cmdlet targets the sender virtual machine.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False