1.5.2 hcmds64checkauth (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 an external authentication server when JP1/AO links with the external authentication server.

As an external authentication server, JP1/AO can link with JP1/Base or Active Directory.

This command checks whether:

The values of the keys in the configuration file for external authentication server linkage (exauth.properties) that are commonly used when JP1/AO links with an external authentication server.
The auth.server.type key in the configuration file for external authentication server linkage (exauth.properties) has a valid value specified.

When JP1/AO links with the authentication function in JP1/Base, set the auth.server.type key to jp1base. When JP1/AO links with Active Directory, set the key to ldap. The key is case sensitive. If the default value for theauth.server.type key (that is, internal) is specified, an error message appears indicating the setting for using the external authentication server is not enabled.
If JP1/AO links with the authentication function in JP1/Base, this command checks whether:
- 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.
If JP1/AO links with Active Directory, this command checks whether:
- The values of the keys, used for Active Directory linkage, in the configuration file for external authentication server linkage (exauth.properties).
- JP1/AO can connect to Active Directory.
- A group search can be performed if JP1/AO can connect to Active Directory.

Syntax

hcmds64checkauth
     /user user-name
     /pass password
     [/summary]

Arguments

/user user-name: This option specifies the user name which has already been registered in the external authentication server. Note that, if JP1/AO links with the authentication function in JP1/Base, you must specify a user name that does not match the user name that has been registered in the JP1/AO.
/pass password: This option specifies the password for the user name which has already been registered in the external authentication server.
/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

In Windows:: Common-Component-installation-folder\bin
In Linux:: /opt/HiCommand/Base64/bin

Execute permission

Execute the command as a user with Administrator or root 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.
247	The user ID specified in the `user` option cannot be authenticated because the user ID matches the user ID which has already been registered in JP1/AO. Specify a user ID that does not match a JP1/AO user ID.
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 example shows how to use the command to verify, in Windows, the connection with the external authentication server:

hcmds64checkauth /user test01 /pass TTdate00 /summary