MultipleComputerSystem
Class IBMTSSVC_Cluster


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement
      \_CIM_System
        \_CIM_ComputerSystem
          \_CIM_Cluster


Description

A group of between one and four Redundancy Groups therefore up to eight Nodes form a Cluster.

Subclasses


Referenced By

IBMTSSVC_CascadingElementCapabilities IBMTSSVC_CascadingHostedService IBMTSSVC_ClusterConcreteIdentity IBMTSSVC_ClusterDumps IBMTSSVC_ClusterFabricView IBMTSSVC_ClusterFeatures IBMTSSVC_ClusterMaskingCapabilities IBMTSSVC_ClusterScopeAsyncCopySet IBMTSSVC_ClusterScopeCandidateVolume IBMTSSVC_ClusterScopeCloneCopySet IBMTSSVC_ClusterScopeFlashCopySet IBMTSSVC_ClusterScopeHardwareIdStorageVolumeView IBMTSSVC_ClusterScopeNodeVPD IBMTSSVC_ClusterScopePrivilege IBMTSSVC_ClusterScopeStorageVolumeBackendVolumeView IBMTSSVC_ClusterScopeStorageVolumeCopyBackendVolumeView IBMTSSVC_ClusterScopeSyncCopySet IBMTSSVC_ClusteringCandidate IBMTSSVC_ClusteringServiceForSystem IBMTSSVC_ComputerSystemPackage IBMTSSVC_ConnectedBackendController IBMTSSVC_ControllerConfigurationServiceForSystem IBMTSSVC_DeviceSettingData IBMTSSVC_ElementConformsToProfile IBMTSSVC_HostedAllocatedResources IBMTSSVC_HostedConcretePool IBMTSSVC_HostedFlashCopyJob IBMTSSVC_HostedFormatVolumeJob IBMTSSVC_HostedJob IBMTSSVC_HostedMigrateVolumeJob IBMTSSVC_HostedPrimordialPool IBMTSSVC_HostedRemoteServiceAccessPoint IBMTSSVC_HostedRepairVdiskCopyJob IBMTSSVC_HostedStorageConfigurationService IBMTSSVC_HostedSyncCopyJob IBMTSSVC_HostedVdiskSyncJob IBMTSSVC_IOGroupComponentOfCluster IBMTSSVC_InitiatorControllerOnCluster IBMTSSVC_InstalledClusterSoftwareIdentity IBMTSSVC_NodeComponentOfCluster IBMTSSVC_PartnershipCandidate IBMTSSVC_PortsOnCluster IBMTSSVC_PrivilegeServiceForSystem IBMTSSVC_ProtocolControllerOnCluster IBMTSSVC_RemotePartnership IBMTSSVC_StorageExtentOnCluster IBMTSSVC_StorageHardwareIDsForSystem IBMTSSVC_StorageVolumeOnCluster IBMTSSVC_UseOfMessageLog

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 label by which the object is known. Format: cluster_ip:object_id
Read Only
AllocatedCapacity uint64
The total capacity of all StorageVolumes in the cluster.
AvailableCapacity uint64
The currently available space in the cluster. This is approx. BackendStorageCapacity-AllocatedCapacity.
BackendStorageCapacity uint64
The total capacity of all backend storage connected to the cluster.
ClusterState uint16
Unknown0
Other1
On-line2
Off-line3
Degraded4
Unavailable5
Indicates the state of the Cluster. The cluster can be defined to be on-line (value=2), off-line (3), in a degraded mode of operation (4) or unavailable (5).
CodeLevel string
The code level of the cluster.
ConfiguredAddress string
The address that this cluster is configured at in the CIMOM.
ConnectionType uint16
IPv41
IPv62
The type of connection being used to manage this SVC Cluster.
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 (ie, dedicated to a particular use), SAN Volume Controller is a dedicated storage device and will return {15,21} ("Storage","Storage Virtualizer")
Description string
The Description property provides a textual description of the object.
DiscoveryStatus sint8
Not Supported-2
Unknown-1
No Discovery In Progress0
Discovery In Progress1
The discovery status of the cluster. This property is not supported by SVC versions previous to v4.1.0.
EMailContact string
Email Contact
EMailContactAlternate string
Email Contact Alternate
EMailContactLocation string
Email Contact Location
EMailContactPrimary string
Email Contact Primary
EMailReply string
Email Reply
EMailServer string
Email Server
EMailServerPort uint32
Email Server Port
EmailSetting string
The email setting.
EMailState uint32
Unknown (0)0
Running (1)1
Stopped (2)2
Invalid (3)3
Email State
EMailUserCount uint32
Email User Count
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 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.
IdentifyingDescriptions string
An array of free-form strings providing explanations and details behind the entries in the OtherIdentifying Info array. Note, each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.
Locale string
The current locale setting of the cluster.
MaxNumberOfNodes uint32
Indicates the maximum number of nodes that may participate in the Cluster. If unlimited, enter 0.
NameFormat string
Max Length64
The NameFormat property identifies how the ComputerSystem Name is generated. SAN Volume Controller returns the cluster's id as Name, therefore this attribute is set to"Other"
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..
The cluster's operational status. Can be"OK"(2) - cluster is online and connected,"Error"(6) - SSH authentication failed,"Non-Recoverable Error"(7) - cluster's CLI down,"No Contact"(12) - cluster not visible on the network,"Connection Lost"(13) - SSH connection opened, but no response on commands sent.
OtherDedicatedDescriptions string
A string describing how or why the system is dedicated when the Dedicated array includes the value 2,"Other".
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.
OtherIdentifyingInfo string
Max Length256
The cluster's IP Address, Subnet Mask, Default Gateway and Service IP Address. If this cluster also has a IPv6 interface, the IPv6 information will be appended to the end of this array.
PoolCapacity uint64
The total capacity of all StoragePools in the cluster.
PrimaryOwnerName string
Max Length64
The name of the primary system owner. The system owner is the primary user of the system.
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.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, 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. SAN Volume Controller does not evaluate this attribute and therefore no action is taken when it's changed.
RequiredMemory uint32
The amount of required memory for that cluster.
ResetCapability uint16
Other1
Unknown2
Disabled3
Enabled4
Not Implemented5
If enabled (value = 4), the ComputerSystem can be reset via hardware (for example, the power and reset buttons). If disabled (value = 3), hardware reset is not allowed. In addition to Enabled and Disabled, other Values for the property are also defined:"Not Implemented"(5),"Other"(1) and"Unknown"(2).
SNMPCommunity string
The SNMP community.
SNMPServerIP string
The SNMP server ip address.
SNMPSetting string
The SNMP setting of the cluster.
StatisticsFrequency uint32
Indicates the update interval for the cluster statistics
StatisticsStatus boolean
Is true if statistics collection is active.
Status string
The status of the cluster.
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.
TimeZone string
The timezone setting of the cluster.
TotalOverallocation uint64
Amount of Space-Efficient storage that does not have correspondng real backup.
TotalUsedCapacity uint64
Total used capacity of all StorageVolumes.When space efficent features are being used this figure the total used capicity
TotalVdiskCapacity uint64
Sum of all VDisk capacities. Does not include capacity of VDisk mirrors. For space efficient VDisks the capacity is the size, not the real size.For the total capacity of all VDisk mirrors see TotalVdiskCopyCapacity.
TotalVdiskCopyCapacity uint64
Sum of capacities of all VDisk copies. For space efficient VDisk copies the capacity is the size, not the real size. For total capacity of VDisks excluding mirroring see TotalVdiskCapacity.
Types uint16
Unknown0
Other1
Failover2
Performance3
Distributed OS4
Node Grouping5
SysPlex6
The cluster types. This specifies whether the cluster is for failover (value=2), performance (3), etc. The values which can be specified are not mutually exclusive. Thus, Types is an array.
Read Write
Caption string
Max Length15
The Caption property is a short textual description (one-line string) of the object.
ConsoleIP string
The IPv4 address of the management console.
ConsolePort string
The port address of the management console.
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.
FcPortSpeed uint64
The transmission speed of the attached Fibre-Channel. Accepts values of 1GB or 2GB only, default is 1
GMInterClusterDelaySimulation uint32
The Global Mirror Inter-Cluster Delay Simulation. Accepts values from 0 to 100, default is 0. This property is only supported if cluster supports Global Mirror.
GMIntraClusterDelaySimulation uint32
The Global Mirror Inter-Cluster Delay Simulation. Accepts values from 0 to 100, default is 0. This property is only supported if cluster supports Global Mirror.
GMLinkTolerance uint32
The Global Mirror link tolerance. Accepts values from 60 to 86400 in steps of 10, default is 60. This property is only supported in cluster supports Global Mirror.
PrimaryOwnerContact string
Max Length256
The EMail address of the primary contact person for this cluster
 
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
 
Inherited from class CIM_Cluster
ClusterState, Interconnect, InterconnectAddress, MaxNumberOfNodes, Types
 

Method Summary

NameDescription
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 
Inherited from class CIM_ComputerSystem
SetPowerState
 

Method Detail