# 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

Name | Data Type | Value
--- | --- | ---
Description | string | 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.
Experimental | boolean | true
UMLPackagePath | string | CIM::Network::iSCSI
Version | string | 2.10.0

## Class Properties

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_Service
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
Name | string | CIM_Service
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryOwnerContact | string | CIM_Service
PrimaryOwnerName | string | CIM_Service
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Started | boolean | CIM_Service
StartMode | string | CIM_Service
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_Service
SystemName | string | CIM_Service
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### CreateiSCSIProtocolEndpoint (uint32)

#### Method Qualifiers (CreateiSCSIProtocolEndpoint)

Name | Data Type | Value
--- | --- | ---
Description | string | This 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097, 4098, 4099, 4100, 4101, 4102, 4103, 4104..32767, 32768..65535
Values | string | Success, 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Identifier | string
Description | string | If 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.
IN | boolean | true
MaxLen | uint32 | 13
ModelCorrespondence | string | CIM_iSCSIConfigurationCapabilities.IdentifierSelectionSupported
Role | uint16
Description | string | For iSCSI, each iSCSIProtocolEndpoint must act as either a target or an initiator endpoint. This property indicates which role this iSCSIProtocolEndpoint implements.
IN | boolean | true
ValueMap | string | 2, 3
Values | string | Initiator, Target
NetworkPortals | CIM_ProtocolEndpoint[]
Description | string | Array 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.
IN | boolean | true
iSCSINode | REF CIM_SCSIProtocolController
Description | string | The SCSIProtocolController instance representing the iSCSI Node that will contain the iSCSI Port.
IN | boolean | true
iSCSIPort | REF CIM_iSCSIProtocolEndpoint
Description | string | A reference to the new iSCSIProtocolEndpoint that is created.
IN | boolean | false
OUT | boolean | true

#### DeleteiSCSIProtocolEndpoint (uint32)

#### Method Qualifiers (DeleteiSCSIProtocolEndpoint)

Name | Data Type | Value
--- | --- | ---
Description | string | The method deletes an instance of iSCSIProtocolEndpoint and all associations in which this iSCSIProtocolEndpoint is referenced.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097..32767, 32768..65535
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Endpoint Non-Existent, Method Reserved, Vendor Specific

#### Method Parameters (DeleteiSCSIProtocolEndpoint)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
iSCSIPort | REF CIM_iSCSIProtocolEndpoint
Description | string | The iSCSIProtocolEndpoint to be deleted.
IN | boolean | true

#### BindiSCSIProtocolEndPoint (uint32)

#### Method Qualifiers (BindiSCSIProtocolEndPoint)

Name | Data Type | Value
--- | --- | ---
Description | string | This 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'.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097, 4098, 4099, 4100..32767, 32768..65535
Values | string | Success, 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
iSCSIPort | REF CIM_iSCSIProtocolEndpoint
Description | string | A reference to the iSCSIProtocolEndpoint.
IN | boolean | true
NetworkPortal | REF CIM_ProtocolEndpoint
Description | string | The 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.
IN | boolean | true

#### CreateiSCSINode (uint32)

#### Method Qualifiers (CreateiSCSINode)

Name | Data Type | Value
--- | --- | ---
Description | string | This 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097, 4098..32767, 32768..65535
Values | string | Success, 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Alias | string
Description | string | The iSCSI Alias for the new Node.
IN | boolean | true
MaxLen | uint32 | 128
ModelCorrespondence | string | CIM_SCSIProtocolController.ElementName
iSCSINode | REF CIM_SCSIProtocolController
Description | string | The SCSIProtocolController instance representing the created iSCSI Node.
OUT | boolean | true

#### DeleteiSCSINode (uint32)

#### Method Qualifiers (DeleteiSCSINode)

Name | Data Type | Value
--- | --- | ---
Description | string | This 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6..4095, 4096, 4097, 4098..32767, 32768..65535
Values | string | Success, 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)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
iSCSINode | REF CIM_SCSIProtocolController
Description | string | The SCSIProtocolController instance representing the iSCSI Node that will be deleted.
IN | boolean | true

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
ChangeAffectedElementsAssignedSequence | uint32 | CIM_Service
RequestStateChange | uint32 | CIM_EnabledLogicalElement
StartService | uint32 | CIM_Service
StopService | uint32 | CIM_Service