Share via


CIM_EnabledLogicalElementCapabilities class

Describes the restrictions on the properties of an associated CIM_EnabledLogicalElement object.

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

Syntax

[Abstract, Version("2.22.0"), UMLPackagePath("CIM::Core::Capabilities")]
class CIM_EnabledLogicalElementCapabilities : CIM_Capabilities
{
  string  Caption;
  string  Description;
  string  InstanceID;
  string  ElementName;
  boolean ElementNameEditSupported;
  uint16  MaxElementNameLen;
  uint16  RequestedStatesSupported[];
  string  ElementNameMask;
};

Members

The CIM_EnabledLogicalElementCapabilities class has these types of members:

Properties

The CIM_EnabledLogicalElementCapabilities class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

A short textual description of the object.

This property is inherited from CIM_ManagedElement.

Description

Data type: string

Access type: Read-only

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 class instance. In addition, the user friendly name can be used as a index property for a query. This value does not have to be unique within its namespace.

This property is inherited from CIM_Capabilities.

ElementNameEditSupported

Data type: boolean

Access type: Read-only

Qualifiers: MappingStrings ("FC-SWAPI.INCITS-T11|SWAPI_UNIT_CONFIG_CAPS_T|EditName"), ModelCorrespondence ("CIM_ManagedElement.ElementName")

true if the ElementName property of the enabled logical element can be modified; otherwise, false.

ElementNameMask

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElementCapabilities.MaxElementNameLen")

A regular expression that indicates the restrictions on the ElementName property of the enable logical element. See DMTF standard ABNF with the Management Profile Specification Usage Guide, appendix C for the permitted syntax.

Note

If this property and the ElementNameMask property of the enable logical element describe the maximum length of ElementName, the smaller value is used.

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 the InstanceID property 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 that defines the InstanceID, or be a registered ID that is assigned by a recognized global authority. This pattern 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. Therefore 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 above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider 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_Capabilities.

MaxElementNameLen

Data type: uint16

Access type: Read-only

Qualifiers: MaxValue (256), MappingStrings ("FC-SWAPI.INCITS-T11|SWAPI_UNIT_CONFIG_CAPS_T|MaxNameChars"), ModelCorrespondence ("CIM_FCSwitchCapabilities.ElementNameEditSupported", "CIM_EnabledLogicalElementCapabilities.ElementNameMask")

The maximum supported length of the ElementName property of the enabled logical element.

RequestedStatesSupported

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.RequestStateChange")

The possible states that can be requested on the enabled logical element by the RequestStateChange method.

The possible values are.

Enabled (2)

Disabled (3)

Shut Down (4)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2016
Namespace
Root\HyperVCluster\v2
MOF
WindowsHyperVCluster.V2.mof
DLL
VMMS.exe

See also

CIM_Capabilities

Failover Clustering Hyper-V WMI Provider