Msvm_TransparentBridgingService class

Article
05/31/2018

Serves as a placeholder for the service inside the switch that learns MAC addresses and serves as a bridge between the Msvm_VirtualSwitch 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   Caption = "Microsoft 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   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  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	This method is not supported.
StartService	This method is not supported.
StopService	This method is not supported.

Properties

The Msvm_TransparentBridgingService class has these properties.

AgingTime

Data type: uint32
Access type: Read-only
Qualifiers: Units ("Seconds"), MappingStrings ("MIB.IETF|BRIDGE-MIB.dot1dTpAgingTime")

The timeout period in seconds for aging out dynamically learned MAC addresses. This property is inherited from CIM_TransparentBridgingService and is always set to 300.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

A short textual description (one- line string) of the object. This property is inherited from CIM_ManagedElement and is always "Microsoft Virtual Switch Transparent Bridging Service".

CreationClassName

Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

A short textual description (one- line string) of the object. This property is inherited from CIM_Service and is always "Msvm_TransparentBridgingService".

Description

Data type: string
Access type: Read-only

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

ElementName

Data type: string
Access type: Read-only

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. This property is inherited from CIM_ManagedElement.

EnabledDefault

Data type: uint16
Access type: Read/write

An administrator's default or startup configuration for the Enabled State of an element. This property is inherited from CIM_EnabledLogicalElement and is always set to 2 (Enabled).

EnabledState

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")

The enabled and disabled states of an element. This property is inherited from CIM_EnabledLogicalElement and is always set to 5 (Not Applicable).

Not Applicable (5)

Indicates the element does not support to be enabled or disabled.

FID

Data type: uint32
Access type: Read-only

The filtering database identifier used by VLAN-aware switches that have more than one filtering database. This property is inherited from CIM_TransparentBridgingService and is always set to 0.

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 and is always set to 5 (OK).

OK (5)

The element is fully functional and operates within normal operational parameters and without error.

InstallDate

Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

A datetime value that indicates 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 is not used.

Keywords

Data type: string array
Access type: Read-only
Qualifiers: Deprecated ("No value")

A free-form array of strings that provide descriptive words and phrases that can be used in queries. To-date, this property has not been implemented, because it is not standardized. Also, if this was 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. This property is inherited from CIM_NetworkService.

Name

Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

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

OperationalStatus

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

The current status of the element. This property is inherited from CIM_ManagedSystemElement and is always set to 2 (OK).

OK (2)

Indicates full functionality without errors.

OtherEnabledState

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

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 is not used.

OtherProtocolType

Data type: string
Access type: Read-only
Qualifiers: MaxLen (32), ModelCorrespondence ("CIM_ForwardingService.ProtocolType")

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/write
Qualifiers: MaxLen (256), MappingStrings ("MIF.DMTF|General Information|001.4")

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

PrimaryOwnerName

Data type: string
Access type: Read/write
Qualifiers: MaxLen (64), MappingStrings ("MIF.DMTF|General Information|001.3")

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

ProtocolType

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ForwardingService.OtherProtocolType")

The type of protocol that is being forwarded. This property is inherited from CIM_ForwardingService and is always set to 15 (Ethernet).

RequestedState

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

The last requested or desired state for the management service. This property is inherited from CIM_EnabledLogicalElement and is always set to 12 (Not Applicable).

Not Applicable (12)

Indicates that this instance does not support the RequestedState property.

ServiceURL

Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_ServiceAccessURI")

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. 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 and is always set to True.

StartMode

Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_Service.EnabledDefault"), MaxLen (10)

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 and is always set to "Automatic".

StartupConditions

Data type: string array
Access type: Read-only
Qualifiers: Deprecated ("No value")

A free-form array of strings that specify any specific pre-conditions that must be met in order for this service to start correctly. It was expected that subclasses would refine the inherited StartService method to suit their specific requirements. To-date, this refinement has not been necessary. Also, the property is not useful, because it is not standardized. If this was 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. This property is inherited from CIM_NetworkService.

StartupParameters

Data type: string array
Access type: Read-only
Qualifiers: Deprecated ("No value")

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

Status

Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

This property is inherited from CIM_ManagedSystemElement but it is not used.

StatusDescriptions

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement and is always set to "OK".

SystemCreationClassName

Data type: string
Access type: Read-only
Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)

The creation class name of the scoping system. This property is inherited from CIM_Service and is always set to "Msvm_ComputerSystem".

SystemName

Data type: string
Access type: Read-only
Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)

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 is not used.

Remarks

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

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2008
End of client support	None supported
End of server support	Windows Server 2012 R2
Namespace	Root\Virtualization
MOF	WindowsVirtualization.mof

Partager via