CIM_PhysicalMedia class

The CIM_PhysicalMedia class represents types of documentation and storage medium, such as tapes, CD ROMs, and so on. This class is typically used to locate and manage removable media (versus media sealed with the media access device as a single package, such as hard disks). Sealed media, however, can also be modeled using this class when the media is associated with the physical package using the CIM_PackagedComponent relationship.

Important

The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of its inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

[Abstract, UUID("{FAF76B7D-798C-11D2-AAD1-006008C78BC7}"), AMENDMENT]
class CIM_PhysicalMedia : CIM_PhysicalComponent
{
  uint64   Capacity;
  string   Caption;
  boolean  CleanerMedia;
  string   CreationClassName;
  string   Description;
  boolean  HotSwappable;
  datetime InstallDate;
  string   Manufacturer;
  string   MediaDescription;
  uint16   MediaType;
  string   Model;
  string   Name;
  string   OtherIdentifyingInfo;
  string   PartNumber;
  boolean  PoweredOn;
  boolean  Removable;
  boolean  Replaceable;
  string   SerialNumber;
  string   SKU;
  string   Status;
  string   Tag;
  string   Version;
  boolean  WriteProtectOn;
};

Members

The CIM_PhysicalMedia class has these types of members:

Properties

The CIM_PhysicalMedia class has these properties.

Capacity

Data type: uint64

Access type: Read-only

Qualifiers: Units ("bytes")

Number of bytes that can be read from, or written to, a media. This property is not applicable to hard copy (documentation) or cleaner media. Data compression should not be assumed, as it would increase the value in this property. For tapes, it should be assumed that no file marks or blank space areas are recorded on the media.

For more information about using uint64 values in scripts, see Scripting in WMI.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64), DisplayName ("Caption")

Short textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

CleanerMedia

Data type: boolean

Access type: Read-only

If TRUE, the physical media is used for cleaning purposes, not data storage.

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: CIM_Key, MaxLen (256)

Name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified.

This property is inherited from CIM_PhysicalElement.

Description

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Description")

Textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

HotSwappable

Data type: boolean

Access type: Read-only

If TRUE, the package can be hot-swapped. A physical package can be hot-swapped if the element can be replaced by a physically different (but equivalent) one while the containing package is turned on. For example, a fan component may be designed to be hot-swapped. All components that can be hot-swapped are inherently removable and replaceable.

This property is inherited from CIM_PhysicalComponent.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5"), DisplayName ("Install Date")

Date and time the object was installed. This property does not need a value to indicate that the object is installed.

This property is inherited from CIM_ManagedSystemElement.

Manufacturer

Data type: string

Access type: Read-only

Qualifiers: MaxLen (256)

Name of the organization responsible for producing the physical element. For more information, see the Vendor property of CIM_Product.

This property is inherited from CIM_PhysicalElement.

MediaDescription

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_PhysicalMedia.MediaType")

Additional detail related to the MediaType enumeration. For example, if value 3 ("QIC Cartridge") is specified, this property would indicate whether the tape is wide or 1/4 inch, pre-formatted, Travan compatible, and so on.

MediaType

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_PhysicalMedia.MediaDescription")

Type of physical media. The MediaDescription property provides more explicit definition of the media type.

Unknown (0)

Other (1)

Tape Cartridge (2)

QIC Cartridge (3)

AIT Cartridge (4)

DTF Cartridge (5)

DAT Cartridge (6)

8mm Tape Cartridge (7)

19mm Tape Cartridge (8)

DLT Cartridge (9)

Half-Inch Magnetic Tape Cartridge (10)

Cartridge Disk (11)

JAZ Disk (12)

ZIP Disk (13)

SyQuest Disk (14)

Winchester Removable Disk (15)

CD-ROM (16)

CD-ROM/XA (17)

CD-I (18)

CD Recordable (19)

WORM (20)

Magneto-Optical (21)

DVD (22)

DVD+RW (23)

DVD-RAM (24)

DVD-ROM (25)

DVD-Video (26)

Divx (27)

Floppy/Diskette (28)

Floppy disk

Hard Disk (29)

Memory Card (30)

Hard Copy (31)

Clik Disk (32)

CD-RW (33)

CD-DA (34)

CD+ (35)

DVD Recordable (36)

DVD-RW (37)

DVD-Audio (38)

DVD-5 (39)

DVD-9 (40)

DVD-10 (41)

DVD-18 (42)

Magneto-Optical Rewriteable (43)

Magneto-Optical Write Once (44)

Magneto-Optical Rewriteable (LIMDOW) (45)

Phase Change Write Once (46)

Phase Change Rewriteable (47)

Phase Change Dual Rewriteable (48)

Ablative Write Once (49)

Near Field Recording (50)

MiniQic (51)

Travan (52)

8mm Metal Particle (53)

8mm Advanced Metal Evaporate (54)

NCTP (55)

LTO Ultrium (56)

LTO Accelis (57)

9 Track Tape (58)

9-track tape

18 Track Tape (59)

18-track tape

36 Track Tape (60)

36-track tape

Magstar 3590 (61)

Magstar MP (62)

D2 Tape (63)

Tape - DST Small (64)

Tape DST small

Tape - DST Medium (65)

Tape DST medium

Tape - DST Large (66)

Tape DST large

Model

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

Name by which the physical element is generally known.

This property is inherited from CIM_PhysicalElement.

Name

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Name")

Label by which the object is known. When subclassed, this property can be overridden to be a key property.

This property is inherited from CIM_ManagedSystemElement.

OtherIdentifyingInfo

Data type: string

Access type: Read-only

Additional data, beyond asset tag information, that can be used to identify a physical element. One example is bar-code data that is associated with an element, which also has an asset tag. Note that if only bar-code data is available, and is unique and able to be used as an element key, this property would be null and the bar-code data would be used as the class key in the Tag property. This property is inherited from CIM_PhysicalElement.

PartNumber

Data type: string

Access type: Read-only

Qualifiers: MaxLen (256)

Part number assigned by the organization responsible for producing or manufacturing the physical element.

This property is inherited from CIM_PhysicalElement.

PoweredOn

Data type: boolean

Access type: Read-only

If TRUE, the physical element is powered on.

This property is inherited from CIM_PhysicalElement.

Removable

Data type: boolean

Access type: Read-only

If TRUE, this element is designed to be taken in and out of the physical container in which it is normally found, without impairing the function of the overall packaging. A package is considered removable even if the power must be off to perform the removal. If the power can be on and the package removed, then the element is removable and can be hot-swapped. For example, an ungradable processor chip is removable.

This property is inherited from CIM_PhysicalComponent.

Replaceable

Data type: boolean

Access type: Read-only

If TRUE, it is possible to replace the element with a physically different one. For example, some computer systems allow the main processor chip to be upgraded to one of a higher clock rating. In this case, the processor is said to be replaceable. All removable components are inherently replaceable.

This property is inherited from CIM_PhysicalComponent.

SerialNumber

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

Manufacturer-allocated number used to identify the physical element.

This property is inherited from CIM_PhysicalElement.

SKU

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

Stock-keeping unit number for the physical element.

This property is inherited from CIM_PhysicalElement.

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10), DisplayName ("Status")

Current status of the object.

This property is inherited from CIM_ManagedSystemElement.

Values include the following:

OK ("OK")

Error ("Error")

Degraded ("Degraded")

Unknown ("Unknown")

Pred Fail ("Pred Fail")

Starting ("Starting")

Stopping ("Stopping")

Service ("Service")

Stressed ("Stressed")

NonRecover ("NonRecover")

No Contact ("No Contact")

Lost Comm ("Lost Comm")

Tag

Data type: string

Access type: Read-only

Qualifiers: CIM_Key, MaxLen (256)

Arbitrary string that uniquely identifies the physical element and serves as the element's key. This property can contain information, such as asset tag or serial number data. The key for CIM_PhysicalElement is placed very high in the object hierarchy to independently identify the hardware or entity, regardless of physical placement in (or on) cabinets, adapters, and so on. For example, a removable component that can be hot-swapped can be taken from its containing (scoping) package and be temporarily unused. The object still continues to exist and can even be inserted into a different scoping container. The key for a physical element is an arbitrary string that is defined independently of placement or location-oriented hierarchy.

This property is inherited from CIM_PhysicalElement.

Version

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

Version of the physical element.

This property is inherited from CIM_PhysicalElement.

WriteProtectOn

Data type: boolean

Access type: Read-only

If TRUE, the media is currently write-protected by a physical mechanism, such as a protect tab on a floppy disk.

Remarks

The CIM_PhysicalMedia class is derived from CIM_PhysicalComponent.

WMI does not implement this class.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

Minimum supported client
Windows Vista
Minimum supported server
Windows Server 2008
Namespace
Root\CIMV2
MOF
CIMWin32.mof
DLL
CIMWin32.dll

See also

CIM_PhysicalComponent