cpasetumap
- Organization of this page
Function
Registers the following information in the user mapping file (usrprof.xml): CPA virtual users used with the Windows log-on function or execution user setting function and information regarding the users to be mapped to the virtual users (Windows user names and passwords).
Format
cpasetumap [{-a virtual-user-name -u Windows-user-name -p password|-d virtual-user-name}]
Permission for execution
None
Arguments
- -a virtual-user-name
-
Specifies the value to be specified as the virtual user name for the Windows log-on action item or the item that uses the execution user setting function.
The virtual user name specified with this option is linked with the user information specified with the -u and -p options and then registered in the user mapping file.
You can specify 1- to 14-byte half-width alphanumeric characters as a virtual user name.
If you specify a virtual user name that has already been registered in the user mapping file, the registered values are updated with the values specified for the -u and -p options. If the user mapping file already contains the maximum number of virtual users that can be registered (10 virtual users) in it, you cannot add a new virtual user to it.
- -u Windows-user-name
-
Specifies the Windows Windows user name to be linked to the virtual user name specified by the -a option.
When applicable, a user name containing a domain name must be specified in NetBIOS-domain-name\user-name format. If you omit the NetBIOS domain name, it is assumed that the local host name.
You can specify a 1- to 276-byte Windows user name consisting of half-width alphanumeric characters and the following half-width symbols:
_ - \ .
If the specified Windows user name contains any of the above half-width symbols, enclose the Windows user name in double quotation marks (\). Any double quotation marks within the password must be denoted as \\ format.
You can only use a backslash (\) to separate domain-name from user-name. Neither domain-name nor user-name can contain a backslash.
- -p password
-
Sets a password for the Windows user name specified by the -u option.
You can specify a 1- to 20-byte password consisting of half-width alphanumeric characters and the following half-width symbols:
` ~ ! @ # $ % ^ & * ( ) _ - + = { } [ ] \ | : ; " ' < > , . ? /
If the specified password contains any of the above half-width symbols, enclose the password in double quotation marks ("). Any double quotation marks within the password must be denoted as \" format.
- -d virtual-user-name
-
From the user mapping file, removes the specified virtual user name as well as the Windows user name and password linked to it.
- No option
-
If you do not specify any options, virtual user names registered in the user mapping file as well as the Windows user names linked to them are displayed in the following list format:
virtual-user-name=Windows-user-name
When there is no item to be displayed, a message stating that no virtual user information has been registered is sent to the standard output. In this case, the return value of the command will indicate that the command was completed successfully.
Return values
0 |
Succeeded |
16 |
The specified virtual user is not registered. |
40 |
Insufficient resources |
58 |
Invalid argument |
85 |
Exceeded the maximum allowed number of registered items. |
94 |
The system settings file (config.xml) has an error. |
104 |
The user mapping file (usrprof.xml) is invalid. |
109 |
The system settings file (config.xml) does not exist. |
112 |
File access error |
125 |
System error |
126 |
Program error |
Environment requirements
This command can run regardless of whether the job execution service is running or stopped.
This command can run regardless of whether the message communication service is running or stopped.
Command stored in:
install-path\bin
Note that the command is stored in the following folder by default.
- In a 32-bit operating system:
-
%ProgramFiles%\Hitachi\JP1CPA\bin
- In a 64-bit operating system:
-
%ProgramFiles(x86)%\Hitachi\JP1CPA\bin
Notes
-
Even Windows users with general privileges can use this command. We recommend that you confirm in advance whether it is acceptable to allow Windows user with general privileges to perform the following operations:
-
Even Windows users with general privileges can view virtual user names and Windows user names registered in the user mapping file. For example, they can obtain such user information and then use it with the Windows log-on function to log on to Windows.
-
Even Windows users with general privileges can update virtual user information registered in the user mapping file. For example, they can use the updated information to log on to Windows by using the Windows log-on function.
-
Even Windows users with general privileges can have full control (read and write privileges) over the user mapping file.
-
-
Password information specified with the ?p option is obfuscated so that it cannot be easily recovered, and then set in the user mapping file. However, encryption by means of AES, RSA, or SHA-2 will not be performed. For details about the location in which the user mapping file is placed, see D.1 Files and folders in CPA.