The scripting library provides Jython script procedures
to assist in automating your environment. Use the scripts in the AdminResources
script library to configure mail, URL, and resource settings.
Before you begin
Before you can complete this task, you must install an application
server in your environment.
About this task
Scripting 程式庫提供一組自動執行最常見應用程式伺服器管理功能的程序。
Jython Script 程式庫有三種使用方式。
- 利用 wsadmin 工具,以互動模式執行 Jython Script 程式庫中的 Script。
您可以啟動 wsadmin 工具,然後利用下列語法來執行併入 Script 程式庫的個別 Script:
wsadmin>AdminServerManagement.createApplicationServer("myNode", "myServer", "default")
- 利用文字編輯器,依照下列範例所示,將 Jython Script 程式庫中的若干 Script 結合起來:
#
# My Custom Jython Script - file.py
#
AdminServerManagement.createApplicationServer("myNode", "Server1", "default")
AdminServerManagement.createApplicationServer("myNode", "Server2", "default")
# 使用其中一個作為叢集的第一個成員
AdminClusterManagement.createClusterWithFirstMember("myCluster", "APPLICATION_SERVER",
"myNode", "Server1")
# 新增第二個成員到叢集中
AdminClusterManagement.createClusterMember("myCluster", "myNode", "Server3")
# 安裝應用程式
AdminApplication.installAppWithClusterOption("DefaultApplication",
"..\installableApps\DefaultApplication.ear", "myCluster")
# 啟動節點上的所有伺服器和應用程式
AdminServerManagement.startAllServers("myNode")
請將自訂 Script 儲存起來,然後依照下列語法所示,從指令行執行它:
bin>wsadmin -language jython -f path/to/your/jython/file.py
- 利用 Jython Scripting 程式庫程式碼作為撰寫自訂 Script 的語法範例。
Script 程式庫中的各個 Script 範例示範撰寫 wsadmin Script 的最佳實務。
Script 程式庫程式碼位於app_server_root/scriptLibraries 目錄中。
在這個目錄內,Script 是先依照功能組織成子目錄。
例如,app_server_root/scriptLibraries/application/V70
子目錄所包含的程序會執行適用於產品 7.0 版及更新版本的應用程式管理作業。Script 程式庫路徑中的 V70 子目錄不表示
在該子目錄中的 Script 為 7.0 版 Script。
The
resource management procedures in scripting library are located in
a
app_server_root/scriptLibraries/resources/ subdirectory.
Each script from the directory automatically loads when you launch
the wsadmin tool. To automatically load your own Jython scripts (
*.py)
when the wsadmin tool starts, create a new subdirectory and save existing
automation scripts under the
app_server_root/scriptLibraries directory.
最佳作法: To create custom scripts using the scripting library
procedures, save the modified scripts to a new subdirectory to avoid
overwriting the library. Do not edit the script procedures in the
scripting library.
bprac
You can use the AdminResources.py scripts
to perform multiple combinations of administration functions. See
the documentation for the resource configuration scripts for additional
scripts, argument descriptions, and syntax examples.
The example
script configures a custom mail provider and session. A mail provider
encapsulates a collection of protocol providers like SMTP, IMAP and
POP3, while mail sessions authenticate users and controls users' access
to messaging systems. Configure your own mail providers and sessions
to customize how JavaMail is handled.
Procedure
- Optional: Launch the wsadmin tool.
Use
this step to launch the wsadmin tool and connect to a server, job
manager, or administrative agent profile, or run the tool in local
mode. If you launch the wsadmin tool, use the interactive mode examples
to run scripts.
When the wsadmin tool launches, the system
loads all scripts from the scripting library.
- Create a mail provider.
Run the createMailProvider
script from the AdminResources script library, specifying the node
name, server name, and new mail provider name, as the following example
demonstrates:
wsadmin -lang jython -c "AdminResources.createMailProvider(myNode, myServer, newMailProvider)"
You
can also use interactive mode to run the script procedure, as the
following example demonstrates:
wsadmin>AdminResources.createMailProvider(nodeName, serverName, mailProviderName)
- Define the protocol provider for the mail provider.
You can also configure custom properties, classes, JNDI name,
and other mail settings with this script. See the documentation for
the resource configuration scripts for argument descriptions and syntax
examples. Run the configMailProvider script from the AdminResources
script library to define the protocol provider, as the following example
demonstrates:
wsadmin -lang jython -c "AdminResources.configMailProvider(myNode, myServer, newMailProvider, "", "", "SOAP", "", "", "", "", "", "")"
You can also use interactive mode to run the script
procedure, as the following example demonstrates:
wsadmin>AdminResources.configMailProvider(myNode, myServer, newMailProvider, "", "", "SOAP", "", "", "", "", "", "")
- Create the mail session.
Run the createMailSession
script from the AdminResources script library, specifying the node
name, server name, mail provider name, mail session name, and Java™ Naming and Directory Interface (JNDI) name
arguments, as the following example demonstrates:
wsadmin -lang jython -c "AdminResources.createMailSession("myNode", "myServer", "newMailProvider", "myMailSession", "myMailSession/jndi")"
You
can also use interactive mode to run the script procedure, as the
following example demonstrates:
wsadmin>AdminResources.createMailSession("myNode", "myServer", "newMailProvider", "myMailSession", "myMailSession/jndi")
- Save the configuration changes.
請利用下列指令範例來儲存您的配置變更:
AdminConfig.save()
- Synchronize the node.
To propagate the configuration
changes to the node, run the syncNode script procedure from the AdminNodeManagement
script library, specifying the node of interest, as the following
example demonstrates:
wsadmin -lang jython -c "AdminNodeManagement.syncNode("myNode")"
You
can also use interactive mode to run the script procedure, as the
following example displays:
wsadmin>AdminNodeManagement.syncNode("myNode")
Results
The wsadmin script libraries return the same output as
the associated wsadmin commands. For example, the AdminServerManagement.listServers()
script returns a list of available servers. The AdminClusterManagement.checkIfClusterExists()
script returns a value of true if the cluster exists,
or false if the cluster does not exist. If the command
does not return the expected output, the script libraries return a
1 value when the script successfully runs. If the script fails, the
script libraries return a -1 value and an error message with the exception.
By
default, the system disables failonerror option. To enable this option,
specify
true as the last argument for the script
procedure, as the following example displays:
wsadmin>AdminApplication.startApplicationOnCluster("myApplication","myCluster","true")
What to do next
Create custom scripts to automate your environment by
combining script procedures from the scripting library. Save custom
scripts to a new subdirectory of the app_server_root/scriptLibraries directory.