To set up the HDLM operating environment

Dynamic Link Manager (for Linux®) User Guide

Version
9.0.x
Audience
anonymous
Part Number
MK-92DLM113-64
ft:lastEdition
2025-11-06

The table below 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. Default and recommended values

Item name

Default value

Recommended value

Load balancing

on

The Extended Least I/Os algorithm is used.

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 (Interval is 30 minutes.)

on

The recommended checking interval depends on the operating environment.

Automatic failback

on (Interval is 1 minutes.)

The recommended checking interval depends on the operating environment.

Intermittent error monitoring

off

off

Collecting audit log data

off

The recommended value depends on the operating environment.

Set on, if you want to collect audit log data.

Audit log facility

user

local0 to local7#

Number of times the same path can be used for load balancing

32

The recommended value depends on the operating environment.

Number of times the same path can be used for extended load balancing (sequential I/O)

100

The recommended value depends on the operating environment.

Number of times the same path can be used for extended load balancing (random I/O)

1

The recommended value depends on the operating environment.

Displaying the physical storage system information

off

The recommended value depends on the operating environment. Set to on if you want to display the physical storage system information.

-lb {on [-lbtype {rr|exrr|lio|exlio|lbk|exlbk}]|off}

Enables or disables load balancing.

on: Enabled

off: Disabled

-lbtype {rr|exrr|lio|exlio|lbk|exlbk}

Specify the algorithm to be used for load balancing.

rr: The Round Robin algorithm

exrr: The Extended Round Robin algorithm

lio: The Least I/Os algorithm

exlio: The Extended Least I/Os algorithm

lbk: The Least Blocks algorithm

exlbk: The Extended Least Blocks algorithm

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

-ellv error-log-collection-level

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

The HDLM manager log (dlmmgr[1-16].log) contains log files in which an error log collection level can be set.

Table 2 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. Values of the error log collection levels

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 (including maintenance information) or higher level.

The higher the error log collection level value, the more log information will be output. As the amount of log information that is output increases, the amount of time before existing information will be overwritten becomes shorter.

Example
# /opt/DynamicLinkManager/bin/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 2,000,000 (in KB) for the size of the error log files (dlmmgrn.log (n indicates a file number from 1 to 16)). The specified files size is applied to HDLM manager logs.

By specifying both the error log file size and the number of error log files, you can collect up to 32,000,000 KB (approximately 30 GB) of error logs in total.

When the size of all the log files in a log file group reaches their maximum value, the new log data will overwrite the existing log data, starting with the oldest log data.

-elfn number-of-error-log-files

Specify the number of error log files (dlmmgrn.log (n indicates a file number from 1 to 16)). Specify a value from 2 to 16.

By specifying both the error log file size and the number of error log files, you can collect up to 32,000,000 KB (approximately 30 GB) of error logs in total.

-systflv trace-level

Specify the trace output level.

Log files for which the trace level can be set are hdlmtrn.log (where n is a value from 1 to 64).

Table 3 shows the values of the trace level. When an error occurs, we recommend that you set the value of the trace level to 1 or higher and re-collect log information.

Table. 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 higher the error log collection level value, the more log information will be output. As the amount of log information that is output increases, the amount of time before existing information will be overwritten becomes shorter.

-systfs trace-file-size

Specify a value from 100 to 16,000 for the size of the trace log file (in KB).

By specifying both the trace file size and the number of trace files, you can collect up to 1,024,000 KB of trace files in total.

If you specify a value smaller than the set value, the KAPL01097-W message is displayed to confirm execution, and the trace file is temporarily deleted.

Trace files for which the trace file size can be set are hdlmtrn.log (where n is a value from 1 to 64). The length of a trace file is fixed. Therefore, even if the amount of written trace information is less than the set file size, the file 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 a value from 2 to 64 for the number of trace log files.

By specifying both the trace file size and the number of trace files, you can collect up to 1,024,000 KB of trace data in total.

If you specify a value smaller than the set value, the KAPL01097-W message is displayed to confirm execution, and the trace file is temporarily deleted.

Trace files for which the number of files can be set are hdlmtrn.log (where n is a value from 1 to 64).

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

Enables or disables path health checking.

on: Enabled

off: Disabled

For a standby host, we recommend that you activate path health checking so that you can detect errors in paths where I/Os operations 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 previously specified interval

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. 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 over.

The path health check interval setting remains stored in the system even if you disable the function by changing the path health checking to off. Therefore, when you re-enable path health checking and do not change the interval, the path health interval stored in the system is used.

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

Enables or disables automatic failback.

on: Enabled

off: Disabled

Enabling automatic failbacks might automatically place paths online that were intentionally placed offline (for example, paths placed offline for maintenance work).

When intermittent errors occur in paths or storage systems, path status alternates between the online and offline status frequently, so I/O performance might deteriorate.

Automatic failbacks are performed on the following types of paths:

  • Paths where an error occurred and for which the KAPL08022-E message was displayed.

  • Path where an error occurred during the startup of the HDLM manager.

To prevent intermittent errors from deteriorating I/O performance, we recommend that you also enable intermittent error monitoring when the automatic failback function is enabled. Intermittent error monitoring is specifiable only when automatic failbacks are enabled.

See Table 4 for the relationship between automatic failbacks and intermittent error monitoring.

When you specify on, specify the checking interval by specifying the parameter immediately following on. If you do not specify a checking interval, path statuses will be checked in the following way:

  • When the checking interval has not been specified before:

    Every minute (default setting)

  • When the checking interval has been specified before:

    The previously used interval

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. Specify a value from 1 to 1440 minutes. The default is 1. Specify an interval appropriate for your operating 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 will be output and an error will occur. If this happens, change any of the following settings: the checking interval for automatic failbacks, 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 changed the error monitor interval during monitoring an intermittent error, 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 failbacks to off. Therefore, if you re-enable automatic failbacks and do not change the interval, path status checks will be executed at the interval already stored in the system.

-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 automatic failback is set to on.

The default is off. 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, be sure to also 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. A path that is assumed to have an intermittent error is excluded from automatic failbacks. Intermittent error monitoring is performed on each path. Intermittent error monitoring starts when a path is recovered from an error by performing an 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 from the last time are used.

When a value of 2 or more is specified for the 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 will be output and an error will occur. If this happens, 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 that should be specified: the error monitoring interval and the number of times that the error is to occur:

-intvl error-monitoring-interval

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

During intermittent error monitoring, if changes are made to the intermittent error monitoring interval setting or the setting for the number of times that an error is to occur, the error count and the elapsed time measured since monitoring has started are reset to 0.

When intermittent error monitoring is not being performed, 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 will take effect after the next time an automatic failback is successful. Because the errors and elapsed time are not counted or measured while intermittent errors are not being monitored, the values will 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 a monitoring interval is not specified, error monitoring will be performed by using the stored monitoring interval.

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

Specify the number of times the error is to occur. Valid values are 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 has started are reset to 0. The changed setting will take effect immediately and intermittent error monitoring will restart.

When intermittent error monitoring is not being performed, 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 new value will take effect after the next automatic failback successfully completes. When intermittent error monitoring is not being performed, the number of errors that determine that an intermittent error has occurred is not counted and this value is not changed.

The number of times that the error is to occur is stored in the system, even when -iem off is specified and intermittent error monitoring is disabled. Therefore, when you re-enable intermittent error monitoring without specifying the number of times, the error monitoring will be executed using the value stored in the system.

When the set -iem on operation is executed during error monitoring, even though you do not change the conditions for intermittent error monitoring,the number of errors and the time that has passed since the error monitoring has started are reset to 0. Intermittent error monitoring will then resume with the changed settings.

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

The executable operations for the automatic failback function and intermittent error monitoring depend on the settings for those functions. The following table shows the relationship between the settings and available operations for automatic failback and intermittent error monitoring.

Table. Relationship between the setting for the automatic failback function 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 is performed under the 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 (during a 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 will restart.

  • When a path is not being monitored, nothing changes.

Change the IEM settings.

  • While a path is being monitored, the value of the error count and the elapsed monitoring time are reset to 0, and then intermittent error monitoring will restart.#1

  • When a path is not being monitored, the IEM settings will take effect again when the path is recovered from the error status by performing an automatic failback.

Set IEM to off.

  • IEM is disabled.

  • The error count, elapsed monitoring time, and information about paths not subject to automatic failbacks 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 intermittent error monitoring does not change.

#2

Because automatic failback is off, intermittent error monitoring is disabled.

Example

The following example shows how to monitor for intermittent errors.

# /opt/DynamicLinkManager/bin/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 for when a license is updated. The HDLM license is provided via a license key or license key file. A license key file is a file that stores the HDLM license.

If a license key file is provided:

Store the license key file named hdlm_license directly under /var/tmp, 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 defined 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 a license key is provided:

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. For a temporary license key or emergency license key, the expiration period is also displayed (KAPL01071-I, KAPL01072-I).

The following table lists and describes the license key types.

Table. License key types

Type

Description

Permanent license key

Permanent license keys are valid for using HDLM permanently.

Temporary license key#

Temporary license keys are used temporarily, for example, when a user needs to perform product evaluations. Temporary license keys are valid for 120 days after the installation. You cannot reuse a temporary license key.

Emergency license key

Emergency license keys are used temporarily, for example, when waiting for a permanent license key to be issued. Emergency license keys 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 command's set operation.

Example 1

The following example shows how to update the license key when the license key file exists:

# /opt/DynamicLinkManager/bin/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.
#
Example 2

The following example shows how to update the license key when the license key file does not exist:

# /opt/DynamicLinkManager/bin/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 =/var/tmp/hdlm_license
KAPL01068-I Enter a license key:*************
KAPL01071-I A permanent license was installed.
#
-audlog {on [-audlv audit-log-data-collection-level] [-category [[ss] [a] [ca]|all]]|off}

Specifies whether to collect audit log data.

on: Audit Log data is collected.

off: Audit Log data is not collected.

-audlv audit-log-data-collection-level

Specifies the severity level of audit log data to be collected. The table below lists and describes the values used for this setting. The default is 6.

Table. Values indicating audit log data collection levels

Value (severity)

Explanation

0

No audit log data is collected.

1

2

Critical-level audit log data is collected.

3

Critical-level and Error-level audit log data is collected.

4

Critical-level, Error-level, and Warning-level audit log data is collected.

5

6

Critical-level, Error-level, Warning-level, and Informational-level audit log data is collected.

7

-category [[ss] [a] [ca]|all]

Specifies the categories of audit log data to be collected. The table below lists and describes the values used for this setting. The default is all. If you specify the -category parameter without specifying a value, all is assumed.

Table. Values indicating audit log data categories

Value

Explanation

ss

Audit log events of the StartStop category are collected.

a

Audit log events of the Authentication category are collected.

ca

Audit log events of the ConfigurationAccess category are collected.

all

Audit log events of the StartStop, Authentication, and ConfigurationAccess categories are collected.

-audfac facility-value

Specifies the audit log facility.

The table below lists the values used for this setting. The default is user.

Table. Values of the audit log facility

Value

Corresponding facility value in the syslog settings file

user or 1

user

local0 or 16

local0

local1 or 17

local1

local2 or 18

local2

local3 or 19

local3

local4 or 20

local4

local5 or 21

local5

local6 or 22

local6

local7 or 23

local7

-lbpathusetimes number-of-path-use-times

Specifies the number of times the same path can be used for I/O operations when the Round Robin (rr), Least I/Os (lio), or Least Blocks (lbk) algorithm is used for load balancing.

You can specify a decimal (base 10) value from 0 to 999999. The default is 32.

If you specify 0, operation is the same as when load balancing is disabled.

-expathusetimes number-of-path-use-times

Specifies the number of times the same path can be used for sequential I/O operations when the extended Round Robin (exrr), Least I/Os (exlio), or Least Blocks (exlbk) algorithm is used for load balancing.

You can specify a decimal (base 10) value from 0 to 999999. The default is 100.

If you specify 0, the same path is used as long as the sequential I/O operations continue.

-exrndpathusetimes number-of-path-use-times

Specifies the number of times the same path can be used for random I/O operations when the extended Round Robin (exrr), Least I/Os (exlio), or Least Blocks (exlbk) algorithm is used for load balancing.

You can specify a decimal (base 10) value from 0 to 999999. The default is 1.

If you specify 0, the same path is used as long as the random I/O operations continue.

-pstv {on|off}

Enables or disables the display of the physical storage system information. The default value is "off".

on: Enabled

off: Disabled

If the display of the physical storage system information is enabled, information about the physical storage system is displayed. If the display of the physical storage system information is disabled, information about the storage system recognized by the operating system is displayed. For a virtualized storage system, virtual information is displayed, and for a non-virtualized storage system, physical information is displayed.

The display results of view operations depend on whether the display of the physical storage system information is enabled or disabled. The following table shows the display items for which the display results differ.

Table. Display items for which the display results of the view operation differ depending on the -pstv parameter specification

Operation

Display item

view -path

DskName

iLU

ChaPort (CP)

view -lu

Product

SerialNumber (S/N)

iLU

ChaPort

view -drv

LDEV

-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.