ServiceMode
Class IBMTSSVC_ClusteringService


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement
      \_CIM_Service
        \_CIM_ClusteringService


Description


Subclasses


Referenced By

IBMTSSVC_ClusteringServiceForSystem

Properties

IdTypeRangeDescription
Key
CreationClassName string
Max Length256
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
Max Length256
The CreationClassName of the scoping System.
SystemName string
Max Length256
The Name of the scoping System.
Read Only
Description string
The Description property provides a textual description of the object.
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.
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 status(es) of the element. Various health and operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail."Stressed"indicates that the element is functioning, but needs attention. Examples of"Stressed"states are overload, overheated, etc."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 element's state and configuration may need to be updated."Dormant"indicates that the element is inactive or quiesced."Supporting Entity in Error"describes that this element may 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 the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded implies the operation finished, but did not complete OK or report an error."Power Mode"indicates 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 since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, providers/instrumentation must provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus will contain the primary status for the element. When instrumented, Status (since 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 must be set to null when EnabledState is any value other than 1.
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.
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
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).
PrimaryOwnerContact string
Max Length256
A string that provides information on how the primary owner of the Service can be reached (for example, phone number, e-mail address, and so on).
PrimaryOwnerName string
Max Length64
The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the Service.
 
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_Service
Started, StartMode, PrimaryOwnerContact, PrimaryOwnerName
 

Method Summary

NameDescription
AddNodeAddNode brings a new ComputerSystem into a Cluster.
BackupConfigurationThis method runs the backup script.
CleanThis command allows you to clean the various dumps on a specific node.
DeleteConfigurationBackupThis method deletes a backup in the backup/ directory.
DumpThis method generates a dump file on the SVC Cluster.
EvictNodeEvictNode removes a ComputerSystem from a Cluster.
GetDumpRetrieves a dump file and decodes if necessary.
GetResetPasswordChangeFeatureStatusReturns the status of the password reset feature.
ListConfigurationBackupsThis method lists the backups in the backup/ directory.
ModifyIPAddressChanges the ip address of the cluster this service belongs to.
ModifyResetPasswordChangeFeatureEnables or disables the password reset feature.
RequestStateChangeUnsupported method.
RestoreConfigurationThis method runs the configuration restore script.
RestoreConfigurationFileThis method copies the locally stored cluster configuration backup file to the SVC Cluster.
SetLocaleSets the locale of a cluster.
SetPasswordsSets the Admin and/or Service password of the cluster.
SetTimeZoneSets the time zone of the cluster.
ShutdownShuts down the cluster or a node.
StartStatisticsCollectionStarts the cluster's statistics collection.
StopStatisticsCollectionStops the cluster's statistics collection.
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 
Inherited from class CIM_Service
StartService, StopService
 
Inherited from class CIM_ClusteringService
AddNode, EvictNode
 

Method Detail


AddNode

Description

AddNode brings a new ComputerSystem into a Cluster. The node to be added is specified as a parameter to the method.

Parameters

IdTypeRangeDescription
In
CS IBMTSSVC_CandidateNode
The node to add to the cluster. Must be of class IBMTSSVC_CandidateNode.
Set IBMTSSVC_IOGroup
The IOGroupSet to add the node to.
Name string
The new name for the added node.
out
none
Return Codes
none

BackupConfiguration

Description

This method runs the backup script. The script stores the current configuration of the cluster which is associated with this instance in an XML file. The file is named svc.config.backup.xml and is stored in the directory backup/<clustername>relative to the CIMOM home directory. If a backup of the current cluster configuration already exists, it will be overwritten

Parameters

IdTypeRangeDescription
In
Force boolean
If true, command continuation is forced. False by default
FilePath string
The path of the backup files.
Messages string
The errors/warnings received from the backup script. Each array element corresponds to one line on stdout.
out
FilePath string
The path of the backup files.
Messages string
The errors/warnings received from the backup script. Each array element corresponds to one line on stdout.
Return Codes
none

Clean

Description

This command allows you to clean the various dumps on a specific node.

Parameters

IdTypeRangeDescription
In
Filter string
The filter's syntax is:1. If a directory is specified - with no file filter- all relevant dump/log files in this directory are cleaned.The allowable directory arguments are:dumps (cleans all files in all subdirectories - for example, those listed below) /dumps/configs, /dumps/elogs, /dumps/feature, /dumps/iostats, /dumps/iotracehome/admin2. In addition to the directory, a file filter can be specified. For example: /dumps/elog/*.txt will clean all files in the /dumps/elog directory that end in .txt
Node IBMTSSVC_Node
Specifies the Node where dump files shall be deleted. If nothing is specified here dumps on the config node will be deleted.
out
none
Return Codes
none

DeleteConfigurationBackup

Description

This method deletes a backup in the backup/ directory.

Parameters

IdTypeRangeDescription
In
Backup string
The name of the backup to delete. (Only<clustername>)
out
none
Return Codes
none

Dump

Description

This method generates a dump file on the SVC Cluster.

Parameters

IdTypeRangeDescription
In
Type uint16
Type decides what type of dump will be generated. Allowable values are:0 = An error log will be generated2 = A feature log will be generated
FileNamePrefix string
If not supplied, then the dump will be directed to a file with a system defined name. If supplied a filename is created from the prefix and a timestamp, and will take the form"FileNamePrefix"_NN_YYMMDD_HHMMSS.Where NN is the current configuration node ID.
out
GeneratedFile string
The filename of the generated file
Return Codes
none

EvictNode

Description

EvictNode removes a ComputerSystem from a Cluster. The node to be evicted is specified as a parameter to the method.

Parameters

IdTypeRangeDescription
In
CS IBMTSSVC_Node
The node to evict from the cluster. Must be of class IBMTSSVC_Node.
out
none
Return Codes
none

GetDump

Description

Retrieves a dump file and decodes if necessary

Parameters

IdTypeRangeDescription
In
RetrievalWaitSecs uint32
Optionally specify a time period (in seconds) to wait for the dump file to be retrieved from the node specified above. If the file has not been retrieved within this time period, the timeouterror code (0x8006) will be returned. Passing in 0 for this parameter will cause the method to wait for the retrieval indefinitely. By default, this method does not wait for the file to be retrieved.
FilePath string
The fully specified name of the dump file. This must be the name of a file, not a directory and wildcards are not allowed. The list of available dump files can be found by enumerating the IBMTSSVC_Dump class. Dump files must be in one of the following directories on the SVC Cluster: /dumps/configs/, /dumps/elogs/, /dumps/feature/, /dumps/iostats/, /dumps/iotrace/,/home/admin/upgrade/, or /dumps/
Node IBMTSSVC_Node
If a node is passed in this parameter then the dump file will be retrieved from this node, otherwise the dump file is assumed to exist on the config node.
out
File string
The file as a string array.
Return Codes
none

GetResetPasswordChangeFeatureStatus

Description

Returns the status of the password reset feature.

Parameters

IdTypeRangeDescription
In
IsEnabled boolean
The status of the password reset feature.
out
IsEnabled boolean
The status of the password reset feature.
Return Codes
none

ListConfigurationBackups

Description

This method lists the backups in the backup/ directory. Only the directory names are reported of the cluster which is associated with this instance of ClusteringService from the corresponding cluster configuration backup

Parameters

IdTypeRangeDescription
In
Backup string
Each element of the array contains the name of one backup available in the backup/ directory
out
Backup string
Each element of the array contains the name of one backup available in the backup/ directory
Return Codes
none

ModifyIPAddress

Description

Changes the ip address of the cluster this service belongs to

Parameters

IdTypeRangeDescription
In
ClusterIP string
The new ip address of the cluster.
out
none
Return Codes
none

ModifyResetPasswordChangeFeature

Description

Enables or disables the password reset feature.

Parameters

IdTypeRangeDescription
In
Enable boolean
If"Enable"is true, the password reset feature will be enabled. Otherwise it will be disabled.
out
none
Return Codes
none

RequestStateChange

Description

Unsupported method.

Parameters

IdTypeRangeDescription
In
RequestedState uint16
TimeoutPeriod datetime
out
none
Return Codes
none

RestoreConfiguration

Description

This method runs the configuration restore script. The script restores the configuration of the cluster which is associated with this instance of ClusteringService from the corresponding cluster configuration backup

Parameters

IdTypeRangeDescription
In
Force boolean
If true, then the command will continue even if there are non fatal errors. The default is False.
Format boolean
If true, the VDisks are formatted during restore. The default is False.
Phase uint8
The restoration phase to be performed
Messages string
The errors/warnings received from the backup script. Each array element corresponds to one line on stdout.
out
Messages string
The errors/warnings received from the backup script. Each array element corresponds to one line on stdout.
Return Codes
none

RestoreConfigurationFile

Description

This method copies the locally stored cluster configuration backup file to the SVC Cluster. After copying the file, please contact IBMSupport to complete the cluster configuration restoration process.

Parameters

IdTypeRangeDescription
In
Clear boolean
If true, then the existing config files on the cluster will be cleared before the local config file is copied to the cluster. If this parameter is not present, no files will be cleared.
out
none
Return Codes
none

SetLocale

Description

Sets the locale of a cluster.

Parameters

IdTypeRangeDescription
In
Locale uint16
The locale to set. Locales are encoded as follows: 0=US English, 1=Simplified Chinese, 2=Traditional Chinese, 3=Japanese, 4=Korean, 5=French, 6=German, 7=Italian, 8=Spanish, 9=Portugese.
out
none
Return Codes
none

SetPasswords

Description

Sets the Admin and/or Service password of the cluster

Parameters

IdTypeRangeDescription
In
AdminPw string
The new administrator password.
ServicePw string
The new service password.
out
none
Return Codes
none

SetTimeZone

Description

Sets the time zone of the cluster.

Parameters

IdTypeRangeDescription
In
Zone uint16
The new time zone of the cluster.
out
none
Return Codes
none

Shutdown

Description

Shuts down the cluster or a node.

Parameters

IdTypeRangeDescription
In
System CIM_ComputerSystem
The IBMTSSVC_Node or IBMTSSVC_Cluster to shut down.
Force boolean
If"Force"is true, the SAN Volume Controller will shut down nodes even if they are the only node of a IOGroup.
out
none
Return Codes
none

StartStatisticsCollection

Description

Starts the cluster's statistics collection.

Parameters

IdTypeRangeDescription
In
Interval uint32
The interval for statistics collection. For SVC Clusters running firmware version 4.1.0 or lower, this value must be at least 15.
out
none
Return Codes
none

StopStatisticsCollection

Description

Stops the cluster's statistics collection.

Parameters

IdTypeRangeDescription
In
none
out
none
Return Codes
none