Understanding the WASService with the WASServiceCMD Tool in WebSphere Application Server

Size: px

Start display at page:

Download "Understanding the WASService with the WASServiceCMD Tool in WebSphere Application Server"

Camilla Bryan
6 years ago
Views:

1 IBM Software Group Understanding the WASService with the WASServiceCMD Tool in WebSphere Application Server Alain Del Valle Randal Anders Paul Van Norman WebSphere Application Server L2 Support 9 August 2011 WebSphere Support Technical Exchange

2 Agenda WASService command What is WASServiceCmd? Required permissions Required/Optional parameters Benefits of WASServiceCmd Examples Problem determination, common problems & known APARs WebSphere Support Technical Exchange 2 of 55

3 WASService command Used to create a Windows service to run WebSphere Application Server Invoked from the was_root/bin directory Accepts many parameters that can be passed-in when creating the service WebSphere Support Technical Exchange 3 of 55

4 WASService command (cont) Some parameters are required without them the service will not run properly The creation of a service requires many characters entered manually: WASService.exe" -add "server1node3" -servername "server1" -profilepath "C:\testwork\WebSphere\AppServer\profiles\AppSrv03" -logroot "C:\testwork\WebSphere\AppServer\profiles\AppSrv03\logs\server1" -logfile "C:\testwork\WebSphere\AppServer\profiles\AppSrv03\logs\server1\WS_star tserver1.log" -starttype manual -restart false WebSphere Support Technical Exchange 4 of 55

5 Required permissions For a standalone machine, the user must: Be a member of the administrative group Have the Act as part of the operating system privilege Have the Log on as a service privilege WebSphere Support Technical Exchange 5 of 55

6 Required permissions (cont) For a machine that is a member of a domain, at a minimum, the user must: Be a member of the administrative group on the local machine Have the Act as part of the operating system privilege in the Local security policy on the local machine Have the Log on as a service privilege on the local machine If service is running on domain controller, user may need to: Be a member of the domain administrative group on the domain controller Have the Act as part of the operating system privilege in the Domain security policy on the domain controller WebSphere Support Technical Exchange 6 of 55

7 Required parameters WebSphere Support Technical Exchange 7 of 55

8 Optional parameters WebSphere Support Technical Exchange 8 of 55

9 Optional parameters (cont) WebSphere Support Technical Exchange 9 of 55

10 Optional parameters (cont) Needed for log on as property WebSphere Support Technical Exchange 10 of 55

11 What is WASServiceCmd? Utility used to assemble lengthy parameters for the WASService command Reduces the opportunity for human errors Presents WASService parameters in a numbered list for selection based on system configuration WebSphere Support Technical Exchange 11 of 55

12 Benefits of WASServiceCmd Provides user-friendly method for creating complex services via the command line Utilized by other stack products that require Windows services such as (Maximo, Portal, etc) Detects required paths needed automatically WebSphere Support Technical Exchange 12 of 55

13 Benefits of WASServiceCmd (cont) Prompts user for easy to follow informational prompts with choices Allows the passing of security parameters (Hiding password) Lists status of all services. Started or stopped Capability to enable\disable tracing WebSphere Support Technical Exchange 13 of 55

14 Benefits of WASServiceCmd (cont) Easy to follow removal of services from a list WASServiceCmd log that logs the command if not executed at time of creation Supports V6.0, V6.1 and V7.0. Released with product in V8.0 as the WASServiceHelper Utility Can be used in normal debugging of stop and start server issues WebSphere Support Technical Exchange 14 of 55

15 Examples WASServiceCmd add (Required) WASServiceCmd add (Optional) WASServiceCmd removal WASServiceCmd status WASServiceCmd enable trace WebSphere Support Technical Exchange 15 of 55

16 WASServiceCmd menu options C:\WAS61\AppServer\bin>WASServiceCmd.exe Menu Options : 1 Add new or update existing WebSphere service (minimum parameters required) 2 Add new or update existing WebSphere service (all parameters) 3 Remove WebSphere service 4 Status of WebSphere service 5 Tracing WASServices Select number next to the options (default 1)[q to Quit]: 1 WebSphere Support Technical Exchange 16 of 55

17 WASServiceCmd add Required 1 Add new or update existing WebSphere service (minimum parameters required) 2 Add new or update existing WebSphere service (all parameters) 3 Remove WebSphere service 4 Status of WebSphere service 5 Tracing WASServices Profile : 1 Dmgr01 2 AppSrv01 3 Evan01 Select number next to the profile [q to Quit]: 1 File C:\WAS61\AppServer\profiles\Dmgr01\bin\setupcmdLine.bat IS found Cell in setupcmdline: randalacell01 Node in setupcmdline: randalacellmanager01 WebSphere Support Technical Exchange 17 of 55

18 WASServiceCmd add Required (cont) Servers : 1 dmgr Hint: If the application server is running in an ND environment then only the nodeagent and deployment manager servers should be started as a Windows service. Warning: In an ND environment, starting the application server as a service may fail under certain conditions where its nodeagent is running. Select number next to server [q to Quit]: 1 dmgr WebSphere Support Technical Exchange 18 of 55

19 WASServiceCmd add Required (cont) Service Name : Type in a Service Name (e.g hostnamenode01) [q to Quit]: 61serviceAsUser Service Name : 61serviceAsUser Restart Policy : 1 Automatic: Restarts this service if it fails 2 Manual: Restart manually if service if it fails Select number next to restart policy (default 1)[q to Quit]: 2 WebSphere Support Technical Exchange 19 of 55

20 WASServiceCmd add Required (cont) Start Type : 1 Automatic: Starts this service when the operating system starts or when the service is called for the first time. 2 Manual: Requires the service to be started manually using Windows services panel. Select number next to start type (Default 1)[q to Quit]: 2 *** Security *** Hint: Userid needs to be a member of an administrative role with authority to stop a server such as Admin or Operator roles. NOTE: When Security is enabled a userid and password is required in order to be able to stop the service Is SECURITY enabled? (default N)[Y/N][q to Quit]: y Username : randaltest Password: ********* Please re-enter password for verification: ********* WebSphere Support Technical Exchange 20 of 55

21 WASServiceCmd add Required (cont) Execute : wasservice.exe -add "61serviceAsUser" -servername "dmgr" -profilepath "C:\WAS61\AppServer\profiles\Dmgr01" -encodeparams -stopargs "-username randaltest -password ********" -starttype manual -restart false Execute command now? (default=yes) [Y/N][q to Quit]: y Adding Service: 61serviceAsUser Config Root: C:\WAS61\AppServer\profiles\Dmgr01\config Server Name: dmgr Profile Path: C:\WAS61\AppServer\profiles\Dmgr01 Was Home: C:\WAS61\AppServer\ Start Args: Restart: 0 IBM WebSphere Application Server V6.1-61serviceAsUser service successfully added. WebSphere Support Technical Exchange 21 of 55

22 WASServiceCmd add Optional 1 Add new or update existing WebSphere service (minimum parameters required) 2 Add new or update existing WebSphere service (all parameters) Contains all of the required parameters plus the following optional ones: Start Arguments : (Optional) Enter additional start arguments, press enter for none Start args: -startargs Log Root Path : Press enter to use following location: C:\WAS61\AppServer\profiles\Dmgr01\logs\dmgr - or - Enter the full path to your log root directory: (e.g. C:\Program Files\production\profiles\profile_Name\logs\server_name\) Log root path: C:\WAS61\AppServer\profiles\Dmgr01\logs\dmgr WebSphere Support Technical Exchange 22 of 55

23 WASServiceCmd add Optional (cont) Log File : Press enter to use following location: C:\WAS61\AppServer\profiles\Dmgr01\logs\WS_startdmgr.log - or - Enter the full path to your log file directory: (e.g. C:\Program Files\production\profiles\profile_Name\logs\WS_startdmgr.log) Log file name: C:\WAS61\AppServer\profiles\Dmgr01\logs\WS_startdmgr.log Config Root : Press enter to use following location: C:\WAS61\AppServer\profiles\Dmgr01\config - or - Enter the full path to your config root directory: (e.g. C:\Program Files\production\profiles\profile_Name\config\) Config root path: C:\WAS61\AppServer\profiles\Dmgr01\config WebSphere Support Technical Exchange 23 of 55

24 WASServiceCmd add Optional (cont) *** Security *** Hint: Userid needs to be a member of an administrative role with authority to stop a server such as Admin or Operator roles. NOTE: When Security is enabled a userid and password is required in order to be able to stop the service Is SECURITY enabled? (default N)[Y/N][q to Quit]: y Username : randaltest Password: ********* Please re-enter password for verification: ********* Stop Arguments : (Optional) Note: stopargs "-userid username -password password" will be added automatically if you answered yes to the "Is SECURITY enabled" prompt above. Enter additional stop arguments, press enter for none Stop args: stopargs : WebSphere Support Technical Exchange 24 of 55

25 WASServiceCmd add Optional (cont) Execute : wasservice.exe -add "61serviceAsUser" -servername "dmgr" -profilepath "C:\WAS61\AppServer\profiles\Dmgr01" -logroot "C:\WAS61\AppServer\profiles\Dmgr01\logs\dmgr" -logfile "C:\WAS61\AppServer\profiles\Dmgr01\logs\WS_startdmgr.log" -configroot "C:\WAS61\AppServer\profiles\Dmgr01\config" -encodeparams -stopargs "-username randaltest -password ********" -starttype manual -restart false Execute command now? (default=yes) [Y/N][q to Quit]: y Adding Service: 61serviceAsUser Config Root: C:\WAS61\AppServer\profiles\Dmgr01\config Server Name: dmgr Profile Path: C:\WAS61\AppServer\profiles\Dmgr01 Was Home: C:\WAS61\AppServer\ Start Args: Restart: 0 IBM WebSphere Application Server V6.1-61serviceAsUser service successfully added. WebSphere Support Technical Exchange 25 of 55

26 WASServiceCmd removal 1 Add new or update existing WebSphere service (minimum parameters required) 2 Add new or update existing WebSphere service (all parameters) 3 Remove WebSphere service Remove Service: 1 IBMWAS61Service - 61serviceAsUser 2 IBMWAS61Service - randalacellmanager01 3 IBMWAS70Service - randalacellmanager02 4 IBMWAS70Service - testwas7service Select the number next to the service to remove [q to Quit]: 1 You selected 61serviceAsUser to be deleted. cmd : wasservice.exe -remove "61serviceAsUser" Execute command now? [Y/N][q to Quit]: y Remove Service: 61serviceAsUser Successfully removed service Remove Another? (default Y)[Y/N][q to Quit]: n WebSphere Support Technical Exchange 26 of 55

27 WASServiceCmd status 1 Add new or update existing WebSphere service (minimum parameters required) 2 Add new or update existing WebSphere service (all parameters) 3 Remove WebSphere service 4 Status of WebSphere service Service Status: 1 IBMWAS61Service - 61serviceAsUser 2 IBMWAS61Service - randalacellmanager01 3 IBMWAS70Service - randalacellmanager02 4 IBMWAS70Service - testwas7service Select the number next to the service to show status. [q to Quit]: 1 The service is stopped. Another? (default Y)[Y/N][q to Quit]: n WebSphere Support Technical Exchange 27 of 55

28 WASServiceCmd tracing 1 Add new or update existing WebSphere service (minimum parameters required) 2 Add new or update existing WebSphere service (all parameters) 3 Remove WebSphere service 4 Status of WebSphere service 5 Tracing WASServices Tracing Trace output is captured in \WASServiceTrace.log NOTE: WASService tracing for Windows was introduced in , and If you are running a lower level of code, please obtain a copy newer version of WASService.exe. You can move a newer copy from another installation (must be same release level) or call IBM to obtain a newer copy. WASService trace NOT currently enabled Enable WASService traces? (default Y)[Y/N][q to Quit]: y Tracing enabled WebSphere Support Technical Exchange 28 of 55

29 WASServiceCmd log WASServiceCmd.log is found in was_root/bin directory Logs all WASService commands executed by the WASServiceCmd tool wasservice.exe -add "61serviceAsUser" -servername "dmgr" -profilepath "C:\WAS61\AppServer\profiles\Dmgr01" -encodeparams -stopargs "-username randaltest -password ******** -starttype manual -restart false wasservice.exe -status "61serviceAsUser" wasservice.exe -remove "61serviceAsUser" WebSphere Support Technical Exchange 29 of 55

30 Section Problem determination, common problems & known APARs WebSphere Support Technical Exchange 30 of 55

31 Problem determination Service does not start: Do you have the correct OS permission? Must be an administrator or a member in the administrators group Act as part of the operating system Log on as a service WebSphere Support Technical Exchange 31 of 55

32 Problem determination cont. Service does not start: Disable the service Try to start the server from the command line If it starts successfully, there is a problem with the service. Delete and recreate the service using wasservicecmd / wasservicehelper WebSphere Support Technical Exchange 32 of 55

33 Problem determination cont. Service does not start even after recreating: Check for APAR s or install the latest fixpack Delete and recreate the service WebSphere Support Technical Exchange 33 of 55

34 Problem determination cont. Service does not start: Delete Java shared class cache C:\Documents and Settings\<username>\Local Settings\Application Data\javasharedresources Or disable the Java shared class cache Admin console > servers > Application servers > server1 > java and process management > process definition > java virtual machine > specify "-Xshareclasses:none" under "generic JVM arguments" section WebSphere Support Technical Exchange 34 of 55

35 Problem determination cont. Service does not start: Enable tracing Try to start the service When service fails, review the trace in c:\wasservicetrace.log for cause WebSphere Support Technical Exchange 35 of 55

36 Problem determination cont. Service fails to start after restarting Windows Is the application server started as a service The nodeagent should be started with the service and the nodeagent should start the application servers via monitoring policy WebSphere Support Technical Exchange 36 of 55

37 Problem determination cont. Service starts but when user logs off Windows, the service stops: Regular users can create a windows service but the service will stop if the user is not a member of the administrative group in Windows WebSphere Support Technical Exchange 37 of 55

38 Problem determination cont. Service status does not show correctly (Stopped/Started) When a server is started through the administrative console its status may not be detected by the OS this is working as designed Windows is responsible for detecting the Java process. WebSphere Support Technical Exchange 38 of 55

39 Common problems Misspelled paths will cause the service to fail Service must be recreated if new parameters are needed WebSphere Support Technical Exchange 39 of 55

40 Common problems cont. Need to start service as domain user (issue does not exist in V8): Run the WASServiceCmd tool and select option 2 (all parameters) Follow all the prompts but do not execute the command Cut and paste the command into notepad and add the following: -userid <DOMAIN\user_name> and password wasservice.exe -add "61serviceAsUser" -servername "dmgr" -profilepath "C:\WAS61\AppServer\profiles\Dmgr01" -logroot "C:\WAS61\AppServer\profiles\Dmgr01\logs\dmgr" -logfile "C:\WAS61\AppServer\profiles\Dmgr01\logs\WS_startdmgr.log" -configroot "C:\WAS61\AppServer\profiles\Dmgr01\config" -encodeparams -userid AUSTIN\randaltest -password ******** -stopargs "-username AUSTIN\randaltest -password ********" -starttype manual -restart false WebSphere Support Technical Exchange 40 of 55

41 Known APARs in PM32369 WASService is unable to read the pid when Microsoft Windows service is started Failing Scenario: 1. Microsoft Windows Service is created to start Deployment Manager 2. Start the Service 3. The Deployment Manager starts but the Service fails 4. With WASService trace enabled, the WASServiceTrace.log shows: getpidforserverfromstdout: Checking stdout for pid: C:\WAS70\appserver\profiles\dmgr01\logs\dmgrService.log... getpidforserverfromstdout: Could not get pid from stdout. Problem conclusion: There was a problem extracting a PID from the standard output generated from the application server WebSphere Support Technical Exchange 41 of 55

42 Known APARs in PM24498 WASService timed out getting PID from file, service status stopped. From WasServiceTrace.log, we have the following: startserver: Breaking out of wait for startserver.bat getregistryvalue: SYSTEM\CurrentControlSet\Services\IBMWAS61Service WASServiceMain: startserver returned. getpidforserver: Checking [built] pid path for pid file: waitforpidfile: trying to open pid file parsepidfromstdout: not pid ADMU0116I: waitforpidfile: Timed out getting pid from file. Pid file is created and listed in startserver.log. Problem conclusion: Code expected the application server to write a file within 15 seconds of starting. In busy environment, file might not be produced in this time frame. Time value increased to 300 seconds WebSphere Support Technical Exchange 42 of 55

43 Known APARs in PM15004 WASService.sh fails when updating existing service Failures to re-substitute some strings in the existing service entry causes a wasservice.sh failure. The only feedback provided is "java.lang.stringindexoutofboundsexception" with no stack trace. Problem conclusion: Code updated to more rigorously re-substitute existing service entries. WebSphere Support Technical Exchange 43 of 55

44 Known APARs in PM04497 WASService has a default timeout value of 20 minutes The stopserver command receives an ADMU7705E error 1200 seconds after running the stopserver command in spite of specifying a timeout value. From WAService.cpp, it internally has a fixed timeout value (20 minutes) and returns -1 when it reaches the timeout (20 minutes) regardless of the timeout value of the stopserver command (stopserver -timeout option) Local fix: Remove the start command from Windows Services and use the command manually. Problem conclusion: Code has been modified to search the arguments passed to the stopserver and startserver scripts and use that timeout value if provided. WebSphere Support Technical Exchange 44 of 55

45 Known APARs in PK94821: WASSERVICE DOES NOT RECOGNIZE SERVER STARTED WHEN RUNNING JAPANESE LOCALE The service code searches the log files for the process ID to verify successful initialization. The message translation which contains the process ID is not in the expected format so the ID could not be retrieved. Local fix: Disable the service and run WebSphere from command line. Problem conclusion: Code was changed to locate the process ID. WebSphere Support Technical Exchange 45 of 55

46 Enable WASService tracing There are two ways to enable WASService tracing: Automatically using the WASServiceCmd tool Manually editing the WASServiceTrace.enabled file WebSphere Support Technical Exchange 46 of 55

Automatically enable tracing NOTE: WASService tracing was introduced in V6.

47 Automatically enable tracing NOTE: WASService tracing was introduced in V , V & V WebSphere Support Technical Exchange 47 of 55

$enabled in C:\ Enter the word trace (case-insensitive) Save the file and recreate the problem$

48 Manually enable tracing Create a file called WASServiceTrace.enabled in C:\ Enter the word trace (case-insensitive) Save the file and recreate the problem WebSphere Support Technical Exchange 48 of 55

49 WASServiceTrace.log WASServiceTrace.log is written to the c:\ Look for the following: startserver: executable: "C:\WAS61\AppServer\bin\startServer.bat" "dmgr" -fromwinservice "\\.\pipe\w6svcpipe_1789a_1574d" > "C:\WAS61\AppServer\profiles\Dmgr01\logs\WS_startdmgr.log" Indicates that wasservice has called the startserver batch file startserver output written to WS_startdmgr.log WASService only writes to WASServiceTrace.log WebSphere Support Technical Exchange 49 of 55

50 WASServiceTrace.log (cont) WASService waits for JVM to notify start has completed: startserver: WaitForSingleObject startserver Once completed: WASServiceMain: startserver returned. WASService opens PID file and verifies running process: waitforpidfile: Waiting for pid file: C:\WAS61\AppServer\profiles\Dmgr01\logs\dmgr\dmgr.pid waitforpidfile: trying to open pid file waitforpidfile: pid found breaking waitforpidfile: close pid file waitforpidfile: Got pid from file: 2860 WASServiceMain: about to open process and wait. WASServiceMain: Successful start of WAS process WASServiceMain: Waiting for multiple events WebSphere Support Technical Exchange 50 of 55

51 Summary WASService command requires many parameters Entering these parameters manually is error prone WASServiceCmd reduced the opportunity for human error Allows passing of security parameters Provides ability to enable/disable tracing Logs commands which can be executed at a later time Requires additional privileges for domain users WebSphere Support Technical Exchange 51 of 55

52 References Learn about the default WASService command at: topic=/com.ibm.websphere.nd.doc/info/ae/ae/rins_wasservice.html Review the technote entiteld Using WASServiceCmd to create Windows services for WebSphere Application Server at: Access the DeveloperWorks article entitled The Support Authority: Take the confusion (and errors) out of creating Windows services for WebSphere Application Server at: h.html View the TroubleShooting guide for WebSphere Application Server (Windows Services) problems for V6.1 & V7.0 at: WebSphere Support Technical Exchange 52 of 55

53 Additional WebSphere Product Resources Learn about upcoming WebSphere Support Technical Exchange webcasts, and access previously recorded presentations at: Discover the latest trends in WebSphere Technology and implementation, participate in technically-focused briefings, webcasts and podcasts at: Join the Global WebSphere Community: Access key product show-me demos and tutorials by visiting IBM Education Assistant: View a webcast replay with step-by-step instructions for using the Service Request (SR) tool for submitting problems electronically: Sign up to receive weekly technical My Notifications s: WebSphere Support Technical Exchange 53 of 55

54 Connect with us! 1. Get notified on upcoming webcasts Send an to with subject line wste subscribe to get a list of mailing lists and to subscribe 2. Tell us what you want to learn Send us suggestions for future topics or improvements about our webcasts to wsehelp@us.ibm.com 3. Be connected! Connect with us on Facebook Connect with us on Twitter WebSphere Support Technical Exchange 54 of 55

55 Questions and Answers WebSphere Support Technical Exchange 55 of 55

Advanced Integration Services In IBM Business Process Manager

IBM Software Group Advanced Integration Services In IBM Business Process Manager Pratima Ahuja (pratima@us.ibm.com) Software Engineer 09/11/2012 WebSphere Support Technical Exchange Agenda What is an AIS