CIM_iSCSIConfigurationService, ROOT\CIMV2\storage\iscsitarget

Class | Childs (1) | Methods (8) | Properties (21) | Qualifiers (5) | Instances (1) | Namespaces (1)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

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.

CIM_iSCSIConfigurationService - child subclasses in ROOT\CIMV2\storage\iscsitarget

Number of classes:1
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
MSISCSITARGET_iSCSIConfigurationService02181---

CIM_iSCSIConfigurationService methods

CIM_iSCSIConfigurationService has 8 methods (5 Local, 3 Derived)

NameOriginReturn
BindiSCSIProtocolEndPointCIM_iSCSIConfigurationServiceuint32 {'out':True}
CreateiSCSINodeCIM_iSCSIConfigurationServiceuint32 {'out':True}
CreateiSCSIProtocolEndpointCIM_iSCSIConfigurationServiceuint32 {'out':True}
DeleteiSCSINodeCIM_iSCSIConfigurationServiceuint32 {'out':True}
DeleteiSCSIProtocolEndpointCIM_iSCSIConfigurationServiceuint32 {'out':True}
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}
StartServiceCIM_Serviceuint32 {'out':True}
StopServiceCIM_Serviceuint32 {'out':True}

CIM_iSCSIConfigurationService properties

CIM_iSCSIConfigurationService has 21 properties (21 Derived)

NameOriginCIMType
CaptionCIM_ManagedElement8 [string]
key
CreationClassName
CIM_Service8 [string]
DescriptionCIM_ManagedElement8 [string]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
HealthStateCIM_ManagedSystemElement18 [uint16]
InstallDateCIM_ManagedSystemElement101 [datetime]
key
Name
CIM_ManagedSystemElement8 [string]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
PrimaryOwnerContactCIM_Service8 [string]
PrimaryOwnerNameCIM_Service8 [string]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
StartedCIM_Service11 [boolean]
StartModeCIM_Service8 [string]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
key
SystemCreationClassName
CIM_Service8 [string]
key
SystemName
CIM_Service8 [string]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]

Detailed description of CIM_iSCSIConfigurationService methods

Local methods (5) of CIM_iSCSIConfigurationService class

BindiSCSIProtocolEndPoint method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
iSCSIPortref:CIM_iSCSIProtocolEndpoint0-{'Description':'A reference to the iSCSIProtocolEndpoint.'}
NetworkPortalref:CIM_ProtocolEndpoint1-{'Description':'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.'}
Description'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['0', '1', '2', '3', '4', '5', '6..4095', '4096', '4097', '4098', '4099', '4100..32767', '32768..65535']
Values['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']
BindiSCSIProtocolEndPoint method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
CreateiSCSINode method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Aliasstring0-{'Description':'The iSCSI Alias for the new Node.','MaxLen':128,'ModelCorrespondence':['CIM_SCSIProtocolController.ElementName']}
iSCSINoderef:CIM_SCSIProtocolController1-{'Description':'The SCSIProtocolController instance representing the created iSCSI Node.'}
Description'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['0', '1', '2', '3', '4', '5', '6..4095', '4096', '4097', '4098..32767', '32768..65535']
Values['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']
CreateiSCSINode method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
CreateiSCSIProtocolEndpoint method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
iSCSINoderef:CIM_SCSIProtocolController0-{'Description':'The SCSIProtocolController instance representing the iSCSI Node that will contain the iSCSI Port.'}
Roleuint161-{'Description':'For iSCSI, each iSCSIProtocolEndpoint must act as either a target or an initiator endpoint. This property indicates which role this iSCSIProtocolEndpoint implements.','ValueMap':['2', '3'],'Values':['Initiator', 'Target']}
Identifierstring2-{'Description':'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.','MaxLen':13,'ModelCorrespondence':['CIM_iSCSIConfigurationCapabilities.IdentifierSelectionSupported']}
NetworkPortalsref:CIM_ProtocolEndpoint3-{'Description':'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.'}
iSCSIPortref:CIM_iSCSIProtocolEndpoint4-{'Description':'A reference to the new iSCSIProtocolEndpoint that is created.'}
Description'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['0', '1', '2', '3', '4', '5', '6..4095', '4096', '4097', '4098', '4099', '4100', '4101', '4102', '4103', '4104..32767', '32768..65535']
Values['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']
CreateiSCSIProtocolEndpoint method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
DeleteiSCSINode method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
iSCSINoderef:CIM_SCSIProtocolController0-{'Description':'The SCSIProtocolController instance representing the iSCSI Node that will be deleted.'}
Description'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['0', '1', '2', '3', '4', '5', '6..4095', '4096', '4097', '4098..32767', '32768..65535']
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'DMTF Reserved', 'SCSIProtocolController Non-Existent', 'Sessions Active on Node Ports', 'Method Reserved', 'Vendor Specific']
DeleteiSCSINode method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace
DeleteiSCSIProtocolEndpoint method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
iSCSIPortref:CIM_iSCSIProtocolEndpoint0-{'Description':'The iSCSIProtocolEndpoint to be deleted.'}
Description'The method deletes an instance of iSCSIProtocolEndpoint and all associations in which this iSCSIProtocolEndpoint is referenced.'
ValueMap['0', '1', '2', '3', '4', '5', '6..4095', '4096', '4097..32767', '32768..65535']
Values['Success', 'Not Supported', 'Unspecified Error', 'Timeout', 'Failed', 'Invalid Parameter', 'DMTF Reserved', 'Endpoint Non-Existent', 'Method Reserved', 'Vendor Specific']
DeleteiSCSIProtocolEndpoint method is in 2 classes of ROOT\CIMV2\storage\iscsitarget and in 1 namespace

Derived methods (3) of CIM_iSCSIConfigurationService class

RequestStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160-{'Description':'The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), 3 ('Timeout'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.','ModelCorrespondence':['CIM_EnabledLogicalElement.RequestedState'],'ValueMap':['2', '3', '4', '6', '7', '8', '9', '10', '11', '..', '32768..65535'],'Values':['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved', 'Vendor Reserved']}
Jobref:CIM_ConcreteJob1-{'Description':'Reference to the job (can be null if the task is completed).'}
TimeoutPerioddatetime2-{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' must be returned.'}
RequestStateChange method is in 51 classes of ROOT\CIMV2\storage\iscsitarget and in 15 namespaces
StartService method
Returnuint32 {'out':True}
StartService method is in 17 classes of ROOT\CIMV2\storage\iscsitarget and in 11 namespaces
StopService method
Returnuint32 {'out':True}
StopService method is in 17 classes of ROOT\CIMV2\storage\iscsitarget and in 11 namespaces

Detailed description of CIM_iSCSIConfigurationService properties

Derived properties (21) of CIM_iSCSIConfigurationService class

Caption property
CIMTYPE'string'
Caption property is in 90 classes of ROOT\CIMV2\storage\iscsitarget and in 37 namespaces
CreationClassName property
CIMTYPE'string'
keyTrue
CreationClassName property is in 45 classes of ROOT\CIMV2\storage\iscsitarget and in 20 namespaces
Description property
CIMTYPE'string'
Description property is in 91 classes of ROOT\CIMV2\storage\iscsitarget and in 142 namespaces
ElementName property
CIMTYPE'string'
ElementName property is in 90 classes of ROOT\CIMV2\storage\iscsitarget and in 21 namespaces
EnabledDefault property
CIMTYPE'uint16'
EnabledDefault property is in 49 classes of ROOT\CIMV2\storage\iscsitarget and in 10 namespaces
EnabledState property
CIMTYPE'uint16'
EnabledState property is in 49 classes of ROOT\CIMV2\storage\iscsitarget and in 13 namespaces
HealthState property
CIMTYPE'uint16'
HealthState property is in 59 classes of ROOT\CIMV2\storage\iscsitarget and in 15 namespaces
InstallDate property
CIMTYPE'datetime'
InstallDate property is in 59 classes of ROOT\CIMV2\storage\iscsitarget and in 23 namespaces
Name property
CIMTYPE'string'
keyTrue
Name property is in 67 classes of ROOT\CIMV2\storage\iscsitarget and in 142 namespaces
OperationalStatus property
CIMTYPE'uint16'
OperationalStatus property is in 59 classes of ROOT\CIMV2\storage\iscsitarget and in 18 namespaces
OtherEnabledState property
CIMTYPE'string'
OtherEnabledState property is in 49 classes of ROOT\CIMV2\storage\iscsitarget and in 11 namespaces
PrimaryOwnerContact property
CIMTYPE'string'
PrimaryOwnerContact property is in 21 classes of ROOT\CIMV2\storage\iscsitarget and in 15 namespaces
PrimaryOwnerName property
CIMTYPE'string'
PrimaryOwnerName property is in 21 classes of ROOT\CIMV2\storage\iscsitarget and in 15 namespaces
RequestedState property
CIMTYPE'uint16'
RequestedState property is in 49 classes of ROOT\CIMV2\storage\iscsitarget and in 12 namespaces
Started property
CIMTYPE'boolean'
Started property is in 17 classes of ROOT\CIMV2\storage\iscsitarget and in 11 namespaces
StartMode property
CIMTYPE'string'
StartMode property is in 17 classes of ROOT\CIMV2\storage\iscsitarget and in 15 namespaces
Status property
CIMTYPE'string'
Status property is in 59 classes of ROOT\CIMV2\storage\iscsitarget and in 42 namespaces
StatusDescriptions property
CIMTYPE'string'
StatusDescriptions property is in 59 classes of ROOT\CIMV2\storage\iscsitarget and in 18 namespaces
SystemCreationClassName property
CIMTYPE'string'
keyTrue
SystemCreationClassName property is in 41 classes of ROOT\CIMV2\storage\iscsitarget and in 20 namespaces
SystemName property
CIMTYPE'string'
keyTrue
SystemName property is in 45 classes of ROOT\CIMV2\storage\iscsitarget and in 22 namespaces
TimeOfLastStateChange property
CIMTYPE'datetime'
TimeOfLastStateChange property is in 51 classes of ROOT\CIMV2\storage\iscsitarget and in 17 namespaces

CIM_iSCSIConfigurationService Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AbstractTrue
Description'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.'
ExperimentalTrue
UMLPackagePath'CIM::Network::iSCSI'
Version'2.10.0'

CIM_iSCSIConfigurationService System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\CIMV2\storage\iscsitarget:CIM_iSCSIConfigurationService'___SYSTEM8
__NAMESPACE'ROOT\CIMV2\storage\iscsitarget'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_Service', 'CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT21___SYSTEM3
__RELPATH'CIM_iSCSIConfigurationService'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_Service'___SYSTEM8
__CLASS'CIM_iSCSIConfigurationService'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to CIM_iSCSIConfigurationService

Number of classes:21
comments powered by Disqus
WUtils.com