Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 3.64 KB

vpnchannel_startwithtrafficfilter_794156625.md

File metadata and controls

53 lines (36 loc) · 3.64 KB
-api-id -api-type
M:Windows.Networking.Vpn.VpnChannel.StartWithTrafficFilter(Windows.Foundation.Collections.IIterable{Windows.Networking.HostName},Windows.Foundation.Collections.IIterable{Windows.Networking.HostName},Windows.Networking.Vpn.VpnInterfaceId,Windows.Networking.Vpn.VpnRouteAssignment,Windows.Networking.Vpn.VpnDomainNameAssignment,System.UInt32,System.UInt32,System.Boolean,Windows.Foundation.Collections.IIterable{System.Object},Windows.Networking.Vpn.VpnTrafficFilterAssignment)
winrt method

Windows.Networking.Vpn.VpnChannel.StartWithTrafficFilter

-description

Creates the VPN channel for an arbitrary numbers of transports to be used by the VPN plug-in. It also creates an L3 network interface for applications in the client machine to be able to see the corporate network. It allows the specification of traffic filters to use in per-app VPN scenarios.

-parameters

-param assignedClientIpv4Addresses

A list of Windows.Networking.HostName objects specifying the IPv4 address(es) assigned by the VPN server to the VPN client. The address(es) should be set on the VPN L3 interface. If null, DHCPv4 is used.

-param assignedClientIpv6Addresses

A list of Windows.Networking.HostName objects specifying the IPv6 address(es) assigned by the VPN server to the VPN client, and which should be set on the VPN L3 interface. If null, DHCPv6 or RD is used.

-param vpninterfaceId

A VpnInterfaceId object.

-param assignedRoutes

A Windows.Networking.VpnRouteAssignment object that represents the routes that should be associated / not associated with the VPN interface.

-param assignedNamespace

A Windows.Networking.DomainNameAssignment object that represents the list of name prefixes that are associated with the VPN channel, including its DNS and proxy servers.

-param mtuSize

A UINT16 value specifying the MTU size of the VPN L3 network interface. This is also the size of the IVpnPacketBuffers in the Receive pool. This value should be configured to be at most 1400.

-param maxFrameSize

A UINT16 value specifying the max size of the frame defined by the VPN protocol encapsulation without counting the outerTunnelTransport. This is also the size of the IVpnPacketBuffers in the Send pool. This value should be configured as mtuSize + [size of encapsulation headers], and should be <=1500. If it would be greater than 1500 either mtuSize or encapsulation header size should be reduced as the platform limits the framesize to 1500.

-param reserved

Reserved.

-param transports

A list of IInspectable objects for socket transport. Each object can be a Windows.Networking.Sockets.DatagramSocket or a Windows.Networking.Sockets.StreamSocket. They will control the connection to the VPN server and will be used to send encapsulated IP packets and receive encapsulated data. The sockets must be unconnected at the point of the call.

-param assignedTrafficFilters

A VpnTrafficFilterAssignment object, which allows the specification of traffic filters to a VPN channel.

-remarks

-see-also

-examples

-capabilities

networkingVpnProvider