Class CIM_iSCSIConfigurationService
extends CIM_Service

The iSCSIConfigurationService provides methods that allow a client to manipulate iSCSIProtocolEndpoints in an iSCSI Node. iSCSIProtocolController models the iSCSI Port. The instance of the service is scoped by an instance of ComputerSystem that represents that Network Entity. The capabilities of this service are defined in the companion class iSCSIConfigurationCapabilities.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_iSCSIConfigurationService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThe iSCSIConfigurationService provides methods that allow a client to manipulate iSCSIProtocolEndpoints in an iSCSI Node. iSCSIProtocolController models the iSCSI Port. The instance of the service is scoped by an instance of ComputerSystem that represents that Network Entity. The capabilities of this service are defined in the companion class iSCSIConfigurationCapabilities.
Experimentalbooleantrue
UMLPackagePathstringCIM::Network::iSCSI
Versionstring2.10.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

CreateiSCSIProtocolEndpoint (uint32)

Method Qualifiers (CreateiSCSIProtocolEndpoint)

NameData TypeValue
DescriptionstringThis method creates an iSCSI Port in the form of an instance of iSCSIProtocolEndpoint. As part of the creation process the iSCSIProtocolEndpoint is 'bound to' the underlying TCP or IP ProtocolEndpoints which are specified as inputs by creating instances of the BindsTo association between the new instance and those instances. In addition, an instance of SAPAvailableForElement is created between the specified SCSIProtocolController and the new instance of iSCSIProtocolEndpoint.
ValueMapstring0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097, 4098, 4099, 4100, 4101, 4102, 4103, 4104..32767, 32768..65535
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, SCSIProtocolController Non-existent, Role Not Supported By Specified SCSIProtocolController, Identifier In Use, Not Unique, Identifier Selection Not Supported, ProtocolEndpoint Non-Existent, TCPProtocolEndpoint Not Bound To Underlying IPProtocolEndpoint, TCPProtocolEndpoint In Use By Other iSCSIProtocolEndpoint In Same Target SCSIProtocolController, ProtocolEndpoints Not From Same Endpoint Collection, Method Reserved, Vendor Specific

Method Parameters (CreateiSCSIProtocolEndpoint)

NameTypeQualifiers
NameData TypeValue
Identifierstring
DescriptionstringIf this is an Initiator Port, Identifier MUST contain the ISID, if this is a Target Port, Identifier MUST contain the Target Portal Group Tag (TGPT). Each iSCSIProtocolEndpoint (iSCSI port) associated to a common SCSIProtocolController (iSCSI node) must have a unique Identifier. This field is a string that contains 12 hexadecimal digits. If the property IdentifierSelectionSupported in class iSCSIConfigurationCapabilities is false, this parameter MUST be set to NULL.
INbooleantrue
MaxLenuint3213
ModelCorrespondencestringCIM_iSCSIConfigurationCapabilities.IdentifierSelectionSupported
Roleuint16
DescriptionstringFor iSCSI, each iSCSIProtocolEndpoint must act as either a target or an initiator endpoint. This property indicates which role this iSCSIProtocolEndpoint implements.
INbooleantrue
ValueMapstring2, 3
ValuesstringInitiator, Target
NetworkPortalsCIM_ProtocolEndpoint[]
DescriptionstringArray of References to either TCPProtocolEndpoints representing Target NetworkPortals or IPProtocolEndpoint instances representing Initiator NetworkPortals. If TCPProtocolEndpoints are supplied each MUST be in turn associated to an instance of IPProtocolEndpoint via a BindsTo association in order to provide the Target Network Portal functionality. The selected Portal endpoints MUST be from the same SystemSpecificCollection, which represents a Portal Group.
INbooleantrue
iSCSINode REF CIM_SCSIProtocolController
DescriptionstringThe SCSIProtocolController instance representing the iSCSI Node that will contain the iSCSI Port.
INbooleantrue
iSCSIPort REF CIM_iSCSIProtocolEndpoint
DescriptionstringA reference to the new iSCSIProtocolEndpoint that is created.
INbooleanfalse
OUTbooleantrue

DeleteiSCSIProtocolEndpoint (uint32)

Method Qualifiers (DeleteiSCSIProtocolEndpoint)

NameData TypeValue
DescriptionstringThe method deletes an instance of iSCSIProtocolEndpoint and all associations in which this iSCSIProtocolEndpoint is referenced.
ValueMapstring0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097..32767, 32768..65535
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Endpoint Non-Existent, Method Reserved, Vendor Specific

Method Parameters (DeleteiSCSIProtocolEndpoint)

NameTypeQualifiers
NameData TypeValue
iSCSIPort REF CIM_iSCSIProtocolEndpoint
DescriptionstringThe iSCSIProtocolEndpoint to be deleted.
INbooleantrue

BindiSCSIProtocolEndPoint (uint32)

Method Qualifiers (BindiSCSIProtocolEndPoint)

NameData TypeValue
DescriptionstringThis method provides for modification of an existing iSCSIProtocolEndpoint by associating a TCPProtocolEndpoint representing an Target NetworkPortal or an IPProtocolEndpoint instance representing an Initiator NetworkPortal to the iSCSIProtocolEndpoint. The association is persisted as an instance of BindsTo. The selected Portal endpoint must be from the same SystemSpecificCollection, which represents a Portal Group, as the endpoints currently bound to the iSCSIProtocolEndpoint. This action is intended to be reversed by the use of the intrinsic method 'DeleteInstance'.
ValueMapstring0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097, 4098, 4099, 4100..32767, 32768..65535
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, ProtocolEndpoint Non-Existent, TCPProtocolEndpoint Not Bound To Underlying IPProtocolEndpoint, ProtocolEndpoint In Use By Other iSCSIProtocolEndpoint In Same Target SCSIProtocolController, ProtocolEndpoint Not From Same Endpoint Collection, Method Reserved, Vendor Specific

Method Parameters (BindiSCSIProtocolEndPoint)

NameTypeQualifiers
NameData TypeValue
iSCSIPort REF CIM_iSCSIProtocolEndpoint
DescriptionstringA reference to the iSCSIProtocolEndpoint.
INbooleantrue
NetworkPortal REF CIM_ProtocolEndpoint
DescriptionstringThe ProtocolEndpoint instance. If an iSCSI Initiator Port is being modified this will be an IPProtocolEndpoint. If an iSCSI Target Port is being modified this will be a TCPProtocolEndpoint.
INbooleantrue

CreateiSCSINode (uint32)

Method Qualifiers (CreateiSCSINode)

NameData TypeValue
DescriptionstringThis method creates an iSCSI Node in the form of an instance of SCSIProtocolController. As part of the creation process a SystemDevice association is created between the new SCSIProtocolController and the scoping Network Entity (CIM_ComputerSystem) hosting this service.
ValueMapstring0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097, 4098..32767, 32768..65535
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Node Creation Not Supported, Alias In Use By Other Node, Method Reserved, Vendor Specific

Method Parameters (CreateiSCSINode)

NameTypeQualifiers
NameData TypeValue
Aliasstring
DescriptionstringThe iSCSI Alias for the new Node.
INbooleantrue
MaxLenuint32128
ModelCorrespondencestringCIM_SCSIProtocolController.ElementName
iSCSINode REF CIM_SCSIProtocolController
DescriptionstringThe SCSIProtocolController instance representing the created iSCSI Node.
OUTbooleantrue

DeleteiSCSINode (uint32)

Method Qualifiers (DeleteiSCSINode)

NameData TypeValue
DescriptionstringThis method deletes an instance of SCSIProtocolController respresenting an iSCSI Node. If Sessions are active on iSCSIProtocolEndpoints belonging to this node an error will be returned. If no Sessions are active the scoped iSCSIProtocolEndpoints will be deleted.
ValueMapstring0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097, 4098..32767, 32768..65535
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, SCSIProtocolController Non-Existent, Sessions Active on Node Ports, Method Reserved, Vendor Specific

Method Parameters (DeleteiSCSINode)

NameTypeQualifiers
NameData TypeValue
iSCSINode REF CIM_SCSIProtocolController
DescriptionstringThe SCSIProtocolController instance representing the iSCSI Node that will be deleted.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service