Professional Documents
Culture Documents
Instructions
Introduction .................................................................................................................................................................................. 3
1. Measurement Overview ..................................................................................................................................................... 3
1.1. Conventions .............................................................................................................................................................. 4
1.2. Files Overview .......................................................................................................................................................... 5
1.3. Base Script ............................................................................................................................................................... 5
1.4. Data Collection Scripts ............................................................................................................................................. 5
1.5. CPU Scripts .............................................................................................................................................................. 6
2. Data Collection ................................................................................................................................................................... 6
2.1. Technical Requirements ........................................................................................................................................... 6
2.2. Credentials Requirements ........................................................................................................................................ 8
2.3. Running the Scripts .................................................................................................................................................. 8
On Linux / UNIX Systems ........................................................................................................................................................ 9
Examples - Running the Tool on Linux / UNIX ...................................................................................................................... 11
On Windows Systems ............................................................................................................................................................ 12
Examples - Running the Tool on Windows ........................................................................................................................... 13
Partitioned Servers - LMSCPU Script .................................................................................................................................... 15
Multiplexing architecture ........................................................................................................................................................ 15
3. Troubleshooting Initial Phase .......................................................................................................................................... 15
Troubleshooting Executing Phase ............................................................................................................................................ 16
4. Collected Data Description .............................................................................................................................................. 16
This document is owned by Oracle License Management Services – Global Business Services. Revisions may only be made
with the written approval of appropriate Program Manager.
1. Measurement Overview
This document describes the technical steps required to collect license measurement data for the following Oracle products:
This document and all information contained herein are STRICTLY CONFIDENTIAL and are for use by Oracle and
Customers for the purposes of Oracle license usage measurement. They are not to be divulged in whole or in part whether
electronically or as hard copy to any third party without the express permission of Oracle or an authorized signatory.
The Oracle LMS Collection Tool (referred to herein as the “LMS Collection Tool” or “tool”) is a collection of scripts that are
executed from within the operating system of the server(s) where the Oracle Software is installed. In what follows, “Oracle
Software” designates all the products listed above. This tool detects and collects measurement data for the Oracle Software
running on Windows servers and most versions of UNIX and Linux.
Note: Running scripts outside of the LMS Collection Tool is not recommended or supported by Oracle LMS. In
addition, by accessing the scripts outside of the tool, you thereby agree to the Oracle LMS License Agreement.
Files Overview – Provides information on the files included in the LMS Collection Tool.
Technical Requirements – Provides an overview on the pre-requisite information (credentials, domain names,
machine name, environment variable, etc…) required to run the tool
Credentials Requirements – Provides a summary of credentials needed to run the scripts
Running the Scripts - Provides information on running the tool on UNIX/Linux and Windows environments.
o For UNIX/Linux deployments – Provides information on running the tool on UNIX/Linux environments
o For Windows deployments – Provides information on running the tool on Windows environments
Troubleshooting initial phase – Provides troubleshooting information on how to start the script
1.1. Conventions
The following text conventions are used in this document:
convention Meaning
boldface Boldface type indicates graphical user interface elements associated with an
action, or terms defined in text or the glossary
italic Italic type indicates book titles, emphasis, or placeholder variables for which you
supply particular values.
WLS Acronym for WebLogic Server. This will refer to Oracle WebLogic Server or BEA
WebLogic Server throughout this document.
SOA Acronym for Service-Oriented Architecture. This will refer to Oracle Service-
Oriented Architecture Suite throughout this document.
Refer to the Running the Scripts section for more information on the instructions for running the scripts.
OPERATING LOCATION
SYSTEM
Windows Oracle_LMS_Collection_Tool\LMSCollection\bin\LMSCollection.cmd
Windows Oracle_LMS_Collection_Tool\LMSCollection\resources\util\OAS\run_opmnctl_status.
cmd
Windows Oracle_LMS_Collection_Tool\LMSCollection\resources\util\WLST\WLSNUP\getWLS
_NUP.cmd
Windows Oracle_LMS_Collection_Tool\LMSCollection\resources\util\WLST\WLSBasic\wls-
basic-measurement.cmd
Windows Oracle_LMS_Collection_Tool\LMSCollection\resources\util\tuxedo\countclients.cmd
Windows Oracle_LMS_Collection_Tool\LMSCollection\resources\util\LMSCPU\lms_cpuq.cmd
2. Data Collection
This chapter describes the technical steps required to be executed by the operating system and middleware admin in order to
collect LMS Collection Tool measurement data. If you require any assistance with the information presented in this chapter,
please contact your LMS representative.
TSAM
WTC
SALT
Tuxedo Adapters
Message Q
Oracle Tuxedo
o Tuxedo 11g and 12c
o Tuxedo Add-On products
Jolt
TSAM
WTC
SALT
Tuxedo Adapters
Message Q
Oracle SOA Suite
o Versions 10g, 11g, and 12c
o Components of SOA Suite
Oracle Service Bus
Oracle BPEL
Oracle Application Server
o Version 10g
o All editions
PRODUCT REQUIREMENTS
OAS and The OAS and iAS data collection process does not have specific technical requirements.
iAS
WLS and The following application server’s connection details must be identified by the WebLogic Server
SOA administrator if the instance is running WebLogic Basic or licensed under the Named User Plus (NUP)
metric. In order to measure NUP, the WebLogic Server being measured must be version 10.3 or greater.
For processor based WebLogic or SOA measurement, WebLogic Home and domain configuration
information is not needed.
– This environment variable must be set in the shell that is running the LMSCollection script.
WL_HOME
WL_HOME is the directory where WebLogic is installed. You can set this location in the
LMSCollection\resources\util\WLST\wlstInput.txt file.
– Name of machine to connect to via WLST, set in
Target_Machine_Name_or_IP
LMSCollection\resources\util\WLST\wlstInput.txt file.
Name of the WebLogic domain to connect to, set in
W e b L o g i c _ D o m a i n N a m e –
LMSCollection\resources\util\WLST\wlstInput.txt file.
WebLogic_DomainHostURL_or_IP:Port – URL of the Domain administrator’s host and port, set in
LMSCollection\resources\util\WLST\wlstInput.txt file.
Administrative ID for the WebLogic Domain, set in
W e b L o g i c _ D o m a i n A d m i n I D –
LMSCollection\resources\util\WLST\wlstInput.txt file.
Password of the Admin User of the WebLogic Domain, set in
W e b L o g i c _ D o m a i n A d m i n I D P a s s w o r d –
LMSCollection\resources\util\WLST\wlstInput.txt file.
In the wlstInput.txt file you would write the above information on a comma separated line. For example
127.0.0.1, base_domain,127.0.0.1:7001,weblogic,weblogic1
NOTE: After execution off the LMS Collection Tool it is recommended to remove the information above as
a standard security measure. By default the LMS Collection tool will delete the wlstInput.txt file upon
completion and replace it with a template file.
Tuxedo The following Tuxedo environment variables must be identified and set.
– This environment variable must be set in the shell that is running the LMSCollection script.
TUXDIR
TUXDIR is the directory where Tuxedo is installed.
– Environment variable pointing to the Tuxedo configuration file.
TUXCONFIG
Linux / UNIX / AIX Root username and password. WebLogic, Tuxedo, or OAS administrator
username and password.
NOTE: Root username is recommended but another account can be used given
that it has Root’s privileges.
Running the LMS Collection Tool requires the acceptance of the Oracle LMS License Agreement (included in the script).
In what follows, we provide instructions on running the tool on Linux/UNIX or Windows environments for each product.
Customers can also choose to run the tool to collect data for multiple (or all) products at once on a given machine.
If you are unsure of the products installed on a given server, run the LMS Collection Tool to collect data for all the Oracle
Software products listed in the Measurement Overview. Details on this option are provided in the sections below.
3. Log into the target system as root, if you log on as another user the search may not pick up all of the necessary
Oracle Software Files.
4. Go to the directory where you placed the Oracle_LMS_Collection_Tool.zip file and extract the files.
$unzip Oracle_LMS_Collection_Tool.zip.
$ cd Oracle_LMS_Collection_Tool/LMSCollection
Note: It is recommended to change permissions to execute for all files prior to usage.
$ chmod –R +x *
6. Create the output directory where the output files will be stored.
$ mkdir /tmp/LMS_Review
7. Go to the bin directory and type ‘LMSCollection.sh’ with the proper options to run.
$ cd bin
$ ./LMSCollection.sh <OPTIONS>
Refer to Table 6 below for instructions on the proper options that you need to include. Refer to Table 7
for specific examples.
[-d search_dir] [-fsall true|false] [-o dir_name] [-follow true|false] [-debug true|false] [-m all|ip|user] [-L Y|N]
[-p product] [-fastsearch]
OPTION DESCRIPTION
-fsall true | false When specified, all file systems (including remote ones) are searched, otherwise
only the local file system is searched. Default is true.
-follow true | false Follow symbolic links during file search. Some older versions of AIX do not allow
the find command to follow symbolic links, so this must be set to false for the
script to work with those systems. Default is true.
-m all|ip|user Option to turn on masking of sensitive information for WebLogic license and
configuration files. Refer to the README.txt for details. Perl needs to be in the
system path for this to run. Default is off. Applicable to WebLogic, SOA and
Tuxedo only.
-p product Option to pass in a list of Oracle products to look for. Valid options are one or
more of the following:
If you are uncertain of the products installed on a given server, run the LMS
Collection Tool to collect data for all the Oracle Software products listed in the
Measurement Overview by using the –p all option.
-fastsearch Option to have the tool search for default Oracle environments from well known
file locations, environment variables and command line options.
Note: The fast search option of the tool is intended to gather information from the
system with minimal file searching.
8. Length of Scan.
The Oracle LMS Collection Tool searches for several possible configuration, registry, and log files on the target
machine. To verify that the Oracle LMS Collection Tool is running, you can use the following UNIX commands:
$ tail -a /<output_dir>/FMWfiles.*
9. After the tool has finished running the data collection process, an output directory and a .tar or .tar.bz2 (or .tar.Z if
bzip2 or compress is found on your UNIX system) file that contains Oracle Software related files will be created.
10. Return the output file ‘LMSCollection-<MACHINE_NAME>.tar ’ (.tar.bz2 or .tar.Z), to your LMS representative per
the instructions that were provided to you.
Table 8 below provides examples on the options that could be passed as parameters to step 7 above.
PRODUCT OPTIONS
For customers who need data masking, they can run the tool with the following
options:
$ ./LMSCollection.sh -d / -p WLS -o /tmp/LMS_Review -m all
For customers who are running WebLogic Basic or own WebLogic Named User
Plus licenses, run the tool by adding the appropriate options and value the input
file wlstInput.txt. The wlstInput.txt file is required to be valued correctly in order for
the WebLogic NUP or WebLogic Basic script to run.
Example Commands:
WebLogic and WLBasic: -p WLS,WLSBasic
WebLogic, and WLS NUP: -p WLS,WLSNUP
For customers who need data masking, run the tool with the following options:
$ ./LMSCollection.sh -d / -p SOA -o /tmp/LMS_Review -m all
For customers who are using WebLogic Basic or own SOA Suite licenses under
the Named User Plus metrics, run the tool by adding the appropriate options and
value the input file wlstInput.txt. The wlstInput.txt file is required to be valued
correctly in order for the WebLogic NUP or WebLogic Basic script to run.
Example Commands:
SOA, WLBasic and WLS NUP: -p SOA,WLSBasic, WLSNUP
For customers who need data masking, run the tool with the following options:
$ ./LMSCollection.sh -d / -p Tuxedo -o /tmp/LMS_Review -m all
On Windows Systems
2. Log into the target Windows system as Administrator, if you log on as another user the search may not pick up all
of the necessary Oracle Software Files.
> cd Oracle_LMS_Collection_Tool\LMSCollection\bin
6. Create the output directory where the output files will be stored.
>mkdir C:\LMS_Review
>LMSCollection.cmd <OPTIONS>
Refer to Table 8 below for instructions on the proper options that you need to include. Refer to Table 9
for specific examples.
-d search_dir [-p product] [-o dir_name] [-debug true|false] [-m all|ip|user] [-L Y|y|N|n][-fastsearch]
OPTION DESCRIPTION
-d search_dir Specifies the folders to be searched for Oracle software installations. A string of directory
names separated by a comma is required when more than one directory is to be
-o dir_name Option to output the collected files to the directory given by <dir_name>. The file will be
named LMSCollection-<MACHINE_NAME>.zip. If not specified, the default is the
%TEMP% directory.
-m all|ip|user Option to turn on masking of sensitive information. Refer to the README.txt for details.
Perl needs to be in the system path for this to run. Default is off. Applicable to WebLogic,
SOA and Tuxedo only.
-L Y|y|N|n Option to agree to the license agreement without having it displayed. Default is off, the
License Agreement will be printed on the screen.
-p product Option to pass in a list of Oracle products to look for. Valid options are one or more of the
following:
If you are unsure of the products installed on a given server, run the LMS Collection Tool
to collect data for all the Oracle Software products listed in the Measurement Overview
by using the –p all option.
-fastsearch Option to have tool search for default Oracle environments from well known file locations,
environment variables and command line options.
Note: The fast search option of the tool is intended to gather information from the system
with minimal file searching.
8. Length of Scan.
The Oracle LMS Collection Tool searches for several possible configuration, registry and log files on the target
machine. To verify that Oracle LMS Collection Tool is running, you can use the Windows Task Manager.
9. After the tool has finished running the data collection, an output folder and a .zip file that contains Oracle Software
related files will be created.
10. Return the output file ‘LMSCollection-<MACHINE_NAME>.tar ’ (.tar.bz2 or .tar.Z), to your LMS representative per
the instructions that were provided to you.
The table 10 below provides examples on the options that could be passed as parameters to step 7 above.
PRODUCT OPTIONS
For customers who are running WebLogic Basic or own WebLogic Named User
Plus licenses, run the tool by adding the appropriate options and value the input
file wlstInput.txt. The wlstInput.txt file is required to be valued correctly in order for
the WebLogic NUP or WebLogic Basic script to run.
For example:
WebLogic and WLBasic: -p WLS,WLSBasic
WebLogic, and WLS NUP: -p WLS,WLSNUP
For customers who are using WebLogic Basic or own SOA Suite licenses under
the Named User Plus metrics, run the tool by adding the appropriate options and
value the input file wlstInput.txt. The wlstInput.txt file is required to be valued
correctly in order for the WebLogic NUP or WebLogic Basic script to run.
For example:
SOA, WLBasic and WLS NUP: -p SOA,WLSBasic,WLSNUP
If server partitioning is in use, in addition to running the Oracle LMS Collection Tool from within the partition on which the
Oracle software is deployed, the Oracle LMS Collection Tool needs to be run on the operating system of the underlying
server hardware to collect the relevant CPU information (an exception to this would be when an Oracle-approved hard
partitioning technique is used). If an embedded hypervisor, such as VMware, is used, then screenshots of the embedded
hypervisor administration interface are required. These screenshots must show the underlying base server hardware for
each virtual guest. If screenshots are not provided, then the hardware specifications are needed along with mappings of
each virtual guest to its underlying base server hardware.
Table 11 below provides an example on running the script to collect the CPU information of the underlying server hardware.
PRODUCT OPTIONS
M u l t i p l ex i n g a r c h i t e c tu r e
If Oracle software is part of an environment in which multiplexing hardware or software is used and individual connections
cannot be identified, then all users and/or devices must be declared at the multiplexing front end.
o Use comma separated directories for the –d search dir option.
o Make sure there is one space after the options, not two nor tab character.
o Make sure that the directory you used for the –o output directory option is writable by the user running the
script.
o If you are not sure of the options to use, you can choose not to give any options and have the script
prompt you for values. At this time the script will use default values for the output directory and search
directory.
Not accepting the license agreement. The license agreement must be accepted before continuing on with the script.
If you don’t accept the prompt or use the –L Y license agreement option, the script will not continue.
o If you do not update the wlstInput.txt file and are running a search for a product that needs to run the
WLST commands for WLNUP and/or WLSBasic, the script will pause (if not using the –L option) and
request that you update the file. The message shown will be:
The file wlstInput.txt has not been updated to include the values needed to connect to your
WebLogic domain(s). Please do so at this time in a separate text editor.
While the script is paused you can correctly value the wlstInput.txt file.
o In the wlstInput.txt file you would write the information from the Technical Requirements table on a comma
separated line. You can have lines for multiple servers. For example
Target_Machine_Name_or_IP,WebLogic_DomainName,WebLogic_DomainHostURL_or_IP:700
1,WebLogic_DomainAdminID,WebLogic_DomainAdminIDPassword
127.0.0.1, base_domain,127.0.0.1:7001,weblogic,weblogic1
o In addition to the WebLogic domain variables, if you do not have the WLS_HOME environment variable
set, you can value it in the wlstInput.txt file.
WLS_HOME=C:\Oracle\Middleware\wlserver_10.3
WLST output errors with the WLNUP and/or the WLSBasic Product options. Depending on the server security setup
we may not always be able to connect to the running WebLogic Server. Make sure that the wlstInput.txt is set up
correctly. If it is and you still have WLST errors, then those errors are acceptable. Please contact your LMS
representative if you require further assistance.
o If there is an error during the WLST product run, you will be notified with a message at the end of the
entire script run. Make sure that the values in wlstInput.txt are correct and try again. If the error persist
contact your LMS representative for further assistance.
Running the script with the Tuxedo Product options without setting up your environment. Please make sure that you
set up the Tuxedo TUXDIR and TUXCONFIG environment variables correctly when running the script.
All Products <machine_name>-info.txt These files contain the Operating System and machine
<machine_name>- information.
lms_cpuq.txt
LMSCollection-Actions- This file contains a listing of the files run and the actions
<machine_name>-txt taken by the LMS Collection tool
<machine_name>_<products
run>.zip(.tar,.bz2) Compressed archive of the contents to be collected.
WLS comps.xml These files contain elements that are used by J2EE
SOA opmn.xml Application Servers to configure and deploy FMW
OAS ias.properties applications.
ear-deployer.xml
ejb-deployer.xml
server.xml
domain.xml
config.xml
*jdbc.xml
*jms.xml
Module-.xml
deployment.xml
setupinfo.txt
WLS registry.xml These files are created or updated by FMW product
SOA domain.xml installers when a product is installed and includes
Tuxedo install*.out information such as the date when the FMW product was
OAS installActions*.log installed.
installProfile*.log
oraInstall*.log
WLS domain-registry.xml This registry file contains the location of all domains
SOA currently registered with this WebLogic Server
installation. Whenever you add a new domain, it is
registered in this file.
CONNECT WITH US
blogs.oracle.com/oracle
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. This document is provided for information purposes only, and the
contents hereof are subject to change without notice. This document is not warranted to be error-free, nor subject to any other
facebook.com/oracle warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or
fitness for a particular purpose. We specifically disclaim any liability with respect to this document, and no contractual obligations are
twitter.com/oracle formed either directly or indirectly by this document. This document may not be reproduced or transmitted in any form or by any
means, electronic or mechanical, for any purpose, without our prior written permission.
oracle.com Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and
are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are
trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. 0615