jddcreatetree
- Organization of this page
Function
This command collects system configuration information from products managed by the Intelligent Integrated Management server to create the IM management node-related files, which in turn are input to the jddupdatetree command. Before you can execute this command, you must execute the jddsetaccessuser command to set a user ID and password that are required for authentication.
For details about the jddupdatetree and jddsetaccessuser commands, see jddupdatetree and jddsetaccessuser in Chapter 1. Commands.
This command requests the Intelligent Integrated Management Base to create the IM management node-related files and waits until the request is completed.
Before you can execute this command, you must complete definitions in the following files: system node definition file (imdd_systemnode.conf), category name definition file for IM management nodes (imdd_category_name.conf), and target host definition file for configuration collection (imdd_target_host.conf). Additionally, you must complete the host name definition file (imdd_host_name.conf) for mapping between aliases and real host names if you want IM management nodes to include products that can have aliases for host names.
For details about the IM management node-related files, see the section that describes the IM management node-related files in the JP1/Integrated Management 2 - Manager Overview and System Design Guide.
For details about the definition files, see System node definition file (imdd_systemnode.conf), Category name definition file for IM management nodes (imdd_category_name.conf), Target host definition file for configuration collection (imdd_target_host.conf), and Host name definition file (imdd_host_name.conf) in Chapter 2. Definition Files.
Format
jddcreatetree -o directory-name [-h logical-host-name]
Execution permission
In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)
In UNIX: Superuser permissions
Storage directory
- In Windows:
-
Manager-path\bin\imdd\
- In UNIX:
-
/opt/jp1imm/bin/imdd/
Arguments
- -o directory-name
-
Specifies the path of the directory that stores files to be created. The value can be an absolute path or a relative path from the directory where this command is executed. The value must be enclosed in double quotation marks (") if a space is included. The length of the path can be up to 200 characters.
- -h logical-host-name
-
Specifies the logical host name of JP1/IM if JP1/IM is running in a cluster system.
If this option is omitted, the command assumes the logical host name specified in the JP1_HOSTNAME environment variable. If the JP1_HOSTNAME environment variable is not specified, the command assumes the physical host name.
The length of logical-host-name must be equal to or less than 32 bytes to successfully collect the configuration information of the logical host. Otherwise, the jddcreatetree command fails with the message KAJY02015-E and the configuration management tree will not be updated.
Notes
-
You cannot execute the jddcreatetree command concurrently multiple times. Doing so results in an error.
-
While the jddupdatetree command and jddupdatesuggestion command are running, you cannot execute the jddcreatetree command . Doing so results in an error.
-
Before you can execute the jddcreatetree command, JP1/IM - Manager and the IM database must be running.
-
Do not stop JP1/IM - Manager or the IM database while the jddcreatetree command is running.
-
If you have defined the base manager or the relay manager, verify if the system hierarchy has been synchronized, and then execute the jddcreatetree command on the integrated manager. When on site manager and relay manager, there is no need to execute the jddcreatetree command.
-
Execute the jddcreatetree command during a period when no job is running on the JP1/AJS3 - Manager host. Otherwise, each processing might be delayed as both processing loads are required simultaneously.
-
Execute the jddcreatetree command when the JP1/AJS3 - Manager service is running. If the jddcreatetree command is executed when the JP1/AJS3 - Manager service is stopped or in the process of starting or stopping, the information collection fails.
-
Do not stop the JP1/AJS3 service from which information is collected when the jddcreatetree command is collecting information. Doing so might delay the stop processing of the service.
-
The jddcreatetree command cannot collect the unit definition information that includes multi-byte characters other than Japanese. If such information is collected, the configuration management tree might not be displayed correctly.
-
The information collection might fail if control characters are included in the information that the jddcreatetree command collects, such as unit names, unit definition information, execution agent names, and JP1 resource group names. Do not include control characters in the information to be collected.
Return values
0 |
Normal termination |
1 |
Normal termination (invalid property) |
2 |
Exclusive locked |
3 |
Invalid argument |
4 |
Invalid logical host name |
5 |
Authentication information used by the Intelligent Integrated Management Base is not set |
6 |
Missing information required for the jddcreatetree command to run |
7 |
No execution permission for the jddcreatetree command |
8 |
The specified directory is not accessible |
9 |
The path to the specified directory is too long |
11 |
Failed to connect to the Intelligent Integrated Management Base |
12 |
The Intelligent Integrated Management Base could not be authenticated |
13 |
A required file does not exist |
14 |
A required file could not be read |
15 |
A required file has an invalid format |
16 |
A required file has an invalid description |
17 |
Information could not be received from the plug-in |
18 |
Invalid information was received from the plug-in |
20 |
The IM management node file could not be created |
21 |
The IM management node link file could not be created |
22 |
The IM management node tree data could not be created |
23 |
The IM management node tree file could not be created |
26 |
The user used for authentication has insufficient permissions |
255 |
System error |
Example 1
Specify that created files will be stored in C:\tmp:
$ jddcreatetree -o C:\tmp KAJY02009-I The command (jddcreatetree) has started. KAJY02010-I The command (jddcreatetree) terminates normally.
Example 2
Specify that created files will be stored in C:\tmp and specify a logical host named ronri:
$ jddcreatetree -o C:\tmp -h ronri KAJY02009-I The command (jddcreatetree) has started. KAJY02010-I The command (jddcreatetree) terminates normally.