ontune version 4 admin user guideontune.us/.../uploads/2013/12/ontune_admin-user-guide.pdf ·...
TRANSCRIPT
onTune Version 4
Admin User Guide
Nov. 2013
The Content provided on this document is copyrighted by TeemStone Corporation and is protected from copying,
reproduction, modification, distribution, display, performance or transmittal for any purpose under international copyright laws. The trademarks, trade names, service marks, product packaging, designs and corporate logos and
emblems displayed on this document belong exclusively to TeemStone Corporation are protected from reproduction,
It is not allowed to copy, reproduce, modify, distribute, display, and transmit this document without written permission of TeemStone Corporation.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 2
Table of Contents
General Information on Conventions, Copyrights, Contacts ................................... 6
1. Introduction to onTune Admin ........................................................................................... 8
1.1 Checklist before executing onTune Admin ........................................................... 10
2. Execution of onTune Admin ............................................................................................... 11
2.1 Main Window and Menu ................................................................................................. 14
2.2 onTune Admin Environments Settings ...................................................................... 16
2.2.1 Environment Settings Manually .............................................................................. 16
2.2.2 Environment Settings at First Execution .......................................................... 16
2.2.3 Environment settings via Config Menu .............................................................. 18
2.3 License Registration ............................................................................................................ 20
2.4 Menus and Icons.................................................................................................................... 21
3. onTune License Management .......................................................................................... 22
3.1 Overall Introduction to onTune License Management ................................... 22
3.2 License Registration and Update ................................................................................ 25
3.3 View Registered License ................................................................................................... 27
4. Functions of Admin Menu ................................................................................................... 29
4.1 Menu Structure ....................................................................................................................... 29
4.2 File Menu..................................................................................................................................... 30
4.2.1 File > Config ........................................................................................................................ 30
4.2.2 File > Upload Update Files ......................................................................................... 30
4.2.3 File > Exit .............................................................................................................................. 30
4.3 View Menu.................................................................................................................................. 31
4.4 License Menu ........................................................................................................................... 33
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 3
4.5 Help Menu .................................................................................................................................. 34
4.6 Admin Icons ............................................................................................................................... 35
4.6.1 onTune Admin Environments Settings .................................................................. 35
4.6.2 Refresh .................................................................................................................................... 35
5. User Management for onTune Viewer ......................................................................... 36
5.1 Creating User Accounts ..................................................................................................... 38
5.2 Modifying User Account Information ........................................................................ 40
5.3 Deleting User Account ....................................................................................................... 41
5.4 Assigning Servers (Hosts) to the User ................................................................... 42
6. Server (Host) Grouping and Performance Monitoring Settings .............. 44
6.1 Server (Host) Navigation Window and Information Window ................... 46
6.2 Server (Host) Items on Information Window .................................................... 47
6.2.1 General Information Items - Common .............................................................. 47
6.2.2 Short Term (Real-time) Performance Data Collection Interval ......... 48
6.2.3 Long Term Performance Data Collection Interval ...................................... 48
6.3 Automatically-Created Server (Host) Tree - Host List ................................. 49
6.3.1 Initial Windows of Host Tree and Server Information Window ......... 49
6.3.2 Host List and Server Information Window when Step-by-step
Unfolding Selected......................................................................................................................... 50
6.3.3 Expanding Whole Tree Icon ....................................................................................... 51
6.3.5 Collapsing whole Tree Icon ........................................................................................ 52
6.4 User Defined Server (Host) Groups .......................................................................... 54
6.4.1 Highest Level Group Management ........................................................................ 55
6.4.1.1 Creating Highest Level Group.............................................................................. 55
6.4.1.2 Modifying Highest Level Group Information .............................................. 56
6.4.1.3 Deleting Highest Level Group .............................................................................. 57
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 4
6.4.2 Sub-Group Management ............................................................................................. 57
6.4.2.1 Creating Sub-Group ................................................................................................... 57
6.4.2.2 Modifying Sub-Group Information .................................................................... 59
6.4.2.3 Deleting Sub-Group .................................................................................................... 60
6.4.3 Assigning Servers to the Group .............................................................................. 61
6.5 Select Server (Host) to be Configured ................................................................... 62
6.5.1 Select Server(s) from Host List .............................................................................. 62
6.5.2 Select Server(s) from Group List ........................................................................... 63
6.5.3 Find Server (Host) ........................................................................................................... 65
6.5.4 Server (Host) Filtering .................................................................................................. 68
6.5.4.1 Single Key Filtering ..................................................................................................... 69
6.5.4.2 Multiple Key Filtering ................................................................................................. 71
6.6 Performance Information Collection Settings .................................................... 74
6.6.1 Settings for Single Server (Host) .......................................................................... 74
6.6.2 Settings for Multiple Servers (Hosts) .................................................................. 75
7. Other onTune Admin Functions ....................................................................................... 77
7.1 File Upload and Download, Command Execution ............................................ 77
7.1.1 Accessing to Utility Tab Menu .................................................................................. 77
7.1.2 Upload File ............................................................................................................................ 79
7.1.3 Download File ...................................................................................................................... 80
7.1.4 Command Execution ...................................................................................................... 81
7.2 Defining and Executing User Job ................................................................................ 84
7.2.1 Accessing User Job Scheduling / User Job Scheduling from File Tab
Menu ....................................................................................................................................................... 84
7.2.2 Managing User Job Script – User Job Scheduling ....................................... 86
7.2.2.1 Creating User Job Script ......................................................................................... 87
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 5
7.2.2.2 Editing User Job Script ............................................................................................. 90
7.2.2.3 Deleting User Job Script .......................................................................................... 92
7.2.3 Executing Pre-created Script File – User Job Scheduling to File ...... 93
7.2.3.1 Registering Pre-created Script File Information ...................................... 94
7.2.3.2 Modifying Pre-created Script File Information.......................................... 96
7.2.2.3 Deleting Pre-created Script File Information ............................................. 98
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 6
General Information on Conventions, Copyrights, Contacts
Conventions
Fonts Contents
Rockwell Italics onTune system, or onTune modules or
subsystems.
MS Reference Sans Serif Regular content
MS Reference Sans Serif Bold with
underscore
Described separately even if they are
in the same chapter.
MS Reference Sans Serif Bold Menus, buttons, check boxes, radio
buttons on window and TitleBar or
messages on window. Actual file
name.
MS Reference Sans Serif Italics Window messages that are different from case to case.
MS Reference Sans Serif Bold Red Font Important information to remember
MS Reference Sans Serif Bold Red Font
with underscore
Important information related to
application execution.
Arial Unicode MS Entry names in configuration file or scripts.
(Not allowed to user to modify.)
Arial Unicode MS Italics User input field in configuration file and/or
runtime script
Copy Rights
onTune® , OnTune® are registered trademark of TeemStone Corp.
All other trademarks or registered trademarks contained and/or mentioned herein
are used for identification purposes only and may be trademarks or registered
trademarks of their respective companies.
AIX® IBM© Copyright IBM Corporation 1994, 2013.
http://www.ibm.com/legal/us/en/copytrade.shtml
Solaris® Oracle Copyright © 2002, 2011, Oracle and/or its affiliates. All rights
reserved.
http://docs.oracle.com/cd/E27449_01/doc/dcommon/html/cpyr.htm
HP-UX® , HP-UX © Copyright Hewlett-Packard Company 1999-2007. All Rights
Reserved.
http://www8.hp.com/us/en/privacy/terms-of-use.html#trademarks
Microsoft® , Windows® , Windows NT® , Windows Server® Microsoft© 2013
Microsoft Corporation. All rights reserved.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 7
http://www.microsoft.com/en-
us/legal/intellectualproperty/Trademarks/Usage/General.aspx
Redhat® , CentOS® Copyright © 2013 Red Hat, Inc.
https://www.redhat.com/about/mediarelations/trademark.html
SUSE® Copyright © 2011 SUSE, All rights reserved.
http://www.novell.com/company/legal/copyrights/
VMware® Copyright © 2013 VMware, Inc. All rights reserved.
http://www.vmware.com/help/legal.html
Linux is a registered trademark of Linus Torvalds.
MariaDB® , © SkySQL Corporation Ab, 2013. MariaDB is a trademark of SkySQL
Corporation Ab.
https://mariadb.com/about/legal/trademarks
PostgreSQL® Copyright © 1996-2013 The PostgreSQL Global Development Group
http://www.PostgreSQL.org/docs/6.4/static/intro321.htm
Ubuntu © 2013 Canonical Ltd. Ubuntu and Canonical are registered trademarks of
Canonical Ltd.
http://www.ubuntu.com/legal
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 8
1. Introduction to onTune Admin
onTune is a system Performance Monitoring and Tuning Tool. It utilizes Agent
processes on the monitored server(s) to collect and package the information. And
user-defined system events are notified to the user by SMS and/or E-mail.
onTune Admin is used to configure onTune operating environments to meet user
requirements, and user(s) settings as well.
onTune Admin directly operates on the database instance used by onTune
Manager. In multiple onTune Manager usage environments, the user must connect
to each database used by each onTune Manager, and configure each one using
onTune Admin. To configure the settings to connect to the database, please refer
to “2.2 onTune Admin environment settings.
If the run-time environment settings are incorrect, a “connection to database
error” will occur. Ignore this error; modify the settings for connecting to the
database correctly thru the “Configure” menu; stop onTune Admin, and re-execute
onTune Admin.
onTune Admin provides the following functions:
Updating onTune Viewer
onTune Admin updates the onTune Viewer program, which presents system
performance information to the user. The onTune Viewer is updated automatically
via the internet by defining the update URL link, and by the user manually to a
specific version using onTune Admin.
Register and manage onTune License
onTune license is registered by onTune Admin function.
Configure onTune Admin running environments
onTune Admin connects to the database which is used by onTune Manager.
Configuring onTune Admin essentially means to set the database connection
settings.
Manage performance data collection periods of each server to be monitored
onTune Admin provides functions to configure settings of onTune Agent
managed by onTune Manager.
Group definition of servers’ (hosts) for onTune Viewer user(s)
System performance information of servers (hosts) under monitor can be
grouped for viewing on the onTune Viewer. The server group(s) are defined and
managed using onTune Admin. We recommend creating user defined server
group(s) when Agent(s) connect to Manager for the first time. This is specially so
when having a large number of servers under monitor. It becomes complicated to
navigate and find a particular server information under monitor without the
grouping structure.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 9
User account management (Viewer user)
Only authorized-users are permitted to view and investigate server
performance and event information. User accounts for onTune Viewer are created
and managed by onTune Admin only. This include granting privileges to access
specific server information.
Upload file(s) to the server (host) where Agent runs
Users may upload any file from the onTune Admin operational PC or server to
the Agent operational Server (host). Once the user selects a file to upload and
stores this information, the onTune Manager informs Agent and sends the file.
Optionally, the user may command onTune to execute the file upon finishing the
upload to the Agent Server (host).
Download file(s) from the server (host) where Agent runs
Users may download any file from the Agent server (host) to the user’s PC or
server by executing the download command to onTune Manager via onTune Admin.
The Admin or Viewer window will show the result of this command execution.
Send executable command to the server where Agent runs
An Agent will execute commands received from onTune Manager. The command
may be – stop Agent, update Agents, collect system information at a particular
time, and others.
Create executable script and execute it on the server where Agent runs
The user may create an executable script to be sent and executed on the
Agent Server (host). The Admin or Viewer window will show the result of script
execution.
Send executable script file to the server where Agent runs and execute it
The user may send an executable script to be executed on the Agent Server
(host). The Admin or Viewer window will show the result of script execution.
View onTune Manager runtime logs
onTune runtime logs are shown on Admin message window.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 10
1.1 Checklist before executing onTune Admin
onTune Admin manages onTune runtime environments using onTune Managers’
database(s). Verify the following before executing onTune Admin.
- Execute all onTune Manager(s) database(s) to be managed.
- Execute all onTune Manager(s) to be managed.
- Install and execute Agents that will be connected to the Manager(s). Only
installed and executing Agents prior to executing onTune Admin, are shown
in onTune Admin’s server (host) list – Host List or Group List. We
recommend installing and executing Agents before executing of onTune
Admin. If not, the Server (Host) list will be blank. Newly Agent installed
servers after Admin executing are shown when the Agents execute and
connect to Manager first time.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 11
2. Execution of onTune Admin
Execute onTuneAdmin.exe from the onTune installed directory. Refer to onTune
Version 4 Installation Guide, “3.2 onTune Admin Installation and Configuration” for
how to install onTune Admin. The contents of the onTune installed directory are
shown below:
onTune Admin directly operates on the database instance used by onTune
Manager. In multiple onTune Manager usage environments, the user must connect
to each database used by each onTune Manager, and configure each one using
onTune Admin. To configure the settings to connect to the database, refer to “2.2
onTune Admin environment settings.
If the run-time environment settings are incorrect, a “connection to database
error” will occur. Ignore this error; modify the settings for connecting to the
database correctly thru the “Configure” menu; stop onTune Admin, and re-execute
onTune Admin.
onTune Admin shows license information at very first step of execution. If
license is not registered, following message is shown.
- Click OK to go to next step.
If you have a trial license, the warning window shows how many effective
days remain.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 12
- Click OK to go to next step.
For a valid license, the window TitleBar will show the license information. For
a license that’s not valid, a license information dialogue box will be shown, as well
as window TitleBar.
The following are the License information dialogue boxes:
Standard user license has expired.
onTune still works, however support
is limited.
Trial license has expired. Standard
license should be registered. Refer
to “3. onTune License
Management.”
No License was registered. onTune
License should be registered. Refer
to “3. onTune License
Management.”
The MACHINE ID CODE is onTune generated from your particular computer
system parameters. It is a unique identifier that will be used as a component of
the license key. You must provide the machine ID code in order to obtain an
onTune license.
Window TitleBars are as follows;
License
type
Effectiveness TitleBar Remarks
Standard Valid Standard License for
CUSTOMER
CUSTOMER:
customer name.
Feb. 20, 2014 :
Expiry date of
license
Expired Limited Support License for
CUSTOMER
Trial Valid Trial License - Expired on Feb. 20, 2014
Expired Trial License - Expired
None No License Found
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 13
License Information Dialogue Box texts shown on onTune Admin or Viewer:
License Type Effectiveness Dialogue texts
Standard Valid No dialogue box will be shown.
Expired Your license has expired. Your onTune system will
still work properly with limited support. Please contact onTune support to obtain new
license. Register your new license using onTune
Admin. MACHINE ID CODE = XXXX.
Trial Valid No dialogue box will be shown.
Expired Your trial license has expired. Register your valid license using onTune Admin.
Please contact onTune support to obtain valid
license. Register your new license using onTune Admin.
MACHINE ID CODE = XXXX.
None Please register your valid license using onTune
Admin.
Please contact onTune support to obtain valid
license.
MACHINE ID CODE = XXXX
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 14
2.1 Main Window and Menu
- ① onTune Admin top line TitleBar shows version and license information.
License Information Messages
Standard License for CUSTOMER: CUSTOMER license is valid. Limited Support License for CUSTOMER: CUSTOMER license
has expired. Trial License - Expires on Feb. 20, 2014: onTune runs on a
Trial license that will expire on date. Trial License – Expired: Trial license has expired.
- ② Window menu
File : Config, Upload Update Files, Exit View : Message Toggle License : Register/Update, View License About
- ③ Admin Configuration icon and Refresh icon
- ④ Window controls
- ⑤ Admin Utility tabs
- ⑥ Servers(hosts) selection window
- ⑦ Information window of servers (hosts) selected. Some fields may be
modified.
- ⑧ onTune runtime log messages.
If the configuration file (.\config\config.ini) does not exist or the operating
environment settings are incorrect, a “connection to database error” will occur.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 15
-Click OK.
This is an example with the PostgreSQL.
Just Click OK.
-Click OK.
When this error occurs, Click OK and verify the correct configuration settings
using the Config Menu. Stop and Re-execute onTune Admin. (Refer to “2.2 onTune
Admin Environments Settings.”
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 16
2.2 onTune Admin Environments Settings
onTune Admin runtime environment settings are set via the Admin menu, or by
manually editing the configuration file. In both cases, new settings are applied
when Admin re-executes.
2.2.1 Environment Settings Manually
The configuration file onTune.ini is found in the config directory where the
onTune Admin directory is installed. Modify the following entries. Environment
settings can also be configured via the Config menu. Refer to “2.2.3 Environment
Settings via Config Menu” to configure environment settings via Admin menu.
[DB]
Host=
Port=
Database=
Stamp=
Code=
User=
Password
Section Entry Default Comments
[DB] HOST= 127.0.0.1 IP address of Database server.
Port= 3306 5432
Listening port number of Database. The
default value of MariaDB is 3306,
PostgreSQL 5432.
Database= onTune Database name
DBType= 3 4
3 is PostgreSQL
4 is MariaDB
Stamp= onTune’s internal codes, do not modify.
Code= User= Login ID and password to database. These
are deleted after first access to database. Password=
To apply the new settings, save the modified file and re-execute onTune Admin.
2.2.2 Environment Settings at First Execution
When onTune Admin is executed for the first time, without configuring
environment settings manually, a database connection error will occur due to
incorrect environment settings.
- Click OK.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 17
This is an example with PostgreSQL.
Just Click OK.
- Click OK.
When this error occurs, Click OK and verify correct configuration settings on
the following environment setting window below. Input the onTune Manager’s
database information correctly.
- Host is IP Address of database server. The default value is Local (127.0.0.1).
This should be confirmed by database administrator.
- Select database engine which will be used in DB Type selection box.
- Port is Listening port of database engine. The default value of MariaDB is
3306, PostgreSQL 5432. If database installed in custom mode or settings
were changed, this port number should be confirmed by database
administrator.
- Database is the name of database for onTune Manager. The default value is
ontune. This should be confirmed by database administrator.
- Username is the user account ID of database to access database engine.
The default value is ontune. This should be confirmed by database
administrator.
- Password is the user password of database to access database engine. The
default value is teemstone. This should be confirmed by database
administrator.
- Click OK to save new environment settings.
- Click Cancel to cancel environment settings.
Following is a sample of config.ini file.
[DB]
Host=127.0.0.1
Port=5432
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 18
Database=ontune
Stamp=705070290BDD
Code=6BF2603FA418722D13
Stamp and Code are onTune’s internal codes, do not modify. After saving new
environment settings, the following dialogue box will appear.
- Click OK to go to next step.
Stop and re-execute onTune Admin.
Whenever Admin runtime environment settings are modified, onTune Admin
must be re-executed.
2.2.3 Environment settings via Config Menu
To manage onTune Manager with other database than the configured database
in Admin’s configuration file, reset Admin configuration settings based on the
connection information of Manager’s database. New environment settings can be
configured via Admin’s Config menu. If you want to configure environment settings
manually, refer to “2.2.1 Environment Settings Manually.”
Select Config menu or Click configuration icon ( ).
- Host is IP Address of database server. The default value is Local
(127.0.0.1). This should be confirmed by database administrator.
- Select database engine which will be used in DB Type select box.
- Port is Listening port of database engine. The default value of MariaDB is
3306, PostgreSQL 5432. If the database installed in custom mode or
settings are changed, this port number must be confirmed with your
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 19
database administrator.
- Database is the name of database for onTune Manager. The default value is
onTune. Confirm this with your database administrator.
- Username is the user account ID of database to access database engine.
The default value is onTune. Confirm this with your database administrator.
- Password is the user password of database to access database engine. The
default value is onTune. Confirm this with your database administrator.
- Click OK to save new environment settings.
- Click Cancel to cancel environment settings.
The following is a sample of the config.ini file.
[DB]
[DB]
Host=127.0.0.1
Port=5432
Database=ontune
Stamp=705070290BDD
Code=6BF2603FA418722D13
Stamp and Code are onTune’s internal codes, do not modify. After saving new
environment settings, the following dialogue box will appear.
- Click OK to go to next step.
Stop and re-execute onTune Admin.
Whenever Admin runtime environment settings are modified, onTune Admin
must be re-executed.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 20
2.3 License Registration
Refer to “3. onTune License Management” to register onTune License.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 21
2.4 Menus and Icons
onTune Admin has the following menu structure. The functions of onTune Admin
menu are described in “4. Functions of Admin Menu” for main menus, “5. User
Management for onTune Viewer”, “6. Server (Host) Grouping and Performance
Monitoring Settings” and “7. Other onTune Admin Functions” for tab functions.
- Main Menu
File - (Refer to “4.2 File Menu”)
Config
Upload Update Files
Exit
View - (Refer to “4.3 View Menu”)
Message
License – (Refer to “3. onTune License Management”)
Register / Update
View License
Help – (Refer to “4.5 Help Menu”)
About
- Icons – (Refer to “4.6 Admin Icons”)
Configure Environment Settings
Refresh Admin windows
- Tab Menu
Agent Config – (Refer to “6.2 Server(Host Items on Information
Windows” and “6.6 Performance Information Collection Settings”)
Group – (Refer to “6.4 User Defined Server(Host) Groups”)
User Permission – (Refer to “5. User Account Management for onTune
Viewer”)
Utility – (Refer to “7.1 File Upload and Download, Command
Execution”)
User Job Scheduling – (Refer to “7.2 Defining and Executing User
Job”)
User Job Scheduling to File – (Refer to “7.2 Defining and Executing
User Job”)
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 22
3. onTune License Management
The onTune licensing process is managed via the License menu in the main
menu.
3.1 Overall Introduction to onTune License Management
Management of the onTune license is based on onTune License management
policy and the end-user license agreement. onTune offers a standard license and a
trial license.
Standard License
The user purchases an onTune License and installs onTune software. The
license effective periods is 1 year from delivery date, and the license must be
renewed annually. (The exception is if user purchases onTune software with a
special license agreement including specified license validity periods).
Upon license expiry, the user may continue to use onTune, but will only
receive limited support.
- During license valid period, the user is entitled to :
Use onTune software.
Bug fixes and upgrade patches for the licensed version.
No cost support by phone and e-mail.
Receive on-site support. (for those who have a special support
agreement.)
- After the date of expiry, the user is entitled to:
Use onTune software.
Receive limited support. (Support costs may be charged on a case by
case basis.)
Trial License
A Trial license is provided for testing or proof-of-concept of onTune in the
user’s environment. A Trial license is valid for 30 days from installation.
onTune Admin displays the license information at the very first step of
execution. If the license is unregistered, the following message is displayed.
- Click OK to go to next step.
If you have a trial license, the following dialogue box shows how many
effective days remain.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 23
- Click OK to go to next step.
For a valid license, the window TitleBar will display the license information.
For an invalid license, the dialogue box below appears, as well as window TitleBar.
License information dialogue boxes are as follows;
Standard user license has expired.
onTune still works, however support
is limited.
Trial license has expired. Standard
license should be registered. Refer
to “3. onTune License
Management.”
No License was registered. onTune
License should be registered. Refer
to “3. onTune License
Management.”
The MACHINE ID CODE is onTune generated from your particular computer
system parameters. It is a unique identifier that will be used as a component of
the license key. You must provide the machine ID code in order to obtain an
onTune license.
Window TitleBars are as follows;
License
type
Effectiveness TitleBar Remarks
Standard Valid Standard License for
CUSTOMER
CUSTOMER:
customer name:
License Expiration
date Expired Limited Support License for
CUSTOMER
Trial Valid Trial License - Expired on date
Expired Trial License - Expired
None No License Found
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 24
License Information Dialogue Box texts shown on onTune Admin or Viewer:
License Type Effectiveness Dialogue texts
Standard Valid No dialogue box is shown.
Expired Your license has expired. Your onTune system will
still work properly with limited support. Please contact onTune support to obtain new
license. Register your new license using onTune
Admin. MACHINE ID CODE = XXXX.
Trial Valid No dialogue box will be shown.
Expired Your trial license has expired. Register your valid license using onTune Admin.
Please contact onTune support to obtain valid
license. Register your new license using onTune Admin.
MACHINE ID CODE = XXXX.
None Please register your valid license using onTune
Admin.
Please contact onTune support to obtain valid
license.
MACHINE ID CODE = XXXX
License management menus are as follows;
- Main Menu
File
View
License
Register / Update
View License
Help
- Icons
- Tabs
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 25
3.2 License Registration and Update
The onTune License is registered and updated via the License Menu. Select
Register / Update menu under License menu. (You must obtain the License file
from ontune support prior to license registration or update.)
Select Register / Update under License menu.
Warning: License must be registered on each server where onTune Manager
runs. When running multiple onTune Managers, onTune licenses are
issued for each onTune Manager, with the corresponding number of
Agents and Viewers. Except for a trial license, user must provide
MACHINE ID CODE when requesting license. The Trial license (30 days, 16 Agents and 4 Viewers) does not require a MACHINE ID CODE to be
issued, but do require user information to forward the license file(s). When onTune Manager is re-installed on a different server, a license for
the new server will be issued from the customer request using the
existing license file, and the new server’s MACHINE ID CODE. Refer to “2. Execution of onTune Admin” to obtain MACHINE ID CODE. If you
have difficulty locating the MACHINE ID CODE, please contact onTune
Support.
Locate the onTune license in the license folder. Click Open.
The following dialogue box will show for an invalid license file.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 26
- Click OK to return to main window.
If you try to register a Trial license where a Trial license is already registered,
you’ll see the following dialogue.
- Click OK to return to main window.
To extend a Trial license, please contact onTune support.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 27
3.3 View Registered License
Select View License under License menu.
If license is not registered, the following message is shown.
- Click OK to go to next step.
You’ll see the following window.
- Host : Server where license is registered
- Machine ID Code : MACHINE ID CODE which was used by onTune to issue
license
- License Type
Standard or
Trial
- Core / Node : Number of Agents allowed
- Viewer User: Number of Viewer User allowed (Additional users allowed in
addition to basic number.)
- Date of Expiry
- Click OK
If the license is registered, you’ll see the following window:
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 28
- Host : Server where license is registered
- Machine ID Code : MACHINE ID CODE which was used by onTune to issue
license
- License Type
Standard or
Trial
- Core / Node : Number of Agents allowed
- Viewer User: Number of Viewer Users allowed (In addition to basic number
of viewer users.)
- Date of Expiry
- Click OK
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 29
4. Functions of Admin Menu
4.1 Menu Structure Main menu structure is as follow;
- Main Menu
File - (Refer to “4.2 File Menu”)
Config
Upload Update Files
Exit
View - (Refer to “4.3 View Menu”)
Message
License – (Refer to “3. onTune License Management”)
Register / Update
View License
Help – (Refer to “4.5 Help Menu”)
About
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 30
4.2 File Menu
4.2.1 File > Config
Configure onTune Admin environments settings. Refer to “2.2 onTune Admin
Environment Settings.”
4.2.2 File > Upload Update Files
The onTune Viewer is updated automatically usually via the online update URL.
In the case where the onTune Viewer-installed PC cannot access the internet, the
Viewer must be updated manually. A new Viewer executable is updated Using
Upload Update Files under File menu. When this menu selected, a file browser will
be displayed.
- Locate and Select the new onTune Viewer executable file, and the version
information file:
OnTuneViewerVersion.ini
onTuneViewer.exe
- Click Open. If selected file is the correct onTune Viewer, the Viewer will be
updated by onTune Manager. (This step is unnecessary if onTune Viewer is
configured to be updated automatically. Refer to “2.3 Viewer Configuration
and Version Update” in onTune Version 4 Viewer User Guide.)
4.2.3 File > Exit
Stop Admin process when selected.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 31
4.3 View Menu
This is a toggle menu to display or not display onTune Manager logs.
Message On
Select View > Message menu to turn message window display on when message
window is absent.
- onTune Manager log messages are shown at bottom of window.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 32
Message Off
Select View > Messages menu when message window is not displayed.
- onTune Manager log messages are not shown in bottom of window.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 33
4.4 License Menu
Refer to “3. onTune License Management.”
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 34
4.5 Help Menu
Displays onTune Admin module information.
- Click OK.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 35
4.6 Admin Icons
Admin has two icon menus.
Click icon to configure Admin environments settings.
Click icon to refresh left Server (Host) navigation window and right Server
(Host) information window.
4.6.1 onTune Admin Environments Settings
Refer to “2.2 onTune Admin Environments Settings.”
4.6.2 Refresh Click icon .
- Left window – area ⑥ – of Host Tree and Group Tree, and right window –
area ⑦ – of Server (Host) information will be updated with the latest
information.
- onTune Manager log messages are automatically updated whether Refresh
icon is clicked or not.
- Refer to “6. Server (Host) Grouping and Performance Monitoring Settings”
to for description of window ⑥ or ⑦.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 36
5. User Management for onTune Viewer
To manage onTune Viewer user account, Click User Permission tab. To manage
Admin user login information, refer to “2.2 onTune Admin Environments Settings.”
The user accounts parameters defined here are used to login to onTune Viewer.
When a user login to onTune Viewer, only assigned Server(s)’ information will be
shown on his/her PC. The Main window display is as follows:
- Window ① is the list of defined already user accounts.
- Window ② is the list of servers (hosts) accessible to the selected user from
window ①.
- Window ③ is the list of available servers (hosts) to be accessible to the
selected user from window ①.
The columns in window ② or ③ are as follows. When you click on the column
name, the contents of the window are sorted in ascending order. Another click on
the column name will cause window contents to be sorted in descending order.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 37
Name is hostname.
OS is operating system information.
Group shows the default group where host belongs. Agent Version is Agent Version.
Replication shows where the Agent connects to, Primary or Secondary Manager.
Click Name, window displays below:
The contents are ordered by Name in ascending order. (Case sensitive, i.e.,
uppercase letters will display ahead of lowercase letters.)
Click Name again, contents are sorted in descending order.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 38
5.1 Creating User Accounts
Click icon in the red box.
The user account creation window is displayed.
- User Name is the name of user account to be created.
- Password is the password of user account to be created.
- All Hosts, (if selected), all of the servers (hosts) will are accessible to this
user.
- Click OK to create new user account.
- Click Cancel to cancel.
The following example shows a user account created with the above
information.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 39
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 40
5.2 Modifying User Account Information
Select a user from the user list and Click icon , or double-click name of user,
to modify selected user information.
The user information modification window displays below:
- User Name is the name of user account to be modified.
- Password is the password of user account to be modified.
- All Hosts, (if selected) all of the servers (hosts) are accessible to this user.
- Click OK to modify user account information.
- Click Cancel to cancel.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 41
5.3 Deleting User Account
Select a user from user list and Click icon in the red box to delete selected
user account.
The confirmation window displays below.
- Click Yes to delete user.
- Click No to cancel.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 42
5.4 Assigning Servers (Hosts) to the User
The Assigned Host List window ② and Host List window ③ is where you may
assign servers (hosts) to the user. The Assigned Host List is the list of servers
(hosts) which are accessible to the selected user; while the Host List is the list of
available servers (hosts) which may be made accessible to the selected user.
Assign Servers (Hosts) to be allowed to selected user
Select server(s) to be made accessible to the user from the Host List window,
then drag and drop them into the Assigned Host List window to assign Server(s)
to the selected user.
Exclude Servers (Hosts) from selected user
Select server(s) to be excluded from the Assigned Host List window, then
drag and drop them into the Host List window to delete Server(s) from the
selected user. Alternately, you may select server(s), and Click top-right icon .
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 43
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 44
6. Server (Host) Grouping and Performance Monitoring Settings
onTune Admin provides 2 methods to locate and select servers (hosts) for
display of their performance parameters on onTune Viewer and Event Viewer. One is
through user-defined server (host) groups for easy navigation, and the other is to
use server (host) trees that are created by onTune automatically. Both navigation
trees are shown in the left window when you choose the Agent Config tab menu.
User-defined server (host) groups are managed via the Group tab menu
User-defined server (host) group structure are created and maintained by
onTune Admin. Server (host) navigation trees created by onTune automatically are
described in “6.3 Automatically Created Server (Host) Tree - Host List”; and user-
defined server (host) groups for navigation are explained in “6.4 User Defined
Server (Host) Groups – Group List.”
The onTune user may configure monitoring parameter settings that apply to
each server; or all servers selected for following entries. For environments
settings details, refer to “6.6 Performance Information Collection Settings.”
- Performance Data Collection criteria (No option settings required.)
All servers where onTune Agent are installed will be monitored, except
for those with the set execution option. (This server(s) are excluded
from monitoring if the Execute Once option was selected with the
Agent Installer; or using the installation shell script with execution
option set to 0.) Refer to “4. onTune Agent Installation” in onTune
Version 4 Installation Guide for details.
The following performance information is collected automatically
without any specific definition. Refer to “onTune Version 4 Viewer User
Guide” for details.
CPU resource usage
Memory resource usage
Disk resource usage
IO resource usage
OS and user processes
Virtual system resource usage
File system usage
And others which may affect to system performance
- The following entries may be defined. You need not modify the entries if
you are satisfied with the default values.
Short term (real-time) performance data collection interval.
Long term performance data collection interval.
User defined command to execute (no default)
Shell script
Shell script file
File upload and download to/from server where Agent runs
The default values for performance data collection interval are described in
“3.2 onTune Manager Configuration” in “onTune version 4 Installation Guide.”
onTune Admin let’s you set the performance data collection interval; activate
or disable Agent; and set the Time Check option; and apply them to specific or all
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 45
selected servers. This chapter describes where to find and select server(s) and
configure settings. Finding and selecting server(s) is done from the all server list,
or group list, and thru the server filter or finder.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 46
6.1 Server (Host) Navigation Window and Information Window
onTune presents the 2 navigation trees, Host List - host tree created by onTune
automatically based on collected server information, and Group List – user defined
group(s) in the server (host) navigation window and server (host) information
window.
- Window ⑥ is server (host) navigation window. Host List is default display.
- Window ⑦ is server (host) information window ⑥, where selected servers
(hosts) information are displayed.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 47
6.2 Server (Host) Items on Information Window
Server (Host) information is as follows:
- ① Property fields list the item names of information being displayed.
- ② If the item values of all selected servers are same, the common value
is displayed, otherwise it remains blank. This filed may be used to input
values to apply to all selected servers (hosts).
- ③ Item values of each server is displayed. This field may be used to input
values to apply to each server (host).
6.2.1 General Information Items - Common
Common contains general information on Agents and Servers. These are not
editable except Time Check and Active fields.
- Common
ID is the unique Agent identification key assigned to each Agent upon
connection to the Manager. The Agent ID is remains unchanged until
onTune Manager re-installation.
Active is the performance collection state. Yes means Agent is running,
and collecting server performance data; No means collection of server
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 48
performance data is disabled.
Connected is communication session status between Agent and
Manager.
Group is the name of the group where server belongs.
Host Name is name of the server (host).
IP Address is the IP address of the server (host).
Model is the HW model of the server(host)
Operating System is the OS and OS version of the server (host).
S/N is HW serial number of server (host).
Primary/Secondary shows whether Agent connects to the Primary or
Secondary Manager.
Time Check is a flag to check server time periodically, or not.
6.2.2 Short Term (Real-time) Performance Data
Collection Interval
Short-term Interval (sec) are the short term intervals for collecting server
performance data, and is modifiable.
- Short Term (Real-time) Performance Data Collection Interval
Basic is interval for collecting basic server performance data.
Process is interval for collecting Process performance data of each
server.
I/O is interval for collecting IO performance data of each server.
CPU is interval for collecting CPU performance data of each server.
6.2.3 Long Term Performance Data Collection Interval
Long-term Interval (sec) are the long term interval for collecting server
performance data, and is modifiable.
- Long Term Performance Data Collection Interval
Basic is interval for collecting basic server performance data.
Process is interval for collecting Process performance data of each
server.
I/O is interval for collecting IO performance data of each server.
CPU is interval for collecting CPU performance data of each server.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 49
6.3 Automatically-Created Server (Host) Tree - Host List Host List is a server (host) tree structure list automatically created by onTune
based on Agent-collected server information. Tree levels are as follows:
- The structure of Host List
Highest level : Host List
1st level : All List
2nd level: grouped by OS (AIX, HP, Linux, SUN, Windows).
3rd level: grouped by FW version.
4th level: grouped by HW serial number.
Bottom level : Server(Host) name
Host List is updated with the latest information by clicking the refresh icon .
Double-clicking the name of a server(s) or branch(s) of the tree will expand or
collapse that branch. Clicking the specific icon will expand or collapse the entire
tree. Finding and selecting specific server(s) is explained in “6.5 Select Server
(Host) to be Configured.”
6.3.1 Initial Windows of Host Tree and Server Information Window
Only highest level of tree is shown.
In the server information window, the information of all servers are shown.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 50
6.3.2 Host List and Server Information Window when
Step-by-step Unfolding Selected
When step-by-step unfolding is selected, the tree from the highest level to the
current selected branch are expanded and displayed.
In server information windows, the information of all servers under the
selected branch are displayed.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 51
6.3.3 Expanding Whole Tree Icon
Clicking the expanding whole tree icon will expand and display the entire
tree and branches in the Host List Window.
Since no server was selected, clicking the expanding whole tree icon cause
no change to display.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 52
6.3.5 Collapsing whole Tree Icon
Clicking the collapsing whole tree icon collapses the entire Host List tree,
and only highest level of the tree is shown.
Since no server was selected, clicking the collapsing whole tree icon cause
no change to display.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 53
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 54
6.4 User Defined Server (Host) Groups
User-defined groups are created and maintained to ease managing of servers.
- The characteristics of user defined groups
The Group name must be unique.
A group may have multiple sub-groups.
Every group must be a sub-group of a super-group, except for the
highest level groups.
A group may have multiple sub-groups as well as multiple servers
(hosts).
The following windows are displayed upon clicking the Group List
- ① The list of highest level groups. Highest level groups are created and
maintained in this window.
- ② The group tree structure associated with the selected highest group in
window ① are shown. Subgroups are created and maintained in window
②.
- ③ The list of servers that are assigned to the group selected in window ②.
- ④ The list of candidate servers that may be assigned to the group
selected in window ②.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 55
6.4.1 Highest Level Group Management
6.4.1.1 Creating Highest Level Group
Click the group creation icon in the red box below to create the highest
level group.
A Group creation window is displayed.
- Group Name is the name of the highest level group to be created.
- Description is a description of the group to be created.
- Default Group is used as the default group when Group List is selected
under the Agent Config tab menu.
- Click OK to create highest level group.
- Click Cancel to cancel.
Upon execution of the above window, a new highest level group “TeemStone”
is displayed in highest group list window below. Selecting the new highest level
group “TeemStone” causes it to be displayed in the subgroup maintaining window.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 56
6.4.1.2 Modifying Highest Level Group Information
Select a highest level group from highest level group list and Click icon , or
double Click on name of the highest level group to modify information of the
selected highest level group.
- Group Name is the name of highest level group to be modified.
- Description is a description of the group to be modified.
- Default Group is used as the default group when Group List is selected
under Agent Config tab menu.
- Click OK to modify highest level group information.
- Click Cancel to cancel.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 57
6.4.1.3 Deleting Highest Level Group
Select a highest level group from highest level group list and Click icon in
the red box below to delete the selected highest level group.
The following confirmation window is shown.
- Click Yes to confirm.
- Click No to cancel.
6.4.2 Sub-Group Management
6.4.2.1 Creating Sub-Group
Select the highest level group where the new sub-group will be included. Click
creating sub-group icon in the red box below to create a new sub-group.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 58
Sub-group creation window is displayed.
- Group Name is the name of the sub-group to be created.
- Click OK to create highest level group.
- Click Cancel to cancel.
For example, create the sub-group named Teem1.
The results of the sub-group creation are shown below:
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 59
6.4.2.2 Modifying Sub-Group Information
To modify a selected sub-group information - Select a sub-group from the
group tree window and Click icon ; or double click the name of the sub-group.
- Click OK to modify information.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 60
- Click Cancel to cancel.
The modification results are displayed below:
6.4.2.3 Deleting Sub-Group
Select a sub-group from the group tree window and Click the icon in the
red box to delete the selected sub-group.
The following confirmation window is displayed.
- Click Yes to confirm.
- Click No to cancel.
The result of the deletion is displayed:
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 61
6.4.3 Assigning Servers to the Group
Assign Servers (Hosts) to selected group
To assign Server(s) to the selected group, select server(s) from the Host List
window; drag and drop it in the Assigned Host List window.
Exclude Servers (Hosts) from selected group
To delete Server(s) from the selected group, select server(s) from the
Assigned Host List window, then drag and drop them in the Host List window.
Alternatively, you may Select server(s), and Click the top-right icon .
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 62
6.5 Select Server (Host) to be Configured
The procedure to set environment settings for server performance data
collection is as follows:
(1) Select server(s) to be configured.
(2) Check the current environment settings.
(3) Input new values.
The server(s) to be configured are selected from Host List or Group List.
6.5.1 Select Server(s) from Host List
Click Host List.
When servers (hosts) are selected from the Host Tree in the left window, the
window to the right displays the selected server(s)’ information. Clicking the host
name of a server at the last level of a tree displays that server’s information.
Selecting a top or middle level of the tree causes the display of several servers’
information.
For example, when a middle tree is selected below, the right window displays
the information of all the servers under that tree.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 63
For this example, the server information window is displayed below:
For more information about information window items, refer to “6.2 Server
(Host) Items on Information Window.” For configuration settings, refer to “6.6
Performance Information Settings.”
6.5.2 Select Server(s) from Group List
Click Group List tab.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 64
User defined groups are displayed below:
Selecting servers (hosts) from the Group List in the left window results in the
display of selected servers information in the right window. Clicking the host name
of a server at the last level of the tree will display the selected server information.
Selecting a top or middle level of the tree will result in the display of included
servers’ information.
For example, selecting the middle tree below results in the information of all
the servers under that tree displayed in the right information window.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 65
The server information window is displayed below for this example:
For more information about “information window” items, refer to “6.2 Server
(Host) Items on Information Window.” For configuration settings, refer to “6.6
Performance Information Settings.”
6.5.3 Find Server (Host)
Server(s) may be found using the “find server” window. You may search for
server(s) by matching certain string(s) in their name; the tree structure; or its IP
address. The method to find servers is similar to the Host List and Group List. The
method described here is based on the Host List.
Click find icon in the Host List window. (In order to find a server with the
most up-to-date Host List or Group List information, click the refresh icon prior
to clicking find icon . For more information about Refresh, refer to “4.6.2
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 66
Refresh.”) onTune Admin will display the server which has the matched strings in
ascending (Forward selected) or descending (Backward selected) order with each
click. Clicking the find icon displays the window below:
- Find: Matching String used for searching server. “*” matches all
character(s).
- Find from First: Start search from the top of the list if selected. Start
from current position if selected.
- Case Sensitive: if checked, letter case is sensitive.
- Except IP Address: if checked, IP addresses are excluded.
- Direction
Forward
Backward
- Click Find to start searching.
- Click Cancel to cancel.
The following window displays if no server is found:
- Click OK to return to find window.
If the server is found, the results are displayed below: (for this example, the
right window – the server information window, is not updated. Server information
windows will be updated when a server or tree branch is selected or clicked. )
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 67
The Host List and Group List tree is expanded from the top level to the level
where that string exists. Admin found string “70” under the AIX branch and
expanded the tree from the top level to the AIX branch. Clicking the Find button
again will display the yellow-highlighted next item.
If a string match is found in multiple branches, the first branch is expanded,
and the next branch will be expanded with each click of the Find button.
The yellow-highlighted branch name is the first match of string “VM.”
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 68
The expanded branches of the first match and second match are shown
The expanded branches from first match to the current match are displayed.
When servers (hosts) are selected from the Group Tree in the left window, the
selected server(s)’ information are displayed in the right window. Clicking the host
name of a last-level-of-tree server will result in the display of that server’s
information. Selecting a top or middle level of the tree will result in the display of
all the included servers’ information.
6.5.4 Server (Host) Filtering
The Host List and Group List may be filtered and displayed using the filter
window. The filter window will use the matching string(s) in the server name; or
tree structure; or IP address. The method to use filtering is similar to the Host List
and Group List. The method described here is based on the Host List.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 69
Using Filtering means to find servers and create new Host List or Group List
that contains servers or trees with matched string(s). To filter via filter window
with latest information of Host List or Group List, Click refresh icon prior to
clicking find icon . For more information about Refresh, refer to “4.6.2 Refresh.”
6.5.4.1 Single Key Filtering
Clicking the filter icon in Host List window results in the display window
below. The Host List and Group List may be filtered by single key or multiple key
filtering using Filter tab on Filtering window. Single key filtering is the default.
- input field - Input the string of filtering key of server (host) name or tree,
including its branches.
- Case sensitive: Case-sensitive if checked.
- Permanent Filtering: If checked, filtered Host List or Group List is
displayed according to the input filter key as default.
- Condition of filtering (one of followings)
Host Name: Filtering by server (host) names.
Group Name: Filtering by Host List tree branches.
IP Address: Filtering by IP addresses of servers (hosts).
OS: Filtering by OS names.
- Click Reset to clear previously-set filtering information. The Filtering
window will close, and the Host List or Group List are created and
displayed without filter in the Host List or Group List window.
- Click OK to apply filtering condition to the Host Tree or Group List. The
new filtered Host List or Group List are created and displayed in the Host
List or Group List. The Filtering condition remains effective until Reset is
applied (clicked).
- Click Cancel to cancel. Any previous filtering condition remains effective.
The Filtering window will be closed.
If no server match the filtering condition, Host List or Group List will be blank,
as is the server information window.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 70
Input “daehan” as filtering string.
No matches. Host List is blank and server information window is also blank.
However “Host List” and “All List” in Host List window are shown without any
branches, since these are the top level of Host List tree. (Even though the “Host
List” or “All List” is clicked/selected, server information window remains blank.)
Filtering Host List by string “re.”
A New Host List is created, and the information of servers satisfying the
filtering condition is displayed in the server information window.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 71
Filtering Host List by string “211” with IP address checked.
A New Host List is created, and the information of servers satisfying the
filtering condition is displayed in the server information window.
6.5.4.2 Multiple Key Filtering
The Host List and Group List may be filtered by multiple keys using Multi Filter
tab on Filtering window. Clicking the filter icon, and then the Multi Filter tab
displays the following window. Each line of the input filter field is a key. Multiple
lines in the input filtering field are “or”ed. A server or tree branch that satisfies
any one condition of the multiple filter keys will be one of the servers displayed.
- input field - Input the string of filtering key of server (host) name or tree,
including its branches. Each line of the input field is key and condition of
filtering.
- Case sensitive: Case-sensitive if checked.
- Permanent Filtering: If checked, filtered Host List or Group List is
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 72
displayed according to the input filter key as default.
- Condition of filtering (one of the following)
Host Name: Filtering by server (host) names.
Group Name: Filtering by Host List tree branches.
IP Address: Filtering by IP addresses of servers (hosts).
OS: Filtering from OS names.
- Click Reset to clear previously-set filtering information. The Filtering
window will close, and the Host List or Group List are created and
displayed without filter in the Host List or Group List window.
- Click OK to apply filtering condition to the Host Tree or Group List. The
new filtered Host List or Group list are created and displayed in the Host
List or Group List. The Filtering condition remains effective until Reset is
applied (clicked).
- Click Cancel to cancel. Any previous filtering condition remains effective.
The Filtering window will be closed.
If no server matches the filtering condition, the Host List or Group List will be
blank, and the server information window is blank.
No matches. Host List is blank and server information window is also blank.
However “Host List” and “All List” in Host List window are shown without any
branches, since these are the top level of Host List tree. (Even though the “Host
List” or “All List” is clicked/selected, server information window remains blank.)
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 73
Filtering Host List by string “211” or “.11” with IP address checked.
A New Host List is created, and the information of servers satisfying the
filtering condition is displayed in the server information window.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 74
6.6 Performance Information Collection Settings
After selecting server(s), you may configure server performance data
collection settings. Refer to “6.5 Select Server (Host) to be Configured” for server
selection. The server performance data collection settings are done in the server
information window. You may set each server individually, or set servers
collectively.
- Window ⑥ is the server (host) navigation window. The Host List is the
default display.
- Window ⑦ is the server (host) information window where selected servers
(hosts) from window, ⑥ information are displayed.
For details, refer to “6.2 Server (Host) Items on Information Window.”
6.6.1 Settings for Single Server (Host)
The settable parameters are - short term (real-time) system performance
data collection interval (Short-term Interval (sec); long term system performance
data collection interval (Long-term Interval (sec); and Active and Time Check in
the common area.
Double-click the field to be modified in area ② below to configure settings for
a single server.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 75
Double-clicking on a field in area (2) results in the following editing window
below:
- Value field - shows the current value, input your new value here.
- Click OK to temporarily save new value in Admin memory.
- Click Cancel to cancel.
If the selected item in not modifiable, the following window is displayed.
- Click OK to return.
Click the save icon to store and apply new changed values. The Save icon
is activated if changes were effected.
6.6.2 Settings for Multiple Servers (Hosts)
The settable parameters are - short term (real-time) system performance
data collection interval (Short-term Interval (sec); long term system performance
data collection interval (Long-term Interval (sec); and Active and Time Check in
the common area.
Double-click the field in the value column to be modified in area ① below to
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 76
configure settings for multiple servers. The new values will be applied to all servers
(hosts) in the information window.
Double-clicking on a field in area (1) results in the following editing window
below:
- Value field – shows current value if all the servers in the information
window have same values for that item; input new value here.
- Click OK to temporarily save new value in Admin memory.
- Click Cancel to cancel.
If the selected item is unmodifiable, the following window is displayed.
Click save icon to store and apply all new changed values. The Save icon is
activated if changes were effected.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 77
7. Other onTune Admin Functions
7.1 File Upload and Download, Command Execution
The Utility tab menu enables the uploading and downloading of files to/from
server(s) where the Agent is operating. Warning: These operations may affect the server(s) where the Agent is
running. Please secure the access password from unauthorized users.
7.1.1 Accessing to Utility Tab Menu
The input password window is displayed upon first- time access to the Utility
tab menu after the onTune Admin installation. (i.e. no password set)
- Utility Password - password input field to access Utility tab menu.
- Confirm Password - password input field for confirming password
- Click OK to create password.
- Click Cancel to cancel. No password is created, and access to Utility tab is
denied if clicked.
If the input password in the Confirm password field is different from the input
password in Utility Password, the following window displays.
- Click OK to return.
If the input password in Confirm password field is the same as the input
password in Utility Password, the following window displays.
- Click OK to go enter Utility window.
If a password is already set, the following password input window will be
displayed. Access is allowed only if the input password is the same as the Utility
Password. Otherwise, access to Utility tab menu is, denied and you will return to
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 78
the previous page.
- Utility Password is the password to access Utility tab menu.
- Click OK to confirm that input password is the same as the Utility
Password.
- Click Cancel to cancel. Access to the Utility tab is denied, and you will
return to previous page if cancel is clicked.
- Click Change to change the Utility Password. The changing Utility
Password window will display.
If you input the wrong password input, the following window displays.
- Click OK to return to previous page.
If you input the correct password, the initial Utility tab menu window is
displayed.
- Window ① is the list of servers (hosts) connected to Manager. Target
servers (hosts) will be selected from the Host List window.
- Browse the upload file, or input the download file name with path, or input
commands to be executed in window ②.
- Window ③ displays the result of the upload, download, or command
execution.
The Host List window shows following server (host) information.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 79
- Host Name is name of server (host).
- Operation is processing or processed order.
- Result is the result of the last upload, download, or command execution.
- OS is the operating system type.
- Group is the name of the server group.
- Agent Version is the version of the onTune Agent running on the server.
- Replication shows Agent is connecting to the Primary (0) or Secondary (1)
Manager Node.
7.1.2 Upload File
Select the Upload File tab in the Utility initial window (the Upload File tab is
the default menu in Utility tab menu) to upload a file from the Admin-resident
computer/server to the Agent-resident server (host). Select target server(s) from
the Host List window ① below.
Mouse operations are similar to window applications.
- Click right mouse button to select single server (host).
- Click right mouse button while pressing control key to add a server to
selected server(s).
- Click right mouse button while pressing shift key to select servers in a
particular range.
For multiple server selections, a server list window similar to one below is
displayed:
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 80
Browse file to upload in window ② above.
Click browse icon to find the file for upload from the explorer window.
Click the left icon to upload binary files, and the right icon to upload ASCII
files.
7.1.3 Download File
Select the Download File tab in the initial Utility window to download files from
the Agent-resident server (host) to the Manager-resident server/computer. Select
target server(s) from the Host List window ① below.
Mouse operations are similar to window applications.
- Click right mouse button to select single server (host).
- Click right mouse button while pressing control key to add a server to the
selected server(s).
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 81
- Click right mouse button while pressing shift key to select servers in a
particular range.
For multiple server selection, a server list window similar to one below is
displayed.
Input the filename in window ② above.
Input filename with path in input field. Entering the filename without the path
results in the whole directory path from root, and the current path becomes the
Agent runtime directory. Click the left icon to upload binary files, and the right
icon to upload ASCII files.
7.1.4 Command Execution
Select Execute Command tab in the initial Utility window to send an execution
command to the Agent for execution on the Agent-resident server. Select target
server(s) from the Host List window ① below.
Mouse operations similar to window applications.
- Click right mouse button to select single server (host).
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 82
- Click right mouse button while pressing control key to add a server to the
selected server(s).
- Click right mouse button while pressing shift key to select servers in a
particular range.
For multiple server selection, a server list window similar to one below is
displayed.
Input the Execution command in Window ② above.
The example below will execute “ls –l.” Click icon to execute input command.
The result of the execution is displayed in window ③. If the command
executes on multiple servers, the result for each server is shown in turn.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 83
For this instance, the result of each server is shown in the Result column in
the server list window.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 84
7.2 Defining and Executing User Job
Scripts and script files may be sent to Agent-resident node/server and
executed using the User Job Scheduling or the User Job Scheduling to File tab
menu. Warning: These operations may affect the server(s) where the Agent is
running/resident. Please secure the access password from unauthorized users.
User Job Scheduling and User Job Scheduling To File differ as follows:
User Job Scheduling User Job Scheduling to
File
Job Editing Job Script is directly
edited using onTune Admin
window.
Create Job Script File
using other tool.
Input data files for Job
Script
Not permitted. Allowed
Run once a day. Supported Supported
Periodic executions
within 24 hours.
Supported Not Supported
WMI Supported Not Supported
Results stored in: onTune database. The output file.
output\[Name]_[Hostname]_[yyyymmddhhmm].l
og
Displayed on onTune
Viewer Supported (Chart and
Table types)
Results are displayed in onTune Viewer’s User Job
Results (Chart) and/or
User Job Results (Table)
menu.
Not Supported
7.2.1 Accessing User Job Scheduling / User Job Scheduling from File Tab Menu
Your first-time access of the User Job Scheduling or the User Job Scheduling
to File tab menu after onTune Admin installation will display the input password
window below: (i.e. no password set)
- Scheduling Password is the password to access the User Job Scheduling or
User Job Scheduling to File tab menu.
- Confirm password is input field to confirm password
- Click OK to create password.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 85
- Click Cancel to cancel. No password is created, and you are denied
access to the User Job Scheduling or the User Job Scheduling to File tab.
A different password input to the Confirm Password field from the Scheduling
Password will result in the following window displayed.
- Click OK to return.
If the password input in the Confirm Password field is same as the Scheduling
Password, the following window is displayed.
- Click OK to enter the User Job Scheduling or User Job Scheduling to File
window.
If the password is already set, the following password input window will
display. Access is granted only if the password input is the same as the
Scheduling Password. Otherwise, access to User Job Scheduling or User Job
Scheduling to File tab menu is denied, and you are returned to the previous page.
- Scheduling Password is the password to access User Job Scheduling or
User Job Scheduling to File tab menu.
- Click OK to confirm the input password.
- Click Cancel to cancel. Access to User Job Scheduling or User Job
Scheduling to File tab is denied, and you are returned to previous page.
- Click Change to change Scheduling Password. The Changing password
window is displayed.
If you input an incorrect password, the following window is displayed.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 86
- Click OK to return last page.
A correct password input will display the User Job Scheduling or User Job
Scheduling to File tab menu initial below:
Initial window of “User Job Scheduling” Menu
Initial window of “User Job Scheduling to File” Menu
Click the User Job Scheduling tab to directly edit script in the Scheduling
window for execution by the Agent. Click the User Job Scheduling to File tab to
send pre-edited script file for execution by Agent.
7.2.2 Managing User Job Script – User Job Scheduling
Select User Job Results (Chart) or User Job Results (Table) menu in the
onTune Viewer to display the results of User Job execution.
The User Job Scheduling window is shown below:
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 87
- The current executable User Job Scheduling list is displayed in window ①.
- Edit the Script in window ②.
- Window ③ is the list of target servers that are assigned by the selected
script in window ①.
- Window ④ is the list of candidate servers that may be assigned as targets
of the selected script in window ②.
7.2.2.1 Creating User Job Script
Click the icon in the red box below.
The editing window is displayed below:
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 88
- Name is the name of the User Job.
- Description is a description of the User Job.
- Schedule is the time to execute.
(A Scheduled Job is executed once a day if Periodic is not
checked. For example, a schedule entry of 00:10:00 without
Periodic checked results in the execution of the script at
00:10AM every day. With Periodic checked, a Schedule entry of
00:10:00 results in the execution of the script every 10 minutes
at 00, 10, 20, 30, 40, 50 minutes of the hour.)
- Periodic denotes the user job is to be executed periodically.
- WMI denotes the Windows WMI script.
- OS Group denotes the target OS for execution.
0 - runs on selected server(s).
1 – runs on all UNIX server(s).
2 – runs on all Linux server(s).
3 – runs on all Windows server(s).
- Script - Edit the user job script in the Script window.
- Field is a masking function for displaying results. (For example, if the
results for the server is “Diskname : AAA”; and you want the display to be
“Diskname = AAA”, then input “=” in Field.) This name will be used as Tab or Column name in onTune Viewer’s User Job Results (Table) menu. Refer
to “7.16 User Job Results (Table) Menu” in “onTune Version4 Viewer User
Guide.”
After you have finished editing the script editing, Click icon to execute it
once and as defined, or click icon to run script as defined.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 89
The edit window is enlarged during editing for ease of use.
Assign Servers (Hosts) to the target of script
To assign server(s) to the selected group, select the server(s) to be included
in the target of selected script from the Host List window, then drag and drop
them in the Assigned Host List window
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 90
Exclude Servers (Hosts) from target of selected script
To delete server(s) from the target of the selected script, select the server(s)
to be excluded from the Assigned Host List window, then drag and drop them in
the Host List window. Alternatively, you may select server(s); and click the top-
right icon .
7.2.2.2 Editing User Job Script
Select a Scheduled User Job (script) from the Scheduling List window.
The following script editing window is displayed.
- Name is the name of the User Job.
- Description is a description of the User Job.
- Schedule is the time to execute.
(A Scheduled Job is executed once a day if Periodic is not checked.
For example, a schedule entry of 00:10:00 without Periodic
checked results in the execution of the script at 00:10AM every
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 91
day. With Periodic checked, a Schedule entry of 00:10:00 results
in the execution of the script every 10 minutes at 00, 10, 20, 30,
40, 50 minutes of the hour.)
- Periodic denotes the user job is to be executed periodically.
- WMI denotes the Windows WMI script.
- OS Group denotes the target OS for execution.
0 - runs on selected server(s).
1 – runs on all UNIX server(s).
2 – runs on all Linux server(s).
3 – runs on all Windows server(s).
- Script – Edit the user job script in the Script window.
- Field is a masking function for displaying results. (For example, if the
results for the server is “Diskname: AAA”; and you want the display to be
“Diskname = AAA”, then input “=” in Field.) This name will be used as Tab or Column name in onTune Viewer’s User Job Results (Table) menu. Refer
to “7.16 User Job Results (Table) Menu” in “onTune Version4 Viewer User
Guide.”
After you have finished editing the script editing, Click icon to execute it
once, or click icon to run script as defined.
The edit window is enlarged during editing for ease of use.
Assign Servers (Hosts) to the target of script
To assign server(s) to the selected group, select the server(s) to be included
in target of selected script from the Host List window, then drag and drop them in
the Assigned Host List window
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 92
Exclude Servers (Hosts) from target of selected script
To delete server(s) from the target of the selected script, select the server(s)
to be excluded from the Assigned Host List window, then drag and drop them in
the Host List window. Alternatively, select server(s) and click the top-right icon .
7.2.2.3 Deleting User Job Script
Select a Scheduling Job (script) from the Scheduling List window, and click
the icon to delete the script.
The following is displayed after deleting.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 93
7.2.3 Executing Pre-created Script File – User Job Scheduling to File
The results of an executed User Job via a Pre-created Script File won’t be
displayed in the onTune Viewer. To view the results, see the log files
[Name]_[Hostname]_[yyyymmddhhmm].log in the output folder. (Name is the
name of User Job, Hostname is the server name where script ran,
yyyymmddhhmm is run time.
The onTune Manager transmits the script file with information saved by Admin
to the Agent for execution on the Agent-resident server(s).
Below is the initial display:
- The current executable User Job Scheduling list is displayed in window ①.
- The Script is registered in window ②.
- Window ③ is the list of servers that are assigned as the target of the
selected script in window ①.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 94
- Window ④ is the list of candidate servers that may be assigned as the
target of the selected script in window ②.
7.2.3.1 Registering Pre-created Script File Information
Click the icon in the red box below.
An editing window is displayed below.
- Name is the name of the User Job.
- Description is a description of the User Job.
- Schedule is the time to execute. A script file registered by onTune Admin is
executed once a day at a defined time in hh:mm:ss format.
- OS Group is the target OS for execution.
0 - runs on selected server(s).
1 – runs on all UNIX server(s).
2 – runs on all Linux server(s).
3 – runs on all Windows server(s).
- Script File is the browse window to locate a script file.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 95
- Data File is the input field to register input data files for script file.
Click the icon to browse for the Script File.
As with script files, browse for data files using the explorer window. To delete
data file from the list, select file(s) to be deleted, and click the icon .
After you have finished editing the script file, click the icon to run script file
as defined.
Assign Servers (Hosts) to the target of script
To assign server(s) to the selected group, select the server(s) to be included
in the target of the selected script from the Host List window, then drag and drop
in the Assigned Host List window
Exclude Servers (Hosts) from target of selected script
To delete server(s) from the target of the selected script, select server(s) to
be excluded from the Assigned Host List window, then drag and drop in the Host
List window. Alternatively, select server(s), and click top-right icon .
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 96
7.2.3.2 Modifying Pre-created Script File Information
Select a Scheduled User Job (script file) from the Scheduling List window.
The following script editing window is displayed.
- Name is the name of User Job.
- Description is a description of the User Job.
- Schedule is the time to execute. A Script file registered by onTune Admin is
executed once a day at defined the time in hh:mm:ss format.
- OS Group is the target OS for execution.
0 - runs on selected server(s).
1 – runs on all UNIX server(s).
2 – runs on all Linux server(s).
3 – runs on all Windows server(s).
- Script File is a browse window to locate the script file.
- Data File is the input field to register input data files for script file.
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 97
Click the icon to browse Script File.
As with script files, you may browse for data files using the explorer window.
To delete data file from the list, select file(s) and click the icon .
After you have finished editing the script file, click the icon to run the
script file as defined.
Assign Servers (Hosts) to the target of script
To assign server(s) to the selected group, select the server(s) to be included
as the target of the selected script from the Host List window, then drag and drop
in the Assigned Host List window.
Exclude Servers (Hosts) from target of selected script
To delete server(s) from the target of the selected script, select the server(s)
to be excluded from the Assigned Host List window, then drag and drop them in
the Host List window. Alternatively, select server(s), and click the top-right icon .
2013© TeemStone All Rights Reserved
onTune V4 Admin User Guide 98
7.2.2.3 Deleting Pre-created Script File Information
To delete a script file, select a Scheduled User Job (script file) from the
Scheduling List window, and click the icon