MSFT_TargetPort class
Represents a target port.
A target port is an endpoint in a storage subsystem with associated properties for showing and hiding virtual disks. Fibre Channel, Serial Attached SCSI, and iSCSI ports within a storage subsystem controller are all examples of target ports.
The following syntax is simplified from Managed Object Format (MOF) code.
Syntax
class MSFT_TargetPort : MSFT_StorageObject
{
String FriendlyName;
String PortAddress;
String NodeAddress;
String StorageControllerId;
UInt16 Role;
UInt16 UsageRestriction;
UInt16 HealthStatus;
UInt16 OperationalStatus[];
String OtherOperationalStatusDescription;
UInt16 ConnectionType;
String OtherConnectionTypeDescription;
UInt16 LinkTechnology;
String OtherLinkTechnology;
UInt64 Speed;
UInt64 MaxSpeed;
String NetworkAddresses[];
UInt16 PortNumbers[];
UInt16 PortType;
};
Members
The MSFT_TargetPort class has these types of members:
Properties
The MSFT_TargetPort class has these properties.
ConnectionType
Data type: UInt16
Access type: Read-only
| Value | Meaning |
|---|---|
| 1 | Other |
| 2 | Fibre Channel |
| 3 | Parallel SCSI |
| 4 | SSA |
| 5 | IEEE 1394 |
| 6 | RDMA |
| 7 | iSCSI |
| 8 | SAS |
| 9 | ADT |
FriendlyName
Data type: String
Access type: Read-only
Qualifiers: Required
A user-friendly name for the target port.
HealthStatus
Data type: UInt16
Access type: Read-only
Qualifiers: Required
The health status of the target port.
Healthy (0)
Warning (1)
Unhealthy (2 )
LinkTechnology
Data type: UInt16
Access type: Read-only
The link technology of the target port.
Unknown (0)
Other (1)
Ethernet (2)
IB (3)
FC (4)
FDDI (5)
ATM (6)
Token Ring (7)
Frame Relay (8)
Infrared (9)
BlueTooth (10)
Wireless LAN (11)
Microsoft Reserved (..)
MaxSpeed
Data type: UInt64
Access type: Read-only
Qualifiers: Units ("bits/sec")
The maximum speed of the target port, in bits per second.
NetworkAddresses
Data type: String array
Access type: Read-only
An array of strings that represent the various network addresses for the target port.
The type and format of these addresses are specified in the PortType property.
NodeAddress
Data type: String
Access type: Read-only
Qualifiers: Required
The node address.
OperationalStatus
Data type: UInt16 array
Access type: Read-only
Qualifiers: Required
An array of values that denote the operational status of the target port.
Unknown (0)
Other (1)
OK (2)
Degraded (3)
Stressed (4)
Predictive Failure (5)
Error (6)
Non-Recoverable Error (7)
Starting (8)
Stopping (9)
Stopped (10)
In Service (11)
No Contact (12)
Lost Communication (13)
Aborted (14)
Dormant (15)
Supporting Entity in Error (16)
Completed (17)
Power Mode (18)
Microsoft Reserved (..)
OtherConnectionTypeDescription
Data type: String
Access type: Read-only
A string representation of the vendor-defined connection type. Relevant only if the ConnectionType property is Other.
OtherLinkTechnology
Data type: String
Access type: Read-only
A string representation of the vendor-defined link technology. Relevant only if the LinkTechnology property is Other.
OtherOperationalStatusDescription
Data type: String
Access type: Read-only
A string representation of the vendor-defined status. Relevant only if the OperationalStatus array contains Other.
PortAddress
Data type: String
Access type: Read-only
Qualifiers: Required
The port identifier or address.
For Fibre Channel networks, this property should be the World-Wide Name (WWN) for the port, formatted as a hexadecimal string (16 characters long), with the most significant byte first. For example, a WWN address of 01:23:45:67:89:AB:CD:EF should be represented as 0123456789ABCDEF.
For iSCSI networks, this field should be the IQN.
PortNumbers
Data type: UInt16 array
Access type: Read-only
A list of port numbers for the target port.
PortType
Data type: UInt16
Access type: Read-only
The specific mode that is currently enabled for the port. If the port is logged in, this will be the negotiated port type. Otherwise, the configured port type will be reported.
Unknown (0)
Other (1)
N (10)
NL (11)
F/NL (12)
NX (13)
E (14)
F (15)
FL (16)
B (17)
G (18)
10BaseT (50)
10-100BaseT (51)
100BaseT (52)
1000BaseT (53)
2500BaseT (54)
10GBaseT (55)
10GBase-CX4 (56)
SAS (94)
100Base-FX (100)
100Base-SX (101)
1000Base-SX (102)
1000Base-LX (103)
1000Base-CX (104)
10GBase-SR (105)
10GBase-SW (106)
10GBase-LX4 (107)
10GBase-LR (108)
10GBase-LW (109)
10GBase-ER (110)
10GBase-EW (111)
DMTF Reserved (112..15999)
Vendor Reserved (16000..65535)
Role
Data type: UInt16
Access type: Read-only
Qualifiers: Required
The role of this controller port. For iSCSI, this port must act as either a target or an initiator endpoint. Other transports allow a port to act as both an initiator and a target.
Unknown (0)
Initiator (1)
Target (2)
Both Initiator and Target (3)
Speed
Data type: UInt64
Access type: Read-only
Qualifiers: Units ("bits/sec")
The current speed (bandwidth) of the port, in bits per second. For ports that vary in bandwidth, or for those where no accurate estimation can be made, this property should contain the nominal bandwidth for the port.
StorageControllerId
Data type: String
Access type: Read-only
The identifier of the controller to which this port belongs.
UsageRestriction
Data type: UInt16
Access type: Read-only
The usage restriction of the target port.
In some circumstances, a target port may be identifiable as a front-end or back-end port. For example, a storage array might have back-end ports to communicate with physical disks, 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.
Unknown (0)
Front-end only (2)
Back-end only (3)
Not restricted (4)
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8 [desktop apps only] |
| Minimum supported server | Windows Server 2012 [desktop apps only] |
| Namespace | Root\Microsoft\Windows\Storage |
| MOF | Storagewmi.mof |