+

Search Tips   |   Advanced Search

Use command-line tools

Command-line tools only work on local servers and nodes. They cannot operate on a remote server or node. To administer a remote server, we can use the wsadmin scripting program connected to the deployment manager for the cell in which the target server or node is configured.

Unless otherwise specified, all of the application server commands are located in the app_server_root/bin directory.

Parameter values that specify a server name, a node name or a cell name are case sensitive. For example, to start the application server MyServer for the profile test, invoke startServer MyServer -profileName test. If we specify myserver for the server name, the startServer script fails.

(Dist) (Vista) Win2008) (Windows7) Run command line tools on the Microsoft Windows Vista or later Microsoft operating system: On the Windows Vista, Windows Server 2008, and Windows 7 operating systems, we can install WAS as either Administrator or non-Administrator. When it is installed as Administrator, certain operations (such as those involving Windows Services) require Administrator privileges. To ensure that WAS command-line tools have sufficient privileges, run them with elevated administrator authority on systems that have the Windows User Account Control (UAC) Run all administrators in Admin Approval Mode policy enabled. When we run these command-line tools from a Command Prompt, run them from a Command Prompt window that is launched by performing the following actions:

Examples of these tools are the startServer command, stopServer command, startManager command, stopManager command, startNode command, stopNode command, firststeps command, and the Profile Management Tool.

If we are using a Windows Server Core installation of Windows Server 2008, any WAS commands that require a graphical interface are not supported since a Windows Server Core system does not have a graphical user interface. Therefore, commands such as launchpad.exe or ifgui.bat are not supported on that type of Windows Server 2008 installation.

Use the following general steps to run a command:


Tasks

  1. Open a system command prompt.

  2. (iSeries) From the IBM i command line, start a Qshell session by issuing the STRQSH CL command.

  3. Determine whether to run the script from the profile or application server root directory.

    Most command-line tools function relative to a particular profile. To determine if a command requires the -profileName parameter, refer to the documentation for that specific command. If we run a command from the app_server_root/bin directory and do not specify the -profileName parameter, the default profile for the product sets profile-specific variables. To specify a different profile, use one of the following options:

    • Navigate to app_server_root/bin and run the following command, specifying the profile of interest as the value for the profileName parameter: 
      startServer server1 -profileName AppServerProfile

    • When a profile is created, the application server creates a proxy script in the profile_root/bin directory for each script in the app_server_root/bin directory that is applicable to the type of profile created. When a proxy script is invoked, the profile-specific variables for the script are set based on the profile from which the script is invoked. To run the command for a specific profile, navigate to the profile_root/bin directory for the profile of interest to run the command.

  4. Run the command of interest.

The command runs the requested function and displays the results on the screen.

Refer to the command log file for additional information. When we use the -trace option for the command, the additional trace data is captured in the command log file. The directory location for the log files is under the default system log root directory, except for commands related to a specific server instance, in which case the log directory for that server is used. We can override the default location for the command log file using the -logfile option for the command.


What to do next

For more information about using profiles, including how to obtain a list of profiles, see the information about the manageprofiles command topic.

  • Get started with wsadmin scripting
  • (iSeries) Configure Qshell to run WebSphere scripts
  • (iSeries) Granting authority to a profile using the IBM i command line
  • (iSeries) Revoking authority to a profile using the IBM i command line
  • (iSeries) checkprereqs command
  • (iSeries) chgwassvr command
  • (iSeries) configureOs400WebServerDefinition command
  • (iSeries) dspwasinst command
  • (iSeries) enablejvm command (deprecated)
  • (iSeries) enbprfwas command
  • (iSeries) heapMonitor command
  • (iSeries) ivt command
  • (iSeries) port validator tool
  • (iSeries) prerequisite validator tool
  • (iSeries) removeOs400WebServerDefinition command
  • (iSeries) rvkwasaut command
  • (iSeries) servicetools command
  • (iSeries) updwashost command (deprecated)
  • (iSeries) grtwasaut command
  • registerNode command
  • deregisterNode command
  • revokeCertificate command
  • requestCertificate command
  • createCertRequest command
  • queryCertificate command
  • (iSeries) PropFilePasswordEncoder command reference
  • (iSeries) Qshell environment variables
  • Example: Security and the command line tools
  • manageprofiles command
  • managesdk command
  • startServer command
  • stopServer command
  • startManager command
  • stopManager command
  • startNode command
  • stopNode command
  • addNode command
  • serverStatus command
  • removeNode command
  • cleanupNode command
  • syncNode command
  • renameNode command
  • backupConfig command
  • restoreConfig command
  • EARExpander command
  • GenPluginCfg command
  • retrieveSigners command
  • versionInfo command
  • genVersionReport command
  • historyInfo command
  • genHistoryReport command