Cascade
Class IBMTSSVC_BackendController


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement
      \_CIM_System
        \_CIM_ComputerSystem


Description

Controller on the backend of the clusters FC. BackendControllers control the BackendVolumes that are needed to form StoragePools in the SAN Volume Controller.It is the cascading representation of the backend storage system device.

Subclasses


Referenced By

IBMTSSVC_BackendControllerForVolume IBMTSSVC_ConnectedBackendController IBMTSSVC_PrimordialPoolForController IBMTSSVC_RemoteBackendSystemDevice

Properties

IdTypeRangeDescription
Key
CreationClassName string
Max Length256
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.
Name string
The inherited Name serves as the key of a System instance in an enterprise environment.
Read Only
AllowQuorum boolean
AllowQuorum is a Boolean that indicates whether the controller has the ability to be a Quorum device, yes (TRUE), or no (FALSE).
Dedicated uint16
Not Dedicated0
Unknown1
Other2
Storage3
Router4
Switch5
Layer 3 Switch6
Central Office Switch7
Hub8
Access Server9
Firewall10
Print11
I/O12
Web Caching13
Management14
Block Server15
File Server16
Mobile User Device17
Repeater18
Bridge/Extender19
Gateway20
Storage Virtualizer21
Media Library22
ExtenderNode23
NAS Head24
Self-contained NAS25
UPS26
IP Phone27
Management Controller28
Chassis Manager29
DMTF Reserved28..32567
Enumeration indicating whether the ComputerSystem is a special-purpose System (that is, dedicated to a particular use), SAN Volume Controller is a dedicated storage device and will return {3,15} ("Storage","Block Server")
Description string
The Description property provides a textual description of the object.
DeviceID string
An address or other identifying information uniquely naming the Backend Controller
EnabledDefault uint16
Enabled2
Disabled3
Not Applicable5
Enabled but Offline6
No Default7
DMTF Reserved8..32767
Vendor Reserved32768..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
Unknown0
Other1
Enabled2
Disabled3
Shutting Down4
Not Applicable5
Enabled but Offline6
In Test7
Deferred8
Quiesce9
Starting10
DMTF Reserved11..32767
Vendor Reserved32768..65535
EnabledState is an enumerated integer 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) indicatesthat 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.
IdentifyingDescriptions string
An array of free-form strings providing explanations and details behind the entries in the OtherIdentifying Info array. Each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.
NameFormat string
The ComputerSystem object and its derivatives are Top Level Objects of CIM. They provide the scope for numerous components. Having unique System keys is required. The NameFormat property identifies how the ComputerSystem Name is generated. The NameFormat ValueMap qualifier defines the various mechanisms for assigning the name.Another name can be assigned and used for the ComputerSystem that better suits a business, using the inherited ElementName property.
OperationalStatus uint16
Unknown0
Other1
OK2
Degraded3
Stressed4
Predictive Failure5
Error6
Non-Recoverable Error7
Starting8
Stopping9
Stopped10
In Service11
No Contact12
Lost Communication13
Aborted14
Dormant15
Supporting Entity in Error16
Completed17
Power Mode18
DMTF Reserved..
Vendor Reserved0x8000..
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 ofOperationalStatus will contain the primary status for the element. When instrumented, Status (because it is single-valued) will 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 mustbe set to null when EnabledState is any value other than 1.
OtherIdentifyingInfo string
Max Length256
OtherIdentifyingInfo captures additional data, beyond System Name information, that could be used to identify a ComputerSystem. One example would be to hold the Fibre Channel worldwide name (WWN) of a node. If only the Fibre Channel name is available and is unique (able to be used as the System key), then this property would be NULL and the WWN would become the System key, its data placed in the Name property.
ProductIdHigh string
The higher part of the controller's product ID.
ProductIdLow string
The lower part of the controller's product ID.
ProductRevision string
The controller's product revision.
ProductSerialNumber string
The controller's product serial number.
RequestedState uint16
Enabled2
Disabled3
Shut Down4
No Change5
Offline6
Test7
Deferred8
Quiesce9
Reboot10
Reset11
Not Applicable12
DMTF Reserved..
Vendor Reserved32768..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. 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, 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, 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.
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.
VendorID string
The ID of the controllers vendor
VolumeLinkCount uint32
The number of links to BackendVolumes
VolumeMaxLinkCount uint32
The maximum number of links to BackendVolumes
WWNN string
The controllers WWNN
Wwpn string
The controller's WWPNs
WwpnMaxPathCount uint64
The maximum path count to the corresponding WWPN.
WwpnPathCount uint64
The path countto the corresponding WWPN.
Read Write
ElementName string
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.The Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. The same property cannot convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties.
 
Inherited from class CIM_ManagedElement
Caption, Description, ElementName
 
Inherited from class CIM_ManagedSystemElement
HealthState, InstallDate, Name, OperationalStatus, Status, StatusDescriptions
 
Inherited from class CIM_EnabledLogicalElement
EnabledState, OtherEnabledState, RequestedState, TimeOfLastStateChange, EnabledDefault
 
Inherited from class CIM_System
NameFormat, PrimaryOwnerContact, PrimaryOwnerName, Roles
 
Inherited from class CIM_ComputerSystem
Dedicated, IdentifyingDescriptions, NameFormat, OtherDedicatedDescriptions, OtherIdentifyingInfo, PowerManagementCapabilities, ResetCapability
 

Method Summary

NameDescription
GetDependentVdisksIntroduced with mirroring.
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 
Inherited from class CIM_ComputerSystem
SetPowerState
 

Method Detail


GetDependentVdisks

Description

Introduced with mirroring. One of the purposes of introducing mirroring is to make it easier to take a controller offline without VDisks going offline. This method lists the VDisks that will go offline if this controller is taken offline. This includes not just VDisks that will be globally offline, but also those that will go offline to some nodes.

Parameters

IdTypeRangeDescription
In
Vdisks string
List of VDisks that will either be globally offline or offline to some nodes if this controller is taken offline.
out
Vdisks string
List of VDisks that will either be globally offline or offline to some nodes if this controller is taken offline.
Return Codes
none