jbssetumap
- Organization of this page
Function
The jbssetumap command registers specific user mapping information into the common definition information.
Format
When using a definition file:
jbssetumap [-h logical-host-name] -f definition-file-name [-no]
When not using a definition file:
jbssetumap [-h logical-host-name] {-u JP1-user-name | -ua} {-sh server-host-name| -sha} -o OS-user-name [,OS-user-name...] [-no]
Required execution permission
In Windows: Administrators (If User Account Control (UAC) for Windows is enabled, you must execute the command from the administrator console.)
In UNIX: Superuser or JP1/Base administrator permission
Command directory
- In Windows:
-
installation-folder\bin\
- In UNIX:
-
/opt/jp1base/bin/
Arguments
-h logical-host-name
When using JP1/Base in a cluster system, specify the logical host for which you want to register the user mapping information. If you omit this option, the host name set in the environment variable JP1_HOSTNAME is assumed. If the environment variable JP1_HOSTNAME is not set, the physical host name is assumed.
-f definition-file-name
Specify the name of the definition file containing the mapping information you want to register or modify. You can store the definition file in any location. You can use any file name when you store the file, but the file format must be the same as the user mapping definition file (jp1BsUmap.conf). For details on the format of the user mapping definition file, see User mapping definition file in 16. Definition Files.
When you specify this option, you cannot specify the -u, -ua, -sh, or -sha option.
-u JP1-user-name
Specify the name of the JP1 user for which you want to register or modify mapping information. You can only specify this option when the -ua option is not specified.
-ua
Specify an asterisk (*) for the JP1 user name. Entering an asterisk (*) grants the rights of the users specified in user-list to all JP1 users. You can only specify this option when the -u option is not specified.
-sh server-host-name
Specify the name of the server host where the JP1 user issues operating instructions. You can only specify this option when the -sha option is not specified.
-sha
Specify an asterisk (*) for the server host name. This option enables the JP1 users to operate from any server host. You can only specify this option when the -sh option is not specified.
-o OS-user-name
Specify the OS user name to which you want to map the JP1 user. You can use a comma (,) as a delimiter to specify multiple OS users.
-no
This option causes the system to return an error without registering mapping information if the specified mapping information has already been registered for the specified JP1 user.
Note
-
To check the settings done by this command, execute the jbsgetumap command.
-
When you register user mapping information by using a definition file that contains a large number of definitions, it might take a long time to apply the definition contents to the common definition information. While user mapping information is being updated, masked user functionality cannot be used, and therefore operations that require masked user functionality (such as JP1/AJS job execution and remote commands in JP1/IM - Manager) cannot be performed.
Therefore, if you intend to update a large amount of user mapping information at one time, execute the jbssetumap command in a maintenance period not during operation. If you want to update a large amount of user mapping information during operation, consider splitting the definition contents before executing the jbssetumap command. This minimizes the time required by the jbssetumap command to apply the definition contents to the common definition information.
Return values
0 |
Normal end |
1 |
Invalid arguments |
2 |
The user executing the command does not have an appropriate privilege. |
3 |
An error occurred during reading of the user mapping definition file. |
4 |
The user mapping definition file contains a syntax error. |
5 |
An error occurred during access to the common definitions. |
6 |
Insufficient system resource such as memory |
10 |
An error occurred during locking of the common definitions. |
255 |
Other error |