8.5.2 hcmdscheckauth (verifying the connection with the external authentication server)

Description

This command verifies the settings in the configuration file for external authentication server linkage and the connection with the external authentication server (JP1/Base) when JP1/AO links with the authentication function in JP1/Base.

This command checks whether:

The auth.server.type key in the configuration file for external authentication server linkage (exauth.properties) has a valid value specified.
If JP1/AO links with the authentication function in JP1/Base, set the auth.server.type key to jp1base. The key is case sensitive. If the default value for the auth.server.type key (that is, internal) is specified, an error message appears indicating the setting for using the external authentication server is not enabled.
The same host has JP1/Base and Common Component.
JP1/AO supports the current version of JP1/Base.
Users of JP1/Base can be properly authenticated.

Syntax

hcmdscheckauth

     /user JP1-user-name

     /pass password

     [/summary]

Arguments

/user JP1-user-name: This option specifies the user name of a JP1 user who has already been registered in the external authentication server (JP1/Base).
/pass password: This option specifies the password for the user name of a JP1 user who has already been registered in the external authentication server (JP1/Base).
/summary: This option simplifies the confirmation message that appears when the command is executed. If this option is specified, the messages to be displayed are limited to messages indicating whether each processing phase is successful or failed, error messages, and messages indicating the results. However, if an error message similar to the message indicating the results is to appear, the former error message is omitted and only the latter resulting message is displayed.

Located in

Common-Component-installation-folder\bin

Execute permission

Execute the command as a user with Administrator permissions.

Return code

Return code	Description
0	The command succeeded.
1-99	This code indicates the total number of syntax errors.
100	This is the return code when the number of syntax errors exceeds 100 lines.
101-199	A connection or authentication error occurred. Unit's place: Number of connection errors Ten's place: Number of authentication errors The maximum number of each place is nine. If more than nine errors occur, each place displays nine.
248	JP1/Base is not installed on the same host as the one on which this command is executed.
249	The unsupported version of JP1/Base is used.
250	The command is executed on the secondary server.
252	The common item setting in the definition file is incorrect.
253	External authentication linkage is not set.
254	The argument is invalid.
255	The command terminated abnormally.

Example

The following command shows an example of how to verify the connection with the external authentication server (JP1/Base):

hcmdscheckauth /user test01 /pass TTdate00 /summary