Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

MSFT_ForwardingConsumer class

The MSFT_ForwardingConsumer class represents an event consumer that forwards messages to target computers.

Note  For more information about support and installation of this component on a specific operating system, see Operating System Availability of WMI Components.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties and methods are in alphabetic order, not MOF order.

Syntax

class MSFT_ForwardingConsumer : __EventConsumer
{
  boolean Authenticate = TRUE;
  uint8   CreatorSID[];
  boolean Encryption = FALSE;
  sint32  ForwardingQoS = 0;
  boolean IncludeSchema = FALSE;
  string  MachineName;
  uint32  MaximumQueueSize;
  string  Name;
  string  Targets[];
  string  TargetSD;
};

Members

The MSFT_ForwardingConsumer class has these types of members:

Properties

The MSFT_ForwardingConsumer class has these properties.

Authenticate
Data type: boolean
Access type: Read/write

If TRUE (default), authentication information is included when forwarding a message. If the registry key

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\WBEM\FWD\AllowUnauthenticatedEvents

on the computer receiving the events is 0 (default), only events where Authenticate = TRUE are accepted. If the key setting is 1, all forwarded events are accepted. A setting of 0 for AllowUnauthorizedEvents is only supported for domains containing Active Directory.
CreatorSID
Data type: uint8 array
Access type: Read-only

Security identifier that uniquely identifies the user who created this filter. This property is inherited from __EventConsumer.

Encryption
Data type: boolean
Access type: Read/write

If TRUE, the message is encrypted before forwarding. On Windows XP, the default is FALSE.

ForwardingQoS
Data type: sint32
Access type: Read/write

Quality-of-Service level used to forward the message. Values are:

0 - "Synchronous"

IncludeSchema
Data type: boolean
Access type: Read/write

If TRUE, schema information is sent for the event being forwarded. The default value is FALSE.

MachineName
Data type: string
Access type: Read/write

Name of the computer from which the message originates. This property is inherited from __EventConsumer.

MaximumQueueSize
Data type: uint32
Access type: Read/write
Qualifiers: Units (Bytes)

Maximum size of the queue in bytes. This property is inherited from __EventConsumer.

Name
Data type: string
Access type: Read/write
Qualifiers: Key

Unique identifier for this consumer. When this property is not specified, a unique GUID is generated.

Targets
Data type: string array
Access type: Read-only

Array of addresses to which the Forwarding Consumer sends messages. The Forwarding Consumer will try to forward the message to each address in the list until it successfully sends it to one of them.

TargetSD
Data type: string
Access type: Read/write

Security descriptor (SD), in SDDL format, that is attached to the forwarded event. This SD indicates to the receiver which security identities are allowed to receive the forwarded event.

Examples

For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository.

For C++ code examples, see WMI C++ Application Examples.

Requirements

Minimum supported client

Windows XP

Minimum supported server

None supported

End of client support

Windows XP

Namespace

\root\subscription

MOF

Fconprov.mof

DLL

Frdprov.dll

See also

Supporting Classes for the Forwarding Consumer
Forwarding WMI Events and Data

 

 

Show:
© 2014 Microsoft