Get-VpnS2SInterface Statistics

Module:
remoteaccess
Retrieves statistics of a site-to-site (S2S) interface.

Syntax 

Get-VpnS2SInterfaceStatistics
   [-Clear]
   [-Force]
   [-Name] <String>
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-VpnS2SInterfaceStatistics
   [-Clear]
   [-Force]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-VpnS2SInterfaceStatistics cmdlet retrieves statistics for a site-to-site (S2S) interface.

Examples

EXAMPLE 1 

PS C:\> Get-VpnS2SInterfaceStatistics -Name 2-edge1
BytesTransmitted      : 2874 
BytesReceived         : 14701 
FramesTransmitted     : 39 
FramesReceived        : 193 
CrcErrors             : 0 
TimeoutErrors         : 0 
AlignmentErrors       : 0 
HardwareOverrunErrors : 0 
FramingErrors         : 0 
BufferOverrunErrors   : 0

This example retrieves statistics for the S2S VPN interface named 2-edge1.

Required Parameters

-Name

Specifies the name of the connection.

Type: String
Aliases: ElementName
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Clear

Indicates that the interface statistics are cleared.

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

Forces the command to run without asking for user confirmation.

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

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

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

Inputs

None

Outputs

Microsoft.Management.Infrastructure.CimInstance#VpnS2SInterfaceStatistics

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign ( # ) provides the namespace and class name for the underlying WMI object.