CIM_ForwardingService class

Represents the functions used in forwarding network traffic. Its instances act on packets received from one or more protocol endpoints or services, and drop (discard), or send those packets to one or more other protocol endpoints or services. The explicit endpoints being forwarded between, are described using the CIM_ForwardsAmong association (or one of its subclasses). Generally, the endpoints are at the same protocol layer and are usually of similar types, or of the same type. The forwarding service is different than the route calculation service in that it represents the function of forwarding traffic independent of calculating routing information. Examining the CIM_ForwardingService class definition, be aware that its superclass CIM_NetworkService is deprecated. Therefore, the CIM_NetworkService properties need not be implemented in an instance of CIM_ForwardingService. Unfortunately, CIM_NetworkService cannot be removed from the object hierarchy without a major schema release. If this occurs, the CIM_NetworkService superclass will be removed, and CIM_ForwardingService will subclass from CIM_Service directly. Also be aware that there are a large number of other protocols that are not currently modeled.

Important  The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

class CIM_ForwardingService : CIM_NetworkService
{
  string StartupParameters;
  string StartupConditions;
  string ServiceURL;
  string Keywords;
  uint16 ProtocolType;
  string OtherProtocolType;
};

Members

The CIM_ForwardingService class has these types of members:

• Properties

Properties

The CIM_ForwardingService class has these properties.

Keywords

Data type: string

Access type: Read-only

This is a free-form array of strings that provide descriptive words and phrases that can be used in queries. Currently, this property has not been implemented because it is not standard. Also, if this were a necessary query construct, then it would be required higher in the inheritance hierarchy. The latter has not proven necessary. Therefore, the property is deprecated.

OtherProtocolType

Data type: string

Access type: Read-only

Qualifiers: MaxLen ( 32)

The type of protocol that is being forwarded when the value of ProtocolType is 1("Other"). This provides for future extensibility.

ProtocolType

Data type: uint16

Access type: Read-only

The type of protocol that is being forwarded.

Unknown (0)

Other (1)

IPv4 (2)

IPv6 (3)

IPv4/IPv6 (4)

IPX (5)

AppleTalk (6)

DECnet (7)

SNA (8)

CONP (9)

CLNP (10)

VINES (11)

XNS (12)

ATM (13)

Frame Relay (14)

Ethernet (15)

TokenRing (16)

FDDI (17)

Infiniband (18)

Fibre Channel (19)

ServiceURL

Data type: string

Access type: Read-only

This is a URL that provides the protocol, network location, and other service-specific information required to access the service. It is deprecated with the recommendation that ServiceAccessURI be instantiated instead. This new class correctly positions the semantics of the service access and clarifies the format of the information.

StartupConditions

Data type: string

Access type: Read-only

This is a free-form array of strings that specify any specific preconditions that must be met for this service to start correctly. It was expected that subclasses would refine the inherited StartService() method to suit their specific requirements. Currently, this refinement has not been necessary. Also, the property is not useful because it is not standard. If this were a necessary construct, then it would be required higher in the inheritance hierarchy (on Service). The latter has not proven true. Therefore, the property is deprecated.

StartupParameters

Data type: string

Access type: Read-only

This is a free-form array of strings that specify any specific parameters that must be supplied to the StartService() method for this service to start correctly. It was expected that subclasses would refine the inherited StartService() methods to suit their specific requirements. Currently, this refinement has not been necessary. If indeed the method were refined, then its parameters would more formally convey this information. Therefore, the property is deprecated.

Requirements

See also

CIM_NetworkService