MSFT_NetRoute, ROOT\Microsoft\Windows\RemoteAccess\Client\MS_409

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

Description

Represents the Route class in TCPIP WMIv2 provider.

MSFT_NetRoute methods

MSFT_NetRoute has 2 methods (2 Local)

NameOriginReturn
CreateMSFT_NetRouteuint32 {'out':True}
SelectMSFT_NetRouteuint32 {'out':True}

MSFT_NetRoute properties

MSFT_NetRoute has 19 properties (10 Local, 9 Derived)

NameOriginCIMType
AddressFamilyMSFT_NetRoute18 [uint16]
AdminDistanceCIM_NextHopRoute18 [uint16]
CaptionCIM_ManagedElement8 [string]
DescriptionCIM_ManagedElement8 [string]
DestinationAddressCIM_NextHopRoute8 [string]
DestinationPrefixMSFT_NetRoute8 [string]
ElementNameCIM_ManagedElement8 [string]
key
InstanceID
CIM_ManagedElement8 [string]
InterfaceAliasMSFT_NetRoute8 [string]
InterfaceIndexMSFT_NetRoute19 [uint32]
IsStaticCIM_NextHopRoute11 [boolean]
NextHopMSFT_NetRoute8 [string]
PreferredLifetimeMSFT_NetRoute101 [datetime]
ProtocolMSFT_NetRoute18 [uint16]
PublishMSFT_NetRoute17 [uint8]
RouteMetricCIM_NextHopRoute18 [uint16]
StoreMSFT_NetRoute17 [uint8]
TypeOfRouteCIM_NextHopRoute18 [uint16]
ValidLifetimeMSFT_NetRoute101 [datetime]

Detailed description of MSFT_NetRoute methods

Local methods (2) of MSFT_NetRoute class

Create method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
InterfaceIndexuint320-{'In':True}
InterfaceAliasstring1-{'In':True}
DestinationPrefixstring2-{'In':True}
NextHopstring3-{'In':True}
Publishuint84-{'In':True}
RouteMetricuint165-{'In':True}
Protocoluint166-{'In':True}
ValidLifetimedatetime7-{'In':True}
PreferredLifetimedatetime8-{'In':True}
PolicyStorestring9-{'In':True}
AddressFamilyuint1610-{'In':True}
PassThruboolean11-{'In':True}
CmdletOutputobject:MSFT_NetRoute12-{'Out':True}
Description'Create the Route.'
Create method is in 1 class (MSFT_NetRoute) of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 14 namespaces
Select method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
InterfaceIndexuint320-{'In':True}
LocalIPAddressstring1-{'In':True}
RemoteIPAddressstring2-{'In':True}
CmdletOutputobject:CIM_ManagedElement3-{'Out':True}
Description'Selects the best local IP address and best route to reach the specified remote address.'
Select method is in 1 class (MSFT_NetRoute) of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 3 namespaces

Detailed description of MSFT_NetRoute properties

Local properties (10) of MSFT_NetRoute class

AddressFamily property
CIMTYPE'uint16'
Description'To indicate whether the address family for this route is v4 or v6.'
Values['IPv4', 'IPv6']
AddressFamily property is in 2 classes of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 6 namespaces
DestinationPrefix property
CIMTYPE'string'
Description'The destination prefix.'
DestinationPrefix property is in 2 classes of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 4 namespaces
InterfaceAlias property
CIMTYPE'string'
Description'The user-friendly interface name.'
InterfaceAlias property is in 1 class (MSFT_NetRoute) of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 9 namespaces
InterfaceIndex property
CIMTYPE'uint32'
Description'The user-friendly interface index.'
InterfaceIndex property is in 1 class (MSFT_NetRoute) of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 9 namespaces
NextHop property
CIMTYPE'string'
Description'The next hop address or gateway address.'
NextHop property is in 1 class (MSFT_NetRoute) of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 8 namespaces
PreferredLifetime property
CIMTYPE'datetime'
Description'Lifetime over which the route is preferred. The default value is infinite.'
PreferredLifetime property is in 1 class (MSFT_NetRoute) of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 6 namespaces
Protocol property
CIMTYPE'uint16'
Description'The routing mechanism via which this route was learned.'
Values['Other', 'Local', 'NetMgmt', 'Icmp', 'Egp', 'Ggp', 'Hello', 'Rip', 'IsIs', 'EsIs', 'Igrp', 'Bbn', 'Ospf', 'Bgp', 'Idpr', 'Eigrp', 'Dvmrp', 'Rpl', 'Dhcp']
Protocol property is in 1 class (MSFT_NetRoute) of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 19 namespaces
Publish property
CIMTYPE'uint8'
Description'One of the following values: No: Not advertised in Route Advertisements. This is the default. Age: Advertised in Route Advertisements with a finite lifetime. Yes: Advertised in Route Advertisements with an infinite lifetime.'
Values['No', 'Age', 'Yes']
Publish property is in 1 class (MSFT_NetRoute) of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 4 namespaces
Store property
CIMTYPE'uint8'
Description'One of the following values: Active: Change only lasts until next boot. Persistent: Change is persistent. This is the default.'
Values['Persistent', 'Active']
Store property is in 1 class (MSFT_NetRoute) of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 4 namespaces
ValidLifetime property
CIMTYPE'datetime'
Description'Lifetime over which the route is valid. The default value is infinite.'
ValidLifetime property is in 1 class (MSFT_NetRoute) of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 6 namespaces

Derived properties (9) of MSFT_NetRoute class

AdminDistance property
CIMTYPE'uint16'
Description'The specific administrative distance of this route, overriding any default distances specified by the system or routing service.'
AdminDistance property is in 2 classes of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 4 namespaces
Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one- line string) of the object.'
Caption property is in 3 classes of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 37 namespaces
Description property
CIMTYPE'string'
Description'The Description property provides a textual description of the object.'
Description property is in 4 classes of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 142 namespaces
DestinationAddress property
CIMTYPE'string'
Description'The address which serves as the destination to be reached.'
DestinationAddress property is in 2 classes of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 4 namespaces
ElementName property
CIMTYPE'string'
Description'A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.
Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.'
ElementName property is in 3 classes of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 21 namespaces
InstanceID property
CIMTYPE'string'
Description'Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following \'preferred\' algorithm:
:
Where and are separated by a colon \':\', and where MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority. (This is similar to the _ structure of Schema class names.) In addition, to ensure uniqueness MUST NOT contain a colon (\':\'). When using this algorithm, the first colon to appear in InstanceID MUST appear between and .
is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above \'preferred\' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance\'s NameSpace.
For DMTF defined instances, the \'preferred\' algorithm MUST be used with the set to \'CIM\'.'
keyTrue
InstanceID property is in 3 classes of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 21 namespaces
IsStatic property
CIMTYPE'boolean'
Description'TRUE indicates that this is a static route, and FALSE indicates a dynamically-learned route.'
IsStatic property is in 2 classes of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 4 namespaces
RouteMetric property
CIMTYPE'uint16'
Description'RouteMetric provides a numeric indication as to the preference of this route, compared to other routes that reach the same destination.'
RouteMetric property is in 3 classes of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 4 namespaces
TypeOfRoute property
CIMTYPE'uint16'
Description'An enumerated integer indicating whether the route is administrator-defined (value=2), computed (via a routing protocol/algorithm, value=3) or the actual route implemented in the network (value=4). The default is a computed route.'
Values['Administrator Defined Route', 'Computed Route', 'Actual Route']
TypeOfRoute property is in 2 classes of ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409 and in 4 namespaces

MSFT_NetRoute Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AMENDMENTTrue
Description'Represents the Route class in TCPIP WMIv2 provider.'
LOCALE'MS_409'

MSFT_NetRoute System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409:MSFT_NetRoute'___SYSTEM8
__NAMESPACE'ROOT\Microsoft\Windows\RemoteAccess\Client\ms_409'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_NextHopRoute', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT19___SYSTEM3
__RELPATH'MSFT_NetRoute'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_NextHopRoute'___SYSTEM8
__CLASS'MSFT_NetRoute'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to MSFT_NetRoute

Number of classes:2
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_NextHopRoute190----
PS_VpnConnectionRoute032----
comments powered by Disqus
online utility - toplist
WUtils.com