MSFT_NetCompartment class
Represents a routing compartment for the TCP/IP (Internet Protocol Suite) provider.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[UMLPackagePath("CIM::Core::Settings"), ClassVersion("1.0.0"), dynamic, provider("nettcpip"), AMENDMENT]
class MSFT_NetCompartment : MSFT_NetSettingData
{
string Caption;
string Description;
string InstanceID;
string ElementName;
uint32 CompartmentId;
string CompartmentGuid;
string CompartmentDescription;
uint32 CompartmentType;
};
Members
The MSFT_NetCompartment class has these types of members:
Properties
The MSFT_NetCompartment class has these properties.
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
Contains a short textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
CompartmentDescription
-
-
Data type: string
-
Access type: Read-only
Gets the user-friendly description of the routing compartment.
**Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012: **
This property is not supported before Windows 10 and Windows Server 2016.
-
-
CompartmentGuid
-
-
Data type: string
-
Access type: Read-only
Get the Globally Unique Identifier (GUID) of the routing compartment.
**Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012: **
This property is not supported before Windows 10 and Windows Server 2016.
-
-
CompartmentId
-
-
Data type: uint32
-
Access type: Read-only
Gets the identifier of the routing compartment.
-
-
CompartmentType
-
-
Data type: uint32
-
Access type: Read-only
Gets the type of the routing compartment.
**Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012: **
This property is not supported before Windows 10 and Windows Server 2016.
-
Unspecified (0)
-
Native (1)
-
RoutingDomain (2)
-
-
Description
-
-
Data type: string
-
Access type: Read-only
Provides a textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
ElementName
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Required
The user-friendly name for this instance. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)
This property is inherited from CIM_SettingData.
-
-
InstanceID
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: key
Uniquely and opaquely identifies an instance of this class within the scope of the containing Namespace.
[!Important]In order to ensure uniqueness within the Namespace, the value of InstanceID should be constructed in the following pattern:
OrgID:LocalID
OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity defining the InstanceID, or be a registered ID that is assigned by a recognized global authority. This is similar to the structure of Schema class names. In addition, to ensure uniqueness the first colon in InstanceID must be between the OrgID andLocalID. Therefor the OrgID must not contain a colon (':').
LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.
If the preceding pattern 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 Namespace.
For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.
This property is inherited from CIM_SettingData.
-
Requirements
| Minimum supported client |
Windows 8.1 |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
Root\standardcimv2 |
| MOF |
|
| DLL |
|