IBM Software Group

WebSphere Administration
A practical guide to WebSphere scripted administration
options

Andrew Simms, Consulting IT Specialist

IBM SWG WebSphere Services
[email protected]

WebSphere UK User Group - October 2004

© 2004 IBM Corporation
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

WebSphere Administration: What we’ll cover

2 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

What we’re going to do . . .

ƒ Talk through and demonstrate configuration scripts that:
o set the initial heap and maximum heap size
o add or change environment entries
o set the maximum requests per keep-alive value of a particular transport
o display the changed values
ƒ Talk through and demonstrate application deployment scripts.
ƒ From these hope to see the relative merits of each tool

3 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Tool 1: The Admin Console

ƒ You could avoid writing scripts by using the Admin Console to perform
configuration tasks and install applications
ƒ If you like typing and don’t make mistakes, this is the tool for you
ƒ Going to:
o select server1
o navigate to Process Definition + Java Virtual Machine and change heap sizes
o navigate to Process Definition + Environment Entries and change envvars
o navigate to Web Container + HTTP Transports, select the SSL-disabled
transport, select Custom Properties and add a new property
o install an application
ƒ Similar navigation on v4
ƒ http://ajsnode1:9090/admin

4 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Admin Console: Comments

ƒ Different look and feel in v4 and v5
ƒ v5.1 & v6 have same look and feel as v5
ƒ Use for ad hoc configuration and operational tasks, e.g.:
o building a playpen environment
o examining transactions
o examining product information
o controlling trace and examining logs
ƒ Avoid for bulk and repetitive tasks
ƒ Useful early in the test cycle
ƒ Use when some task is just too difficult or expensive to script

5 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

So why not just use the Admin Console?

ƒ Consider:
o you have N1 domains/cells
o N2 test environments
o N3 application servers or server groups (clusters) in each domain/cell
o N4 enterprise applications
o N5 drops received from development for each app
ƒ If Ni ≈ 1 for each i, then you could use the Admin Console
ƒ When Ni >> 1 then using Admin Console becomes tedious and error prone
ƒ Solution: script domain/cell builds and enterprise application
installations
ƒ Up front cost but in the long term you save administrator costs and
provide a more reliable service.

6 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Tool 2: wscp
ƒ What is it?
o v4’s configuration and runtime scripting language
ƒ Main features:
o Extension of Tcl, the Tool Command Language
• Tcl is portable across many platforms
• Tcl widely used for scripting tasks, not just WebSphere
• Simple to learn, powerful to use
o Interactive or scripted access
o Typically used for bulk and repeatable tasks, e.g.:
• Add a set of definitions in a repeatable manner
• Change the value of a system property on all servers in all domains (but
not easily)
o Can do most things that can be done in the Admin Console

7 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

wscp: Style of usage

ƒ Command line /script
ƒ Three modes of operation:
o interactive
o single command (-c option)
o run a script (-f option)
ƒ Access resources using <class> <verb> <object> <options>, e.g.:
o J2CResourceAdapter create <name> –attribute {{Name fred}
{ArchiveFile freda}}
ƒ Names look like this:
o /Node:ajsnode/Server:server1/
o /JDBCDriver:schumacher/DataSource:button/
ƒ Lots of curly brackets!!, e.g.:
o ServerGroup show <name> –attribute EJBServerAttributes
o ServerGroup modify <name> -attribute {{EJBServerAttributes
{WebContainerConfig {SessionManagerConfig {EnableUrlRewriting
true}}}}}

8 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

wscp: Example Code

ƒ Code:
o sample_wscp.tcl (about 90 lines)
o sample_wscp_install.tcl (about 20 lines)
ƒ Reset before running:
o sample_swan_reset_wscp.bat
ƒ Run it:
o sample_wscp.bat
o sample_wscp_install.bat

9 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Tool 3: XMLConfig
ƒ What is it?
o v4’s XML configuration utility
ƒ Main features:
o Private to WebSphere, unlike Tcl
o Exports full or partial repository to an XML file
o Imports from XML file with arbitrary substitutions
o Not interactive (but can be called interactively from wscp)
o Can create, update or delete objects
o Can start/stop objects
o Typically used for repeatable tasks, e.g.:
• Add a set of definitions in a repeatable manner
o Can be invoked from Admin Console, shell or wscp

10 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

XMLConfig: Style of Usage

ƒ Command
ƒ Run xmlconfig –export to export the entire domain to an XML file
ƒ Run xmlconfig –export –partial <file> to export part of a domain to
an XML file, where <file> directs what is to be exported
ƒ Edit the generated XML file:
o remove unwanted bits
o change values to variable names to allow substitution
ƒ Run xmlconfig –import to import from the XML file to a new or the
same domain, usually with substitutions
ƒ Can also build the XML file by hand

11 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

XMLConfig: Example Code

ƒ Code:
o sample_xmlconfig_partial_export.xml (7 lines)
o sample_xmlconfig_partial_export_output.xml (c200 lines, generated)
o sample_xmlconfig_import.xml (50 lines, edited)
o sample_xmlconfig_partial_export_install.xml (5 lines)
o sample_xmlconfig_partial_export_output_install.xml (c70 lines, generated
& edited)
ƒ Reset before running:
o sample_swan_reset_wscp.bat
ƒ Run it:
o sample_xmlconfig.bat
o sample_xmlconfig_install.bat

12 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

wscp is better than XMLConfig is better than wscp

wscp XMLConfig
Is a powerful procedural scripting language Is a utility that allows simple substitutions
with variables and has limited actions
Is based on a Java implementation of a popular Its output is XML, but the utility is unique to
scripting language (Tcl) WebSphere
Represents WebSphere objects as commands Places actions in XML attributes (rather like
(e.g. ApplicationServer) with verbs (e.g. ANT)
“start”, “modify”)

Is a natural choice for doing anything in bulk or Is a good choice for repetitive tasks where
repetitive changes are simple substitutions
Is not dependent on having something built Is dependent on creating something first
manually first manually (unless you create the XML by hand)
Can be used for ad hoc purposes interactively Export+partial can do some ad hoc tasks
(but not always easily)

13 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Scripted options in v5 & v5.1 & v6

ƒ Gone!
ƒ Replacement for wscp: wsadmin
o But provides a completely different set of objects
o wscp scripts are not migratable to wsadmin
ƒ Replacement for XMLConfig: nothing
o Repository now a set of XML files
o Expectation that customers would copy/edit directories/files
o Proved too hard
o Some as-is scripts available on WebSphere Developer Domain for doing
XMLConfig-like things (v5.1.2)
o Some more XMLConfig-like things in v6 and beyond

14 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Tool 4: wsadmin
ƒ What is it?
o v5’s scripting language
ƒ Main features:
o Uses the Bean Scripting Framework (BSF)
• Provides access to Java objects and methods from supported scripting
languages.
• Architecture for easily incorporating scripting into Java applications
and applets
• Applications independent and not bound to a single scripting language
• Different language scripts can access Java objects using wsadmin
o Current supported languages for wsadmin:
• Jacl - Java Command Language based on Tcl scripting
• Jython – Java implementation of the OO language Python

15 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Tool 4: wsadmin
ƒ How is it different from wscp?
o The WebSphere objects are completely different from wscp
o Tcl is easy to learn, but wsadmin is complex
o Separates static configuration from dynamic changes
ƒ Typically used for bulk and repeatable tasks, e.g.:
o Add a set of definitions in a repeatable manner
o Change the value of an environment variable on all servers in all cells
ƒ Can do everything in the Admin Console, but not in a necessarily intuitive
manner

16 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

wsadmin: JMX MBeans

ƒ wsadmin acts as an interface to Java objects for access by scripts
o Objects communicate with MBeans (JMX management objects)
ƒ Objects perform different operations. There are four built-in objects:
o $AdminConfig (Jacl) or AdminConfig (Jython)
• Create or change the WebSphere configuration
o $AdminApp (Jacl) or AdminApp (Jython)
• Install, modify, or administer applications
o $AdminControl (Jacl) or AdminControl (Jython)
• Work with live running objects and perform traces and data type conversion
o $Help (Jacl) or Help (Jython)
• Display general help information and details about which MBeans are running
ƒ Separation between Configuration and Control

p
inAp
m MBean
Ad
AdminConfig MBean
Script wsadmin AdminControl
H
el

MBean
p

MBean

17 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

wsadmin: Style of usage

ƒ Command line / script
ƒ Three modes of operation:
o interactive
o single command (-c option)
o run a script (-f option)
ƒ Connect over SOAP or RMI
ƒ Pass language identifier to wsadmin command – Jacl assumed
ƒ Access configuration resources using AdminConfig. In Jacl:
o set id [$AdminConfig getid <name>]
o $AdminConfig modify $id {{name fred} {desc “fred bloggs”}}
ƒ And in Jython:
o id = AdminConfig.getid(<name>)
o AdminConfig.modify(id, “[[name fred], [desc ““fred bloggs””]]”
ƒ Configuration names look like this:
o /Cell:ajs_cell/Node:ajsnode/Server:server1/
o /JDBCProvider:schumacher/DataSource:button/

18 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

wsadmin: Style of usage (2)

ƒ Access runtime resources using AdminControl. In Jacl:
o set mbeanId [$AdminConfig getObjectName $id]
o $AdminControl invoke $mbeanId getState
ƒ And in Jython:
o mbeanId = AdminConfig.getObjectName($id)
o AdminControl.invoke(mbeanId, getState)
ƒ Runtime names look like this:
o WebSphere:platform=common,cell=ajs_cell,version=5.0.1,name=NodeAgen
t,mbeanIdentifier=NodeAgent,type=NodeAgent,node=ajsnode1,process=no
deagent

19 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

wsadmin: Some Operations and Functions

ƒ $AdminConfig ƒ $AdminApp ƒ $AdminControl ƒ $Help
o attributes o deleteUserAndGroupEntries o completeObjectName o attributes
o convertToCluster o edit o getAttribute o operations
o create o editInteractive o getAttributes o constructors
o export o getCell o description
o createClusterMember
o exportDDL o getConfigId o classname
o createUsingTemplate
o install o getHost o all
o defaults o installInteractive o getMBeanCount o AdminControl
o getid o list o getNode o AdminApp
o getObjectName o listModules o getPort o AdminConfig
o installResourceAdapter o options o getType o wsadmin
o list o publishWSDL o invoke o message
o listTemplates o taskInfo o makeObjectName
o modify o uninstall o queryNames
o parents o setAttribute
o reset o setAttributes
o startServer
o save
o stopServer
o show
o testConnection
o showall o trace
o showAttribute
o types

20 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

wsadmin: Miscellaneous
ƒ Commands are case-sensitive
ƒ Configuration changes not persisted until "save" call
ƒ If multiple scripts or clients (Administrative Console) are saving
configuration changes at the same time, exception thrown on
Save call
o No changes will be persisted
ƒ Upon "save" call, validation procedure verifies updates
o Create two servers with the same name throws exception
ƒ wsadmin -f "xxxxx" much faster than wsadmin -c "xxxxx"
o Better to run multiple commands in a file than individual commands
o Call "save" in file periodically to persist configurations updates
• Avoids no changes being persisted should an exception occur

21 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

wsadmin: Installing an Application

ƒ Use $AdminApp
ƒ Can use interactively inside a command
ƒ Can get the configurable options from an EAR file
o $AdminApp options myapp.ear
ƒ Then can get the task information for each option:
o $AdminApp taskInfo myapp.ear MapWebModToVH
ƒ Could then use this info to help build the relevant options for
installation:
o $AdminApp install myapp.ear {-appname freda -MapWebModToVH
{{{Default Application} default_app.war,WEB-INF/web.xml
myvhost}} -<lots of other options . . .>}
ƒ Just as difficult to construct this as in wscp

22 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

wsadmin: Example Code

ƒ JACL Code:
o sample_wsadmin.tcl (about 90 lines)
o sample_wsadmin_install.tcl (about 25 lines)
ƒ Jython Code:
o sample_wsadmin.py (about 90 lines)
ƒ Reset before running:
o sample_swan_reset_wsadmin.bat
ƒ Run JACL:
o sample_wsadmin_jacl.bat
o sample_wsadmin_install_jacl.bat
ƒ Reset before running:
o sample_swan_reset_wsadmin.bat
ƒ Run Jython:
o sample_wsadmin_py.bat

23 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Jacl is better than Jython is better than Jacl

ƒ Not that different
ƒ If you can program in one you can probably program in the other
ƒ Jacl may suit shell script programmers
ƒ Jython may suit those with OO background
ƒ Both take just as much as code as the other in our example

24 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Tool 5: ws_ant (ANT)

ƒ What is it?
o ANT – Java-based, platform-neutral, open source build tool
o ws_ant: Copy of Apache ANT with task extensions to support WebSphere-
specific capabilities
ƒ Main Features:
o Tasks provided include:
• Install and uninstall applications
• Start and stop servers
• Run administration scripts or commands
o But the admin task is just a call to wsadmin – you still have to write the
wsadmin code to do the actual configuration
o Main advantage is ability to build the EAR, run a configuration script and
then install the EAR, all from a single ws_ant build.xml.

25 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

ws_ant: Style of Usage

ƒ Command-oriented
ƒ Specify tasks, targets and dependencies between targets
ƒ Connect over SOAP or RMI
ƒ Pass language identifier to wsadmin command – Jacl assumed

26 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

ws_ant: Example Code

ƒ Code:
o build.xml (45 lines)
o sample.props (20 lines)
ƒ Reset:
o sample_swan_reset_wsadmin.bat
ƒ Run it:
o sample_wsant_wsadmin.bat
o sample_wsant_install.bat

27 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Tool 6: WsAdmin Automation Platform (WAP)

ƒ What is it?
o Set of utility functions sitting over wsadmin
o Eases a lot of wsadmin hassle
ƒ Main features:
o Available from IBM Techdocs, the Technical Sales Library
o Not supported by IBM: provided “as is”
o Greatly simplifies many wsadmin scripting tasks
o Provides a library of Tcl procedures for creating, modifying and deleting WebSphere
objects (e.g. application servers, data sources)
o Runs on 5.0 and 5.1
o Syntax (on Windows):
• set WAP_SOURCE=/installed/wap
• set PATH=%PATH%;%WAP_SOURCE%
• jwap.bat

28 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

WAP: Style of usage

ƒ Command line / script
ƒ Runs over wsadmin, so:
o Three modes of operation:
• interactive
• single command (-c option)
• run a script (-f option)
o Connect over SOAP or RMI
ƒ Jacl only (not Jython)
ƒ Set subsequent commands’ scope:
o setNode ajsnode1
o setServer server1
ƒ Provides a number of Jacl procedures named:
o createXXX, removeXXX, modifyXXX
o e.g. createCustomService, modifyJDBCProvider
ƒ Pass parameters as dash-options, plus “you-name-it” options

29 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

WAP: Style of usage (2)

ƒ Names become simpler (no need for /Cell:xxx/Node:xxx/Server:xxx/)
ƒ Not all documented:
o getIDByListing & modifyConfigObject are not documented but very useful
ƒ Mainly aimed at create/modify/delete
o little support for display & list
o “list” does not return as Tcl lists so you can’t do “foreach” style processing

30 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

WAP: Example Code

ƒ Code:
o sample_wap.tcl (c90 lines)
ƒ Reset:
o sample_swan_reset_wsadmin.bat
ƒ Run it:
o sample_wap.bat

31 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

WAP: Installing an application

ƒ Use the installApplication command

ƒ Pass customisations in same way as wsadmin’s $AdminApp install:
installApplication -appname fred -earfile
/installed/websphere/appserver/base5.1/installableApps/ivtApp.ear \
{-MapModulesToServers {{{IVT Application} ivt_app.war,WEB-
INF/web.xml WebSphere:cell=ajs_cell,node=ajsnode1,server=server1}}}

ƒ -interact option to customise by answering questions (couldn’t get this to work)

ƒ Can install then customise afterwards using the editApplication command
ƒ Not really any different from $AdminApp
ƒ About 15 long statements in our example

32 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Tool 7: JMX
ƒ What is it?
o Java Management Extensions (JMX) is a framework oriented at managing applications
and resources (like application servers)
• Allows for exposing your application to remote or local management tools
• JMX is a specification oriented to the application and network management
• Part of J2SE
ƒ Main Features:
o Some of the JMX functionality:
• Allows you to query the configuration settings and change them at runtime
• Provides services such as monitoring, event notification, timers, ....
• Allows you to load, initialize, change, and monitor application components and
resources
o Structured in three layers:
• Instrumentation layer - MBeans
• Agent layer - MBeanServer and agents
• Distributed Services (this part is still out of the scope of the current level of the
specs)
JSR-077

33 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

About JMX: How does JMX work?

ƒ Resources are managed by Managed Beans (MBeans)
o These are simple JavaBeans that perform operational or configuration changes
on resources
ƒ MBeans provide APIs to the external world to manage its resources
o Each JMX-enabled JVM contains a MBean Server (Managed Bean Server) that
registers all the MBeans in the system
• MBean Server provides access to all of its registered MBeans
o External programs access MBeans registered on the MBean Server via
Connectors/Adapters

JVM
Resources
External tools
Connector MBeans
and programs MBean
Server
MBeans

34 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

JMX Benefits
ƒ Enables Java applications to be managed without heavy investment
o Relies on a core managed object server that act as a ‘management agent’
o Java application simply needs to embed a managed object server and make some of its
functionality available as one or several Manageable Beans registered in the object
server
ƒ Provides a scalable management architecture
o Every JMX agent service is an independent module that can be plugged into the
management agent
ƒ Integrates existing management solutions
o JMX smart agents are capable of being managed through HTML browsers or by
various management protocols such as Web Services, JMS, SNMP, etc.
ƒ Defines only the interfaces necessary for management

35 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

JMX: Architectural Principles

Management Application

Connector Adapter

Agent Layer

MBean Server

Agent Agent Agent Services

Services Services (as MBeans)

Resource 1 Resource 2 Instrumentation

MBean MBean Layer
Manages Manages

Resource 1 Resource 2 Managed Resources

JVM

36 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

WebSphere JMX Architecture

ƒ All WebSphere 5.0 processes run the JMX agent
ƒ All WebSphere 5.0 runtime administration is done through JMX operations

E xternal tools and prog ram s

W ebS phere A pplication

H TTP S e rv er P rocess
SNMP
JM X
JM X
A dapter R M I/IIO P
A dapter
JM X
SOAP C onnector internal
JM X runtim e
C onnector M B ea n objects
S erver
M Beans
M B eans
M B ean
M B ean
P roxy
P roxy

In te rn al M B e an s reg iste r w ith loca l

E xternal M B eanS erver M B ea nS e rve r.
E xte rn al M B e an s h ave lo ca l proxy to the ir
Illustrates possibilities or future M B ea nS e rve r. P roxy registe rs w ith loca l
plans M B ea nS e rve r.

37 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

WebSphere Distributed Administration

Clients, Multi-cell
mgmt, & other EMS
(Tivoli, BMC)
Deployment Mgr

JMX
MBean Connector
Server
MBeans
MBeans
MBean
MBean
Proxy
Proxy

Node Mgr
Config Repository
Service
JMX
MBean Connector
Server To Other
Nodes Master
MBeans
Master
files
MBeans Master
files
To Other App MBean files
MBean
Servers Proxy
Proxy

App Server Config Distribution

Service

JMX
tmx4j Connector config
MBean files
MBean
Server
Server

MBeans
EAR files
MBeans

38 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

JMX: Some MBeans

ƒ Cell ƒ J2CConnectionFactory
ƒ Node ƒ JavaMailProvider
ƒ ManagedObject ƒ MailSession
ƒ ApplicationServer ƒ URLProvider
ƒ ServerCluster ƒ URL
ƒ JMSServer ƒ JDBCProvider
ƒ Application, EJBModuleConfig, ƒ DataSource, WAS40DataSource
WebModuleConfig ƒ ConnectionPool
ƒ EJBContainer, WebContainer ƒ ORBPlugin
ƒ ListenerPort ƒ JavaVirtualMachine
ƒ JMSProvider ƒ SecurityPermission
ƒ JMSConnectionFactory ƒ NameServer
ƒ JMSDestination ƒ LocalOSUserRegistry
ƒ J2CResourceAdapter

These Mbeans are built

into WebSphere – 224
of them in v5.1

39 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

How Can Customers Use JMX?

ƒ All WAS 5.0 Admin client programs use JMX
o Web Admin console
o wsadmin scripting
o Admin Client Java API
o Included in both Base App Server package and Advanced Deployment

ƒ Use the APIs to control WebSphere runtime

ƒ Extend the set of managed objects with custom JMX MBeans
ƒ Attach Admin clients to Cell Manager in order to access entire Admin domain
ƒ Node Agents start & monitor individual App Servers

40 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

JMX: Example Code

ƒ Code:
o sample_jmx.java (c160 lines)
ƒ Reset:
o sample_swan_reset_wsadmin.bat
ƒ Run it:
o sample_jmx.bat

41 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Tool 8: SWAN
ƒ What is it?
o Simplified WebSphere AdministratioN
o Greatly eases wscp and wsadmin hassle
ƒ Main features:
o Runs in wscp and wsadmin
o Obtainable from the author
o Runs on WebSphere v4, v5, v5.1
o Runs on Windows, AIX (probably all UNIXes) and z/OS
o Simplifies writing wscp and wsadmin scripts
o Simplifies interactive access
o Provides a high degree of portability between WebSphere versions

SWAN

wscp wsadmin

42 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

SWAN Syntax
ƒ <class> <verb> [<object>] [<options>] [<attributes>]
ƒ Examples:
o appserv list
o dsource list –format -short
o jcafact delete jack –ra jill
o resadapt create ada –rarfile /usr/product/somefile.rar
o cluster show clouseau +maxheap +minheap
o appserv show jeeves +webhttpbacklog –constraint {Host * Port 9080}
o appserv modify jeeves +webhttpbacklog 53 –constraint {Host * Port 9080}
o appserv modify –constraint {Host * Port 9080} +webhttpbacklog 57 jeeves
o jmsdest exists jack –jmsprov jill

43 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

SWAN is better than wscp/wsadmin is better than SWAN

ƒ In wscp/wsadmin you have to know how to reach a particular attribute

o Not a problem for many cases
• e.g. JDBCProvider has no attribute hierarchy
o Big problem for server groups and application servers
• have to understand the hierarchy to navigate through it
o SWAN solves this by hiding the hierarchy
ƒ In wscp/wsadmin you have long names:
o Long names for configuration and runtime objects
o Much of which is probably constant in your script (e.g. cell name & node
name)
o SWAN solves this by setting a scope and providing the –short option
ƒ In wscp/wsadmin you need long Tcl lists to set attributes:
o SWAN solves this because it has flattened the attribute hierarchy
ƒ wscp scripts cannot be migrated to wsadmin without complete rewriting:
o But wscp scripts written to use the SWAN syntax will be migratable
o Some changes will be needed though because of differences in v5

44 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

SWAN is better than wscp/wsadmin is better than SWAN

ƒ SWAN does not implement all of the object types:

o There are 224 in wsadmin in v5.1
o SWAN implements the most commonly used object types
o SWAN can be extended to implement the others – easily if they follow the
patterns of the current SWAN types
o You can always use the wsadmin types directly in your scripts
ƒ SWAN is not supported by IBM:
o SWAN is provided as-is
o Whereas wscp and wsadmin are supported

45 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

SWAN: Further Examples

ƒ Getting help:
o help
o dsource help
o jdbcdrv help create
o jcafact attributes
o jcafact attributes -details
o cluster create clouseau -member sellers –vertical 3
o cluster showmembers clouseau
o appserv makecluster jeeves –cluster wooster
o cluster start wooster
o cluster stop wooster -force

46 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

SWAN: Coverage
appserv Application servers
cell Domain or cell
cluster Clusters (server groups)
dsource Data sources
entapp Enterprise applications
jcafact J2C connection factories
jdbcdrv JDBC drivers (providers)
jmsdest JMS destinations
jmsfact JMS connection factories
jmsprov Generic JMS providers
mail Java mail
nagent Node agents
resadapt Resource adapters
vhost Virtual hosts

47 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Installing enterprise applications using SWAN

ƒ Packager or Deployer runs "entapp produceaid":
o Creates an XML file called an Enterprise Archive Application Installation
Descriptor (EAR AID)
o EAR AID houses all of the deployable options from the EAR file's
deployment descriptors
ƒ Intention is that the Deployer then edits this file using an XML or text
editor to set appropriate values (as would be done through the console)
ƒ Deployer then runs "entapp create":
o takes the EAR file and uses the AID file to install the enterprise app
o same procedure whether v4 or v5, but different EAR AID file
ƒ Non-SWAN software available to produce an Excel spreadsheet
containing the EAR AID file, and to transform it back
o makes it easier to edit

48 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

SWAN: Example Code

ƒ Code:
o sample_swan.tcl (25 lines, does both v4 and v5)
ƒ Reset:
o sample_swan_reset_wscp.bat
o sample_swan_reset_wsadmin.bat
ƒ Run it:
o sample_swan_wscp.bat
o sample_swan_wsadmin.bat

49 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

SWAN Internals: Code Size

File Type # lines non-commentary code

Configuration files 800

v4 code 3700

v5 code 3600

Common v4 code 1400

Common v5 code 900

Other common code 1500

Total non-commentary code 11,400

Plus comment lines 4,300

Includes debug/trace code 1000

50 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Configuration & Deployment Using SWAN (1)

Default
Configuration
Spreadsheet
Other Release
.ear .zip Artefacts Note
1

2
Edit in Excel

PVCS

Project-Specific
Configuration Spreadsheet
iwf_acm_iiw_app.cfg.xls

51 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Configuration & Deployment Using SWAN (2)

entapp EAR
.ear
PVCS
4 produceaid AID
3
5
Generate
Spreadsheet
AID
Spreadsheet
6 iwf_acm_iiw_ap
p.xls

Edit in Excel

Project-Specific
Configuration Edited
Spreadsheet Project-Specific
Configuration
Spreadsheet

52 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Configuration & Deployment Using SWAN (3)

7
Generator

Project-Specific
Configuration Configuration
Configuration
Configuration
Spreadsheet scripts
scripts
scripts

zip Package PVCS

Generator

Other Release Edited 8 AID

.ear .zip Artefacts Note EAR Spreadsheet
AID
53 © 2004 IBM Corporation
WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Configuration & Deployment Using SWAN (4)

10 Tivoli Software
Package Distribution Node A

14
11
Package
i..edApps
on node EAR
A

Edited Configuration
Configuration
Configuration 12
13 scripts
Tivoli Software
.ear EAR scripts
scripts Configurator
Distribution
AID

15
WebSphere
Domain
entapp create

Node B Node C Node D

54 © 2004 IBM Corporation
WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Tool 9: J2EE 1.4 Management and Deployment

ƒ What is it?
o J2EE 1.4 APIs for product-independent configuration & deployment
ƒ Main features:
o No standard up to J2EE 1.3
o J2EE 1.4 (WebSphere v6) introduces:
• J2EE Management Specification (JSR-77)
• ability to configure and control J2EE objects in a Java-application-
server-independent manner
• J2EE Deployment Specification (JSR-88)
• ability to install enterprise applications in a Java-application-
server-independent manner
• wsadmin still works
• write programs to these specs to lessen vendor lock-in
• many configuration/deployment possibilities:
• Admin Console
• wsadmin scripts in Jacl and Jython
• Programs written to the JMX API
• Programs written to JSR-77 & JSR-88

55 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Comparison: Lines of code

wscp XmlConfig wsadmin wsadmin ws_ant JMX SWAN

Jacl Jython

Heap sizes 2 4 6 45 9 2
(plus
Environment 16 60 24 19 wsad 35 6
min)
Transport 43 23 ? 40 3

Display 30 8 30 ? 50 6
(but displays
everything)

Installation 20 75 25 ? ? 4

56 © 2004 IBM Corporation

WebSphere UK User Group - October 2004
 WebSphere
IBM SoftwareApplication
Group | WebSphere
Server software

Summary
ƒ References
o “IBM WebSphere System Administration” by Leigh Williamson et al (ISBN: 0-
13-144604-5)
o “IBM WebSphere Deployment and Advanced Configuration” by
Barcia/Hines/Alcott/Botzum (ISBN: 0-13-146862-6)
o WAP:
• http://www-1.ibm.com/support/techdocs/atsmastr.nsf/WebIndex/PRS981
o SWAN:
• [email protected]

57 © 2004 IBM Corporation

WebSphere UK User Group - October 2004