1.5.5 hcmds64ldapuser (registering and deleting users for LDAP search)

Description

This command registers the user information required for Active Directory registration information search when JP1/AO links with Active Directory. This command can also be used to delete registered user information.

After you use this command to register the user information, execute the hcmds64checkauth command to verify that the information can be properly authenticated.

Syntax

hcmds64ldapuser
     {/set /dn user-identifier /pass password | /delete}
     /name {server-identifier | domain-name}
     | /list

Arguments

/set

This option causes the command to register the user information.

/dn user-identifier

This option specifies the user identifier of the user to be registered. Follow RFC 4514 for the possible characters.

The characters &, |, ^, (, ), <, and > must be enclosed by double quotation marks (") or escaped with a caret (^).

If you want to specify a value that ends with \, escape it with \.

/pass password

This option specifies the password for the user that is specified with the dn option.

/delete

This option causes the command to delete the registered user information. The information of the user which includes the server identifier or domain name specified by the name option is deleted.

/name {server-identifier | domain-name}

When registering the user information, specify the server identifier or domain name to which the user is registered.

When deleting the user information, specify the server identifier or domain name of the server in which the user to be deleted is registered.

However, you cannot specify the domain name if group linkage with Active Directory is disabled and a user for LDAP search is registered. In that case, specify the server identifier.

/list

This option causes the command to display the list of server identifiers and domain names contained in the registered user information.

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. If a user without Administrator or root permissions executes the command, a message appears asking the user to elevate the permission level.

Return code

The following table lists the return codes from the command.

Return code	Description
0	The command succeeded.
1	The argument is invalid.
2	The argument includes a character that cannot be specified.
3	The registered information cannot be found.
255	The command execution has been interrupted due to an error other than the above.

Example

Registering the user information in Windows:

To register the user information with the user name smith, belonging in the group Users, in the server with the domain name example.com, with the password qweasd00:

hcmds64ldapuser /set /dn "CN=suzuki,CN=Users,DC=Example,DC=com" /pass qweasd00 /name example.com
Deleting the user information in Windows:

To delete the user information with the server name chicago:

hcmds64ldapuser /delete /name tokyo
To display the list of registered server identifiers and domain names:

hcdms64ldapuser /list

Output example

The following shows an example of when the list of registered server identifiers and domain names are output:

[ServerName]
chicago
washington
newyork