MSISCSITARGET_iSCSIProtocolEndpoint class

Represents an iSCSI port.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Dynamic, Provider("MSiSCSITargetProv"), Version("1.0.0")]
class MSISCSITARGET_iSCSIProtocolEndpoint : CIM_iSCSIProtocolEndpoint
{
  string   Caption;
  string   ElementName;
  datetime InstallDate;
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  string   SystemCreationClassName;
  string   SystemName;
  string   CreationClassName;
  datetime TimeOfLastStateChange;
  uint16   EnabledState;
  uint16   OperationalStatus[];
  string   Description;
  string   NameFormat;
  uint16   ProtocolType;
  string   OtherTypeDescription;
  uint32   TargetRelativePortNumber;
  string   OtherConnectionType;
  string   Name;
  uint16   ProtocolIFType = 1;
  uint16   ConnectionType = 7;
  string   Identifier = 000000000001";
  uint16   Role = 3;
};

Members

The MSISCSITARGET_iSCSIProtocolEndpoint class has these types of members:

Methods

The MSISCSITARGET_iSCSIProtocolEndpoint class has these methods.

MethodDescription
RequestStateChange

Requests that the state of the element be changed to the specified value.

This method is inherited from the CIM_EnabledLogicalElement class.

 

Properties

The MSISCSITARGET_iSCSIProtocolEndpoint class has these properties.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

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

This property is inherited from CIM_ManagedElement.

ConnectionType
Data type: uint16
Access type: Read-only
Qualifiers: Override ("ConnectionType"), MappingStrings ("SPC.INCITS-T10 | Protocol Identifier | Values"), ModelCorrespondence ("CIM_SCSIProtocolEndpoint.Name", "CIM_SCSIProtocolEndpoint.OtherConnectionType")

Indicates the supported connection type for this endpoint. The connection type is used in some SCSI commands and might be required before the ports are associated.

Important  For MSISCSITARGET_iSCSIProtocolEndpoint and all classes that are derived from it, the ConnectionType property must be iSCSI (7).
 

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)

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

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.

This property is inherited from CIM_ServiceAccessPoint.

Description
Data type: string
Access type: Read-only
Qualifiers: MappingStrings ("MIB.IETF|IF-MIB.ifDescr")

TBD

This property is inherited from CIM_ProtocolEndpoint.

ElementName
Data type: string
Access type: Read-only

Contains 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.

This property is inherited from CIM_ManagedElement.

EnabledDefault
Data type: uint16
Access type: Read/write

An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is "Enabled" (value=2).

This property is inherited from CIM_EnabledLogicalElement.

Enabled (2)

Disabled (3)

Not Applicable (5)

Enabled but Offline (6)

No Default (7)

Quiesce (9)

DMTF Reserved

10–32767

Vendor Reserved

32768–65535
EnabledState
Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIB.IETF|IF-MIB.ifAdminStatus")

TBD

This property is inherited from CIM_ProtocolEndpoint.

HealthState
Data type: uint16
Access type: Read-only

Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its sub-components.

This property is inherited from CIM_ManagedSystemElement.

The following values have been defined:

Unknown (0)

The implementation cannot report on HealthState at this time.

OK (5)

The element is fully functional and is operating within normal operational parameters and without error.

Degraded/Warning (10)

The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors

Minor failure (15)

All functionality is available but some might be degraded.

Major failure (20)

The element is failing. It is possible that some or all of the functionality of this component is degraded or not working.

Critical failure (25)

The element is non-functional and recovery might not be possible.

Non-recoverable error (30)

The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.

DMTF Reserved

DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.

Identifier
Data type: string
Access type: Read-only
Qualifiers: Required, Override ("Identifier"), MaxLen (13)

Uniquely identifies the endpoint. The Identifier property must contain the Initiator Session ID (ISID) if it is an initiator, or the Target Portal Group Tag (TGPT) if it is a target. This property must be unique across all CIM_iSCSIProtocolEndpoint instances that are associated with a common CIM_SCSIProtocolController instance. This field is formatted as 12 hexadecimal digits.

InstallDate
Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

Indicates when the object was installed. The lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

Name
Data type: string
Access type: Read-only
Qualifiers: MaxLen (256), ModelCorrespondence ("CIM_SCSIProtocolEndpoint.ConnectionType", "CIM_SCSIProtocolEndpoint.OtherConnectionType")

The format of Name is based on the ConnectionType property. For iSCSI, the Name property of a CIM_SCSIProtocolEndpoint MUST contain the iSCSI port name as described in the iSCSI RFC (currently http://www.ietf.org/internet-drafts/draft-ietf- ips-iscsi-20.txt) -

<iSCSI node name> + 'i,' + ISID for initiators,

<iSCSI node name> + 't,' + TPGT for targets,

where <iSCSI node name> can be any of the standard iSCSI name namespaces (eg. iqn, eui); and includes the namespace prefix.

This property is inherited from CIM_iSCSIProtocolEndpoint.

NameFormat
Data type: string
Access type: Read-only
Qualifiers: MaxLen (256)

NameFormat contains the naming heuristic that is selected to ensure that the value of the Name property is unique. For example, you might choose to prepend the name of the port or interface with the Type of ProtocolEndpoint (for example, IPv4) of this instance followed by an underscore.

This property is inherited from CIM_ProtocolEndpoint.

OperationalStatus
Data type: uint16 array
Access type: Read-only
Qualifiers: MappingStrings ("MIB.IETF|IF-MIB.ifOperStatus")

TBD

This property is inherited from CIM_ProtocolEndpoint.

OtherConnectionType
Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_SCSIProtocolEndpoint.Name", "CIM_SCSIProtocolEndpoint.ConnectionType")

The connection type, if ConnectionType is "Other".

This property is inherited from CIM_SCSIProtocolEndpoint.

OtherEnabledState
Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1.

This property is inherited from CIM_EnabledLogicalElement.

OtherTypeDescription
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64), ModelCorrespondence ("CIM_ProtocolEndpoint.ProtocolType", "CIM_ProtocolEndpoint.ProtocolIFType")

A string that describes the type of ProtocolEndpoint when the Type property of this class (or any of its subclasses) is set to 1 (Other). This property should be set to null when the Type property is any value other than 1.

This property is inherited from CIM_ProtocolEndpoint.

ProtocolIFType
Data type: uint16
Access type: Read-only
Qualifiers: Override ("ProtocolIFType"), MappingStrings ("MIB.IETF|IF-MIB.ifType"), ModelCorrespondence ("CIM_ProtocolEndpoint.OtherTypeDescription")

Indicates the Protocol Interface Type, which is used to categorize and to classify CIM_ProtocolEndpoint instances.

Note  Values are mapped to the Internet Assigned Numbers Authority (IANA) ifType Management Information Base (MIB). For more information, see the IANA website at http://www.iana.org/assignments/ianaiftype-mib.
 

Additional values that are defined by the Distributed Management Task Force (DMTF) have been added.

If the ProtocolIFType property is set to 1 (Other), then the type information must be provided in the OtherTypeDescription property.

ProtocolType
Data type: uint16
Access type: Read-only
Qualifiers: Deprecated ("CIM_ProtocolEndpoint.ProtocolIFType"), ModelCorrespondence ("CIM_ProtocolEndpoint.OtherTypeDescription")

Note: This property is deprecated in lieu of the ProtocolIFType enumeration. This deprecation was done to have better alignment between the IF-MIB of the IETF and this CIM class. Deprecated description: ProtocolType is an enumeration that provides information to categorize and classify different instances of this class. For most instances, information in this enumeration and the definition of the subclass overlap. However, there are several cases where a specific subclass of ProtocolEndpoint is not required (for example, there is no Fibre Channel subclass of ProtocolEndpoint). Therefore, this property is needed to define the type of Endpoint.

This property is inherited from CIM_ProtocolEndpoint.

Unknown (0)

Other (1)

IPv4 (2)

IPv6 (3)

IPX (4)

AppleTalk (5)

DECnet (6)

SNA (7)

CONP (8)

CLNP (9)

VINES (10)

XNS (11)

ATM (12)

Frame Relay (13)

Ethernet (14)

TokenRing (15)

FDDI (16)

Infiniband (17)

Fibre Channel (18)

ISDN BRI Endpoint (19)

ISDN B Channel Endpoint (20)

ISDN D Channel Endpoint (21)

IPv4/v6 (22)

BGP (23)

OSPF (24)

MPLS (25)

UDP (26)

TCP (27)

RequestedState
Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

RequestedState is an integer enumeration that indicates the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the RequestedState of the element is 5 ("No Change"). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11). Reboot refers to doing a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code. A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ("Not Applicable") is used.

This property is inherited from CIM_EnabledLogicalElement.

Enabled (2)

Disabled (3)

Shut Down (4)

No Change (5)

Offline (6)

Test (7)

Deferred (8)

Quiesce (9)

Reboot (10)

Reset (11)

Not Applicable (12)

DMTF Reserved

13–32767

Vendor Reserved

32768–65535
Role
Data type: uint16
Access type: Read-only
Qualifiers: Override ("Role")

Indicates whether the CIM_SCSIProtocolEndpoint is acting as a target or initiator endpoint.

The possible values are.

Initiator (2)

Target (3)

Status
Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

Contains a string indicating the primary status of the object.

Note  This property is deprecated and replaced by the OperationalStatus property. If you choose to use the Status property for backward compatibility it should be secondary to the OperationalStatus property.
 

This property is inherited from CIM_ManagedSystemElement.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

("Stressed")

("NonRecover")

("No Contact")

("Lost Comm")

("Stopped")

StatusDescriptions
Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Contains strings describing the corresponding values in the OperationalStatus array. For example, if an element in OperationalStatus contains the value Stopping, then the element at the same array index in this property may contain an explanation as to why an object is being stopped.

This property is inherited from CIM_ManagedSystemElement.

SystemCreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)

The CreationClassName of the scoping System.

This property is inherited from CIM_ServiceAccessPoint.

SystemName
Data type: string
Access type: Read-only
Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)

The Name of the scoping System.

This property is inherited from CIM_ServiceAccessPoint.

TargetRelativePortNumber
Data type: uint32
Access type: Read-only
Qualifiers: MinValue (1), MappingStrings ("SPC.INCITS-T10 | RelativeTargetPort | IdentifierFormat")

For ports on a target device, the port number, relative to the storage system. 0 is reserved by T10, 1 is port A, 2 is port B, etc. These numbers are used in SCSI commands that operate on target port groups.

This property is inherited from CIM_SCSIProtocolEndpoint.

TimeOfLastStateChange
Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings ("MIB.IETF|IF-MIB.ifLastChange")

TBD

This property is inherited from CIM_ProtocolEndpoint.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012 R2

Namespace

Root\CIMv2\Storage\iScsiTarget

MOF

SmIscsiTarget.mof

DLL

SMiSCSITargetProv.dll

See also

CIM_iSCSIProtocolEndpoint
iSCSI Target Server Reference
CIM_SCSIProtocolController
CIM_ProtocolEndpoint
CIM_ServiceAccessPoint
CIM_EnabledLogicalElement
CIM_ManagedSystemElement
CIM_ManagedElement

 

 

Show: