jddsetproxyuser
- Organization of this page
Function
This command sets authentication information for the proxy server when REST APIs are executed from plug-ins that are provided by JP1/IM - Manager (Intelligent Integrated Management Base). This setting is not needed if you do not use proxy server authentication.
Format 1
Usage:
jddsetproxyuser {-list|-add -id user-ID -pw password |-rm -id user-ID} [-h logical-host-name]
Format 2
jddsetproxyuser -list [-h logical-host-name]
Format 3
jddsetproxyuser -add -id user-ID -pw password [-h logical-host-name]
Format 4
jddsetproxyuser -rm -id user-ID [-h logical-host-name]
Execution permission
In Windows: Administrator permissions (if the Windows UAC feature is enabled, the command is executed from the administrator console)
In UNIX: Superuser permissions
Storage directory
- In Windows:
-
Manager-path\bin\imdd\
- In UNIX:
-
/opt/jp1imm/bin/imdd/
Arguments
- -list
-
Specify this option if you get authentication information for the proxy server configured in the Intelligent Integrated Management Base.
- -add
-
Specify this option if you update the authentication information for the proxy server configured in the Intelligent Integrated Management Base. If this option is specified, the -id option and -pw option must be specified. If they are omitted, an error occurs.
- -rm
-
Specify this option if you remove the authentication information for the proxy server configured in the Intelligent Integrated Management Base. If this option is specified, the -id option must be specified. If it is omitted, an error occurs.
- -id user-ID
-
Specifies the user ID of a user for proxy server authentication.
- -pw password
-
Specifies the password for the user you specified with the -id option.
- -h logical-host-name
-
Specifies the logical host name of JP1/IM if JP1/IM is running in a cluster system.
If this option is omitted, the command assumes the logical host name specified in the JP1_HOSTNAME environment variable. If the JP1_HOSTNAME environment variable is not specified, the command assumes the physical host name.
Notes
-
You cannot execute the jddsetproxyuser command concurrently multiple times. Doing so results in an error.
-
Do not stop JP1/IM - Manager or the IM database while the jddsetproxyuser command is running.
-
You cannot execute the jddsetproxyuser command together with the API for setting proxy authentication information. For details about the proxy credential setup API, see 5.9.1 Proxy credential setup.
-
If the jddsetproxyuser command is executed while JP1/IM - Manager is not running, the KAJY52015-W message is output and the setting will take effect next time JP1/IM - Manager is started.
Return values
|
0 |
Normal termination |
|
1 |
Invalid argument |
|
2 |
Exclusive locked |
|
3 |
A specified argument value was invalid |
|
4 |
Invalid logical host name |
|
5 |
Authentication information used by the Intelligent Integrated Management Base is not set |
|
7 |
No execution permission for the jddsetproxyuser command |
|
11 |
Failed to connect to the Intelligent Integrated Management Base |
|
12 |
The Intelligent Integrated Management Base could not be authenticated |
|
13 |
Update of proxy authentication information failed |
|
255 |
System error |
Example 1
The following is an example of getting authentication information for the proxy server configured in the Intelligent Integrated Management Base:
jddsetproxyuser -list KAJY02009-I The command (jddsetproxyuser) has started. User1 User2 KAJY02010-I The command (jddsetproxyuser) terminates normally.
Example 2
The following is an example of updating authentication information for the proxy server configured in the Intelligent Integrated Management Base:
jddsetproxyuser -add -id User3 -pw PASSWORD KAJY02009-I The command (jddsetproxyuser) has started. KAJY02010-I The command (jddsetproxyuser) terminates normally. jddsetproxyuser -list KAJY02009-I The command (jddsetproxyuser) has started. User1 User2 User3 KAJY02010-I The command (jddsetproxyuser) terminates normally.
Example 3
The following is an example of removing authentication information for the proxy server configured in the Intelligent Integrated Management Base:
jddsetproxyuser -rm -id User3 KAJY02009-I The command (jddsetproxyuser) has started. KAJY02010-I The command (jddsetproxyuser) terminates normally. jddsetproxyuser -list KAJY02009-I The command (jddsetproxyuser) has started. User1 User2 KAJY02010-I The command (jddsetproxyuser) terminates normally.