Server configuration scripts
The scripting library provides multiple script procedures to automate your application server configurations. Use the application server scripts to create application servers, web servers, and generic servers. You can run each script individually, or combine procedures to create custom automation scripts for your environment.
All server management script procedures are located in
the app_server_root/scriptLibraries/servers/V70 directory.
If you do not want to set an argument, specify an empty string as
the value for the argument, as the following syntax demonstrates: ""
.
createApplicationServer
This
script creates a new application server in your environment. During
the installation process, the product creates a default application
server, named server1
. Most installations require
several application servers to handle the application serving needs
of their production environment.
Argument | Description |
---|---|
nodeName | Specifies the name of the node on which to create the application server. |
serverName | Specifies the name of the server to create. |
templateName | Optionally specifies the template to use to create the application server. |
Syntax
AdminServerManagement.createApplicationServer(nodeName, serverName, templateName)
Example usage
AdminServerManagement.createApplicationServer("myNode", "myServer", "default")
createAppServerTemplate
This script creates a new application server template in your configuration. A server template is used to define the configuration settings for a new application server. When you create a new application server, you either select the default server template or a template you previously created, that is based on another, already existing application server. The default template is used if you do not specify a different template when you create the server.
Argument | Description |
---|---|
nodeName | Specifies the node that corresponds to the server from which to base the template. |
serverName | Specifies the name of the server from which to base the template. |
newTemplateName | Specifies the name of the new template to create. |
Syntax
AdminServerManagement.createAppServerTemplate(nodeName, serverName, newTemplateName)
Example usage
AdminServerManagement.createAppServerTemplate("myNode", "myServer", "myNewTemplate")
createGenericServer
This
script configures a new generic server in the configuration. A generic
server is a server that the application server manages, but does not
supply. If you do not want to set an argument, specify an empty string
as the value for the argument, as the following syntax demonstrates: ""
.
Argument | Description |
---|---|
nodeName | Specifies the name of the node on which to create the server. |
newServerName | Specifies the name of the server to create. |
templateName | Optionally specifies the template to use to create the server. |
startCmdPath | Optionally specifies the path to the command that will run when this generic server is started. |
startCmdArguments | Optionally specifies the arguments to pass to the startCommand when the generic server is started. |
workingDirectory | Optionally specifies the working directory for the generic server. |
stopCmdPath | Optionally specifies the path to the command that will run when this generic server is stopped. |
stopCmdArguments | Optionally specifies the arguments to pass to the stopCommand parameter when the generic server is stopped. |
Syntax
AdminServerManagement.createGenericServer(nodeName, newServerName, templateName,
startCmdPath, startCmdArguments, workingDirectory, stopCmdPath, stopCmdArguments)
Example usage
AdminServerManagement.createGenericServer("myNode", "myServer",
"default", "", "", "c:\temp", "", "")
AdminServerManagement.createGenericServer("myNode", "myServer",
"default", "", "", "/temp", "", "")
createWebServer
This
script configures a web server in your configuration. An application
server works with a web server to handle requests for dynamic content,
such as servlets, from web applications. A web server uses Web Server
Plug-ins to establish and maintain persistent HTTP and HTTPS connections
with an application server. If you do not want to set an argument,
specify an empty string as the value for the argument, as the following
syntax demonstrates: ""
.
Argument | Description |
---|---|
nodeName | Specifies the name of the node on which the web server is defined. |
newServerName | Specifies the name of the web server to create. |
port | Optionally specifies the port from which to ping the status of the web server. |
serverInstallRoot | Optionally specifies the fully qualified path where the web server is installed. This field is required if you are using IBM® HTTP Server. For all other web servers, this field is not required. If you enable any administrative function for non-IBM HTTP Server web servers, the installation path is necessary. |
pluginInstallPath | Specifies the installation path for the Web server plug-in. |
configFilePath | Specifies the configuration file for your Web server. Specify the file and not just the directory of the file. The application server generates the plugin-cfg.xml file by default. The configuration file identifies applications, application servers, clusters, and HTTP ports for the web server. The web server uses the file to access deployed applications on various application servers. |
windowsServiceName | Specifies the Windows Operating System name for the web server. |
errorLogPath | Specifies the location of the error log file. |
accessLogPath | Specifies the location of the access log file. |
webProtocol | Specifies the protocol to use for web server
communications. Use the HTTPS protocol to securely
communicate with the web server. The default is HTTP . |
Syntax
AdminServerManagement.createWebServer(nodeName, newServerName, port,
serverInstallRoot, pluginInstallPath, configFilePath,
windowsServiceName, errorLogPath, accessLogPath, webProtocol)
Example usage
AdminServerManagement.createWebServer("myNode", "myWebServer", "", "", "", "", "", "", "", "" )
deleteServer
This script removes a server from the application server configuration.
Argument | Description |
---|---|
nodeName | Specifies the name of the node of interest. |
serverName | Specifies the name of the server to delete. |
Syntax
AdminServerManagement.deleteServer(nodeName, serverName)
Example usage
AdminServerManagement.deleteServer("myNode", "myServer")
deleteServerTemplate
This script deletes a server template from your configuration.
Argument | Description |
---|---|
templateName | Specifies the name of the template to delete. |
Syntax
AdminServerManagement.deleteServerTemplate(templateName)
Example usage
AdminServerManagement.deleteServerTemplate("newServerTemplate")