HiCommand Dynamic Link Manager User's Guide (for Windows(R))

7.6.2 Parameters

Organization of this subsection

(1) To set up the HDLM operating environment

(2) To display the format of the set operation

(1) To set up the HDLM operating environment

Table 7-2 Default values and recommended values shows the defaults and recommended values for each setting. If you change the value of the set operation, the new value takes effect immediately.

Table 7-2 Default values and recommended values

Item name Default value Recommended setting

Load balancing on
Algorithm is round robin on
The recommended algorithm depends on the operating environment.

Error log collection level 3: Collect error information for the Information level and higher. 3: Collect error information for the Information level and higher.

Error log file size 9900 (KB) 9900 (KB)

Number of error log files 2 2

Trace level 0: Do not output any trace. 0: Do not output any trace.

Trace file size 1000 (KB) 1000 (KB)

Number of trace files 4 4

Path health checking on on
The recommended checking interval depends on the operating environment.

Automatic failback off off

Intermittent Error Monitor off off

Remove LU off The recommended value depends on the operating environment.

-lb {on [-lbtype {rr|exrr}]|off}

Enables or disables load balancing.

on: Enabled

off: Disabled

In a cluster environment, the load balancing function is only available for Thunder 9200/9500V Series, Lightning 9900/9900V Series, TagmaStore, and Universal Storage Platform V. In a non-cluster environment, the load balancing function is available for Thunder 9200/9500V Series, Lightning 9900/9900V Series, TagmaStore, and Universal Storage Platform V, the EMC DMX series, and HP EVA series. The above-mentioned conditions are applied regardless of the settings for the EMC DMX series, EMC CX series, and HP EVA series. For example, in a cluster environment, the load balancing function is disabled even if it is set to on for the EMC DMX series. For details on the cluster software supported by HDLM, see 2.12 Cluster support.

-lbtype {rr|exrr}

Specify the algorithm to be used for load balancing.

rr: Round robin

exrr: Extended round robin

The type of algorithm specified by the -lbtype parameter remains stored in the system, even when you disable load balancing function by specifying -lb off. Therefore, when you re-enable load balancing without specifying an algorithm, load balancing will be executed according to the setting stored in the system.

When using MSCS, depending on the micro-program of the storage subsystem, you may not be able to use the load balancing function. For more details, see Hardware Notes provided with HDLM.
-ellv error-log-collection-level

Specify the level of error information you want to collect for an error log.

The following shows the log files in which a error log collection level can be set:

HDLM manager logs:

dlmmgrn.log (n indicates a file number from 1 to 16)

HDLM GUI logs:

dlmguin.log (n indicates a file number of 1 or 2)

Table 7-3 Values of the error log collection level shows the values of the error log collection level. If an error occurs, you may have to set the error log collection level to 1 or higher to collect log information.

Table 7-3 Values of the error log collection level

Value Description

0 Collects no error log.

1 Collects error information for the Error or higher level.

2 Collects error information for the Warning or higher level.

3 Collects error information for the Information or higher level.

4 Collects error information for the Information or higher level (including maintenance information).

As the amount of log information to be output increases, the amount of time before existing information is overwritten becomes shorter.
Example
  
>dlnkmgr set -ellv 1
KAPL01049-I Would you like to execute the operation? Operation name = set [y/n]: y
KAPL01001-I The HDLM command completed normally. Operation name = set, completion time = yyyy/mm/dd hh:mm:ss
>
-elfs error-log-file-size

Specify a value from 100 to 2000000 (kilobytes) for the size of the error log files. The target log files for which a file size can be set are HDLM manager logs (dlmmgrn.log (n indicates a file number from 1 to 16)) and HDLM GUI logs (dlmguin.log (n indicates a file number of 1 or 2)). For HDLM GUI logs, the valid range of a file size is from 100 to 9900. If you specify a value of 9901 or more, 9900 is applied. The specified value is applied for HDLM manager logs.

When combined with the specification for the number of error log files, the maximum total size of error log files that can be collected is 32000000KB (approximately 30GB).

When the size of all log files in a log file group reaches a specified value, new log data overwrites existing log data (the oldest log file is overwritten first).

-elfn number-of error-log-files

Specify the number of error log files. Specify a value from 2 to 16.

When combined with the specification for the error log file size, the maximum total size of error log files that can be collected is 32000000KB (approximately 30GB).

The target log files for which the number of files can be set are HDLM manager logs (dlmmgrn.log (n indicates a file number from 1 to 16)) only. For HDLM GUI logs (dlmguin.log (n indicates a file number of 1 or 2)), the number of log files is fixed to 2.

-systflv trace-level

Specify the trace output level.

The trace files for which trace levels can be set are hdlmtrn.log (n indicates a file number from 1 to 64).

Table 7-4 Trace level values shows the values of the trace level. The default is 0. When an error occurs, we recommend that you set the value of the trace level to 1 or higher and re-collect log information. If an error occurs, you may have to set the trace level to 1 or higher to collect log information.

Table 7-4 Trace level values

Value Description

0 Does not output any trace.

1 Only outputs error information.

2 Outputs a summary of program operation.

3 Outputs details of program operation.

4 Outputs all information.

The larger the trace level value, the larger the amount of log information that is output. As the amount of log information that is output increases, the amount of time before existing information is overwritten becomes shorter.

-systfs trace-file-size

Specify the size of the trace file in kilobytes. Specify a value of 100 to 16000.

When combined with the specification for the number of trace files, the maximum total size of the trace files that can be collected is 1024000KB.

If a value smaller than the setting value is specified, an execution confirmation message KAPL01097-W is displayed and the trace file is once deleted.

The trace files for which a file size can be set are hdlmtrn.log (n indicates a file number from 1 to 64). The trace files are fixed in length. Thus, even if the amount of written trace information is less than the setting file size, the size of each output trace file is always fixed. When trace data is written to all trace files, new trace data overwrites old trace data (the oldest file is overwritten first).

-systfn number-of-trace-files

Specify the number of trace files. Specify a value of 2 to 64.

When combined with the specification for the trace file size, the maximum total size of the trace files that can be collected is 1024000KB.

If a value smaller than the setting value is specified, an execution confirmation message KAPL01097-W is displayed and the trace file is once deleted.

The trace files for which the number of files can be set are hdlmtrn.log (n indicates a file number from 1 to 64).

-pchk {on [-intvl checking-interval]|off}

Enables or disables path health checking.

on: Enabled

off: Disabled

Path health checking checks the paths that have the Online status.

For a standby host, or a host connected to the Thunder 9200, or Thunder 9500V Series, or TagmaStore AMS/WMS series storage subsystem, we recommend that you activate path health checking to enable detection of errors in paths where I/Os do not occur.

When you specify on, specify the checking interval of path health checking by specifying the parameter immediately following on. If you do not specify a checking interval, path health checking is executed in the following interval:

When the checking interval has not been specified before:
Every 30 minutes (default setting)

When the checking interval has been specified before:
The interval used in the last time

The explanation for the following sub-parameter describes how to specify the checking interval.

-intvl checking-interval

Specify the checking interval between path health checks (in minutes). Specify a value from 1 to 1440 minutes depending on the user environment. When you change the checking interval, the new setting takes effect immediately. When the checking interval is shortened and the checking interval after the change (from the end of the previous path health check) has already elapsed, the path health check will start immediately.

The path health check interval setting remains stored in the system even if you disable the function by changing the setting of path health checking to off. Therefore, when you re-enable path health checking and do not change the interval, path health checking is executed at the interval stored in the system.
-afb {on [-intvl checking-interval]|off}

Enables or disables automatic failback.

on: Enabled

off: Disabled

Enabling automatic failback may automatically place online those paths that were intentionally placed offline (for example, paths placed offline for maintenance work).

If you want to prevent such paths from automatically being placed online, disable this function. When intermittent errors occur in paths or storage subsystems, path status alternates between the online and offline status frequently, so I/O performance might deteriorate.

Automatic failback is executed in the following paths:

Path where an error occurred and for which the KAPL08022-E message was displayed

Path where an error occurred at the startup of the HDLM manager.

To prevent an intermittent error from deteriorating I/O performance, we recommend that you also enable intermittent error monitoring when enabling automatic failback. Intermittent error monitoring is specifiable only when automatic failback is enabled.

See Table 7-5 Relationship between the setting status for automatic failback and intermittent error monitoring and the executable operations for the relationship between automatic failback and intermittent error monitoring.

When you specify on, specify the checking interval of path status by specifying the parameter immediately following on. If you do not specify a checking interval, path status is checked in the following interval:

When the checking interval has not been specified before:
Every minute (default setting)

When the checking interval has been specified before:
The interval used in the last time

The explanation for the following sub-parameter describes how to specify the interval between path status checks.
-intvl checking-interval

Specify the interval between path status checks (in minutes). Specify a value from 1 to 1440 minutes. Specify the interval appropriate for your operation environment.

If intermittent error monitoring is on and the number of times that the error is to occur is set to a value of 2 or more, the following condition must be satisfied:
 
error-monitoring-interval >= checking-interval-for-automatic-failback x number-of-times-error-is-to-occur-during-intermittent-error-monitoring
 
If this condition is not satisfied, the KAPL01080-W message is output and an error occurs. In such a case, change any of the following settings: the checking interval for automatic failback, the intermittent error monitoring interval, or the number of times that the error is to occur.

When you set the number of times that the error is to occur to 1, the above condition does not need to be satisfied.

When you change the error monitor interval while monitoring for an intermittent error is operating, the new setting takes effect immediately. When the checking interval is shortened and the checking interval after the change (from the end of the previous path status check) has already elapsed, the path status check will start immediately.

This setting remains stored in the system, even if you disable the function by changing the setting of automatic failback to off. Therefore, when you re-enable automatic failback and do not change the interval, path status checks are executed at the interval stored in the system.
When you upgrade from HDLM 03-00 or 03-01 to 05-00 or later:

When you upgrade to HDLM 05-00 or later from HDLM 03-00 or 03-01, and the -pchk parameter was set to on in the previous version, the -afb parameter will be set to on in the new version. The value of the -intvl parameter will be set to the same value as the checking interval of the -pchk parameter.
-iem { on [-intvl error-monitoring-interval] [-iemnum number-of-times-error-is-to-occur] | off }

Enables or disables intermittent error monitoring.

on: Enabled

off: Disabled

Intermittent error monitoring can be set only when automatic failback is set to on.

When you use automatic failback, we recommend that you set intermittent error monitoring to on to prevent an intermittent error from reducing I/O performance.

If on is specified, in the subsequent parameters specify the intermittent error monitoring interval and the number of times that the error is to occur. The system assumes that an intermittent error is occurring if the specified number of times that the error is to occur is reached during the monitoring interval (from the time that the monitoring interval starts, until the specified interval ends). A path that is assumed to have an intermittent error is excluded from automatic failback. Intermittent error monitoring is performed on individual paths. Intermittent error monitoring starts when a path is recovered from the error by using automatic failback.

If you omit the intermittent error monitoring interval or the number of times that the error is to occur, each setting is specified as follows:

When the intermittent error monitoring interval or the number of times that the error is to occur has not been specified before:
The intermittent error monitoring interval is set to 30 minutes, and the number of times that the error is to occur is set to 3.

When the intermittent error monitoring interval or the number of times that the error is to occur has been specified before:
The values specified the last time are set.

When a value of 2 or more is specified in number of times, the following condition must be satisfied:
 
error-monitoring-interval >= checking-interval-for-automatic-failback x number-of-times-error-is-to-occur-during-intermittent-error-monitoring
 
If this condition is not satisfied, the KAPL01080-W message is output and an error occurs. In such a case, change any of the following settings: the checking interval for automatic failback, intermittent error monitoring interval, or the number of times that the error is to occur.

When you set the number of times that the error is to occur to 1, the above condition does not need to be satisfied.

The following shows the sub-parameters to specify the error monitoring interval and the number of times that the error is to occur (in order for the system to determine that an intermittent error is occurring):

-intvl error-monitoring-interval

Specify the monitoring interval for an intermittent error (in minutes). Use a value from 1 to 1440. The default is 30.

During intermittent error monitoring, if changes are made in the settings of the intermittent error monitoring interval or the number of times that an error is to occur, the error count and the elapsed time measured since monitoring starts are set to 0, and monitoring starts by using the new settings.

Outside the duration of intermittent error monitoring, if changes are made in the settings of the intermittent error monitoring interval or the number of times that an error is to occur, the new settings take effect after the next time automatic failback succeeds. Because the errors and elapsed time are not counted or measured while intermittent errors are not monitored, those values do not change.

The monitoring interval specified in this parameter is stored even though specifying -iem off disables intermittent error monitoring. Therefore, when you re-enable intermittent error monitoring and the monitoring interval is not specified, error monitoring will be executed for the stored monitoring interval.

-iemnum number-of-times-error-is-to-occur

Specify the number of times the error is to occur. Use a value from 1 to 99. The default is 3.

During intermittent error monitoring, if you change the number of times that the error is to occur in order for the system to determine that an intermittent error has occurred, the number of errors and the time that has passed since intermittent error monitoring starts are reset to 0. Then, the changed setting takes effect and intermittent error monitoring starts.

Outside the duration of intermittent error monitoring, if you change the number of times that the error is to occur in order for the system to determine that an intermittent error has occurred, from the next time automatic failback finishes normally, the changed values takes effect. Outside the duration of intermittent error monitoring, the number of errors that determine an intermittent error is not counted and this value is not changed.

The number of times that the error is to occur specified in this parameter is stored even though specifying -iem off disables intermittent error monitoring. Therefore, when you re-enable intermittent error monitoring and the number of times is not specified, the error monitoring will be executed using the stored number of times.

When the set -iem on operation is executed during error monitoring, even if you do not change the conditions for intermittent error, the number of errors and the time that has passed since the error monitoring starts are reset to 0. Then intermittent error monitoring resumes with the changed settings.

If you set automatic failback to off while intermittent error monitoring is on, intermittent error monitoring becomes disabled. Note, however, that if you use the view -sys operation to display the HDLM functionality configuration, Intermittent Error Monitor shows on. When automatic failback is returned to on, intermittent error monitoring becomes enabled.

The executable operations for automatic failback and intermittent error monitoring depend on the setting status for those functions. Table 7-5 Relationship between the setting status for automatic failback and intermittent error monitoring and the executable operations shows the relationship between the setting status for automatic failback and intermittent error monitoring and the executable operations for those functions.

Table 7-5 Relationship between the setting status for automatic failback and intermittent error monitoring and the executable operations

Setting Available operation Result of operation

AFB IEM

on on Set AFB to on. The operations of AFB and IEM do not change.

Change the AFB setting. AFB operates using new settings.^#1

Set AFB to off.

AFB and IEM are disabled.

The error count, elapsed monitoring time, and information about paths not subject to automatic failback are cleared.

Set IEM to on.

When a path is being monitored (in the period of conditional intermittent error monitoring), the value of the error count and the elapsed monitoring time are reset to 0, and then intermittent error monitoring restarts.

When a path is not being monitored (outside the period of conditional intermittent error monitoring), nothing changes.

Change the IEM settings.

When a path is being monitored (in the period of conditional intermittent error monitoring), the value of the error count and the elapsed monitoring time are reset to 0, and then intermittent error monitoring restarts according to the conditions for intermittent error after change.^#1

When a path is not being monitored (outside the period of conditional intermittent error monitoring), the IEM settings will take effect when the path is recovered from the error status by performing automatic failback.

Set IEM to off.

IEM is disabled.

The error count, elapsed monitoring time, and information about paths not subject to automatic failback are cleared.

off Set AFB to on. The operations of AFB and IEM do not change.

Change the AFB setting. AFB operates using new settings.

Set AFB to off. AFB is disabled.

Set IEM to on. IEM is enabled.^#1

off on^#2 Set AFB to on. AFB and IEM are enabled.^#1

Set AFB to off. The operations of AFB and IEM do not change.

off Set AFB to on. AFB is enabled.

Set AFB to off. The operations of AFB and IEM do not change.

Legend:

AFB: Automatic failback

IEM: Intermittent error monitoring

#1

When this condition is not satisfied, the KAPL01080-W message is output and an error occurs. The status of the intermittent error monitoring does not change.

#2

Since automatic failback is off, intermittent error monitoring is disabled.
Example

The following example shows how to enable monitoring of intermittent errors:
 
>dlnkmgr set -iem on -intvl 20 -iemnum 2
KAPL01049-I Would you like to execute the operation? Operation name = set [y/n]: y
KAPL01001-I The HDLM command completed normally. Operation name = set, completion time = yyyy/mm/dd hh:mm:ss
>
-lic

Specify this option when a license is updated. The HDLM license is provided by a license key or a license key file. A license key file is a file that stores an HDLM license key.

If you use a license key file:

Store the license key file named hdlm_license directly under the Windows installation-destination, and then execute the set -lic operation. A message confirming that the license key has been registered is displayed, depending on the license key type described in the license key file. When a temporary license key or emergency license key has been registered, the expiration period is displayed (KAPL01071-I, KAPL01072-I).

If you do not use a license key file:

When the set -lic operation is executed, a message (KAPL01068-I) asking the user to enter a license key appears. Enter the license key. A message confirming that the license key has been registered is displayed, depending on the license key type described in the license key file. When a temporary license key or emergency license key has been registered, the expiration period is displayed (KAPL01071-I, KAPL01072-I).

Table 7-6 License key types lists the license key types.

Table 7-6 License key types

Type Description

Permanent license key Permanent licenses are valid for using HDLM in an ongoing basis.

Temporary license key^# The temporary license key is used temporarily, for example, when a user performs product evaluations. Temporary licenses are valid for only 120 days after installation. You cannot reuse a temporary license key.

Emergency license key The emergency license key is used temporarily, for example, when issuing a permanent license key that is delayed for some reasons. Emergency licenses are valid for 30 days after they are entered. You cannot reuse an emergency license key.

#

A temporary license key cannot be installed by using the dlnkmgr set operation.
Example 1

The following example shows how to update the license key (when the license key file exists).
 
>dlnkmgr set -lic
KAPL01049-I Would you like to execute the operation? Operation name = set [y/n]: y
KAPL01071-I A permanent license was installed.
KAPL01001-I The HDLM command completed normally. Operation name = set, completion time = yyyy/mm/dd hh:mm:ss
>
Example 2

The following example shows how to update the license key (when the license key file does not exist).
 
>dlnkmgr set -lic
KAPL01049-I Would you like to execute the operation? Operation name = set [y/n]: y
KAPL01083-I There is no license key file. File name =Windows-installation-destination-drive-name\hdlm_license
KAPL01068-I Enter a license key:*************
KAPL01071-I A permanent license was installed.
KAPL01001-I The HDLM command completed normally. Operation name = set, completion time = yyyy/mm/dd hh:mm:ss
> 
-rmlu { on [ -force ] | off }

Enables or disables the LU dynamic deletion functionality.

on: Enabled

off: Disabled

The default is off.

The explanation for the following sub-parameter describes how to specify the LU dynamic deletion functionality.

-force

The LU is removed from HDLM management when all the paths to the LU are disconnected, even when an Offline(C) path is included.

For details on the LU dynamic deletion functionality, see 4.6.2 Deleting an LU dynamically.

Table 7-7 Values for the LU dynamic deletion functionality shows the values of the LU dynamic deletion functionality.

Table 7-7 Values for the LU dynamic deletion functionality

Value Description

off The LU is not removed from HDLM-management even if the error occurs in all the paths to the LU, all the paths to the LU are disconnected, or the LU is deleted. The status of the paths is Offline(E) and Online(E). This operation is as equal as the operation in HDLM 05-01 or earlier. The off option is recommended when you want to use the same functionality as you use in HDLM 05-01 or earlier, without using the LU dynamic deletion functionality.

on The LU is removed from HDLM-management when all the paths to the LU are disconnected. However, if an Offline(C) path is included in the disconnected paths, the LU is not deleted from HDLM-management.
The deleted LU is restored when it is recovered from the physical failure and the disk is re-scanned.

on -force The LU is removed from HDLM management when all the paths to the LU are disconnected, even when an Offline(C) path is included.
The removed LU is restored when it is recovered from the physical failure and the disk is re-scanned.

-s

Executes the command without displaying the message asking for confirmation of command execution from the user. Specify this parameter if you want to skip the response to the confirmation message: for example, when you want to execute the command in a shell script or batch file.

Item name	Default value	Recommended setting
Load balancing	on Algorithm is round robin	on The recommended algorithm depends on the operating environment.
Error log collection level	3: Collect error information for the Information level and higher.	3: Collect error information for the Information level and higher.
Error log file size	9900 (KB)	9900 (KB)
Number of error log files	2	2
Trace level	0: Do not output any trace.	0: Do not output any trace.
Trace file size	1000 (KB)	1000 (KB)
Number of trace files	4	4
Path health checking	on	on The recommended checking interval depends on the operating environment.
Automatic failback	off	off
Intermittent Error Monitor	off	off
Remove LU	off	The recommended value depends on the operating environment.

Value	Description
0	Collects no error log.
1	Collects error information for the Error or higher level.
2	Collects error information for the Warning or higher level.
3	Collects error information for the Information or higher level.
4	Collects error information for the Information or higher level (including maintenance information).

Value	Description
0	Does not output any trace.
1	Only outputs error information.
2	Outputs a summary of program operation.
3	Outputs details of program operation.
4	Outputs all information.

Setting	Available operation	Result of operation
AFB	IEM
on	on	Set AFB to on.	The operations of AFB and IEM do not change.
Change the AFB setting.	AFB operates using new settings.^#1
Set AFB to off.	AFB and IEM are disabled. The error count, elapsed monitoring time, and information about paths not subject to automatic failback are cleared.
Set IEM to on.	When a path is being monitored (in the period of conditional intermittent error monitoring), the value of the error count and the elapsed monitoring time are reset to 0, and then intermittent error monitoring restarts. When a path is not being monitored (outside the period of conditional intermittent error monitoring), nothing changes.
Change the IEM settings.	When a path is being monitored (in the period of conditional intermittent error monitoring), the value of the error count and the elapsed monitoring time are reset to 0, and then intermittent error monitoring restarts according to the conditions for intermittent error after change.^#1 When a path is not being monitored (outside the period of conditional intermittent error monitoring), the IEM settings will take effect when the path is recovered from the error status by performing automatic failback.
Set IEM to off.	IEM is disabled. The error count, elapsed monitoring time, and information about paths not subject to automatic failback are cleared.
off	Set AFB to on.	The operations of AFB and IEM do not change.
Change the AFB setting.	AFB operates using new settings.
Set AFB to off.	AFB is disabled.
Set IEM to on.	IEM is enabled.^#1
off	on^#2	Set AFB to on.	AFB and IEM are enabled.^#1
Set AFB to off.	The operations of AFB and IEM do not change.
off	Set AFB to on.	AFB is enabled.
Set AFB to off.	The operations of AFB and IEM do not change.

Type	Description
Permanent license key	Permanent licenses are valid for using HDLM in an ongoing basis.
Temporary license key^#	The temporary license key is used temporarily, for example, when a user performs product evaluations. Temporary licenses are valid for only 120 days after installation. You cannot reuse a temporary license key.
Emergency license key	The emergency license key is used temporarily, for example, when issuing a permanent license key that is delayed for some reasons. Emergency licenses are valid for 30 days after they are entered. You cannot reuse an emergency license key.

Value	Description
off	The LU is not removed from HDLM-management even if the error occurs in all the paths to the LU, all the paths to the LU are disconnected, or the LU is deleted. The status of the paths is Offline(E) and Online(E). This operation is as equal as the operation in HDLM 05-01 or earlier. The off option is recommended when you want to use the same functionality as you use in HDLM 05-01 or earlier, without using the LU dynamic deletion functionality.
on	The LU is removed from HDLM-management when all the paths to the LU are disconnected. However, if an Offline(C) path is included in the disconnected paths, the LU is not deleted from HDLM-management. The deleted LU is restored when it is recovered from the physical failure and the disk is re-scanned.
on -force	The LU is removed from HDLM management when all the paths to the LU are disconnected, even when an Offline(C) path is included. The removed LU is restored when it is recovered from the physical failure and the disk is re-scanned.

(2) To display the format of the set operation

-help

Displays the format of the set operation.

Example

The following example shows how to display the format of the set operation.

[Contents][Back][Next]

[Trademarks]