Skip to content

Latest commit

 

History

History
187 lines (139 loc) · 4.84 KB

Get-VpnS2SInterfaceStatistics.md

File metadata and controls

187 lines (139 loc) · 4.84 KB
description external help file Module Name ms.date online version schema title
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
PS_VpnS2SInterfaceStatistics_v1.0.0.cdxml-help.xml
RemoteAccess
12/20/2016
2.0.0
Get-VpnS2SInterfaceStatistics

Get-VpnS2SInterfaceStatistics

SYNOPSIS

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

SYNTAX

Get

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

All

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.

PARAMETERS

-AsJob

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
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[]
Parameter Sets: (All)
Aliases: Session

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

-Clear

Indicates that the interface statistics are cleared.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: 

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

-Name

Specifies the name of the connection.

Type: String
Parameter Sets: Get
Aliases: ElementName

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
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
Parameter Sets: (All)
Aliases: 

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

OUTPUTS

Microsoft.Management.Infrastructure.CimInstance[]

Microsoft.Management.Infrastructure.CimInstance#VpnS2SInterfaceStatistics

Microsoft.Management.Infrastructure.CimInstance

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.

NOTES

RELATED LINKS

Add-VpnS2SInterface

Clear-VpnS2SInterfaceStatistics

Connect-VpnS2SInterface

Disconnect-VpnS2SInterface

Get-VpnAuthProtocol

Get-VpnS2SInterface

Remove-VpnS2SInterface

Set-VpnAuthProtocol

Set-VpnS2SInterface