jbsparamdump
- Organization of this page
Function
The jbsparamdump command collects the JP1/Base setup information in a single operation and outputs the information under the directory specified as the output destination.
If the collection target host is in logical host operation, this command outputs the setup information of the physical host and all the logical hosts.
When you execute the jbsparamdump command, a directory named JP1Base is created in a specified directory. Under that directory, setup information is output in the groups shown below. Note that if a file with the same name as the output file already exists, the file with the same name is overwritten.
-
Setup information of a physical host (physical-host-name.prm)#1
-
Setup information of a logical host (logical-host-name.prm)#1
-
Setup information of an event server (event-server-name.prm)#1, #2
-
Contents of the files specified in the collection information file (userconf.prm)
#1: If the output file name (physical host name, logical host name, or event server name) is 129 bytes or more in length, the first 128 bytes becomes the file name.
#2: The setup information of an event server on a physical host is output to the physical-host-name.prm file. The setup information of an event server on a logical host is output to the logical-host-name.prm file. If an event server is set up on a host other than physical or logical hosts, the setup information of the event server is output to the event-server-name.prm file.
The following table lists setup information that can be collected.
|
Type of setup information |
Setup information to be collected |
Collection availability for each host type |
|||
|---|---|---|---|---|---|
|
Physical host |
Logical host |
Logical host (secondary node) |
Event server |
||
|
Host information |
Host type (physical, logical, or event server) |
Yes |
Yes |
Yes |
Yes |
|
Physical host name, logical host name, or event server name |
Yes |
Yes |
Yes |
Yes |
|
|
Product information |
Company name#1 |
Yes |
-- |
-- |
-- |
|
Registered user name#1 |
Yes |
-- |
-- |
-- |
|
|
Version ID |
Yes |
-- |
-- |
-- |
|
|
Product ID |
Yes |
-- |
-- |
-- |
|
|
Product name |
Yes |
-- |
-- |
-- |
|
|
OS information |
List of port numbers used by JP1/Base services |
Yes |
-- |
-- |
-- |
|
Yes |
-- |
-- |
-- |
|
|
JP1/Base setup information |
Startup script file (physical host)#2 |
Yes |
-- |
-- |
-- |
|
Stop script file (physical host)#2 |
Yes |
-- |
-- |
-- |
|
|
Startup script file (logical host)#2 |
Yes |
-- |
-- |
-- |
|
|
Stop script file (logical host)#2 |
Yes |
-- |
-- |
-- |
|
|
Start sequence definition file#1 |
Yes |
-- |
-- |
-- |
|
|
Service startup delay time / timer monitoring period definition file#1 |
Yes |
-- |
-- |
-- |
|
|
Event server index file |
Yes |
-- |
-- |
-- |
|
|
Event server settings file |
Yes |
Yes |
No |
Yes |
|
|
Forwarding settings file |
Yes |
Yes |
No |
Yes |
|
|
Forwarding settings file for event forwarding suppression#3 |
Yes |
Yes |
No |
-- |
|
|
API settings file |
Yes |
-- |
-- |
-- |
|
|
Additional extended attribute settings file for transfer reception |
Yes |
Yes |
No |
Yes |
|
|
Additional extended attribute settings file for event registration |
Yes |
Yes |
No |
Yes |
|
|
Action definition file for log file trapping#3 |
Yes |
-- |
-- |
-- |
|
|
Log-file trap startup definition file |
Yes |
-- |
-- |
-- |
|
|
Log information definition file |
Yes |
-- |
-- |
-- |
|
|
Action definition file for event log trapping#1 |
Yes |
-- |
-- |
-- |
|
|
Action definition file for converting SNMP traps#4 |
Yes |
-- |
-- |
-- |
|
|
Filter file for converting SNMP traps#4 |
Yes |
-- |
-- |
-- |
|
|
Distribution definition file (forwarding settings file)#3 |
Yes |
Yes |
No |
-- |
|
|
Distribution definition file (action definition file for log file trapping)#3 |
Yes |
-- |
-- |
-- |
|
|
Distribution definition file (log-file trap startup definition file)#3 |
Yes |
-- |
-- |
-- |
|
|
Distribution definition file (action definition file for event log trapping)#1, #3 |
Yes |
-- |
-- |
-- |
|
|
Authentication server name |
Yes |
Yes |
No |
-- |
|
|
Authentication information (JP1 user name)#5 |
Yes |
Yes |
No |
-- |
|
|
Authentication information (JP1 user permission)#5 |
Yes |
Yes |
No |
-- |
|
|
Password save format |
Yes |
Yes |
Yes |
-- |
|
|
Directory server likage definition#1 |
Yes |
Yes |
Yes |
-- |
|
|
User mapping information |
Yes |
Yes |
No |
-- |
|
|
Health check setup information |
Yes |
Yes |
Yes |
-- |
|
|
Health check definition file |
Yes |
Yes |
No |
-- |
|
|
JP1/Base environment settings file (startup language type)#2 |
Yes |
Yes |
No |
-- |
|
|
JP1/Base parameter definition file |
Yes |
Yes |
Yes |
-- |
|
|
Extended startup process definition file |
Yes |
Yes |
No |
-- |
|
|
jp1hosts definition information |
Yes |
Yes |
No |
-- |
|
|
jp1hosts2 definition information |
Yes |
Yes |
No |
-- |
|
|
Configuration management functionality setup information |
Yes |
Yes |
Yes |
-- |
|
|
Configuration definition file |
Yes |
Yes |
No |
-- |
|
|
Configuration definition information |
Yes |
Yes |
No |
-- |
|
|
Host access control definition file |
Yes |
Yes |
No |
-- |
|
|
SSL communication definition information |
Yes |
Yes |
Yes |
-- |
|
|
Local action setup information |
Yes |
Yes |
Yes |
-- |
|
|
Local action execution definition file |
Yes |
Yes |
No |
-- |
|
|
Extended regular expressions |
Yes |
Yes |
Yes |
-- |
|
|
Operation log definition |
Yes |
Yes |
Yes |
-- |
|
|
Controlling connections (configuration management and command execution) |
Yes |
Yes |
Yes |
-- |
|
|
Controlling connections (operation requests from linkage products) |
Yes |
Yes |
Yes |
-- |
|
|
Command execution environment |
Yes |
Yes |
No |
-- |
|
|
JP1/Base administrator settings#2#6 |
Yes |
-- |
-- |
-- |
|
|
Communication protocol |
Yes |
Yes |
Yes |
-- |
|
|
Operation language type |
Yes |
Yes |
Yes |
-- |
|
|
Character code compatibility mode#2 |
Yes |
Yes |
Yes |
-- |
|
|
User-specified information |
Files specified in the collection information file (jbsparamdump.conf) |
-- |
-- |
-- |
-- |
- Legend:
-
Yes: Collected.
No: Not collected.
--: Not collected (setup information does not exist).
- #1
-
Acquired only in Windows.
- #2
-
Acquired only in UNIX.
- #3
-
Acquired only when the default destination and file name are used.
- #4
-
Acquired only in HP-UX and Solaris.
- #5
-
Acquired only when the command was executed with the -s option specified.
- #6
-
Acquired only when the command was executed by a user with root permissions.
Note that the following setup information will not be collected:
-
Password definition file
-
JP1 user password information
-
Local action environment variable file
Format
jbsparamdump [-s] -d output-destination-directory
Required execution permission
In Windows: Administrators privileges (If User Account Control (UAC) for Windows is enabled, you must execute the command from the administrator console.)
In UNIX: Superuser or JP1/Base administrator privileges
Command directory
- In Windows
-
installation-folder\bin\
- In UNIX
-
/opt/jp1base/bin/
Arguments
- -s
-
Specify this option to collect JP1 user names that are registered in the primary authentication server and operating permission information for JP1 users. An environment in which you can communicate with the authentication servers is required to specify this option.
- -d output-destination-directory
-
Specify the directory name to which the collected setup information is output by full path or by relative path from the current directory in which you are executing the command. If the path contains a space, enclose the space in double quotation marks (").
Notes
-
This command can be executed no matter whether JP1/Base is running or stopped.
-
The character code used in an environment in which you are executing this command must match the character code used in an environment in which JP1/Base is running. If the character codes do not match, multiple character codes might exist in a file.
-
If you use the cluster system, execute this command on the primary node. If you execute the command on the secondary node, some setup information of a logical host cannot be collected.
Return values
|
0 |
Normal end |
|
1 |
Setup information whose collection has failed exists. |
|
4 |
A file whose output has failed exists. |
|
10 |
Invalid arguments |
|
11 |
Insufficient execution permission |
|
12 |
Access error to the output destination directory |
|
13 |
Failed to read the collection information file, or format error of the collection information file. |
|
20 |
Insufficient memory |
|
255 |
Other error |
Output format
The following shows the output format of the setup information:
*****information-identifier<information-type>path-information# Setup information ***End information-identifier(acquisition-result)
#: Information-type and path-information are output in setup information whose type is either JP1/Base setup information or User-specified information in Table 15-1.
The following table describes the meaning for each item.
|
Item |
Description |
|---|---|
|
information-identifier |
A character string used for identifying the setup information |
|
information-type |
The type of information is shown in the following format:
|
|
path-information |
The path of the setup information is shown in the following format:
|
|
acquisition-result |
Acquisition result of the setup information is shown in the following format:
|
The following shows an output example of setup information of a physical host (physical-host-name.prm).
![[Figure]](GRAPHICS/ZU131300.GIF)
The table below shows the correspondence between the information identifiers and setup information that are output. For items that output a specific parameter, such as common definition information, the Parameter column below gives the parameter name. For items that output the contents of a definition file or command execution result, the Parameter column shows --, indicating that there is no applicable entry.
|
Information identifier |
Parameter |
Description |
|---|---|---|
|
Host Information |
hosttype |
|
|
hostname |
Physical host name, logical host name, or event server name |
|
|
Product Information |
RegisteredOrganization |
Company name |
|
RegisteredOwner |
Registered user name |
|
|
ExCurrentVersion |
Version ID |
|
|
ProductID |
Product ID |
|
|
ProgramName |
Product name |
|
|
Service Port Number List |
jp1imevt jp1imevtapi jp1imrt jp1imcmda jp1imcmdc jp1bsuser jp1bsplugin jp1bscom JP1AutoJob jesrd |
List of port numbers used by JP1/Base services |
|
Base Services Startup Information |
-- |
|
|
Starting and stopping:jbs_start |
-- |
Startup script file (physical host) |
|
Starting and stopping:jbs_stop |
-- |
Stop script file (physical host) |
|
Starting and stopping:jbs_start.cluster |
-- |
Startup script file (logical host) |
|
Starting and stopping:jbs_stop.cluster |
-- |
Stop script file (logical host) |
|
Startup control:JP1SVPRM.DAT |
-- |
Start sequence definition file |
|
Startup control:Jp1svprm_wait.dat |
-- |
Service startup delay time / timer monitoring period definition file |
|
Event service:index |
-- |
Event server index file |
|
Event service:conf |
-- |
Event server settings file |
|
Event service:forward |
-- |
Forwarding settings file |
|
Event service:forward_suppress |
-- |
Forwarding settings file for event forwarding suppression |
|
Event service:api |
-- |
API settings file |
|
Event service:recv_add_extattr |
-- |
Additional extended attribute settings file for transfer reception |
|
Event service:send_add_extattr |
-- |
Additional extended attribute settings file for event registration |
|
Event conversion:jevlog.conf |
-- |
Action definition file for log file trapping |
|
Event conversion:jevlog_start.conf |
-- |
Log-file trap startup definition file |
|
Event conversion:jevlogd.conf |
-- |
Log information definition file |
|
Event conversion:ntevent.conf |
-- |
Action definition file for event log trapping |
|
Event conversion:imevtgw.conf |
-- |
Action definition file for converting the SNMP traps |
|
Event conversion:snmpfilter.conf |
-- |
Filter file for converting SNMP traps |
|
Distribution definition file:jev_forward.conf |
-- |
Distribution definition file (forwarding settings file) |
|
Distribution definition file:jev_logtrap.conf |
-- |
Distribution definition file (action definition file for log file trapping) |
|
Distribution definition file:jev_logstart.conf |
-- |
Distribution definition file (log-file trap startup definition file) |
|
Distribution definition file:jev_ntevent.conf |
-- |
Distribution definition file (action definition file for event log trapping) |
|
User management:jbslistsrv |
-- |
Authentication server name |
|
User management:jbslistuser |
-- |
Authentication information (JP1 user name) |
|
User management:jbslistacl |
-- |
Authentication information (JP1 user permission) |
|
User management:HASH_LEVEL |
HASH_LEVEL |
Password save format |
|
User management:ds_setup |
ENABLE SERVER PORT SEARCH_USER_DN BASE_DN ATTR_NAME SSL |
Directory server likage definition |
|
User management:jbsgetumap |
-- |
User mapping information |
|
Health check:setup |
ENABLE FAILOVER |
Health check setup information |
|
Health check:jbshc.conf |
-- |
Health check definition file |
|
Process management:jp1bs_env.conf |
-- |
JP1/Base environment settings file (startup language type) |
|
Process management:jp1bs_param_V7.conf |
SEND_PROCESS_TERMINATED_ABNORMALLY_EVENT SEND_PROCESS_RESTART_EVENT SEND_AUTHSRV_EVENT |
JP1/Base parameter definition file |
|
Process management:jp1bs_service_0700.conf |
-- |
Extended startup process definition file |
|
jp1hosts:jbshostsexport |
-- |
jp1hosts definition information |
|
jp1hosts:jbshosts2export |
-- |
jp1hosts2 definition information |
|
SSL communication definition:setup |
ENABLE CERTIFICATEFILE CACERTIFICATEFILE PRIVATEKEYFILE SSLPROTOCOL SSLCIPHERS BASESSL |
SSL communication definition information |
|
Configuration definition:setup |
JBSRT_DISTRIB_VERSION JBSROUTE_COM_TIMEOUT |
Configuration management functionality setup information |
|
Configuration definition:jbs_route.conf |
-- |
Configuration definition file |
|
Configuration definition:jbsrt_get |
-- |
Configuration definition information |
|
Configuration definition:jbsdfts_srv.conf |
-- |
Host access control definition file |
|
Local action:setup |
LOGSIZE LOGFILENUM PAUSE CODECONV |
Local action setup information |
|
Local action:jbslcact.conf |
-- |
Local action execution definition file |
|
Extending regular expressions |
REGEXP |
Extended regular expressions |
|
Operation log:setup |
ENABLE LOGFILEDIR LOGSIZE LOGFILENUM LOGCHANGEOPT |
Operation log definition |
|
unintended hosts:ROUTE |
UPPER_ONLY ALT_CLIENT_HOSTS |
Controlling connections (configuration management and command execution) |
|
unintended hosts:RECEIVE |
CLIENT_HOSTS |
Controlling connections (operation requests from linkage products) |
|
Command execution:jcocmddef |
-- |
Command execution environment |
|
JP1Base administrator:jbssetadmingrp |
-- |
JP1/Base administrator settings |
|
Base common definition:setup |
JP1_COM_VERSION JP1_BIND_ADDR JP1_CLIENT_BIND_ADDR JP1_ANY_BIND |
Communication protocol |
|
LANG |
Operation language type |
|
|
LANG_MODE |
Character code compatibility mode |
- Legend:
-
--: Not applicable.
For details on the output format of files specified in the collection information file (jbsparamdump.conf), see Collection information file in 16. Definition Files.