MSFT_SMEndpoint class
Represents an endpoint.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Windows Server 2012 R2 and Windows Server 2012: This class does not inherit from MSFT_SMStorageObject which is new for Windows Server 2016.
Syntax
[dynamic, provider("WMIStorage"), AMENDMENT]
class MSFT_SMEndpoint : MSFT_SMStorageObject
{
String ObjectId;
String Identifier;
String Address;
String Name;
String ElementName;
uint16 ConnectionType;
string ConnectionTypeDescription;
uint16 Role;
string RoleDescription;
uInt16 HealthStatus;
string HealthStatusDescription;
uint16 OperationalStatus[];
string StatusDescription;
uint16 LinkTechnology;
uint64 MaxSpeed;
string NetworkAddresses[];
string OtherLinkTechnology;
uint16 PortNumber;
uint16 PortType;
uint64 Speed;
string SystemName;
uint16 UsageRestriction;
};
Members
The MSFT_SMEndpoint class has these types of members:
Properties
The MSFT_SMEndpoint class has these properties.
-
Address
-
-
Data type: String
-
Access type: Read-only
The IP address of the endpoint.
-
-
ConnectionType
-
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: MappingStrings ("SPC.INCITS-T10 | Protocol Identifier | Values"), ModelCorrespondence ("CIM_SCSIProtocolEndpoint.Name", "CIM_SCSIProtocolEndpoint.OtherConnectionType")
The supported connection type for this endpoint.
The possible values are.
-
-
Other (1)
-
Fibre Channel (2)
-
Parallel SCSI (3)
-
SSA (4)
-
IEEE 1394 (5)
-
RDMA (6)
-
iSCSI (7)
-
SAS (8)
-
ADT (9)
ConnectionTypeDescription
-
Data type: string
-
Access type: Read-only
A description of the connection type.
ElementName
-
Data type: String
-
Access type: Read-only
The name of the endpoint that is displayed to users.
**Windows Server 2012: **
This property is not supported.
HealthStatus
-
Data type: uInt16
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed")
The SCXSM current status of the endpoint.
The possible values are.
Healthy (0)
Warning (1)
Unhealthy (2)
HealthStatusDescription
-
Data type: string
-
Access type: Read-only
The SCXSM current status of the endpoint in text.
Identifier
-
Data type: String
-
Access type: Read-only
-
Qualifiers: Required
The ID of the logical instance of the object. This ID must be unique within the scope of the storage system.
This property is inherited from MSFT_SMStorageObject.
Windows Server 2012 R2 and Windows Server 2012: This property is present, but is not inherited from MSFT_SMStorageObject .
LinkTechnology
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_NetworkPort.OtherLinkTechnology")
The type of link. When set to Other, the OtherLinkTechnology property describes the link.
The possible values are.
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)
MaxSpeed
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: PUnit ("bit / second"), ModelCorrespondence ("CIM_LogicalPort.MaxSpeed"), Units ("Bits per Second")
The maximum bandwidth of the port in Bits per Second.
Name
-
Data type: String
-
Access type: Read-only
The label of the endpoint.
NetworkAddresses
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: MaxLen (64), MappingStrings ("MIF.DMTF|Network Adapter 802 Port|001.3"), ModelCorrespondence ("CIM_NetworkPort.NetworkAddresses")
The network addresses for the endpoint. The address format depends on the PortType.
ObjectId
The ID of this class instance. This ID must be unique within the scope of the Windows Storage Management server that hosts the provider object.
This property is inherited from MSFT_SMStorageObject.
Windows Server 2012 R2 and Windows Server 2012: This property is present, but is not inherited from MSFT_SMStorageObject .
OperationalStatus
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ComputerSystem.OperationalStatus")
The current SMIS status of the endpoint.
The possible values are.
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)
OtherLinkTechnology
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_NetworkPort.LinkTechnology")
Describes the type of link when the LinkTechnology property is set to Other.
PortNumber
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_NetworkPort.PortNumber")
The number of the port. Ports may be numbered relative to a logical module or a network element.
PortType
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_LogicalPort.PortType")
The specific mode currently enabled for the port.
The possible values are.
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 Reserrved
Vendor Reserved
Role
-
Data type: uint16
-
Access type: Read-only
Which role this endpoint implements.
For iSCSI, each endpoint must act as either a target or an initiator endpoint. Other transports allow a SCSI endpoint to act as both an initiator and target endpoint.
The possible values are.
Unknown (0)
Initiator (2)
Target (3)
Both Initiator and Target (4)
RoleDescription
-
Data type: string
-
Access type: Read-only
A description of the role of the endpoint.
Speed
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIB.IETF|MIB-II.ifSpeed", "MIF.DMTF|Network Adapter 802 Port|001.5"), PUnit ("bit / second"), ModelCorrespondence ("CIM_NetworkPort.Speed"), Units ("Bits per Second")
The current bandwidth of the Port in Bits per Second.
StatusDescription
-
Data type: string
-
Access type: Read-only
The current SMIS status of the endpoint in text.
SystemName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (256), ModelCorrespondence ("CIM_LogicalDevice.SystemName")
The name of the scoping system.
UsageRestriction
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_LogicalPort.UsageRestriction")
Whether a logical port is restricted to use as a front end or back end port.
The possible values are.
Unknown (0)
Front-end only (2)
Back-end only (3)
Not restricted (4)
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 |
| Namespace |
Root\Microsoft\Windows\Storage\SM |
| MOF |
|
| DLL |
|