PS_VpnConnectionRoute, ROOT\Microsoft\Windows\RemoteAccess\Client

Class | Methods (2) | Properties (3) | Qualifiers (5) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

Route for a VPN connection

PS_VpnConnectionRoute methods

PS_VpnConnectionRoute has 2 methods (2 Local)

NameOriginReturn
AddPS_VpnConnectionRouteuint32 {'out':True}
RemovePS_VpnConnectionRouteuint32 {'out':True}

PS_VpnConnectionRoute properties

PS_VpnConnectionRoute has 3 properties (3 Local)

NameOriginCIMType
AddressFamilyPS_VpnConnectionRoute18 [uint16]
key
DestinationPrefix
PS_VpnConnectionRoute8 [string]
RouteMetricPS_VpnConnectionRoute19 [uint32]

Detailed description of PS_VpnConnectionRoute methods

Local methods (2) of PS_VpnConnectionRoute class

▲ Add method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ConnectionNamestring0✓-{'Description':'Specifies the name of the VPN connection profile to be modified. ','In':True}
DestinationPrefixstring1✓-{'Description':'Destination prefix of the route to be added','In':True}
RouteMetricuint322✓-{'Description':'Metric of the route being added','In':True}
PassThruboolean3✓-{'Description':'Returns the MSFT_NetRoute object','In':True}
AllUserConnectionboolean4✓-{'Description':'Specifies that the VPN connection being modified is in the AllUserConnection phone book entries. ','In':True}
cmdletOutputobject:MSFT_NetRoute5-✓{'Description':'MSFT_NetRoute object. The destination prefix and metric field are populated','EmbeddedInstance':'MSFT_NetRoute','Out':True}
Description'Adds a route to the specified VPN connection'
implementedTrue
staticTrue
Add method is in 5 classes of ROOT\Microsoft\Windows\RemoteAccess\Client and in 17 namespaces
▲ Remove method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ConnectionNamestring0✓-{'Description':'Specifies the name of the VPN connection profile to be modified. ','In':True}
DestinationPrefixstring1✓-{'Description':'Destination prefix of the route to be removed','In':True}
AllUserConnectionboolean2✓-{'Description':'Specifies that the VPN connection being modified is in the AllUserConnection phone book entries. ','In':True}
PassThruboolean3✓-{'Description':'Returns the MSFT_NetRoute object','In':True}
cmdletOutputobject:MSFT_NetRoute4-✓{'Description':'MSFT_NetRoute object. The destination prefix and metric field are populated','EmbeddedInstance':'MSFT_NetRoute','Out':True}
Description'Removes a route from the specified VPN connection'
implementedTrue
staticTrue
Remove method is in 5 classes of ROOT\Microsoft\Windows\RemoteAccess\Client and in 18 namespaces

Detailed description of PS_VpnConnectionRoute properties

Local properties (3) of PS_VpnConnectionRoute class

▲ AddressFamily property
CIMTYPE'uint16'
Description'To indicate whether the address family for this route is v4 or v6.'
readTrue
ValueMap['2', '23']
Values['IPv4', 'IPv6']
AddressFamily property is in 2 classes of ROOT\Microsoft\Windows\RemoteAccess\Client and in 6 namespaces
▲ DestinationPrefix property
CIMTYPE'string'
Description'Destination prefix of the route to be added'
keyTrue
readTrue
writeTrue
DestinationPrefix property is in 2 classes of ROOT\Microsoft\Windows\RemoteAccess\Client and in 4 namespaces
▲ RouteMetric property
CIMTYPE'uint32'
Description'Metric of the route being added'
readTrue
writeTrue
RouteMetric property is in 3 classes of ROOT\Microsoft\Windows\RemoteAccess\Client and in 4 namespaces

PS_VpnConnectionRoute Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
ClassVersion'1.0'✗✗✓✗✓
Description'Route for a VPN connection'✗✓✓✓✓
dynamicTrue✓✗✓✗✓
locale'MS_409'✗✗✓✓✓
provider'VpnClientPSProvider'✓✗✓✗✓

PS_VpnConnectionRoute System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Microsoft\Windows\RemoteAccess\Client:PS_VpnConnectionRoute'___SYSTEM8✗✗
__NAMESPACE'ROOT\Microsoft\Windows\RemoteAccess\Client'___SYSTEM8✗✗
__SERVER'.'___SYSTEM8✗✗
__DERIVATION[]___SYSTEM8✗✓
__PROPERTY_COUNT3___SYSTEM3✗✗
__RELPATH'PS_VpnConnectionRoute'___SYSTEM8✗✗
__DYNASTY'PS_VpnConnectionRoute'___SYSTEM8✗✗
__SUPERCLASSnull___SYSTEM8✗✗
__CLASS'PS_VpnConnectionRoute'___SYSTEM8✗✗
__GENUS1___SYSTEM3✗✗

Similar Classes to PS_VpnConnectionRoute

Number of classes:2
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_NextHopRoute190----
MSFT_NetRoute0192----
comments powered by Disqus
WUtils.com