ProviderConfiguration
Class IBMTSDS_ProviderConfiguration





Description

This class represents the set of configuration properties for the CIM Agent.

Subclasses


Referenced By


Properties

IdTypeRangeDescription
Key
InstanceID string
Always set to'IBMTSDS:DSCIMProvider'. There can only be one instance of this class.
Read Only
DSDutyCycle uint32
The percentage of time spent updating the data cache for DS devices.
JVMArg string
Command line argument passed into JVM.
LogLevel uint32
The level of log event required to log into file. The valid values are: 0 - Fatal errors only, 1 - Errors and above, 2 - Warnings and above, 3 - Informational and above.
OriginalJVMArg string
JVM argument set when starting the service.
PreferredSLPRegIPs string
The IP Addresses to be used for SLP Registration. If none are specified, then a default IP will be chosen. Localhost is not valid.
StorageSyncCacheWindow uint32
StorageSynchronized has a short piggy back cache, where queries made within a certain time of each other (default 10 seconds), will return a cached copy. StorageSyncCacheWindow defines that window. Queries made after that window period will get fresh data from the microcode.
TraceComponent string
The list of trace components currently filtered.
TraceMask uint32
The set of trace events currently filtered. The valid values are: 1 - Entry and Exit events, 2 - Debugging events, 4 - Fine-grained debugging events, 8 - Performance events.
Read Write
 

Method Summary

NameDescription
CleanupPerforms cleanup operations, such as disconnecting internal connections.
GetReturnCodeMessageIf the client application executes an extrinsic method and gets a return code, it can pass the return code into this method and obtain an English description of the return code.
SetDSDutyCycleSets the DS duty cycle, which is the percentage of time spent updating the DS cache.
SetJVMArgSets the JVM argument.
SetLogLevelSets the log level.
SetPreferredSLPRegIPsSets the preferred IP to use to register in SLP.
SetStorageSyncCacheWindowSets the StorageSyncCacheWindow.
SetTraceComponentSets the trace component.
SetTraceMaskSets the trace mask.
 

Method Detail


Cleanup

Description

Performs cleanup operations, such as disconnecting internal connections. This method is used for internal purposes. Clients should not be using this method. Use the stopagent script to shut down the CIM Agent.

Parameters

IdTypeRangeDescription
In
none
out
none
Return Codes
none

GetReturnCodeMessage

Description

If the client application executes an extrinsic method and gets a return code, it can pass the return code into this method and obtain an English description of the return code. The intention of this method is to look up IBM specific return codes. For CIM standard return codes, it is recommended to look up the return code in the qualifiers of the method, because the CIM schema uses some return codes to mean different things in different methods.

Parameters

IdTypeRangeDescription
In
Code uint32
The return code to look up.
out
Description string
The description of the return code.
Return Codes
none

SetDSDutyCycle

Description

Sets the DS duty cycle, which is the percentage of time spent updating the DS cache. A value of zero is interpreted as turning the cache off, so that all data is retrieved realtime from the device

Parameters

IdTypeRangeDescription
In
DSDutyCycle uint32
out
none
Return Codes
none

SetJVMArg

Description

Sets the JVM argument

Parameters

IdTypeRangeDescription
In
JVMArg string
out
none
Return Codes
none

SetLogLevel

Description

Sets the log level

Parameters

IdTypeRangeDescription
In
LogLevel uint32
out
none
Return Codes
none

SetPreferredSLPRegIPs

Description

Sets the preferred IP to use to register in SLP. If any of the IPs are invalid, the method will return 0x9409 and the IP output parameter will contain the list of the valid IPs found on the server. DNS names are not valid . Localhost is not valid The first IP in the list will be used as key for Server Profile classes.

Parameters

IdTypeRangeDescription
In
IPs string
As input parameter, the preferred IPs.As an output parameter, the list of valid IPs.
out
IPs string
As input parameter, the preferred IPs.As an output parameter, the list of valid IPs.
Return Codes
none

SetStorageSyncCacheWindow

Description

Sets the StorageSyncCacheWindow. Under normal conditions, this attribute should not need to be modified. Modification should only be required in the rare cases where the client application cannot tolerate any sort of caching, even for a few seconds, or the microcode is being unusually slow in retreiving the data.

Parameters

IdTypeRangeDescription
In
StorageSyncCacheWindow uint32
out
none
Return Codes
none

SetTraceComponent

Description

Sets the trace component

Parameters

IdTypeRangeDescription
In
TraceComponent string
out
none
Return Codes
none

SetTraceMask

Description

Sets the trace mask

Parameters

IdTypeRangeDescription
In
TraceMask uint32
out
none
Return Codes
none