4.7.7 Add JP1/Base user mapping
Function
Adds user mapping definitions in JP1/Base on a specified server.
This plugin assumes the following server:
• Agent server (Execution target server)
This is the server on which this plugin is executed. JP1/Base must be set up.
When the execution target server is Windows, the built-in Administrator is required to execute this plug-in. If the built-in Administrator does not exist or is invalid on the execution target server, execute "Add JP1/Base user mapping(SYSTEM)" plug-in that executes with the system account.
Use situation
You use this plugin to add user mapping definitions after you have registered a JP1 user and OS user in a JP1/AJS3 job execution environment or in a monitoring system using JP1/IM.
You can optimize the JP1 user-related settings by executing this plugin together with the following plugins:
• jp1baseAddUser
• jp1baseSetPermission
• jp1baseChangeUserInfo
Prerequisites
For the latest support information about [Required products on the execution target server]/[Prerequisite product OS running in the execution target server], see the release notes.
In addition, the following OS and products use abbreviations. For the abbreviations of OS and products, see the "Preface".
[Required products on the execution target server]
(1) JP1/Base
[Prerequisite product OS running in the execution target server]
(1) Windows Server
(2) Red Hat Enterprise Linux Server
[Usage conditions for required products on the execution target server]
(1) If the execution target server's JP1/Base has a cluster configuration, specify in the plugin.destinationHost property the name of the physical host on which JP1/Base's logical host is running, and specify in the JP1.logicalHostName property JP1/Base's logical host name.
Cautions
(1) When you run this plugin in a UNIX environment, do not use multi-byte characters in the properties.
Version
04.00.00
Plug-in tags
Configure JP1,Base,Windows,Linux
Plug-in name displayed in the task log
jp1baseAddMapping
Return code
0: Normal
11: Error (user error) Definition file's contents are invalid
12: Error (user error) Invalid property
13: Error (user error) Authentication disabled
14: Error (user error) File access disabled
21: Error (invalid environment) Command cannot be found (error detected in the plugin script)
22: Error (invalid environment) Insufficient memory or disk capacity
26: Error (linked product error) Internal error
41: Error (error detected in plugin) Missing property (error detected in plugin script)
42: Error (error detected in plugin) Internal error (error detected in the plugin script)
Property list
The following table lists the properties:
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
---|---|---|---|---|---|
JP1.logicalHostName |
Logical host name for the execution target server |
Specify the JP1 logical host name of the execution target server. |
-- |
Input |
O |
JP1Base.jp1UserName |
JP1 user name |
Specify the name of the JP1 user to create a user mapping for. |
-- |
Input |
R |
JP1Base.serverHostName |
Server host name |
Specify the host name of the server that the specified JP1 user can operate. |
-- |
Input |
R |
common.osUserName |
OS user name |
Specify the user name of the OS user to map to a JP1 user. |
-- |
Input |
R |
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |