CIM_PhysicalLink class

The CIM_PhysicalLink class represents the cabling of physical elements. For example, serial or Ethernet cables and infrared links would be subclasses (if additional properties or associations are defined) or instances of CIM_PhysicalLink. Typically, the numerous physical cables within a physical package or network are not modeled. However, when the cables or links are critical components or tagged assets of the company, the objects can be instantiated using this class or one of its descendant classes.

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("{FAF76B82-798C-11D2-AAD1-006008C78BC7}"), AMENDMENT]
class CIM_PhysicalLink : CIM_PhysicalElement
{
  string   Caption;
  string   CreationClassName;
  string   Description;
  datetime InstallDate;
  real64   Length;
  string   Manufacturer;
  real64   MaxLength;
  uint16   MediaType;
  string   Model;
  string   Name;
  string   OtherIdentifyingInfo;
  string   PartNumber;
  boolean  PoweredOn;
  string   SerialNumber;
  string   SKU;
  string   Status;
  string   Tag;
  string   Version;
  boolean  Wired;
};

Members

The CIM_PhysicalLink class has these types of members:

Properties

The CIM_PhysicalLink class has these properties.

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.

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.

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.

Length

Data type: real64

Access type: Read-only

Qualifiers: Units ("feet")

Current length of the physical link, in feet. For some connections, especially wireless technologies, this property might not be applicable and should be left uninitialized.

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.

MaxLength

Data type: real64

Access type: Read-only

Qualifiers: Units ("feet")

Maximum length of the physical link in feet.

MediaType

Data type: uint16

Access type: Read-only

Type of media through which transmission signals pass. Common network media include twisted-pair, coaxial, and fiber-optic cable.

Unknown (0)

Other (1)

Cat1 (2)

Cat2 (3)

Cat3 (4)

Cat4 (5)

Cat5 (6)

50-ohm Coaxial (7)

75-ohm Coaxial (8)

100-ohm Coaxial (9)

Fiber-optic (10)

UTP (11)

STP (12)

Ribbon Cable (13)

Twinaxial (14)

Optical 9um (15)

Optical 50um (16)

Optical 62.5um (17)

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.

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.

Wired

Data type: boolean

Access type: Read-only

If TRUE, the physical link is a cable. Otherwise, it is a wireless connection.

Remarks

The CIM_PhysicalLink class is derived from CIM_PhysicalElement.

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_PhysicalElement