jpcconf agttree export

Organization of this page

Format
Function
Hosts that can execute the command
Execution permission
Installation directory
Arguments
Format of Agents tree definition files
Notes
Return values
Usage example

Format

Format 1

jpcconf agttree export    -owner user-name
                          [-lhost logical-host-name]
                          [-noquery]
                          -f export-file-name

Format 2

jpcconf agttree export    -template
                          [-noquery]
                          -f export-file-name

To Page Top

Function

The jpcconf agttree export command exports Agents tree definition information to the specified file as an Agents tree definition information file. This command can also generate the template file for Agents tree definition information files, rather than the Agents tree definition information file that contains the current definition information.

An exported Agents tree definition information file can be specified in the jpcconf agttree import command as an input file.

To Page Top

Hosts that can execute the command

PFM - Manager

To Page Top

Execution permission

In Windows:: User with Administrators permissions
In UNIX:: User with root user permissions

To Page Top

Installation directory

In Windows:: installation-folder\tools\
In UNIX:: /opt/jp1pc/tools/

To Page Top

Arguments

`-owner` `user-name`

Specifies the name of the user whose Agents tree definition information the command will export.

For user-name, specify a string of 1 to 16 bytes, consisting of single-byte alphanumeric characters, spaces, and the symbols listed below. Alphabetic characters are not case sensitive.

! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

Interpretation of the specified value follows the command line specifications of the OS and shell. You might need to make sure that the character encoding settings are appropriate beforehand, or add escape characters.

`-template`

Specify this option to output the template file for Agents tree definition files.

`-lhost` `logical-host-name`

Specifies the logical host name of the host on which this command is executed. For logical-host-name, specify a string of 1 to 32 bytes, consisting of single-byte alphanumeric characters. If this option is omitted, the command will be executed on the physical host.

`-noquery`

If this option is specified, the command does not output any query messages that interrupt command execution, making it unnecessary for the user to respond. Specify this option if you want the command to run in non-interactive mode.

If the Agents tree definition file specified for the -f option already exists, the file will be overwritten by the new file.

If a file with the same name as the specified file name already exists, a KAVE05399-I message is output and the file is updated.

`-f` `export-file-name`

Specifies the name of the Agents tree definition file to be exported. You can specify an absolute file path, a relative file path from the current directory, or the name of a file in the current directory.

To Page Top

Format of Agents tree definition files

See Format of Agents tree definition files in the description of the jpcconf agttree import command.

To Page Top

Notes

You can execute this command only when the View Server service is running.
The value of the LANG environment variable for the shell that is used to execute the command might differ from the character encoding of the Agents tree definition file to be output. In this case, when you edit the exported Agents tree definition file before importing it, make sure the character encoding in the definition file matches the encoding value in the XML declaration part of that file.

If you import an Agents tree definition file whose character encoding does not match its encoding value, the Agents tree folder names may contain garbled characters. In this case, correct the Agents tree definition file so that the character encoding matches the encoding value, and then import the file again.

The value of the LANG environment variable for the shell that is used to execute the command determines the encoding of the Agents tree definition file and the encoding value in the XML declaration part of that file. If the Agents tree information that you want to export includes non-ASCII characters, make sure that the value of the relevant LANG environment variable is appropriate before you execute this command.

The tables below describe, for each OS, the encoding of the file and the encoding value in the XML declaration for each value of the LANG environment variable.

If the value of the LANG environment variable is not shown in the tables below, the encoding attribute in the XML declaration will be set to UTF-8, and the file will be encoded with UTF-8. If the value of the LANG environment variable is C and the contents of the Agents tree to be exported include non-ASCII characters, the file will be encoded with UTF-8.

Table 3‒12: Correspondence between the value of the LANG environment variable, the character encoding, and the encoding value in the XML declaration (Windows)
Language	Value of the LANG environment variable	Character encoding	Value of encoding in the XML declaration
Japanese	--	UTF-8	`UTF-8`
English	--
Chinese (Simplified)	--

Legend:: --: Not applicable.

Table 3‒13: Correspondence between the value of the LANG environment variable, the character encoding, and the encoding value in the XML declaration (Linux)
Language	Value of the LANG environment variable	Character encoding	Value of encoding in the XML declaration
Japanese	`ja_JP.SJIS`^# `ja_JP.sjis`^#	Shift_JIS (SJIS)	`Shift_JIS`
Japanese	`ja_JP.UTF-8` `ja_JP.utf8`	UTF-8	`UTF-8`
English	`C`	ASCII	`UTF-8`
Chinese (Simplified)	`zh_CN.gb18030` `zh_CN.UTF-8` `zh.CN.utf8`	UTF-8	`UTF-8`

#: Available only in SUSE Linux.

To Page Top

Return values

0	The command terminated normally.
1	An argument specification is invalid.
2	The user does not have execution permission for the command.
5	An attempt was made to execute the command on the PFM - Base host, but the command can only be executed on the PFM - Manager host.
6	The specified user does not exist.
11	Processing was canceled by the user (N was returned as the response to a query).
100	The Performance Management environment is invalid.
101	A service that is prerequisite for executing this command is not running.
102	The specified logical host has not been set up.
200	A memory shortage occurred.
210	A disk space shortage occurred.
211	A file or directory cannot be accessed.
255	An unexpected error occurred.

To Page Top

Usage example

This example exports the Agents tree definition information for the user pfm-user.

# jpcconf agttree export -owner pfm-user -f agttree_def.xml

To Page Top