Key |
CreationClassName
|
string
|
|
CreationClassName indicates the name of the class or the subclass that is 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. |
Name
|
string
|
|
The Name property uniquely identifies the Service and provides an indication of the function that is managed. This function is described in more detail in the Description property of the object. |
SystemCreationClassName
|
string
|
|
The CreationClassName of the scoping System. |
SystemName
|
string
|
|
The Name of the scoping System. |
Read Only |
Description
|
string
|
|
The Description property provides a textual description of the object. |
EnabledDefault
|
uint16
|
Enabled | 2 |
Disabled | 3 |
Not Applicable | 5 |
Enabled but Offline | 6 |
No Default | 7 |
DMTF Reserved | 8..32767 |
Vendor Reserved | 32768..65535 |
|
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). |
EnabledState
|
uint16
|
Unknown | 0 |
Other | 1 |
Enabled | 2 |
Disabled | 3 |
Shutting Down | 4 |
Not Applicable | 5 |
Enabled but Offline | 6 |
In Test | 7 |
Deferred | 8 |
Quiesce | 9 |
Starting | 10 |
DMTF Reserved | 11..32767 |
Vendor Reserved | 32768..65535 |
|
EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states:Enabled (2) indicates that the element is or could be running commands, will process any queued commands, and queues new requests.Disabled (3) indicates that the element will not run commands and will drop any new requests.Shutting Down (4) indicates that the element is in the process of going to a Disabled state.Not Applicable (5) indicates the element does not support being enabled or disabled.Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests.Test (7) indicates that the element is in a test state.Deferred (8) indicates that the element might be completing commands, but will queue any new requests.Quiesce (9) indicates that the element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state, but it processes only a restricted set of commands. All other requests are queued.Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued. |
OperationalStatus
|
uint16
|
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 |
DMTF Reserved | .. |
Vendor Reserved | 0x8000.. |
|
Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration's values are self-explanatory. However, a few are not and are described here in more detail."Stressed"indicates that the element is functioning, but needs attention. Examples of"Stressed"states are overload, overheated, and so on."Predictive Failure"indicates that an element is functioning nominally but predicting a failure in the near future."In Service"describes an element being configured, maintained, cleaned, or otherwise administered."No Contact"indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it."Lost Communication"indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable."Stopped"and"Aborted"are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated."Dormant"indicates that the element is inactive or quiesced."Supporting Entity in Error"indicates that this element might be"OK"but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems."Completed"indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error)."Power Mode"indicates that the element has additional power model information contained in the Associated PowerManagementService association.OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or instrumentation provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus should contain the primary status for the element. When instrumented, Status (because it is single-valued) should also provide the primary status of the element. |
OtherEnabledState
|
string
|
|
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. |
RequestedState
|
uint16
|
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 | .. |
Vendor Reserved | 32768..65535 |
|
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. 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.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 run 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, becauseit 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. |
Started
|
boolean
|
|
Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE). |
StatusDescriptions
|
string
|
|
Strings describing the various OperationalStatus array values. For example, if"Stopping"is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Entries in this array are correlated with those at the same array index in OperationalStatus. |
Read Write |
AttachDevice | This methodassociates a LogicalDevice subclass (specifically a StorageVolume or MediaAccessDevice subclass) to the referenced ProtocolController. |
CreateProtocolControllerWithPorts | This method creates an appropriate subclass of ProtocolController. |
DeleteProtocolController | The method deletes an instance of ProtocolController and all associations in which this ProtocolController is referenced. |
DetachDevice | This method removes the ProtocolControllerForDevice association subclass between the ProtocolController and a LogicalDevice, such as a StorageVolume or a MediaAccessDevice. |
ExposeDefaultLUs | Expose a list of SCSI logical units (such as RAID volumes or tape drives) through a'default view'SCSIProtocolController (SPC) through a list of target ports. |
ExposePaths | Expose a list of SCSI logical units (such as RAID volumes or tape drives) to a list of initiators through a list of target ports, through one or more SCSIProtocolControllers (SPCs). |
HideDefaultLUs | Hide a list of SCSI logical units (such as RAID volumes or tape drives) through a list of target ports on a default view SCSIProtocolController (SPC). |
HidePaths | Hide a list of SCSI logical units (such as a RAID volume or tape drive) from a list of initiators and/or target ports on a SCSIProtocolController (SPC). |
In |
Force
|
boolean
|
|
To set/unset Force flag. Default Force=True. |
ProtocolController
|
IBMTSSVC_ProtocolController
|
|
The ProtocolController instance. |
Device
|
CIM_LogicalDevice
|
|
The LogicalDevice instance to attach. |
DeviceNumber
|
string
|
|
The number assigned to ProtocolControllerForUnit.DeviceNumber (if supported by the hardware). Hardware support is indicated by ProtocolControllerMaskingCapabilities.ClientSelectableDeviceNumbers). If the hardware does not support setting the number, but the DeviceNumber has not been established in an existing ProtocolControllerForDevice subclass, then this parameter's value will be used. If the DeviceNumber has been established, then the current number will be reused. |
out |
DeviceNumber
|
string
|
|
The number assigned to ProtocolControllerForUnit.DeviceNumber (if supported by the hardware). Hardware support is indicated by ProtocolControllerMaskingCapabilities.ClientSelectableDeviceNumbers). If the hardware does not support setting the number, but the DeviceNumber has not been established in an existing ProtocolControllerForDevice subclass, then this parameter's value will be used. If the DeviceNumber has been established, then the current number will be reused. |
Return Codes |
none |
In |
ElementName
|
string
|
|
The string to be used in the ElementName of the new ProtocolController. |
Ports
|
string
|
|
Array of strings containing representations of references to instances of CIM_LogicalPort (or subclass) instances. This is the list of target ports that are associated to the ProtocolController. ProtocolControllerForPort associations are created by the instrumentation associating the new ProtocolController to these ports. If this parameter is null, then all ports in the storage system (this Service's'scoping'System and all its ComponentCS Systems) are attached to the new ProtocolController. |
Protocol
|
uint16
|
|
The protocol type for the new ProtocolController. |
Privilege
|
IBMTSSVC_AuthorizedPrivilege
|
|
Reference to a CIM_Privilege (or subclass) instance to be used as a template. If supplied, it has a 1:1 correspondence with the Identity parameter and this method will atomically create the new ProtocolController instance and related AuthorizedPrivilege, AuthorizedTarget and AuthorizedSubject instances.Note: if ProtocolControllerRequiresAuthorizedIdentity is true, then the Identity/Privilege pair must be specified. If false, then the Identity/Privilege pair must not be specified. |
Identity
|
CIM_ManagedElement
|
|
Reference to a CIM_ManagedElement (or subclass) instance. This ManagedElement must be either a CIM_Identity, or a CIM_Collection (or subclass, eg. SystemSpecificCollection, Role, or Group) that has CIM_Identities as MemberOfCollection. If ProtocolControllerMaskingCapabilities.ProtocolControllerSupportsCollection is false, the reference must be to a CIM_Identity (or subclass). If present, it has a 1:1 correspondence with the Privilege property. If present, this method will atomically create the new ProtocolController instance and instantiate a missing AuthorizedSubject association between the Privilege/Identity pair; and instantiate an AuthorizedTarget association between the AuthorizedPrivilege and the new ProtocolController.Note: if ProtocolControllerRequiresAuthorizedIdentity is true, then at least the Identity/Privilege pair must be specified. |
ProtocolController
|
IBMTSSVC_ProtocolController
|
|
A reference to the new ProtocolController that is created. |
out |
ProtocolController
|
IBMTSSVC_ProtocolController
|
|
A reference to the new ProtocolController that is created. |
Return Codes |
none |
In |
ProtocolController
|
IBMTSSVC_ProtocolController
|
|
The ProtocolController to be deleted. |
DeleteChildrenProtocolControllers
|
boolean
|
|
If true, the management instrumentation provider will also delete'child'ProtocolControllers (for example, those defined as Dependent references in instances of AssociatedProtocolController where this ProtocolController is the Antecedent reference). Also, all direct associations involving the'child'ProtocolControllers will be removed. |
DeleteUnits
|
boolean
|
|
If true, the management instrumentation provider will also delete LogicalDevice instances associated via ProtocolControllerForUnit, to this ProtocolController and its children. ('child'controllers will only be affected if the DeleteChildrenProtocolControllers input parameter is TRUE). LogicalDevice instances are only deleted if there are NO remaining ProtocolControllerForUnit associations, to other ProtocolControllers. |
out |
none |
Return Codes |
none |
In |
Job
|
CIM_ConcreteJob
|
|
Reference to the job if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed). |
LUNames
|
string
|
|
An array of IDs of logical unit instances. The LU instances must already exist. The members of this array must match the Name property of LogicalDevice instances that represent SCSI logical units. See the method description for conditions where this MAY be null. |
TargetPortIDs
|
string
|
|
IDs of target ports. See the method description for conditions where this MAY be null. |
DeviceNumbers
|
string
|
|
A list of logical unit numbers to assign to the corresponding logical unit in the LUNames parameter. (within the context of the elements specified in the other parameters). If the LUNames parameter is null, then this parameter must be null. Otherwise, if this parameter is null, all LU numbers are assigned by the hardware or instrumentation. |
DeviceAccesses
|
uint16
|
|
A list of permissions to assign to the corresponding logical unit in the LUNames parameter. This specifies the permission to assign within the context of the elements specified in the other parameters. Setting this to'No Access'assigns the DeviceNumber for all initiators, but does not grant read or write access. If the LUNames parameter is not null then this parameter must be specified. |
ProtocolControllers
|
CIM_SCSIProtocolController
|
|
An array of references to SCSIProtocolControllers (SPCs). On input, this can be null, or contain exactly one element; there MAY be multiple references on output. If null on input, the instrumentation will create one or more new SPC instances. If an SPC is specified, the instrumentation will attempt to add associations to one or more existing SPCs. If the first array element is a valid SPC reference and SCSI semantics can be preserved, the instrumentation must attach associations to the specified SPC. If multiple elements are non-null on input, the instrumentation must report an invalid parameter. On output, this is an array of references to SPCs created or modified as the result of processing the request. |
out |
Job
|
CIM_ConcreteJob
|
|
Reference to the job if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed). |
ProtocolControllers
|
CIM_SCSIProtocolController
|
|
An array of references to SCSIProtocolControllers (SPCs). On input, this can be null, or contain exactly one element; there MAY be multiple references on output. If null on input, the instrumentation will create one or more new SPC instances. If an SPC is specified, the instrumentation will attempt to add associations to one or more existing SPCs. If the first array element is a valid SPC reference and SCSI semantics can be preserved, the instrumentation must attach associations to the specified SPC. If multiple elements are non-null on input, the instrumentation must report an invalid parameter. On output, this is an array of references to SPCs created or modified as the result of processing the request. |
Return Codes |
none |
In |
Force
|
boolean
|
|
To set/unset Force flag. Default Force=False. |
Job
|
CIM_ConcreteJob
|
|
Reference to the job if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed). |
LUNames
|
string
|
|
An array of IDs of logical unit instances. The LU instances must already exist. The members of this array must match the Name property of LogicalDevice instances that represent SCSI logical units. See the method description for conditions where this MAY be null. |
InitiatorPortIDs
|
string
|
|
IDs of initiator ports. If existing StorageHardwareID instances exist, they must be used. If no StorageHardwareID instance matches, then one is implicitly created. See the method description for conditions where this MAY be null. If this is an array of WWPNs, then a new StorageHardwareID will be created, but the StorageHardwareID.StorageID will not map to the passed in value. |
TargetPortIDs
|
string
|
|
IDs of target ports. SVC does not support this method of modifying target ports. This parameter will be ignored.Use the StorageHardwareID.PortMask set property instead. |
DeviceNumbers
|
string
|
|
A list of logical unit numbers to assign to the corresponding logical unit in the LUNames parameter. (within the context of the elements specified in the other parameters). If the LUNames parameter is null, then this parameter must be null. Otherwise, if this parameter is null, all LU numbers are assigned by the hardware or instrumentation. |
DeviceAccesses
|
uint16
|
|
A list of permissions to assign to the corresponding logical unit in the LUNames parameter. This specifies the permission to assign within the context of the elements specified in the other parameters. Setting this to'No Access'assigns the DeviceNumber for the associated initiators, but does not grant read or write access. If the LUNames parameter is not null then this parameter must be specified. SVC does not support multiple levels of access. A HostMap has either full access or no access, therefore, the only valid value is |
ProtocolControllers
|
IBMTSSVC_ProtocolController
|
|
An array of references to SCSIProtocolControllers (SPCs). On input, this can be null, or contain exactly one element; there MAY be multiple references on output. If nullon input, the instrumentation will create one or more new SPC instances. If an SPC is specified, the instrumentation will attempt to add associations to one or more existing SPCs. If the first array element is a valid SPC reference and SCSI semantics can be preserved, the instrumentation must attach associations to the specified SPC. If multiple elements are non-null on input, the instrumentation must report an invalid parameter. On output, this is an array of references to SPCs created or modified as the result of processing the request. |
out |
Job
|
CIM_ConcreteJob
|
|
Reference to the job if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed). |
ProtocolControllers
|
IBMTSSVC_ProtocolController
|
|
An array of references to SCSIProtocolControllers (SPCs). On input, this can be null, or contain exactly one element; there MAY be multiple references on output. If nullon input, the instrumentation will create one or more new SPC instances. If an SPC is specified, the instrumentation will attempt to add associations to one or more existing SPCs. If the first array element is a valid SPC reference and SCSI semantics can be preserved, the instrumentation must attach associations to the specified SPC. If multiple elements are non-null on input, the instrumentation must report an invalid parameter. On output, this is an array of references to SPCs created or modified as the result of processing the request. |
Return Codes |
none |
In |
Job
|
CIM_ConcreteJob
|
|
Reference to the job if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed). |
LUNames
|
string
|
|
A list of IDs of logical units. Each LU instance must already exist. See the method description for conditions where this MAY be null. |
TargetPortIDs
|
string
|
|
IDs of target ports. See the method description for conditions where this MAY be null. |
ProtocolControllers
|
CIM_SCSIProtocolController
|
|
An array of references to SCSIProtocolControllers (SPCs). On input, this must contain exactly one element; there MAY be multiple references on output. The instrumentation will attempt to remove associations (LUNames or TargetPortIDs) from this SPC. Depending upon the specific implementation, the instrumentation MAY need to create new SPCs with a subset of the remaining associations. On output, this is an array of references to SPCs created or modified as the result of processing the request. |
out |
Job
|
CIM_ConcreteJob
|
|
Reference to the job if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed). |
ProtocolControllers
|
CIM_SCSIProtocolController
|
|
An array of references to SCSIProtocolControllers (SPCs). On input, this must contain exactly one element; there MAY be multiple references on output. The instrumentation will attempt to remove associations (LUNames or TargetPortIDs) from this SPC. Depending upon the specific implementation, the instrumentation MAY need to create new SPCs with a subset of the remaining associations. On output, this is an array of references to SPCs created or modified as the result of processing the request. |
Return Codes |
none |
In |
Force
|
boolean
|
|
To set/unset Force flag. Default Force=False. |
Job
|
CIM_ConcreteJob
|
|
Reference to the job if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed). |
LUNames
|
string
|
|
A list of IDs of logical units. Each LU instance must already exist. See the method description for conditions where this MAY be null. |
InitiatorPortIDs
|
string
|
|
IDs of initiator ports. See the method description for conditions where this MAY be null.A list of WWPNs to remove from the view (they must be members of the host, see the StorageHardwareID.Description or the PortWWNs for values). If the Hide full paths from view parameter set are used, then a StorageHardwareID.StorageID shall be used and the result will delete the StorageHardwareID instance. |
TargetPortIDs
|
string
|
|
IDs of target ports. SVC does not support this method of modifying target ports. This parameter will be ignored.Use the StorageHardwareID.PortMask set property instead. |
ProtocolControllers
|
IBMTSSVC_ProtocolController
|
|
An array of references to SCSIProtocolControllers (SPCs). On input, this must contain exactly one element; there MAY be multiple references on output. The instrumentation will attempt to remove associations (LUNames, InitiatorPortIDs, or TargetPortIDs) from this SPC. Depending upon the specific implementation, the instrumentation MAY need to create new SPCs with a subset of the remaining associations. On output, this is an array of references to SPCs created or modified as the result of processing the request. |
out |
Job
|
CIM_ConcreteJob
|
|
Reference to the job if'Method Parameters Checked - Job Started'is returned (MAY be null if job completed). |
ProtocolControllers
|
IBMTSSVC_ProtocolController
|
|
An array of references to SCSIProtocolControllers (SPCs). On input, this must contain exactly one element; there MAY be multiple references on output. The instrumentation will attempt to remove associations (LUNames, InitiatorPortIDs, or TargetPortIDs) from this SPC. Depending upon the specific implementation, the instrumentation MAY need to create new SPCs with a subset of the remaining associations. On output, this is an array of references to SPCs created or modified as the result of processing the request. |
Return Codes |
none |