Professional Documents
Culture Documents
Tib Tea User Guide
Tib Tea User Guide
Two-Second Advantage
2
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH
EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY
(OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE
EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY
OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND
CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED
SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE
CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD
OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)
OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER
LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF THE
SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND
YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE
BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright laws
and treaties. No part of this document may be reproduced in any form without the written
authorization of TIBCO Software Inc.
TIBCO and Two-Second Advantage are either registered trademarks or trademarks of TIBCO Software
Inc. in the United States and/or other countries.
Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise
Edition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks of
Oracle Corporation in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of their
respective owners and are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT
ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED
AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE
VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.
THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL
ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE
CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO
SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)
AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR
INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,
INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.
Copyright 2013 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
TIBCO Enterprise Administrator Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
TIBCO Enterprise Administrator Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Components of TIBCO Enterprise Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Logging into the TIBCO Enterprise Administrator Server Using the Web UI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Configuring SSL on the TIBCO Enterprise Administrator Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Agent Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Registering an Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Reconnecting an Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Unregistering an Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
User Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Adding Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Importing Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Assigning Users to Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Assigning Roles to Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Deleting Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Resetting the Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Creating a New Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Importing Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Assigning Roles to Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Deleting Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Adding Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Deleting Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Adding Permissions to a User-Defined Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
4
Deleting Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Viewing Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Realms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Adding Realms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Deleting Realms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Shell Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Help Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Navigation Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Scripting Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Advanced Scripting Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
each . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
sort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Direct Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
The Script File Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
The Protocol Commands: SFTP and SCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Using Position and Named Arguments while Defining TeaParam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Figures
Landing Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
The Landing Page Showing Registered Agents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Product Listing of the Tomcat Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Filter By Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Solutions Menu Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Group By Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Solutions Detailed View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Search Results for the Phrase: Tomcat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Custom Search Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Operator Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
The Favorites Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
User Details Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
LDAP Realm Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Assigning Users to Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Assign Users to a New Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Assign Roles to a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Import Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Assigning Roles to Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Adding a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Adding a Realm: General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Adding a Realm: Group Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Adding a Realm: User Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
For an overview of TIBCO Support, and information about getting started with TIBCO Support,
visit this site:
http://www.tibco.com/services/support
If you already have a valid maintenance or support contract, visit this site:
https://support.tibco.com
Entry to this site requires a user name and password. If you do not have a user name, you can
request one.
Simple to use: TIBCO Enterprise Administrator is simple to install, develop, use, and maintain.
Shared Services Model: TIBCO Enterprise Administrator shares common administrative concepts
across all products thereby promoting a consistent and reusable shared services model.
Pluggable and Extensible: As your enterprise evolves, you can add new products to the TIBCO
Enterprise Administrator.
Rich set of API: TIBCO Enterprise Administrator Agent Library allows organizations to develop
custom TIBCO Enterprise Administrator agents to manage TIBCO and non-TIBCO products and
applications. TIBCO products such as TIBCO BusinessWorks Express 1.0.0 and TIBCO
Collaborative Information Manager 8.3.1 provide agents for TIBCO Enterprise Administrator. You
can develop your own agents to expose your product on TIBCO Enterprise Administrator. The
product comes with a set of API that is both declarative and extensible. You can develop your own
agents and decide what part of your product needs to be rendered on TIBCO Enterprise
Administrator.
Support for Interactive Shell: TIBCO Enterprise Administrator provides a command-line utility
called TIBCO Enterprise Administrator Shell. You can use the shell to perform almost all the tasks
offered by the Web-based GUI.
To see your product on TIBCO Enterprise Administrator, you must register the agent with the TIBCO
Enterprise Administrator server.
Register an Agent with the Server
Register the agent with the TIBCO Enterprise Administrator server. The steps are listed in the
procedure, Registering an Agent.
Providing details about the machines on which the products are running
Providing user management features such as granting and revoking a user's permissions
The Agent
An agent is a bridge between the TIBCO Enterprise Administrator server and a product. When an
agent is registered with the TIBCO Enterprise Administrator, it discovers the product that must be
exposed to the administrator. The agent creates a graph of objects specific to the product that needs to
be rendered on the TIBCO Enterprise Administrator server UI. The agent interacts with the server
using the REST API. TIBCO Enterprise Administrator agents can run in any of the following ways:
standalone, embedded, or hosted. TIBCO Enterprise Administrator comes with an extensible set of
API that helps you develop your own agents for your products. An agent provides the following basic
concepts:
Group: is a container of artefacts. For example, a cluster, domain, and ActiveMatrix environment.
Process: is any operating system process. For example, a BusinessWorks engine, and ActiveMatrix
node.
Resource: is a shareable configuration or artefact. For example, a JMS connection, and port
number.
Access_Point: is the result of a deployment. For example, a service point, and queue.
To develop a customized agent, you can either extend these concepts or use annotations.
Server UI
TIBCO Enterprise Administrator provides a default UI to manage and monitor products. You can
customize labels and icons on the UI to match the object types of your product. You can add more
views to suit your product requirements.
Shell
TIBCO Enterprise Administrator provides a command-line utility called the TIBCO Enterprise
Administrator shell. It is a remote shell based on the SSH protocol. The Shell is accessible using any
terminal program such as, Putty. The scripting language is similar to bash from UNIX. You can use
the Shell to perform almost all the tasks offered by the server UI.
Your account gets locked after 10 failed attempts.The admin account is the only exception to this
rule, but the admin account experiences a lag of 1 second on every login after 10 failed attempts.
Procedure
1. Open a browser and navigate to the URL http://localhost:8777/tea/, where localhost is the
default hostname and 8777 is the default port number.
The Login page is displayed.
2. Enter your Login credentials.
On successful authentication, the landing page is displayed.
Landing Page
10
11
Agent Management
Every agent that gets added to the Enterprise Administrator is displayed on the landing page. You can
perform basic administrative tasks collectively on these agents such as reconnecting or unregistering
agents.
Use the Agent Management pane to:
View an agent: When you add an agent, you can drill down the agents to navigate through the
objects exposed by the agent. The objects exposed will depend on the product that is coupled with
the agent. The user interface varies depending on the agent registered.
Registering an Agent
A product is exposed to the TIBCO Enterprise Administrator through an agent. When you register an
agent corresponding to a product, the agent ensures that the product is visible on TIBCO Enterprise
Administrator.
Prerequisites
Start the agent for the corresponding product.
This procedure uses the Tomcat sample provided with the product. You can navigate to <TEA_HOME>
for more details.
\tea\1.0\samples\tomcat
Procedure
1. Login to the Enterprise Adminisrator.
The landing page is displayed.
2. Click the Agents button on the right.
The Agent Management Pane is displayed.
As an alternative, you can also click
Agent Name
Agent URL: For the Tomcat sample, the URL will be http://localhost:8082/tomcatagent.
For more information, refer to the readme file available under <TEA_HOME>\tea\1.0\samples
\tomcat.
Agent Description
12
5. Click Register.
The agent is visible in the Agent Management pane. The landing page also shows an icon for every
registered agent.
If the agent is not immediately visible in the pane, try refreshing the browser.
The Landing Page Showing Registered Agents
If there are two agents for the same object type, ensure that they have the same operation
name and number. This is to ensure that when you invoke an operation, you can select the
agent on which you want to execute the operation from the drop-down list.
Reconnecting an Agent
You can collectively reconnect agents using TIBCO Enterprise Administrator.
Procedure
1. Click
and select Agent Management.
The Agent Management pane is displayed.
2. Select the agents you want to reconnect. Click Reconnect.
A confirmation window is displayed.
3. Click reonnect to confirm.
The agents are reconnected with the server.
Unregistering an Agent
You can collectively unregister agents using the TIBCO Enterprise Administrator.
Procedure
1. Click
and select Agent Management.
The Agent Management pane is displayed.
2. Select the agents you want to unregister. Click Unregister.
A confirmation window is displayed.
3. Click Unregister to confirm.
The agents are unregistered from the server.
13
Select Operation Target: select the Agent on which the instance should be created.
AJP Port: you can leave this empty; a random port number is picked up.
4. Click Create.
The server instance is displayed in the Servers pane.
5. Click one of the instances. You have options to start, stop, delete, or change the port of the server.
6. Under the Server details, a list of assets is displayed. Click one of the assets to drill down further.
You can start or stop any of these assets.
Product Listing of the Tomcat Sample
14
15
System Views: each agent provides details to the Enterprise Administrator server about the machine
on which it is running. For more information, see System Views.
Solutions: this is an optional view and you can develop on this view according toyour requirements.
A Solution is a collection of assets that provide a business functionality. Using this view, you can
bring together assets (applications, processes, resources, endpoints) from across products to provide
a unified solution.
Operator Views: an operator view can be constructed based on the participating products. You can
group together applications, processes, and other assets from various tenant product groups into a
manageable "operator view". The view provides you with a single window of visibility into the
applications, processes, and other assets that interest you.
Search Views: if you have the appropriate permission, you can search for assets in an enterprise.
The result set can be saved as a view and refered to as and when required.
In addition to the available views, you can customize operator and search views depending on the
products you want to track. You can create your own operator and search views by using the Manage
Views option.
Solutions View
A Solution is a collection of assets that provides a business functionality. Using this view, you can bring
together assets (applications, processes, resources, endpoints) from across products to provide a unified
solution.
A solution has a name, status, and contact information as its attributes. You can assign an asset to and
unassign an asset from a solution. You can also define custom action by providing scripts for a solution.
Using the TIBCO Enterprise Administrator server, you can:
Operate within the context of a Solution to CRUD assets across TIBCO Products.
16
Procedure
1. Click
and select a solution from the Solutions list. For example, in case of the
SampleProductAgent, the SampleProductAgentSolution is displayed in the list.
The Solution pane is displayed. A list of assets are displayed.
Solutions Menu Option
When a TopLevelObject is added as a member of a solution, you cannot see the status of
the TopLevelObject.
17
3. You can select multiple assets in a group to perform administrative tasks on them. For example, in
the SampleProductAgentSolution, you can start, stop, delete, or change the port of a server.
Similarly, you can get members of a selected node, or delete nodes collectively.
Solutions Detailed View
Search Views
You can search for assets that you have permissions to access. The result of the search can be saved in a
view that is displayed in the Search Views option.
Prerequisites
By default, no search views are created by the TIBCO Enterprise Administrator. Ensure that you create
the search views by using the procedure mentioned in Creating Custom Search Views.
Procedure
1. Click
. If you have created a list of search views, they will be listed in the Search Views option.
18
3. You can drill down the assets and collectively perform basic administrative tasks on the assets. For
example, if a search for Tomcat resulted in the user Tomcat Admin, you can click the asset to grant
the user Full Control on all applications.
Search Results for the Phrase: Tomcat
Operators View
An operator view can be constructed based on the participating products. You can group together
applications, processes, and other assets from various tenant product groups into a manageable
"operator view". The view provides you with a single window of visibility into the applications,
processes, and other assets that interest you.
Prerequisites
By default, there are no operator views created by the TIBCO Enterprise Administrator. Ensure that
you create the operator views by using the procedure mentioned in Creating Custom Operator Views.
Procedure
1. Click
option.
. If you have created a list of operator views, they will be listed in the Operator Views
19
Procedure
1. Enter a string in the Search field. For example, tomcat.
The search result is displayed.
2. Click Save Search.
The Save Search window is displayed.
3. Enter a name and description of the search. Click Save Search.
The Search View is now saved.
4. To verify that the custom search view exists, refresh the browser and click on
Your latest view is displayed in the Search Views option.
Custom Search Views
20
4. To verify that the custom operator view is displayed on the Views menu, refresh the browser and
click
Your latest view should be displayed in the Operator Views option.
Operator Views
21
User Management
You can use TIBCO Enterprise Administrator to manage users, groups, roles, permissions, and realms.
TIBCO Enterprise Administrator can only manage the roles and permissions exposed by the agent. You
cannot add new permissions other than those provided by the agent.
Users
Users are entities that need access to the system. Each user might need a different level of access to the
system.
TIBCO Enterprise Administrator can manage users internally, or can manage users in an external
system. Users from external systems are mapped into TIBCO Enterprise Administrator to allow access
to the system. The default user provided by TIBCO Enterprise Administrator is admin .
Adding Users
You can add users to the TIBCO Enterprise Administrator. You cannot add new users to an existing
agent.
Procedure
1. Click
and select User Management.
The User Management pane is displayed.
2. Under Users, click Add.
The New User window is displayed.
3. Provide the Name and a valid Password.
4. Click Next.
5. Add the user to a group, if available. This step is optional.
6. Click Next.
7. Select the roles to be assigned to the user. You can select multiple roles. This step is optional.
22
8. Click Finish.
The User pane shows the details of the new user created. Use this page to reset the user's password,
add or remove roles, and add or remove the user from a group.
User Details Pane
Importing Users
While you can add users to the default TEA_DB realm, you cannot add them to the LDAP realm.
However, you can import users from the LDAP realm.
Prerequisites
Ensure that you have added an LDAP realm to the TIBCO Enterprise Administrator before importing
users from the realm. To add a realm, follow the procedure in Adding Realms.
Procedure
1. Click
and select User Management.
The User Management pane is displayed.
23
24
Deleting Users
You can delete users added to the TEA_DB realm and LDAP realm. You cannot delete users added by
the agent.
Procedure
1. Click
and select User Management.
The User Management pane is displayed.
2. Under Users, select the users to be deleted.
3. Click Delete.
4. Click Delete Users to confirm deletion.
TIBCO Enterprise Administrator User's Guide
25
Groups
Groups are logical groupings of the users within an organization. A user can belong to multiple groups
and a group can contain multiple users.
Groups provide easier way to control access to users. Instead of specifying the access permissions for
each user, it is easier and practical to specify access permissions to the groups to which they belong to.
Groups can contain sub-groups.
26
8. Click Finish.
9. To verify, click on the group to view the group details. Ensure that the roles and users selected are
displayed in the details.
Importing Groups
You can import existing groups from the LDAP realm. However, you cannot create new groups in the
LDAP realm.
Prerequisites
Ensure that you have added an LDAP realm to the TIBCO Enterprise Administrator before importing
users from the realm. For details on adding a realm, see Adding Realms.
Procedure
1. Click
and select User Management.
The User Management pane is displayed.
2. Under Groups, click Import.
The Import Groups window is displayed.
Import Groups
27
4. Click a group to see the details of the user. On the Groups details page, you can add or remove
users, and add or remove roles from a group.
Caution: You cannot map the users of a group in the LDAP realm with those in the TEA_DB realm
or viceversa.
Deleting Groups
You can delete groups added to the TEA_DB realm and LDAP realm.
Procedure
and select User Management.
1. Click
The User Management pane is displayed.
2. Under Groups, select the groups to be deleted.
3. Click Delete.
4. Click Delete Groups to confirm deletion.
28
Roles
Role is a mechanism to grant or revoke access to users. A Role is a collection of privileges and are
assigned to users and groups. All the privileges in a role get associated to the user or group to which it
is assigned.
Adding Roles
You can add new roles to TEA_DB, LDAP realm and to the agents. You can also add permissions to an
existing role available in the agent. TEA_ADMIN is the default role.
Agents can contribute roles that are visible in the Roles pane. You cannot delete these roles, but you can
add new roles to the TIBCO Enterprise Administrator server.
Procedure
1. Click
and select User Management.
The User Management pane is displayed.
2. Under Roles, select one or more users, and click Add.
The New Role window is displayed.
3. Select the product on which you want to add the role. A list of available permissions is listed.
4. Select the permissions you want to assign to the role, and select the object type it applies to. Click
Next.
Adding a Role
5. Select the users you want to apply the role to, and click Next.
6. Select the groups you want to assign the role to.
7. Click Finish.
The Roles details page shows the permissions, users, and groups to which the role is assigned. You
can add or remove the permissions, users, or groups for the role from the Roles detail page.
Deleting Roles
You can delete roles added to the TEA_DB realm and LDAP realm. You cannot delete roles added by
the agent.
Procedure
1. Click
and select User Management.
The User Management pane is displayed.
2. Under Roles, select the roles to be deleted.
TIBCO Enterprise Administrator User's Guide
29
3. Click Delete.
4. Click Delete Roles to confirm deletion.
Permissions
A string on the basis of which access control is enforced. The agent decides the granularity of the
permissions that it provides.
A permission could be as fine-grained as UpdateConfig which is applicable to only one operation, or it
could be as coarse-grained as Full Control which applies to the entire system. A Privilege is a
collection of permissions that are applicable to an object or a collection of objects.
Deleting Permissions
You can delete permissions for a role that is defined by the user, but not the permissions contributed by
the agent.
Procedure
1. Click
and select User Management.
The User Management pane is displayed.
2. Under Roles, select a role.
3. From the Permissions pane, select a permission, and Click Delete.
4. Click Delete Permissions to confirm deletion.
Viewing Permissions
You can view permissions contributed by an agent.
Procedure
1. Click
and select User Management.
The User Management pane is displayed.
TIBCO Enterprise Administrator User's Guide
30
Realms
A security realm comprises mechanisms for protecting TIBCO Enterprise Administrator resources. It
contains users, groups, and their security credentials. Information about users and the groups they
belong to, is provided by a realm.
TIBCO Enterprise Administrator supports two kinds of realms : TEA_DB and LDAP. In case of the
TEA_DB realm, the user and group information is stored in a file. In case of LDAP realm, the user or
group information exists on an LDAP server and is accessed from the TIBCO Enterprise Administrator
server.
Adding Realms
You can add LDAP realms to the TIBCO Enterprise Administrator server. The default realm available is
TEA_DB.
Procedure
1. Click
and select User Management.
The User Management pane is displayed.
2. Under Users, click Realms.
The Realms pane is displayed.
3. Click Add.
The Register New Realm is displayed.
4. Provide the following general information:
Name
Server URL
Search Timeout
BindUserDN
Bind Password
31
Group ID Attribute
Sub-Group Attribute
User ID Attribute
7. Click Finish.
Result
The realm is added to the TIBCO Enterprise Administrator server.
32
Deleting Realms
You can delete realms available in the TIBCO Enterprise Administrator server.
Procedure
1. Click
and select User Management.
The User Management pane is displayed.
2. Click Realms.
The Realms pane is displayed.
3. Select a realm and click Delete.
4. Click Delete Realms to confirm deletion.
33
Command completion: Commands can be completed by using the Tab key. Commands and
arguments passed to path-based commands such as ls, cd, show status, and so on are automatically
completed by pressing the Tab key.
Support for interactive arguments: You can enter a command by entering each argument when
being prompted to. For example, the create command takes arg1 and arg2 as parameters. You can
pass these arguments in an interactive mode as follows:
create
arg1:foo
arg2:bar
foo bar
Support for binding session variables to arguments: Consider an operation defined on agent this
way:
create(@TeaParam(name="type") String type, @TeaParam(name="name") String name,
@TeaParam(name="domain", alias="d") String domain);
In this case, you can invoke the operation in the following manner:
domain = QA-Domain
create appspace HR-AppSpace
Support for piping of commands: You can send the output of one command as an input to the other
using pipes (|).
-p 2222 admin@localhost.
34
Shell Commands
Shell commands are quite similar to the bash commands in Unix. Almost all tasks performed on the
Web UI can be performed using the Shell commands. The shell provides a rich set of navigation,
scripting, and help commands.
Help Command
To get comprehensive help using a command, use the
--help
Description
There are two modes of using the help command: cd --help and help cd. The cd --help mode is
used to display a detailed description of the command. For example, the following is the output of the
command, cd --help:
DESCRIPTION
tea:cd
Changes the context to the given path
SYNTAX
tea:cd [path]
ARGUMENTS
path
Target path to which to change the context to.
The help cd mode is used to display a detailed description along with some examples of usage. For
example, the following is the output of the command, help cd:
NAME
tea:cd
Changes the context
to the given path
SYNTAX
tea:cd [path]
ARGUMENTS
path
Target path to which to change the context to.
DESCRIPTION
Change Directory - change the current working directory
to a specific Folder.
If directory is not given, the current working directory
is not changed.
SAMPLES
1. Do cd command in TEA server without argument:
admin@localhost:/>cd
admin@localhost:/>
admin@localhost:/>pwd
/
35
Navigation Commands
Navigating the object hierarchy on the TIBCO Enterprise Administrator server is quite similar to
navigating a file system. Commands offered are like the basic navigation commands available in Unix.
Each object has a path corresponding to it.
The following are some helpful navigation commands:
ls: lists the members contained in a TIBCO Enterprise Administrator object at the specified path.
admin@localhost:/>ls <path>
where <path> is the path of the target object whose contents are to be listed.
If the path is not specified, it lists the objects under the current object. You can nest the path to
subsequent levels. For example, you can list the members contained in the default realm by using
the command ls TEA/Access/Realms/default-realm.
cd: navigates to the TIBCO Enterprise Administrator object at the specified path.
admin@localhost:/>cd <path>
pwd: prints the absolute path of the current TIBCO Enterprise Administrator object.
admin@localhost:/TEA>pwd
Scripting Commands
You can use advanced scripting constructs to combine multiple commands and write complex scripts.
The Shell commands supports the following advanced constructs for scripting:
Arrays
Pipes
Command grouping
Closures
Json ComplexType
36
Arrays
Arrays can be passed as arguments to some commands. For example, the echo command takes an array
of arguments passed to it and displays them at the command prompt.
echo [ 'a' 'b' 'c']
"a" "b" "c"
Pipes
Output of one command can be piped to the input of another command using a '|'.
admin@localhost:> ls /TEA/Types | grep a
tea:1.0.0
Command Grouping
Multiple commands can be grouped using parenthesis, '( ' and ') ' to specify the order of execution.
(echo a | capture) | capture
Closures
Closures are functions which can be invoked with arguments. You can define and invoke the functions
at runtime. Curly braces, '{ ' and '} ' are used to enclose a closure definition.
admin@localhost:> each { ls } {show info $it}
Name:Access
Type:tea:1.0.0:access
Config:
{"activeUsers":[]}
Name:Agents
Type:tea:1.0.0:agents
Name:Search
Type:tea:1.0.0:search
Name:Server
Type:tea:1.0.0:server
Config:
{"version":"1","homeLocation":"..\:\\tea"}
Name:Shell
Type:tea:1.0.0:ShellType
Status:RUNNING
Config:
{"host":"localhost","port":2222,"path":"..\\internal\\nodes\\node1\\work\\cf
\\bcd28823-db70-48be-84d5-6c2295667295\\work\\hostkey.ser"}
Name:Tea Machines
Type:tea:1.0.0:teaMachines
Name:Tea Repository
37
Type:tea:1.0.0:teaRepository
Name:Tea Solutions
Type:tea:1.0.0:solutions
Name:Types
Type:tea:1.0.0:agent_types_group
Name:Views
Type:tea:1.0.0:views
admin@localhost:>
Json ComplexType
If the definition of TeaParam in a TeaOperation is a user-defined object, ensure that you use a String of
the type: Json complexType .
'{"strA":"aa","strB":"bb"}'
each
if
sort
set
get
each
Calls a given function (a closure) on each of the elements in the given array.
Usage: each
values function
where
values
function:
if
Command to support conditional execution.
Usage: if
admin@localhost:/TEA>
Groups
Realms
Roles
Users
admin@localhost:/TEA>
where
condition: is the condition to meet by the if construct.
38
ifTrue:
ifFalse:
sort
Sorts the input objects.
Usage: tea:sort
[options]
where
[options]
--ignore-leading-blanks
--numeric-sort
--unique
--reverse
or
-u:
admin@localhost:Access> ls | sort -r
Users
Roles
Realms
Groups
set
Sets a particular option in the current session.
Usage: tea:set
[options]
where
[options]
session.
is --scope. The --scope option specifies the global scope name to be set for the current
get
Gets the current value of a supported option from the current session.
Usage: tea:get
[options]
where
[options]
is --scope. The --scope option requests for the global scope stored in the current session.
Direct Commands
The TIBCO Enterprise Administrator shell supports executing commands directly from the input.
The following code block shows the usage of a direct command.
ssh -p2222 admin@localhost ls
Output
39
TEA
40
The SFTP command: When you get connected to SFTP using an SFTP-compliant terminal, you can
use the help command at the prompt to get the detailed usage of SFTP.
psftp>
!
bye
cd
chmod
close
del
dir
exit
get
help
lcd
lpwd
ls
mget
mkdir
mput
mv
open
put
pwd
quit
reget
ren
reput
rm
rmdir
psftp>
help
run a local command
finish your SFTP session
change your remote working directory
change file permissions and modes
finish your SFTP session but do not quit PSFTP
delete files on the remote server
list remote files
finish your SFTP session
download a file from the server to your local machine
give help
change local working directory
print local working directory
list remote files
download multiple files at once
create directories on the remote server
upload multiple files at once
move or rename file(s) on the remote server
connect to a host
upload a file from your local machine to the server
print your remote working directory
finish your SFTP session
continue downloading files
move or rename file(s) on the remote server
continue uploading files
delete files on the remote server
remove directories on the remote server
41
The SCP Command: When you get connected to SCP using an SCP-compliant terminal, you can use
the help command at the prompt to get the detailed usage of SCP.
C:\>pscp
PuTTY Secure Copy client
Release 0.63
Usage: pscp [options] [user@]host:source target
pscp [options] source [source...] [user@]host:target
pscp [options] -ls [user@]host:filespec
Options:
-V
print version information and exit
-pgpfp
print PGP key fingerprints and exit
-p
preserve file attributes
-q
quiet, don't show statistics
-r
copy directories recursively
-v
show verbose messages
-load sessname Load settings from saved session
-P port
connect to specified port
-l user
connect with specified username
-pw passw login with specified password
-1 -2
force use of particular SSH protocol version
-4 -6
force use of IPv4 or IPv6
-C
enable compression
-i key
private key file for authentication
-noagent disable use of Pageant
-agent
enable use of Pageant
-batch
disable all interactive prompts
-unsafe
allow server-side wildcards (DANGEROUS)
-sftp
force use of SFTP protocol
-scp
force use of SCP protocol
The following example is about uploading a file from one location to another:
C:\>pscp -scp -P 2222 /TEA/a.xml admin@localhost:/a.xml
admin@localhost's password:
a.xml
| 5 kB |
5.0 kB/s | ETA: 00:00:10 | 100%
C:\>
Position only:
TeaParam definition
public String testA(@TeaParam(name = "aa", description = "Greetings parameter",
alias = "") final long[] greetings)
Usage
shell> testA [12,15]
42
testA
testA
testA
testA
testA
[12,15]
-aa [12,15]
--aa [12,15]
-bb [12,15]
--bb [12,15]