class CIM_EnabledLogicalElementCapabilities : CIM_Capabilities



Description:

EnabledLogicalElementCapabilities describes the capabilities supported for changing the state of the assciated EnabledLogicalElement.

Definition:

Feature Type Class Origin Qualifiers
Caption string CIM_ManagedElement
Description The Caption property is a short textual description (one- line string) of the object.
MaxLen 64
Description string CIM_ManagedElement
Description The Description property provides a textual description of the object.
ElementName string CIM_ManagedElement
Required TRUE
Override ElementName
Description The user friendly name for this instance of Capabilities. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.)
InstanceID string CIM_Capabilities
Key TRUE
Description Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm: <OrgID>:<LocalID> Where <OrgID> and <LocalID> are separated by a colon ':', and where <OrgID> MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness <OrgID> MUST NOT contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID MUST appear between <OrgID> and <LocalID>. <LocalID> is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm 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 instance's NameSpace. For DMTF defined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'.
CreateGoalSettings method CIM_Capabilities
Experimental TRUE
Description Method to create a set of supported SettingData elements, from two sets of SettingData elements, provided by the caller. CreateGoal should be used when the SettingData instances that represents the goal will not persist beyond the execution of the client and where those instances are not intended to be shared with other, non-cooperating clients. Both TemplateGoalSettings and SupportedGoalSettings are represented as strings containing EmbeddedInstances of a CIM_SettingData subclass. These embedded instances do not exist in the infrastructure supporting this method but are maintained by the caller/client. This method should return CIM_Error(s) representing that a single named property of a setting (or other) parameter (either reference or embedded object) has an invalid value or that an invalid combination of named properties of a setting (or other) parameter (either reference or embedded object) has been requested. If the input TemplateGoalSettings is NULL or the empty string, this method returns a default SettingData element that is supported by this Capabilities element. If the TemplateGoalSettings specifies values that cannot be supported, this method shall return an appropriate CIM_Error and should return a best match for a SupportedGoalSettings. The client proposes a goal using the TemplateGoalSettings parameter and gets back Success if the TemplateGoalSettings is exactly supportable. It gets back "Alternative Proposed" if the output SupportedGoalSettings represents a supported alternative. This alternative should be a best match, as defined by the implementation. If the implementation is conformant to a RegisteredProfile, then that profile may specify the algorithms used to determine best match. A client may compare the returned value of each property against the requested value to determine if it is left unchanged, degraded or upgraded. Otherwise, if the TemplateGoalSettings is not applicable an "Invalid Parameter" error is returned. When a mutually acceptable SupportedGoalSettings has been achieved, the client may use the contained SettingData instances as input to methods for creating a new object ormodifying an existing object. Also the embedded SettingData instances returned in the SupportedGoalSettings may be instantiated via CreateInstance, either by a client or as a side-effect of the execution of an extrinsic method for which the returned SupportedGoalSettings is passed as an embedded instance.
ValueMap 0, 1, 2, 3, 4, 5, 6, .., 32768..65535
Values "Success" [0]
"Not Supported" [1]
"Unknown" [2]
"Timeout" [3]
"Failed" [4]
"Invalid Parameter" [5]
"Alternative Proposed" [6]
"DMTF Reserved" [..]
"Vendor Specific" [32768..65535]
ElementNameEditSupported boolean CIM_EnabledLogicalElementCapabilities
Description Boolean indicating whether the ElementName can be modified.
MappingStrings FC-SWAPI.INCITS-T11|SWAPI_UNIT_CONFIG_CAPS_T|EditName
ModelCorrespondence CIM_ManagedElement.ElementName
MaxElementNameLen uint16 CIM_EnabledLogicalElementCapabilities
Description Maximum supported ElementName length.
MaxValue 256
MappingStrings FC-SWAPI.INCITS-T11|SWAPI_UNIT_CONFIG_CAPS_T|MaxNameChars
ModelCorrespondence CIM_FCSwitchCapabilities.ElementNameEditSupported
RequestedStatesSupported uint16[] CIM_EnabledLogicalElementCapabilities
Description RequestedStatesSupported indicates the possible states that can be requested when using the method RequestStateChange on the EnabledLogicalElement.
ValueMap 2, 3, 4, 6, 7, 8, 9, 10, 11
Values "Enabled" [2]
"Disabled" [3]
"Shut Down" [4]
"Offline" [6]
"Test" [7]
"Defer" [8]
"Quiesce" [9]
"Reboot" [10]
"Reset" [11]
ModelCorrespondence CIM_EnabledLogicalElement.RequestStateChange
ElementNameMask string CIM_EnabledLogicalElementCapabilities
Experimental TRUE
Description This string expresses the restrictions on ElementName.The mask is expressed as a regular expression.See DMTF standard ABNF with the Profile Users Guide, appendix C for the regular expression syntax permitted. Since the ElementNameMask can describe the maximum lengthof the ElementName, then the requirements expressed in this property shall take precidence of any length expressed in MaxElementNameLen.
StateAwareness uint16[] CIM_EnabledLogicalElementCapabilities
Experimental TRUE
Description StateAwareness indicates support for modeling the state of the associated instance of CIM_EnabledLogicalElement. If StateAwareness contains the value 2 "Implicit", the RequestedState and TransitioningToState properties of the associated instance of CIM_EnabledLogicalElement shall provide information about state transitions that were initiated through a mechanism other than invocation of the RequestStateChange() method. If StateAwareness contains the value 3 "RequestStateChange", the RequestedState and TransitioningToState properties of the associated instance of CIM_EnabledLogicalElement shall provide information about state transitions initiated by invocation of the RequestStateChange() method. A value of NULL or an array that contains zero elements shall indicate the RequestedState and TransitioningToState properties will not reflect any transitions, irrespective of how they are initiated.
ValueMap 2, 3
Values "Implicit" [2]
"RequestStateChange" [3]

Typographical Conventions:

  1. Inherited properties are italicized.
  2. Local properties are bolded.
  3. Key properties are highlighted in gold