+

Search Tips   |   Advanced Search

ServerManagement

Use the Jython or Jacl scripting languages to manage servers with the wsadmin tool. The commands in the ServerManagement group can be used to manage application server, web server, proxy server, generic server and Java virtual machine (JVM) configurations.

The ServerManagementcommands include:


(ZOS) changeServerSpecificShortName

Change the short name associated with a server.

Target object: None

Required parameters:

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


createApplicationServer

Create a new application server.

Target object:

Name of the node (String, required)

Required parameters:

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


createApplicationServerTemplate

Create a new application server template.

Target object: None

Required parameters:

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


createGenericServer

Create a new generic server in the configuration. A generic server is a server that the product manages, but did not supply. The createGenericServer command provides an additional step, ConfigProcDef, that used to configure parameters specific to generic servers.

Target object: Name of the node (String, required)

Required parameters:

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


createGenericServerTemplate

Create a new generic server template.

Target object: None

Required parameters:

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


createGenericServerTemplate

Create a server template based on a server configuration.

Target object: None.

Required parameters:

Optional parameters:

Examples

Interactive mode example usage:


createProxyServer

Create a new proxy server in the configuration. The proxy server is a specific type of application server that routes HTTP requests to content servers that perform the work. The proxy server is the initial point of entry, after the firewall, for requests into the enterprise.

Target object: Name of the node (String, required)

Required parameters:

Optional parameters:

Optional steps

Examples

Batch mode example usage:

Interactive mode example usage:


createProxyServerTemplate

Create a new proxy server template based on an existing proxy server configuration.

Target object: None

Required parameters:

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


createServerType

Deprecated feature: The createServerType command is deprecated. No alternative command is provided for this deprecation.depfeat

Define a server type.

Target object: None.

Required parameters:

Optional parameters:

Sample output

The command returns the object name of the server type created.

Examples

Batch mode example usage:

Interactive mode example usage:


createWebServer

Create a web server definition. This command creates a web server definition using a template and configures the web server definition properties. Web server definitions generate and propagate the plugin-config.xml file for each web server. For IBM HTTP Server only, we can use web server definitions to administer and configure IBM HTTP Server web servers with the administrative console. These functions include: Start, Stop, View logs, View and Edit configuration files.

Target object: Name of the node (String, required).

Required parameters:

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


createWebServerTemplate

Create a new web server template.

Target object: None

Required parameters:

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


deleteServer

Delete a server.

Target object: None

Required parameters:

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


deleteServerTemplate

Delete a server template. We cannot delete templates defined by the system. We can only delete server templates that we created. This command deletes the directory that hosts the server template.

Target object:

The name of the template to delete. (ObjectName, required)

Required parameters: None.

Optional parameters: None.

Examples

Batch mode example usage:

Interactive mode example usage:


getJavaHome

Get the Java home value.

Target object: None.

Required parameters:

(ZOS) Optional parameters

Examples

Batch mode example usage:

Interactive mode example usage:


(ZOS) getJVMMode

Get information about the mode of the Java virtual machine.

Target object: None

Required parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


getServerType

Return the type of the server specified.

Target object: None

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


listServers

Return a list of servers.

Target object: None

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


listServerTemplates

List server templates.

Target object: None

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


listServerTypes

Display all the current server types. For example, APPLICATION_SERVER, WEB_SERVER, GENERIC_SERVER

Target object:

The node name for which we want to list the valid types. For example, the types that are only valid on z/OS will appear on a z/OS node. (String, optional)

Parameters and return values

Examples

Batch mode example usage:

Interactive mode example usage:


setJVMDebugMode

Set the Java virtual machine (JVM) debug mode for the application server.

Target object: None

Required parameters:

Examples

Interactive mode example usage:


setGenericJVMArguments

Pass command line arguments to the Java virtual machine (JVM) code that starts the application server process.

Target object: None

Required parameters:

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


setJVMInitialHeapSize

Set the JVM initial heap size for the application server.

Target object: None

Parameters and return values

Examples

Interactive mode example usage:


setJVMMaxHeapSize

Set the Java virtual machine (JVM) maximum heap size for the application server.

Target object: None

Parameters and return values

Examples

Batch mode example usage:

Interactive mode example usage:


(ZOS) setJVMMode

Set the Java virtual machine mode.

The mode can be either 64-bit or 31-bit. Local mode is allowed for disconnected modification of the server. If we use this command to set the mode to 31-bit mode, and the server is currently at 64-bit mode, the heap size is automatically set to use a maximum heap size of 512 MB and an initial heap size of 256 MB.

Target object: None.

Parameters and return values

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


setJVMProperties

Set the Java virtual machine (JVM) configuration for the application server.

Target object: None

Required parameters:

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


setJVMSystemProperties

Set the Java virtual machine (JVM) system property for the process of the application server.

Target object: None

Required parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


setProcessDefinition

Set the process definition of an application server.

Target object: None

Required parameters:

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


setTraceSpecification

Set the trace specification for the server. If the server is running new trace specification the change takes effect immediately. This command also saves the trace specification in configuration.

Target object: None

Required parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


showJVMProperties

List the Java virtual machine (JVM) configuration for the server of the application process.

Target object: None

Required parameters:

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


showJVMSystemProperties

Show the Java virtual machine (JVM) system properties for the process of the application server.

Target object: None

Required parameters

Optional parameters

Examples

Batch mode example usage:

Interactive mode example usage:


showProcessDefinition

Show the process definition of the server.

Target object: None

Required parameters:

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


showServerInfo

The showServerInfo command returns the information for a server specified.

Target object: The configuration ID of the server. (required)

Parameters and return values

Examples

Batch mode example usage:

Interactive mode example usage:


showServerTypeInfo

Display information about a specific server type.

Target object: Specifies a server type. For example: APPLICATION_SERVER (String, required)

Optional parameters:

Examples

Batch mode example usage:

Interactive mode example usage:


showTemplateInfo

Display the metadata information for a specific server template.

Target object:

Configuration Id of the server type. (String, required)

Parameters and return values

Examples

Batch mode example usage:

Interactive mode example usage:

  • wsadmin AdminTask
  • Commands for the AdminTask object