Msvm_TransparentBridgingService class

Article
01/07/2021

Serves as a placeholder for the service inside the switch that learns MAC addresses and serves as a bridge between the Msvm_VirtualEthernetSwitch and Msvm_DynamicForwardingEntry classes.

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

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_TransparentBridgingService : CIM_TransparentBridgingService
{
  string   InstanceID;
  string   Caption = "Virtual Switch Transparent Bridging Service";
  string   Description = "Microsoft Virtual Switch Transparent Bridging Service";
  string   ElementName;
  datetime InstallDate;
  uint16   OperationalStatus[] = 2;
  string   StatusDescriptions[] = "OK";
  string   Status;
  uint16   HealthState = 5;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_TransparentBridgingService";
  string   Name;
  string   PrimaryOwnerName;
  string   PrimaryOwnerContact;
  string   StartMode = "Automatic";
  boolean  Started = True;
  string   Keywords[];
  string   ServiceURL;
  string   StartupConditions[];
  string   StartupParameters[];
  uint16   ProtocolType = 15;
  string   OtherProtocolType;
  uint32   AgingTime = 300;
  uint32   FID = 0;
};

Members

The Msvm_TransparentBridgingService class has these types of members:

Methods
Properties

Methods

The Msvm_TransparentBridgingService class has these methods.

Method	Description
RequestStateChange	Requests a state change.
StartService	Starts the service.
StopService	Stops the service.

Properties

The Msvm_TransparentBridgingService class has these properties.

AgingTime

Data type: uint32
Access type: Read-only

The time-out period, in seconds, for aging out dynamically learned MAC addresses. This property is inherited from CIM_TransparentBridgingService.

AvailableRequestedStates

Data type: uint16 array
Access type: Read-only

Indicates the possible values for the RequestedState parameter of the RequestStateChange method. This property is inherited from CIM_EnabledLogicalElement.

Caption

Data type: string
Access type: Read-only

A short description of the object. This property is inherited from CIM_ManagedElement, and it is always "Virtual Switch Transparent Bridging Service".

CommunicationStatus

Data type: uint16
Access type: Read-only

Indicates the ability of the instrumentation to communicate with the underlying managed element. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
Not Available (1)
Communication OK (2)
Lost Communication (3)
No Contact (4)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

CreationClassName

Data type: string
Access type: Read-only

A short description of the object. This property is inherited from CIM_Service.

Description

Data type: string
Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Microsoft Virtual Switch Transparent Bridging Service".

DetailedStatus

Data type: uint16
Access type: Read-only

Compliments the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Not Available (0)
No Additional Information (1)
Stressed (2)
Predictive Failure (3)
Non-Recoverable Error (4)
Supporting Entity in Error (5)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

ElementName

Data type: string
Access type: Read-only

A display name for the object. This property allows each instance to define a display name in addition to its key properties, identity data, and description information. This property is inherited from CIM_ManagedElement.

EnabledDefault

Data type: uint16
Access type: Read-only

An administrator's default or startup configuration for the Enabled State of an element. This property is inherited from CIM_EnabledLogicalElement.

EnabledState

Data type: uint16
Access type: Read-only

The enabled and disabled states of an element. This property is inherited from CIM_EnabledLogicalElement.

FID

Data type: uint32
Access type: Read-only

The filtering database identifier used by switches that support VLAN and that have more than one filtering database. This property is inherited from CIM_TransparentBridgingService.

HealthState

Data type: uint16
Access type: Read-only

The current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. This property is inherited from CIM_ManagedSystemElement.

InstallDate

Data type: datetime
Access type: Read-only

Specifies the time when the object was installed. Lack of a value does not indicate that the object is not installed. This property is inherited from CIM_ManagedSystemElement, and it is not used.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

Keywords

Data type: string array
Access type: Read-only

Do not use. A free-form array of strings that provide descriptive words and phrases that can be used in queries. This property is not implemented because it is not standardized. If this property were a necessary query construct, then it would be required higher in the inheritance hierarchy. This property is inherited from CIM_NetworkService.

Name

Data type: string
Access type: Read-only

A name that uniquely identifies the service and provides an indication of the functionality that is managed. This property is inherited from CIM_Service.

OperatingStatus

Data type: uint16
Access type: Read-only

Provides current status information for the operational condition of the element and can be used for providing more detail with respect to the value of the EnabledState property. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
Not Available (1)
Servicing (2)
Starting (3)
Stopping (4)
Stopped (5)
Aborted (6)
Dormant (7)
Completed (8)
Migrating (9)
Emigrating (10)
Immigrating (11)
Snapshotting (12)
Shutting Down (13)
In Test (14)
Transitioning (15)
In Service (16)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

OperationalStatus

Data type: uint16 array
Access type: Read-only

The current status of the element. This property is inherited from CIM_ManagedSystemElement.

OtherEnabledState

Data type: string
Access type: Read-only

The enabled or disabled state of the element when the EnabledState property is set to 1 (Other). This property is inherited from CIM_EnabledLogicalElement, and it is not used.

OtherProtocolType

Data type: string
Access type: Read-only

The type of protocol that is being forwarded when the value of ProtocolType is 1 (Other). This property is inherited from CIM_ForwardingService.

PrimaryOwnerContact

Data type: string
Access type: Read-only

A string that provides information about how the primary owner of the Service can be reached. This property is inherited from CIM_Service.

PrimaryOwnerName

Data type: string
Access type: Read-only

The name of the primary owner for the service, if one is defined. This property is inherited from CIM_Service.

PrimaryStatus

Data type: uint16
Access type: Read-only

Provides high level status information. This property should be used in conjunction with the DetailedStatus property to provide high level and detailed health status of the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
OK (1)
Degraded (2)
Error (3)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

ProtocolType

Data type: uint16
Access type: Read-only

The type of protocol that is being forwarded. This property is inherited from CIM_ForwardingService.

RequestedState

Data type: uint16
Access type: Read-only

The last requested or desired state for the management service. This property is inherited from CIM_EnabledLogicalElement.

ServiceURL

Data type: string
Access type: Read-only

Do not use. A URL that provides the protocol, network location, and other service-specific information required to access the service. Instead, use the ServiceAccessURI class, which correctly positions the semantics of the service access, and clarifies the format of the information. This property is inherited from CIM_NetworkService.

Started

Data type: boolean
Access type: Read-only

Indicates whether the service has been started (True), or stopped (False). This property is inherited from CIM_Service.

StartMode

Data type: string
Access type: Read-only

Indicates whether the service is automatically started by a system, an operating system, and so on, or is started only upon request. This property is inherited from CIM_Service.

StartupConditions

Data type: string array
Access type: Read-only

Do not use. A free-form array of strings that specify any specific preconditions that must be met for this service to start correctly. This property is not useful because it is not standardized. If this property were a necessary construct, then it would be required higher in the inheritance hierarchy (on Service). This property is inherited from CIM_NetworkService.

StartupParameters

Data type: string array
Access type: Read-only

Do not use. 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. If this method were refined, then its parameters would more formally convey this information. This property is inherited from CIM_NetworkService.

Status

Data type: string
Access type: Read-only

The current status of the object. This property is inherited from CIM_ManagedSystemElement.

StatusDescriptions

Data type: string array
Access type: Read-only

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement.

SystemCreationClassName

Data type: string
Access type: Read-only

The creation class name of the scoping system. This property is inherited from CIM_Service.

SystemName

Data type: string
Access type: Read-only

The NetBIOS name of the hosting computer system. This property is inherited from CIM_Service.

TimeOfLastStateChange

Data type: datetime
Access type: Read-only

The date or time when the enabled state of the element last changed. This property is inherited from CIM_EnabledLogicalElement, and it is not used.

TransitioningToState

Data type: uint16
Access type: Read-only

Indicates the target state to which the instance is transitioning. This property is inherited from CIM_EnabledLogicalElement.

Remarks

Access to the Msvm_TransparentBridgingService class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Namespace	Root\Virtualization\V2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe

Share via