Class reference

Subclass of CIM_ATAPort

Represents the port of an ATA device to system connection.

Local properties

uint64 MaxSpeed

The maximum bandwidth of the Port in Bits per Second.

string InstanceID

InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.

To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following “preferred” algorithm:


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 that is creating or defining the InstanceID or that is a registered ID 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 reused to identify different underlying (real-world) elements. If not null and the above “preferred” algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.

If not set to null for DMTF-defined instances, the “preferred” algorithm must be used with the <OrgID> set to CIM.

string SystemName

The System Name of the scoping system.

string 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 that 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. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.

string Description

The Description property provides a textual description of the object.

string Name

The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.

string Caption

The Caption property is a short textual description (one- line string) of the object.

string DeviceID

An address or other identifying information used to uniquely name the LogicalDevice.

uint16 PortType

The type of port.

ValueMap Values
0 Unknown
1 Other
91 ATA
93 SATA2
16000.. Vendor Reserved

uint16 UsageRestriction

In some circumstances, a LogicalPort might be identifiable as a front end or back end port. An example of this situation would be a storage array that might have back end ports to communicate with disk drives and front end ports to communicate with hosts. If there is no restriction on the use of the port, then the value should be set to ‘not restricted’.

ValueMap Values
0 Unknown
2 Front-end only
3 Back-end only
4 Not restricted

string CreationClassName

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.

uint64 Speed

The bandwidth of the Port in Bits per Second.

string SystemCreationClassName

The CreationClassName of the scoping system.

Local methods