jpcmkkey
- Organization of this page
Format
jpcmkkey -user user-name [-password password] [-mx maximum-heap-size] [-ms initial-heap-size] [-y] [-nocheck]
Function
The jpcmkkey command creates a key file for authentication. The key file is required to execute the following commands on the host on which PFM - Web Console is installed:
-
jpcasrec update
-
jpcasrec output
-
jpcaspsv update
-
jpcaspsv output
-
jpcprocdef create
-
jpcprocdef delete
-
jpcprocdef list
-
jpcprocdef output
-
jpcrdef create
-
jpcrdef delete
-
jpcrdef output
-
jpcrpt
Hosts that can execute the command
PFM - Web Console
Execution permission
- In Windows:
-
User with Administrators permissions
- In UNIX:
-
User with root user permissions
Installation directory
- In Windows:
installation-folder\tools\
- In UNIX:
/opt/jp1pcwebcon/tools/
Arguments
-user user-name
Specifies the Performance Management user name used for logon authentication for execution of a command that requires the key file for authentication.
For user-name, specify a string of 1 to 31 bytes, consisting of single-byte alphanumeric characters, single-byte spaces, and the following symbols:
! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
If the string that you want to specify contains single-byte spaces, enclose the entire string in double quotation marks ("). Note that you might need to add escape characters when specifying single-byte symbols. Exceptionally, if you want to use a backslash (\) at the end of a string, specify four backslashes (\\\\). Any leading and trailing spaces in the input character string are ignored.
-password password
Specifies the password for the Performance Management user specified in the -user option.
For password, specify a string of 0 to 32 bytes, consisting of single-byte alphanumeric characters, single-byte spaces, and the following symbols:
! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
If this option is omitted, the command assumes a password with a length of 0 bytes. If you want to specify a 0-byte string or a string that contains single-byte characters, enclose the entire string in double quotation marks ("). Note that you might need to add escape characters when specifying single-byte symbols. Exceptionally, if you want to use a backslash (\) at the end of a string, specify four backslashes (\\\\). Any leading and trailing spaces in the input character string are ignored.
-mx maximum-heap-size
Specifies the maximum heap size for java.exe (in megabytes). Normally, you do not need to specify this option.
The default is 128 MB. The maximum size that can actually be acquired depends on the system. If the specified value does not satisfy the following conditions, an invalid command line format results:
-
Integer in the range 1 to 2,048
-
Value specified in -mx >= value specified in -ms
-ms initial-heap-size
Specifies the initial heap size for java.exe (in megabytes). Normally, you do not need to specify this option.
The default is 32 MB. If the specified value does not satisfy the following conditions, an invalid command line format results:
-
Integer in the range 1 to 2,048
-
Value specified in -mx >= value specified in -ms
-y
Specifies that if the key file already exists, the command is to overwrite it without asking for confirmation. If this option is omitted and the key file already exists, the command displays a confirmation message asking if the file is to be overwritten. If the user enters y or Y as a response to the message, the command overwrites the file. If the user enters any other value, the command cancels creation of the authentication key file.
-nocheck
Specifies whether the validity of the specified user name and password is to be checked. Validity is determined based on whether the user can log into PFM - Manager (View Server service). If you specify this option, validity is not checked. If you omit this option, validity is checked. Note that the system checks the character string length and the validity of characters even when it does not perform the check for the user name and password.
Note
-
Execute this command while PFM - Manager (View Server service) is running. If you execute the command in JP1 authentication mode, make sure that authentication is possible on the PFM - Manager side.
-
Normally, you do not need to set the -mx or -ms option. If the KAVJK0401-E message, which reports insufficient memory, is output during command execution, re-execute the command with the -mx option to increase the maximum heap size. At this time, make sure that you specify 64 or a greater value for the -mx option.
Return values
0 |
The command terminated normally. |
1 |
An argument specification is invalid. |
2 |
The user does not have execution permission for the command. |
3 |
Creation of authentication key file failed. |
11 |
The specified user name or password resulted in a PFM - Manager authentication error. |
80 |
The user canceled creation of the authentication key file. |
100 |
The Performance Management environment is invalid. |
200 |
A memory shortage occurred. |
202 |
File access error occurred. |
222 |
A communication error occurred (IP address could not be acquired). |
255 |
An unexpected error occurred. |
Usage example
This example creates a key file for authentication with ADMINISTRATOR and xxxxx specified as the user name and password, respectively, to be used for login authentication during command execution:
jpcmkkey -user "ADMINISTRATOR" -password "xxxxx"