Websphere wsadmin

© Copyright IBM Corporation 2006Course materials may not be reproduced in whole or in part without the prior written permission of IBM. 4.0.2

Introduction to wsadmin and scripting

© Copyright IBM Corporation 2006

Unit objectives

After completing this unit, you should be able to:● Explain the purpose of wsadmin● Describe wsadmin administration objects● Obtain help for wsadmin and its commands● Explain the use profile scripts● Explain the use property files● Set up AST to code, test and debug Jython scripts● Set up WebSphere Administration Command assist● Discuss ANT and ws_ant


Why use scripting?

●Making configuration changes using the WebSphere administrative console is error prone and dangerous in production environments

●Scripting is beneficial for production environments, especially with multiple nodes

●Allows multiple configuration changes/updates to be applied to all targeted resources in an efficient and consistent manner

●Allows for automating of routine administration tasks without having to rely on an operator running the administrative console

●Scripts can be scheduled to run at times when it might be inconvenient to have an operator at the administrative console


wsadmin – Introduction

●Provides– Scripting capabilities– Command line administration

●Common operational and configuration tasks can be performed from scripts and command line instead of through the administrative console

●Examples:– Start and stop deployment manager, nodes, application servers,

enterprise applications and clusters– Configure virtual hosts, JDBC providers, JMS resources– Create application servers– Create clusters and add members to a cluster– Almost all tasks available through administrative console


wsadmin overview● wsadmin modes

– Command line– Interactive– Script file

● Support for:– Python commands through Jython– Tcl commands through Java Command Language (Jacl)

● Jacl versus Jython– Use comes down to a personal choice– Jython syntax seems more natural to programmers used to Java or C– Jacl syntax can be more familiar to administrators who are familiar with Tcl– Each language has its own style and syntax, but they end up being able to

do the same things– Jacl to be deprecated in V6.1

• Still supported for the next two versions• Conversion assistant tool available to convert from Jacl to Jython (Jacl2Jython)• Much better support in tooling

– AST (Jython editor, command completion, debugger)– WebSphere administrative console (Console Command Assistance)


wsadmin versus administration console

Write

ReadApplication

Server

Jython or Jacl Script

Configuration(XML Files)

wsadmin

Interactive


wsadmin administrative functions

Running Application ServerRepository

● WebSphere Application Server system management separates administrative functions into two categories:– Configuration of WebSphere Application Server installations (repository) – Running objects in WebSphere Application Server installations


MBean

Script(s) wsadminMBean

MBean

MBean

AdminApp

AdminConfig

AdminControlAdminTask

Resources

wsadmin MBeans● wsadmin acts as an interface to Java objects for access by scripts● wsadmin uses the same interface (through JMX) as the administrative

console to make configuration changes and control servers● There are five administrative objects that perform different operations

– AdminControl – work with "live" running objects, perform traces and data type conversion

– AdminConfig – create/change WebSphere Application Server "static" configuration

– AdminApp – install, modify or administer applications– AdminTask – access administrative commands to provide alternate way to

access configuration commands– Help – provides help


wsadmin with connection type●wsadmin –conntype [SOAP | RMI | NONE ]

– The –conntype specifies the protocol type– Default is SOAP– NONE allows wsadmin to read and write directly to configuration files

without going through an application server

●wsadmin –profile <profile_script_name>– Allows wsadmin to preload a profile script


Invoking wsadmin with security enabled● If security is enabled, authentication information

must be supplied for server communications● User name and password can be supplied in

one of several ways:– Command line parameters– sas.client.props file for connecting with RMI– soap.client.props file for connecting with

SOAP– Encode password with PropFilePasswordEncoder

script– Prompted

● Security related wsadmin commands:– securityoff– securityon user password


Profile scripts● Profile scripts can be used to

preload wsadmin with predefined settings and functions – Run during wsadmin startup– Called by either:

• Using the –profile parameter on the command line

• Defined in wsadmin.properties com.ibm.ws.scripting.profiles=

– Could be used to create a standard wsadmin environment for all WebSphere administrators

– Profile scripts can be written in Jython or Jacl


There are several ways to invoke wsadmin:

•Command option wsadmin [-c command]

•Script file wsadmin [-f scriptfile]

•Interactively wsadmin

Invoking wsadmin


wsadmin properties● Certain default behaviors for wsadmin can be changed by editing

<profile_root>\<profile_name>\properties\wsadmin.properties

● Properties include:– com.ibm.ws.scripting.connectionType=SOAP– com.ibm.ws.scripting.port=8880– com.ibm.ws.scripting.host=localhost– com.ibm.ws.scripting.defaultLang=jython– com.ibm.ws.scripting.traceFile=– com.ibm.ws.scripting.validationOutput=– com.ibm.ws.scripting.traceString=com.ibm.*=all=enabled– com.ibm.ws.scripting.profiles=– com.ibm.ws.scripting.emitWarningForCustomSecurityPolicy=true

– com.ibm.ws.scripting.tempdir=– com.ibm.ws.scripting.validationLevel=– com.ibm.ws.scripting.crossDocumentValidationEnabled=– com.ibm.ws.scripting.classpath=


AdminApp – Managing applications●Application management scripts use the AdminApp object to manageapplications in the application server configuration

●Example:

● Use the AdminApp object to:– Install and uninstall applications– List installed applications– Edit application configurations– Obtain help

Jacl

Jython


AdminControl – Managing running objects

● Use the AdminControl object to:– List running objects and their attributes– Invoke actions on running objects– Obtain dynamic information about Mbeans that represent running objects– Obtain help

Jacl

Jython

● Operation management scripts use the AdminControl object to communicate with the MBeans that represent running objects

● Example:


AdminTask – Accessing admin functions● Used to access set of administrative commands to provide alternate

way to access configuration commands● Runs simple and complex commands● Grouped based on their function

– Example: Commands related to security are grouped into a security management command group

● Can be run in batch or interactive mode● Can be run in connected or local mode

– If run in local mode not all commands available

Jacl

Jython


Help within wsadmin● Jython

– print Help.help()– print Help.AdminConfig()– print Help.AdminTask()– print Help.AdminControl()– print Help.AdminApp()

● Jacl– $Help help– $AdminConfig help– $AdminTask help– $AdminControl help– $AdminApp help


Help on specific commands● Help can be obtained on specific commands within the

administration objects

Jacl

Jython


wsadmin – Important points to remember

●Commands are case-sensitive

●wsadmin -f "scriptfile" faster than wsadmin -c "command"– Better to run multiple commands in a script file than individual

commands with wsadmin –c

●Saving configuration changes is a two step process:– First part validates the changes– Second part performs the save but will throw an exception if changes

conflict (example: creating two servers with the same name)

●Save periodically in the script file or interactive mode to persist configuration updates to existing objects– AdminConfig.save() (Jython)– $AdminConfig save (Jacl)


Scripting – Simple script

JaclJython


Scripting – Looping

JaclJython


Create, test, and debug scripts with AST● Jython projects and source files fully supported in IDE

– Create Jython project and files– Syntax colored editor, command completion– Source Outline view– Source level debugging


Launch Jython debugger● To launch the Jython debugger

– Select the script’s context menu– Select Debug As -> Administration script

● First time requires setup of:– Provide any runtime parameters– Security information for server– Click Debug


Debugger perspective


WebSphere Administration Command assist● Works in concert with administrative console

– Makes last executed commands available in AST– Commands can be pasted directly to Jython script

● Server side setup– Select Applications -> Enterprise Applications– Under Help -> Command Assistance, click View administrative scripting

command for last action – Expand Preferences and enable both options.


WebSphere Administration Command assist● AST setup

– Add WebSphere Administration Command view• Select Window -> Show View -> Other -> Server -> WebSphere Administration

Command– Open the WebSphere Administration Command view– Connect to server using first toolbar button

– Select desired command– Copy into open Jython script file using second toolbar button


Build tool: Apache Ant

●Another Neat Tool written and extended in Java

●Cross platform– Unless you choose to invoke shell commands

●Write scripts by writing Ant targets which– Invoke Ant tasks– Invoke WebSphere tasks– Depend on other targets– May have the side effect of creating an artifact

●Ant tasks implemented in Java– Use existing– Write your own

●WebSphere ships own version: ws_ant


WebSphere Ant tasks

●WebSphere Application Server includes Ant tasks to:– Install and uninstall applications – Run EJB deployment and JSP pre-compilation tools – Start and stop servers – Run administrative scripts or commands

●To run Ant use the ws_ant command

●For complete set of WebSphere Ant tasks and how to use them, see InfoCenter under:– Reference -> Developer -> API Documentation -> Application

programming interfaces -> Package com.ibm.websphere.ant.tasks


Some WebSphere Ant tasks

●wsStartServer, wsStopServer, wsServerStatus

●wsInstallApp, wsUninstallApp, wsUpdateApp, wsListApps

●wsejbdeploy, wsdeploy, JspC

●WSDL2Java, Java2WSDL

●wsadmin


Checkpoint questions

1. What are the five Java objects that perform different operations?

2. Which MBean is used to access set of administrative commands to provide alternate way to access configuration commands?

3. The default protocol type for wsadmin is?A. SOAPB. RMIC. None

4. The default behaviors for wsadmin can be changed by editing which file?


Checkpoint solutions

1. AdminConfig, AdminApp, AdminControl, AdminTask, Help

2. AdminTask

3. The default protocol type for wsadmin is?A. SOAP

4. wsadmin.properties


Unit summary

Having completed this unit, you should be able to:● Explain the purpose of wsadmin● Describe wsadmin administration objects● Obtain help for wsadmin and its commands● Explain the use of profile scripts● Explain the use of property files● Set up AST to code, test and debug Jython scripts● Set up WebSphere Administration Command assist● Discuss ANT and ws_ant


Lab exercise

Exercise 8:Experimenting with wsadmin and scripting

Documents

Websphere wsadmin