Reference Guide

The Reference Guide contains the
file:///T|/htdocs/SOFTWARE/smcliins/cli81/en/refgd/index.html[10/19/2012 10:01:19 AM]
The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ("Not Applicable"),
then this property has no meaning. Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.
Note: The value "No Change" (5) has been deprecated instead of indicating the last requested state is "Unknown" (0). If the last requested or desired state is unknown, RequestedState should have the value "Unknown"
(0), but may have the value "No Change" (5).
There are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11).
Shut Down requests an orderly transition to the Disabled state, and may involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will
not execute or accept any commands or processing requests.
This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a
WRITEable property, because it allows an explicit invocation of the operation and the return of a result code.
If knowledge of the last RequestedState is not supported for the EnabledLogicalElement, the property is NULL or has the value 12 "Not Applicable".
TransitioningToState
Indicates the target state to which the instance is transitioning.
Possible values are:
0 = Unknown
2 = Enabled
3 = Disabled
4 = Shut Down
5 = No Change - Indicates that no transition is in progress.
6 = Offline
7 = Test
8 = Defer
9 = Quiesce
10 = Reboot
11 = Reset
12 = Not Applicable - Indicates the implementation does not support representing ongoing transitions.
A value other than 5 or 12 identifies the state to which the element is in the process of transitioning.
Version A string describing the Operating System's version number. The format of the version information is as follows: <Major Number>.<Minor Number>.<Revision> or <Major Number>.<Minor Number>.<Revision Letter>.
DCIM_SoftwareIdentity
ClassificationDescriptions An array of free-form strings providing more detailed explanations for any of the entries in the Classifications array. Note that each entry is related to one in the Classifications array located at the same index.
Classifications
An array of enumerated integers that classify this software. For example, the software MAY be instrumentation (value=5) or firmware and diagnostic software (10 and 7). The use of value 6, Firmware/BIOS, is being
deprecated. Instead, either the value 10 (Firmware) and/or 11 (BIOS/FCode) SHOULD be used. The value 13, Software Bundle, identifies a software package consisting of multiple discrete software instances that can be
installed individually or together.
Each contained software instance is represented by an instance of SoftwareIdentity that is associated to this instance of SoftwareIdentityinstance via a Component association.
Possible values are:
0 = Unknown
1 = Other
2 = Driver
3 = Configuration Software
4 = Application Software
5 = Instrumentation
6 = Firmware/BIOS
7 = Diagnostic Software
8 = Operating System
9 = Middleware
10 = Firmware
11 = BIOS/FCode
12 = Support/Service Pack
13 = Software Bundle
.. = DMTF Reserved
0x8000..0xFFFF = Vendor Reserved
ElementName
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.
Note: The Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-
friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties.
InstanceID
Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. 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 the 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 must 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'.
IsEntity
The IsEntity property is used to indicate whether the SoftwareIdentity corresponds to a discrete copy of the software component or is being used to convey descriptive and identifying information about software that is not
present in the management domain.A value of TRUE indicates that the SoftwareIdentity instance corresponds to a discrete copy of the software component. A value of FALSE indicates that the SoftwareIdentity instance
does not correspond to a discrete copy of the Software.
Manufacturer Manufacturer of this software.
ReleaseDate The date the software was released.
RevisionNumber
The revision or maintenance release component of the software's version information - for example, '3' from version 12.1(3)T. This property is defined as a numeric value to allow the determination of 'newer' vs. 'older'
releases. A 'newer' revision is indicated by a larger numeric value.
TargetTypes
An array of strings that describes the compatible installer(s). The purpose of the array elements is to establish compatibility between a SoftwareIdentity and a SoftwareInstallationService that can install the
SoftwareIdentity by comparing the values of the array elements of this property to the values of SoftwareInstallationServiceCapabilities.SupportedTargetTypes[] property's array elements.
VersionString
A string representing the complete software version information - for example, '12.1(3)T'. This string and the numeric major/minor/revision/build properties are complementary. Since vastly different representations and
semantics exist for versions, it is not assumed that one representation is sufficient to permit a client to perform computations (i.e., the values are numeric) and a user to recognize the software's version (i.e., the values
are understandable and readable). Hence, both numeric and string representations of version are provided.
DCIM_BIOSElement