Weblogic Authors: Yeshim Deniz, Elizabeth White, Michael Meiner, Michael Bushong, Avi Rosenthal

Related Topics: Weblogic

Weblogic: Article

Admin Automation with wlshell


Wlshell is a tool designed specifically for WebLogic administrators. It combines the flexibility of a scripting language with the full control provided by the JMX interface. It is, therefore, a natural environment for the systems administrator. The units of work of the JMX specification - the Management Beans, or MBeans - are presented in wlshell in the familiar form of the file system and they look like files organized into directories and drive units. This user-friendly environment makes it easy to write scripts to automate daily administrative WebLogic tasks.

Administrative Tasks
Since the beginning of computing, automation has been one of the driving forces of innovation. A couple of examples are the adding machine developed by Blaise Pascal and the punch-card tabulator for the U.S. Census built by Herman Hollerith.

Today, and in a more modest scenario, BEA WebLogic administrators have to face repetitive tasks similar to those just described in the sense that they are candidates for automation. These administrative tasks can be classified in two categories: configuration and monitoring.

A typical configuration task is the deployment of a new application on production servers. In order to deploy the application, it might be necessary to create, configure, and target services this application could rely on, like JDBC connection pools, data sources, JMS messaging servers, and JMS message queues, to name some resources. If the production system contains several WebLogic servers and domains, then the process could be repeated several times, maybe with some differences in parameters like server name and address. Automating this task will produce clear benefits over performing the same task manually using the administration console: the WebLogic administrator will be more productive by doing more in less time, and the possibility of making configuration mistakes will be minimized. In some organizations there are specific and strict regulations about how to roll out applications. In these cases, to automate is more than a nice-to-have practice, it is enforced by law. This is, for example, the case of some companies in the financial and pharmaceutical sectors. In these cases, every application deployment must be performed through an automated process that's documented, repeatable, and auditable.

Another task frequently performed daily by an administrator is supervising the status of servers and services. An administrator might be interested in monitoring the servers in a domain to see if they are active and to check the utilization level. In the case of services, some interesting metrics are the current database connections and the status of the JMS servers.

Administration Using Scripts
Traditionally, scripting languages are the tool of choice to automate administrative tasks, like the UNIX shell. Some of the more radical system administrators say "real administrators don't click." This is a strong statement but it might be telling us that graphical-based tools have some limitations when it comes to task automation. Graphical tools might also lack the level of granularity a professional administrator demands for advanced custom control.

The JMX specification (Java Management eXtensions), on the other hand, provides the right level of detail and control over the systems, but it provides a programmatic interface, a Java API. Experience also tells us "real administrators don't compile code," paraphrasing the previous statement. In reality this means that the power and level of detail of JMX is not directly available to administrators, who aren't necessarily developers. The programming interface lacks the flexibility, dynamism, and conciseness of an interpreted environment like that provided by scripting languages. Is there any way to reconcile both terms? Yes, there are several alternatives. In the remainder of the article, I'll analyze one of them, wlshell, and I'll look at some examples of how to automate some typical administrative tasks.

Creating Services
In the first example I'll create, configure, and start three WebLogic servers. I'll also create three JMS messaging servers, with three message queues each, and deploy the JMS servers on the WebLogic servers.

The first three lines of Listing 1 define the variables that allow the shortening of commands in the rest of the script. The first for loop creates three WebLogic servers, using a combination of the name and the index to produce servers with the names "s1", "s2" and "s3". The listen port is also configured based on the index variable, creating the integer values "7101", "7201", and "7301". wlshell supports two syntaxes for variables, $var and ${var}. The first one is more succinct and is good for interactive typing. The second notation should be used to clearly mark the end of the variable name and avoid any possible mistakes. The last line in the loop starts the server, which assumes the Node Manager is already up and running.

The next loop creates three JMS servers and three message queues for each JMS server using a nested for loop. The "addTarget" MBean operation is used at the end of the loop to target the server to the corresponding WebLogic server.

Finally, the configuration is explicitly persisted on the config.xml file, the default configuration repository. This script can be saved on a file to be executed later in batch mode with wlshell with the "read" command or as a start parameter with the "-f" flag, as shown here.

wlsh -f listing1.wlsh

read listing1.wlsh

Every BEA WebLogic administrator will probably understand immediately the benefits of using a script like this, especially compared to making configuration changes manually with the Web-based console or writing a Java program that uses JMX. The script presented above is relatively easy to read and understand at a first glance, prevents unintended errors, and saves time that can be used to work on more creative tasks.

Offline Configuration
Another new feature of wlshell version 2 is its ability to configure a WebLogic domain when the administration server is not running. This new characteristic creates new and exciting possibilities. We can now configure a domain in offline mode, very much like in the online case, just by using the "connect" command with the name of the "config.xml" file. In this case, the protocol for the connection has the keyword "file" to indicate that it is an offline type connection. We also need to check that the server is not running, so there is only one process making changes to the file.

In offline mode configuration, wlshell reads the config.xml file and presents a directory and file structure very similar to the online mode. All the commands available in the online connection are also available offline, so it is possible to navigate, create, set up, and remove servers, services, and applications. Listing 2 is an example of server configuration to increase the output information displayed on the console.

Once the config.xml file is modified, the administration server can be started with the new configuration. Changes made through wlshell on the config.xml are consistent with the document structure; therefore, the file is always valid. Offline mode is also useful for prepackaging a domain configuration without an administration server, and then distributing the configured package to another environment (testing, production, etc.).

Security Configuration
An important part of systems administration is security, specifically the management of users and groups. BEA WebLogic Security is completely managed through JMX MBeans, and as a result, totally available through wlshell, where administrators can write security management scripts. Within the default settings, the security MBeans are registered under the "Security" domain, without specifying any particular type. wlshell is capable of handling these MBeans with no type and gathers them under a directory named "typeless". Figure 1 shows the wlshell Explorer displaying the Security MBeans. It displays the attributes and operations of the "myrealmDefaultAuthenticator" Security MBean on the right pane. The authenticator MBean is responsible for user authentication and provides operations to manage users and groups. Using these methods, administrators can write scripts to create users in batch mode, assign users to groups, and change the user password. The following code snippet shows how to use the "createUser"operation to create a new user.


cd /typeless/myrealmDefaultAuthenticator
invoke createUser pgomez password "WebLogic Account for Paco Gomez"

WebLogic Runtime MBeans provide a detailed view of the different subsystems of the application server. wlshell makes them easier to access. The "get -r <interval> attribute(s)" command iteratively displays the value of one or more MBean attributes. Sometimes it could be necessary to display information based on the value of a particular MBean attribute or a particular condition. In those cases it might be necessary to write a small script to customize the output. Listing 3 illustrates this point. The script is flexible enough to print the state of the servers configured in the domain without knowing in advance the name or number of them.

The script generates the following output for a particular domain configuration:

Mon Nov 10 21:59:47 GMT-06:00 2003
s1 7101 RUNNING 5899744
s2 7201 not running n/a
s3 7301 RUNNING 5682584

Some automation examples have been presented in this article. They illustrate how to write wlshell scripts to automate administrative tasks for configuration and monitoring. This approach provides clear advantages over other methods, improving productivity and legibility, and reducing the chances of committing configuration mistakes. You can find more administrative scripts at the wlshell home page.


  • wlshell home page: www.wlshell.com
  • wlshell scripts catalog: www.wlshell.com/scripts
  • Scripting advocacy: http://home.pacbell.net/ouster/scripting.html
  • More Stories By Paco Gomez

    Paco Gómez is Principal Systems Architect at BEA Systems. He designs and develops proof-of-concept architectures for BEA customers and prospects. He is co-writer of the first published book about WebLogic and author of wlshell.

    Comments (0)

    Share your thoughts on this story.

    Add your comment
    You must be signed in to add a comment. Sign-in | Register

    In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.

    @ThingsExpo Stories
    In his session at 21st Cloud Expo, Carl J. Levine, Senior Technical Evangelist for NS1, will objectively discuss how DNS is used to solve Digital Transformation challenges in large SaaS applications, CDNs, AdTech platforms, and other demanding use cases. Carl J. Levine is the Senior Technical Evangelist for NS1. A veteran of the Internet Infrastructure space, he has over a decade of experience with startups, networking protocols and Internet infrastructure, combined with the unique ability to it...
    "Space Monkey by Vivent Smart Home is a product that is a distributed cloud-based edge storage network. Vivent Smart Home, our parent company, is a smart home provider that places a lot of hard drives across homes in North America," explained JT Olds, Director of Engineering, and Brandon Crowfeather, Product Manager, at Vivint Smart Home, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
    "IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
    Gemini is Yahoo’s native and search advertising platform. To ensure the quality of a complex distributed system that spans multiple products and components and across various desktop websites and mobile app and web experiences – both Yahoo owned and operated and third-party syndication (supply), with complex interaction with more than a billion users and numerous advertisers globally (demand) – it becomes imperative to automate a set of end-to-end tests 24x7 to detect bugs and regression. In th...
    Large industrial manufacturing organizations are adopting the agile principles of cloud software companies. The industrial manufacturing development process has not scaled over time. Now that design CAD teams are geographically distributed, centralizing their work is key. With large multi-gigabyte projects, outdated tools have stifled industrial team agility, time-to-market milestones, and impacted P&L stakeholders.
    "Cloud Academy is an enterprise training platform for the cloud, specifically public clouds. We offer guided learning experiences on AWS, Azure, Google Cloud and all the surrounding methodologies and technologies that you need to know and your teams need to know in order to leverage the full benefits of the cloud," explained Alex Brower, VP of Marketing at Cloud Academy, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clar...
    Widespread fragmentation is stalling the growth of the IIoT and making it difficult for partners to work together. The number of software platforms, apps, hardware and connectivity standards is creating paralysis among businesses that are afraid of being locked into a solution. EdgeX Foundry is unifying the community around a common IoT edge framework and an ecosystem of interoperable components.
    "MobiDev is a software development company and we do complex, custom software development for everybody from entrepreneurs to large enterprises," explained Alan Winters, U.S. Head of Business Development at MobiDev, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
    "Akvelon is a software development company and we also provide consultancy services to folks who are looking to scale or accelerate their engineering roadmaps," explained Jeremiah Mothersell, Marketing Manager at Akvelon, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
    Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, discussed how from store operations and ...
    "There's plenty of bandwidth out there but it's never in the right place. So what Cedexis does is uses data to work out the best pathways to get data from the origin to the person who wants to get it," explained Simon Jones, Evangelist and Head of Marketing at Cedexis, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
    SYS-CON Events announced today that CrowdReviews.com has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5–7, 2018, at the Javits Center in New York City, NY. CrowdReviews.com is a transparent online platform for determining which products and services are the best based on the opinion of the crowd. The crowd consists of Internet users that have experienced products and services first-hand and have an interest in letting other potential buye...
    SYS-CON Events announced today that Telecom Reseller has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. Telecom Reseller reports on Unified Communications, UCaaS, BPaaS for enterprise and SMBs. They report extensively on both customer premises based solutions such as IP-PBX as well as cloud based and hosted platforms.
    It is of utmost importance for the future success of WebRTC to ensure that interoperability is operational between web browsers and any WebRTC-compliant client. To be guaranteed as operational and effective, interoperability must be tested extensively by establishing WebRTC data and media connections between different web browsers running on different devices and operating systems. In his session at WebRTC Summit at @ThingsExpo, Dr. Alex Gouaillard, CEO and Founder of CoSMo Software, presented ...
    WebRTC is great technology to build your own communication tools. It will be even more exciting experience it with advanced devices, such as a 360 Camera, 360 microphone, and a depth sensor camera. In his session at @ThingsExpo, Masashi Ganeko, a manager at INFOCOM Corporation, introduced two experimental projects from his team and what they learned from them. "Shotoku Tamago" uses the robot audition software HARK to track speakers in 360 video of a remote party. "Virtual Teleport" uses a multip...
    A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, whic...
    SYS-CON Events announced today that Evatronix will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Evatronix SA offers comprehensive solutions in the design and implementation of electronic systems, in CAD / CAM deployment, and also is a designer and manufacturer of advanced 3D scanners for professional applications.
    Leading companies, from the Global Fortune 500 to the smallest companies, are adopting hybrid cloud as the path to business advantage. Hybrid cloud depends on cloud services and on-premises infrastructure working in unison. Successful implementations require new levels of data mobility, enabled by an automated and seamless flow across on-premises and cloud resources. In his general session at 21st Cloud Expo, Greg Tevis, an IBM Storage Software Technical Strategist and Customer Solution Architec...
    To get the most out of their data, successful companies are not focusing on queries and data lakes, they are actively integrating analytics into their operations with a data-first application development approach. Real-time adjustments to improve revenues, reduce costs, or mitigate risk rely on applications that minimize latency on a variety of data sources. In his session at @BigDataExpo, Jack Norris, Senior Vice President, Data and Applications at MapR Technologies, reviewed best practices to ...
    An increasing number of companies are creating products that combine data with analytical capabilities. Running interactive queries on Big Data requires complex architectures to store and query data effectively, typically involving data streams, an choosing efficient file format/database and multiple independent systems that are tied together through custom-engineered pipelines. In his session at @BigDataExpo at @ThingsExpo, Tomer Levi, a senior software engineer at Intel’s Advanced Analytics gr...