Reference Guide

The Reference Guide contains the
file:///T|/htdocs/SOFTWARE/smcliins/cli81/en/refgd/index.html[10/19/2012 10:01:19 AM]
DCIM_ConcreteCollection
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 unique name. It can be a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is
creating or defining the InstanceID. Or, it could be a registered ID that is assigned to the business entity by a recognized global authority.(This requirement 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 ensure that the resulting
InstanceID is not re-used as any of the InstanceIDs produced by this or other providers for the NameSpace of this instance.
DCIM_RedundancySet
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 unique name. It can be a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is
creating or defining the InstanceID. Or, it could be a registered ID that is assigned to the business entity by a recognized global authority.(This requirement 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 ensure that the resulting
InstanceID is not re-used as any of InstanceIDs produced by this or other providers for the NameSpace of this instance.
For DMTF-defined instances, the 'preferred' algorithm must be used with the <OrgID> set to 'CIM'.
MinNumberNeeded
MinNumberNeeded indicates the smallest number of elements that MUST be operational in order to function. For example, in an N+1 redundancy relationship, the MinNumberNeeded property is set equal to N. In a
'LimitedSparing' environment, this property is meaningless and SHOULD be set to zero.
RedundancyStatus
RedundancyStatus provides information on the state of the RedundancyGroup.
Possible values are:
0 = Unknown
1 = DMTF Reserved
2 = Fully Redundant - Indicates that all of the configured redundancy is still available
3 = Degraded Redundancy - Indicates that some configured elements are degraded, missing or failed but that the number of elements in the set is still greater than the minimum required ('MinNumberNeeded');
4 = Redundancy Lost - Indicates that sufficient configured elements are missing or failed that no redundancy is available and the next failure experienced will cause overall failure.
5 = Overall Failure - Indicates that there has been an overall failure of the RedundancySet.
TypeOfSet
TypeOfSet provides information on the type of redundancy. - N+1 (=2) indicates all members are active, are unaware and function independent of one another. However, there exist at least one extra member to achieve
functionality. 'Sparing' is implied (i.e. each member can be a spare for the other(s). An example of N+1 is a system that has 2 power supplies, but needs only 1 power supply to functioning properly.
Possible values are:
0 = Unknown
1 = Other
2 = N+1
3 = Load Balanced - Indicates all members are active. However, there functionality is not independent of each other. Their functioning is determined by some sort of load balancing algrothim (implemented in hardware
and/or software). 'Sparing' is implied (i.e. each member can be a spare for the other(s).
4 = Sparing - Indicates that all members are active and are aware of each others. However, their functionality is independent until failover. Each member can be a spare for the other(s).
5 = Limited Sparing - Indicates that all members are active, and they may or may not be aware of each and they are not spares for each other. Instead, their redundancy is indicated by the IsSpare relationship.
.. = DMTF Reserved
0x8000.. = Vendor Reserved
DCIM_Role
CommonName
A Common Name is a (possibly ambiguous) name by which the role is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is
associated.
CreationClassName
Indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely
identified.
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.
Name The Name property defines the label by which the object is known. In the case of an LDAP-derived instance, the Name property value may be set to the distinguished name of the LDAP-accessed object instance.
RoleCharacteristics
RoleCharacteristics provides descriptive information about the intended usage of the Role.
Possible values are:
2 = Static
3 = Opaque
.. = DMTF Reserved
32000..65535 = Vendor Specific
When the value 2 "Static" is specified, no modification to the role is allowed. Any requests by client to change the privileges or the scope of the role by modifying the associated instances of CIM_Privilege or referencing
associations fails.
When the value 2 "Static" is not specified, the instance of CIM_Role may be modified by a client. The modification may include changing the scope of the role or rights granted. When the value 3 "Opaque" is specified, the
rights granted by the CIM_Role instance is not explicitly modeled through aggregation of instances of CIM_Privilege.
When the value 3 "Opaque" is not specified, the rights granted by the instance of CIM_Role is explicitly modeled through aggregation of instances of CIM_Privilege.
DCIM_IndicationSettingCollection
ElementName Human user oriented identifier for this instance.