2.72 pdntenv (Set up HiRDB operating environment)

Organization of this section
(1) Function
(2) Executor
(3) Format
(4) Options
(5) Rules
(6) Notes
(7) Output format

(1) Function

The pdntenv command displays or sets up a HiRDB operating environment.

(2) Executor

HiRDB administrator

(3) Format

pdntenv [{-hc {on|off}|-pn service-port-name|-a|-os|-sc {auto|manual}
          |-c character-codes-type | -ro {on|off}
          |-shmfile {regular|page}|-k {none|force}
          |-sr resource-name value [resource-name value]...}
          |-wd [process-name]]

(4) Options

(a) -hc {on|off}

Specifies whether or not to use hardware compression during DAT access:

on (initial value): Use hardware compression.
off: Do not use hardware compression.

The information specified at the server machine connected to the DAT device takes effect.

This option is applicable only when the DAT drive supports hardware compression. For the same DAT, use the same setting for both write and read operations.

(b) -pn service-port-name

Specifies the service port name for remote commands. Express the service port name by prefixing pdrshsrv to the identifier (1 to 4 single-byte alphanumeric characters without spaces).

Example
pdrshsrvUNT1

Specify the port number and the service port name specified in the %windir%\system32\drivers\etc\SERVICES file.

The specified value takes effect the next time the service starts.

The initial value is pdrshsrvidentifier.

(c) -a

If multiple HiRDBs are installed (multi-HiRDB configuration), this option displays information about all such HiRDBs.

(d) -os

Displays whether the OS supports shared memory page fixing. In Windows systems that support page fixing, the page size in Windows large pages is also displayed.

(e) -sc {auto|manual}

When a HiRDB/Single Server is to be terminated by the pdstop command, specifies whether or not to also stop Windows services at the same time.

auto
Specifies that Windows services are to be stopped when HiRDB is terminated. In such a case, you must start Windows services before you start HiRDB the next time.
manual (initial value)
Specifies that Windows services are not to be stopped when HiRDB is terminated. In such a case, there is no need to start Windows services the next time you start HiRDB. This option can reduce the time required for locking the Windows service control manager.
Rules
  1. If this option is omitted, the system assumes auto if the HiRDB version is earlier than 06-00 and manual if it is 06-00 or later. If you have installed HiRDB over an existing HiRDB, this option value is inherited.
  2. The specified value takes effect the next time the service starts.
  3. You cannot specify this option for a HiRDB/Single Server.
  4. Whenever you use the pdchgconf or pdprgrenew command, manual must be specified. If the pdchgconf or pdprgrenew command is executed in an environment with auto specified, an error results and HiRDB may stop.
(f) -c character-codes-type

Specifies the type of character codes to be used for national character data in HiRDB.

sjis (initial value): Shift JIS Kanji codes
lang-c: Single-byte character codes
chinese: EUC Chinese Kanji codes
chinese-gb18030: Chinese Kanji codes (GB18030)
utf-8: Unicodes (UTF-8)
According to the ISO/IEC 10646 standard, a range of 1 to 4 bytes is assigned per character and bytes 5 and 6 are reserved for a future standard. Although HiRDB supports a range of 1 to 6 bytes per character, problems may be introduced in the future if you use the range of bytes 5 and 6 in which no characters have been assigned.

If you change the character codes type, you must re-initialize the database.

(g) -ro {on|off}

Specifies whether or not remote commands are to be used. This option is applicable to a HiRDB/Single Server.

on:
Specifies that remote commands are to be used. Remote commands are used in the following cases:
  • A system switchover facility that does not inherit IP addresses is used on the HiRDB/Single Server.
  • The simple setup tool is used to configure an environment for the HiRDB/Single Server on a separate machine.
When you specify on, you must also specify the -pn option.
off (initial value):
Specifies that remote commands are not to be used.

This option's settings take effect the next time the service starts. This option is disabled for a HiRDB/Parallel Server.

(h) -shmfile {regular|page}

Specifies the allocation target for shared memory used in HiRDB. If this option is omitted, the previous allocation target is used.

regular (initial value):
Allocates shared memory to files under the HiRDB directory.
page:
Allocates shared memory to paging files (virtual memory).

The following describes how to change the shared memory allocation target.

How to change the allocation target
To change the shared memory allocation target:
  1. Terminate HiRDB normally and then stop the HiRDB services.
  2. Specify the shared memory allocation target in the -shmfile operand of the pdntenv command and then execute the command.
  3. Extend the size of the paging file (virtual memory size) and restart Windows.#
  4. Restart HiRDB and the HiRDB services.
#
If the estimation of paging file size shows that there is sufficient capacity, there is no need to perform this procedure.
Rules
  1. If you have specified regular, you must add the size of the shared memory that is used in HiRDB# to the capacity of the drive that contains the HiRDB directory.
  2. If you have specified page, you must add the size of the shared memory that is used in HiRDB# to the maximum capacity of the paging file (virtual memory) that is used. In this case, note that the shared memory part of the paging file is fixed for use.
#
For details about the size of the shared memory that is used in HiRDB, see the formula for determining the required memory size in the manual HiRDB Version 9 Installation and Design Guide.
(i) -k {none|force}

Specifies the HiRDB termination method when the OS shuts down.

none (initial value):
Does not terminate HiRDB when the OS shuts down.
force:
Terminates HiRDB explicitly and forcibly when the OS shuts down.

If OS shutdown occurs while HiRDB services are in the process of being stopped, HiRDB is terminated forcibly by the OS (unit down) even if force is specified.

If you are running HiRDB version 09-04 or later, force is set. If you want to change it to none, execute the pdntenv command with -k none specified.

For details about how to terminate HiRDB during an OS shutdown, see the HiRDB Version 9 System Operation Guide.

(j) -sr resource-name value [resource-name value]...

Specifies the numbers and capacities of resources for each unit.

resource-name:
Specifies the name of a resource to be applied. You can specify the following values as resource names:
  • msgmni (number of message queue identifiers)
  • msgtql (number of message queue tables)
  • semmax (number of semaphore identifiers)
  • shmmax (number of shared memory segments)
If the same resource name is specified more than once or a resource name other than those listed above is specified, an error results.
value:
For each resource, value specifies the number of resources or the capacity of the resource. For details about how to determine the values to be specified, see Determining Environment Variables Related to the Number of Resources in the HiRDB Version 9 Installation and Design Guide.
(k) -wd [process-name]

Displays information about Windows dump output.

process-name:
Specifies the name (including the extension) of a HiRDB process for which dump information is to be displayed. HiRDB displays a header for the dump information and then displays information about the target HiRDB process. The following table describes the information that is displayed by this option:
No.HeaderInformation that is displayedMaximum length
1Process#1Name of the HiRDB process subject to dump output20 bytes#2
2FolderDump output destination folder259 bytes
#1
If LocalDumps is displayed as the process name, a dump for the specified process is output to the dump output destination folder that is displayed on that line.
#2
If the length of a process name exceeds 20 bytes, only the first 20 bytes of the process name are displayed.
Rules
  1. If the process name is omitted, dump output information for the executable file (.exe) registered as the dump output target is displayed. HiRDB displays information about all processes registered as dump output targets in the Windows Error Report function. If LocalDumps is displayed as the process name, a dump for the corresponding process is output to the dump output destination folder that is displayed on that line.
  2. If the specified process name is not registered as a dump output target, the KFPC00105-I message is issued. This message is also issued if process names are omitted or if no process has been registered as the dump output target.
  3. If the registry has been updated by the time this command is executed, incomplete values might be displayed because the registry is engaged in update processing.
Note
For details about dump output, see Windows dump output in the HiRDB Version 9 Installation and Design Guide.
(l) No option specified

The pdntenv command displays the current settings.

(5) Rules

  1. The pdntenv command's execution condition is determined by the options. The following table describes the execution conditions:
    OptionsExecution condition
    -hc, -pn, -sc, -ro, -srThe command can be executed regardless of the status of HiRDB. The specified value takes effect the next time the service starts.
    -aThe command can be executed regardless of the status of HiRDB. Execute the command using the most recent version of HiRDB on the server machine.
    -os and -wd options omittedThe command can be executed regardless of the status of HiRDB.
    -cThe command can be executed only while HiRDB or the HiRDB services are stopped.
    -shmfileThe command can be executed only while the HiRDB services are stopped.
    -kThe command can be executed while the status of the HiRDB services is not Stopped or Starting.
  2. Execute the pdntenv command at each server machine.

(6) Notes

  1. Return code 0 for the pdntenv command indicates normal termination, and return code 8 indicates abnormal termination.

(7) Output format

(a) No option specified

***** HiRDB setup information *****
Program Name        = HiRDB/SingleServer
Version             = 07-03
Character Code      = sjis
Dat Hard Compress   = on
Setup ID            = ----
Rsh Port Name       = pdrshsrv
Path Name           = C:\win32app\hitachi\hirdb_s
Service Complete    = manual
Rsh Online          = on
ShmFile             = regular
Shutdown mode       = none
Install Guid        =
Firewall Profile    = public
msgmni              = 50
msgtql              = 80
semmax              = 64
shmmax              = 4096

Explanation
Program Name
Name of HiRDB program
Version
HiRDB version
Character Code
HiRDB's character codes type
sjis: Shift JIS Kanji codes
lang-c: Single-byte character codes
chinese: EUC Chinese Kanji codes
chinese-gb18030: Chinese Kanji codes (GB18030)
utf-8: Unicodes (UTF-8)
Dat Hard Compress
Setting for hardware compression during DAT access
on: Compress
off: Do not compress
Setup ID
Setup identifier (---- is displayed during installation with the standard setup specified)
Rsh Port Name
Service port name for remote commands
Path Name
HiRDB installation directory
Service Complete
Time at which HiRDB services startup is completed
auto: HiRDB services startup is completed when the KFPS01001-I message is displayed.
manual: HiRDB services startup is completed when the system waits for execution of pdstart.
blank: Not applicable.
Rsh Online: Specification of remote commands
on: Uses remote commands.
off: Does not use remote commands.
blank: Not applicable.
Shmfile: Allocation target of the shared memory that is used in HiRDB
regular: Allocates to files under the HiRDB directory
page: Allocates to paging files
Blank: Not applicable
Shutdown mode: How to terminate HiRDB during OS shutdown
none: Does not terminate HiRDB when the OS shuts down.
force: Terminates HiRDB explicitly and forcibly when the OS shuts down.
Blank: Not applicable
Install Guid: GUID (globally unique ID) generated by the installer during installation
Blank: Not applicable
Firewall Profile: Profiles registered into the exceptions list in Windows Firewall with Advanced Security.
  • any: All profiles have been registered.
  • private: Private profiles have been registered.
  • public: Public profiles have been registered.
  • domain: Domain profiles have been registered.
If multiple profiles are registered as exceptions, they are delimited by the comma.
Example: private,public,domain
--------: The OS does not support registration of an exceptions list in Windows Firewall with Advanced Security or no exceptions have been registered.
msgmni: Setting for the number of message queue identifiers specified for each unit
Blank: Not specified.
msgtql: Number of message queue tables specified for each unit
Blank: Not specified.
semmax: Number of semaphore identifiers specified for each unit
Blank: Not specified.
shmmax: Number of shared memory segments specified for each unit
Blank: Not specified.
(b) -a option specified (applicable to multi-HiRDB)

***** HiRDB setup information *****
Program Name        = HiRDB/SingleServer
Version             = 06-02-/D
Character Code      = sjis
Dat Hard Compress   = on
Setup ID            = UNT1
Rsh Port Name       = pdrshsrvUNT1
Path Name           = C:\win32app\hitach\hirdb_sUNT1
Service Complete    = manual
Rsh Online          = on
ShmFile             =
Shutdown mode       =
Install Guid        =
Firewall Profile    = public
msgmni              =
msgtql              =
semmax              =
shmmax              =
***** HiRDB setup information *****
Program Name        = HiRDB/ParallelServer
Version             = 07-03
Character Code      = sjis
Dat Hard Compress   = on
Setup ID            = UNT2
Rsh Port Name       = pdrshsrvUNT2
Path Name           = C:\win32app\hitach\hirdb_pUNT2
Service Complete    = manual
Rsh Online          = on
ShmFile             = regular
Shutdown mode       = none
Install Guid        =
Firewall Profile    = public
msgmni              = 50
msgtql              = 80
semmax              = 64
shmmax              = 4096

Explanation
See the previous explanation for No option specified.
(c) When the -os option is specified

*** Operating system information ***
Fixed Shared Memory :supported
Large Page Size     :8192

Explanation
Fixed Shared Memory: Support for page-fixed shared memory
supported: Windows OSs that support page-fixed shared memory
unsupport: Windows OSs that do not support page-fixed shared memory
Large Page Size: Large page size in Windows (maximum of 20 decimal digits) (bytes)
For Windows OSs that do not support page-fixed shared memory, ---- is displayed.
(d) When the -wd option is specified

*** HiRDB Dump information ***
Process      Folder
LocalDumps   C:\Users\Administrator\AppData\Local\CrashDumps
     :                              :
pdsds.exe    C:\Users\Administrator\AppData\Local\CrashDumps\pdsds.exe
     :                              :

Explanation
Process:
Displays a process name (maximum of 20 bytes).
When a process name was specified:
Specified HiRDB process name or LocalDumps
When a process name was omitted:
HiRDB process name subject to dump output or LocalDumps
Folder:
Displays the absolute path of the dump output folder (maximum of 259 bytes).