Application Management Pack for Oracle Utilities Network Management System

Administrative Guide

Release 13.2.1.0.0

Part number E84888-01

December 2015

Documentation build: 2.6.2017 12:26:26 [NMSOEM_1486401986000]

Copyright © 2015, 2017 Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

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.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Third-party licenses relating to Enterprise Manager and this plug-in are available for viewing online at: Enterprise Manager Licensing Information (http://docs.oracle.com/cd/E24628_01/doc.121/e24474/title.htm).

Related Documentation and Resources

The Help menu provides links to Enterprise Manager Help, Oracle Online Documentation, Oracle Online Forums, and the Oracle Technology Network (OTN), where the complete documentation for Oracle Enterprise Manager 13c is available.

This document and other Application Management Pack for Oracle Utilities Network Management System-specific documentation are available on the Oracle Utilities Information Portal Documentation page (http://docs.oracle.com/cd/E72219_01/documentation.html).

Note: Oracle Utilities Network Management System documentation is also available on the Oracle Utilities Information Portal Documentation page.

Additional information on Oracle Enterprise Manager-specific features and functionality relating to this product is available in the Enterprise Manager Cloud Control Documentation (http://docs.oracle.com/en/enterprise-manager/).

Note: The documentation that accompanies this product is subject to revision and updating. Additional information that may relate to the functionality and features in this product may be found on My Oracle Support (MOS) at https://support.oracle.com (sign-in required). To find all articles relating to this product, enter the search term "Application Management Pack for Oracle Utilities Network Management System".

Plug-in Functionality

Next in This Section

- Product Discovery

- Oracle Utilities NMS Target

- NMS Services Target

- Detailed Description of Target Operations

Product Discovery

Any manageable entity is of a target type. A specific instance of a target type is a target. For example, sf-sunapp-00.us.oracle would be a target of target type host; sf-mydb-00:1521/CD0000SF would be a target of target type database.

For extensibility purposes, Application Management Pack for Oracle Utilities Network Management System provides a discovery framework and the functionality to monitor an Oracle Utilities Network Management System (NMS) environment system target type with target members of type NMS Services, Database System, and WebLogic Server. This models an installation of the Oracle Utilities Network Management System containing the software binaries and runtime components.

High-Level View of the Discovery Process

- The discovery process finds Oracle Utilities Network Management System environments.

- The NMS Services target type models the Oracle Utilities Network Management System services.

- The Database System and WebLogic Server target types are standard target types in Enterprise Manager. They model the Oracle Database and the Oracle WebLogic Server, respectively.

In addition to these target types, a Network Management System environment is modeled as a system target. This system environment has as members the other target types.

Next in This Section

- Environment Discovery

- Viewing a Target's Home Page

Environment Discovery

In order for a target to be monitored, it must first be discovered and promoted. Discovery is the process of making a target instance known to OEM. Once this has been done, the target needs to be promoted from an unmanaged to a managed state.

To discover target environments:

1. Log in to Enterprise Manager.

2. Choose Setup > Add Target > Add Targets Manually. Click Add Using Guided Process

3. Choose the Oracle Utilities Network Management System from Add Using Guided Process dialog.

4. Click Add....

5. Select the agents on which to run discovery and click Next.

6. Select a target and click Properties....

7. Populate credentials for monitoring the NMS database and click OK.

8. Optional: Select a target and click Associations....

9. Optional: Select the database and one or more WebLogic Servers to be associated with this NMS Environment and click OK.
Associations can only be added to database and/or WebLogic Server if it is already managed as a target in Enterprise Manager. These associations can be added, removed, or changed later on the Configuration Associations page.

10. Optional: Set Properties and Associations for any additional NMS Environments you wish to manage.

The Properties column for the target in the table list will have the value of Set when that target’s properties have been set.

11. Select all of the targets to be managed and click Next.

12. Wait for added targets to appear in the Summary. Each NMS Environment will have two targets: one of type Oracle Utilities NMS and one of type NMS Services.

13. Click Exit to finish the operation.

Viewing a Target's Home Page

To view a target's home page:

1. Log in to Enterprise Manager.

2. Click Targets > All Targets.

3. To view its home page, locate and click a target from the sortable and searchable All Targets list.

Oracle Utilities NMS Target

The Oracle Utilities NMS target is a system target that comprises

- one NMS Services target

- up to one Database System target

- any number of Oracle WebLogic Server targets

The Database System target is part of the Oracle Database plug-in. The Oracle WebLogic Server target is part of the Oracle Fusion Middleware plug-in. Both of these are standard plug-ins included in Enterprise Manager.

The NMS Services target is included in Application Management Pack for Oracle Utilities Network Management System.

Next in This Section

- Oracle Utilities NMS Home Page

- Configure Associations Page

Oracle Utilities NMS Home Page

This is the home page for the Oracle Utilities NMS target

Next in This Section

- Summary

- Status

- Issues Overview

- Job Activity

Summary

This section has key information about NMS and its associated targets.

NMS Version

The version of Network Management System being monitored.

Configuration Tag

The configuration tag of the currently built cesejb application. This is the same as the Configuration Tag in the About Web Workspace window in NMS.

Project Name

The project name of the currently built cesejb application. This is the same as the Project Name in the About Web Workspace window in NMS.

NMS URL

The URL of the Java Web Start page for Oracle Utilities Network Management System. This is a hyperlink that will open the URL in a new window

NMS Services

A link to the Enterprise Manager page for the NMS Services member target

Database

A link to the Enterprise Manager page for the Database System member target

WebLogic Server

A link to the Enterprise Manager page for the Oracle WebLogic Server member target

Status

This section shows the availability and current status of the system as well as the availability and current status of the most affected members of the system. Availability is shown for the past 31 days.

Issues Overview

This shows the number of issues and problems for the member targets. More detailed issue information is available in Incident Manager (click NMS > Monitoring > Incident Manager) and Member Dashboard (click NMS > Members > Dashboard). For more information, see the Using Incident Management topic in the Oracle Enterprise Manager Cloud Control Administrator's Guide.

Job Activity

This shows a summary of the jobs submitted to the member targets. For more information, see the Utilizing the Job System topic in the Oracle Enterprise Manager Cloud Control Administrator's Guide.

Configure Associations Page

The Configure Associations page allows the user to change the Database System and Oracle WebLogic Server targets that are members of the Oracle Utilities NMS target. To update the members:

This page has the following fields.

Current Database

Displays the name of the Database System target associated with the Oracle Utilities NMS target.

Current WebLogic Application

Displays a list the names of the Oracle WebLogic Server targets associated with the Oracle Utilities NMS target.

Select Database table

Lists the Database System targets known by Enterprise Manager.

Select WebLogic Server table

Lists the Oracle WebLogic Server targets known by Enterprise Manager.

Next in This Section

- Changing Associations

Changing Associations

1. Select the database in the Select Database table.

2. Select the WebLogic server(s) in the Select WebLogic Server table. Note that multiple rows can be selected in this table by holding down the Ctrl key.
You can use the Ctrl key to unselect entries in the table lists.

3. Press the Save Changes button.

4. Press OK in the Confirm Association Changes dialog.

NMS Services Target

The NMS Services target monitors NMS services and collects metrics from NMS services and the NMS database.

Next in This Section

- NMS Services Home Page

- NMS Activity/Load Page

NMS Services Home Page

This is the home page for the Oracle Utilities NMS target

Next in This Section

- Summary

- Services

- Incidents and Problems

Summary

This section has key information about NMS and its current state. Fields in this section will dynamically update.

NMS Version

The version of Network Management System being monitored.

Current Status

The current status of the NMS Services target. This target is considered Up if all critical services have a status of either RUNNING or FAILED_INTERFACE.

Up Since

The date NMS Services has been up since

Availability (31 days)

The availability percentage over the last 31 days. Clicking on this opens a dialog with more detailed availability information.

Services Status

The current status of services. The tooltip shown when hovering here gives more information. These are the possible values and tooltips:

- Up — Services are running

- Critical Services Up — All Critical Services Ready - non-critical services have failed/stopped

- Initializing — Services Initializing

- Critical Services Down — Services NOT Ready - critical services have failed/stopped

- Down — Services are stopped

- Down — Services and Isis are stopped

Configuration Tag

The configuration tag of the currently built cesejb application. This is the same as the Configuration Tag in the About Web Workspace window in NMS.

Project Name

The project name of the currently built cesejb application. This is the same as the Project Name in the About Web Workspace window in NMS.

Model Build

Indicates whether the model build is currently running and the start time of the model build if it is running.

NMS URL

The URL of the Java Web Start page for Oracle Utilities Network Management System. This is a hyperlink that will open the URL in a new window

Services

This table lists the services recognized by SMService (System Monitor Service) and their current status. It dynamically updates and has the following columns:

Column Name

Description

Service

The name of the service.

Status

The current status of the service. This has the following possible values:

- STARTING — The process has started

- INITIALIZING — The process has registered and is initializing

- RUNNING — The process reports as initialized

- FAILED — The process has failed

- FAILED_INTERFACE — The process reports a failed interface

- STOPPED — The process intentionally stops

Note that the FAILED_INTERFACE status means that the service or adapter is running, but its connection to an external system is failed or lost.

Critical

Indicates whether this service is required for the system to be functional.

This table has the following buttons:

- Stop Service — Stops the selected service. This opens a dialog where NMS host credentials are entered. When OK is pressed, the specified service will be stopped. This action is only valid for Isis-connected services (nms-naming-service and nms-lighttpd are examples of non-Isis services).

- Restart Service — Stops and restarts the selected currently running service. This opens a dialog where NMS host credentials are entered. When OK is pressed, the specified service will be stopped and restarted. This action is valid for most Isis-connected services except SMService, DBService, and ODService.

Incidents and Problems

This shows a summary of the incidents and problems for the NMS Services target as determined by OEM.

The table also lists any active NMS System Alarms. For instance, if an NMS Service goes down abnormally, then a system alarm will be generated. The NMS alarm entry will go away once the alarm has been cleared from the NMS Systems Alarm list. More detailed information is available in Incident Manager (click NMS Services > Monitoring > Incident Manager). For more information, see the Using Incident Management topic in the Oracle Enterprise Manager Cloud Control Administrator’s Guide. Note that any changes to the alarm incident in OEM will not be pushed to NMS. Acknowledging or clearing the alarm from OEM will not clear it within NMS.

NMS Activity/Load Page

This page has charts of the load and activity on the NMS system. Clicking the expand icon on a chart will resize the chart to fill the whole page. Clicking again will restore the chart to its original size.

Next in This Section

- Time Period

- Current Job Count

- Calls

- Current User Count

- Device Operations

- Study Session Count

- Crew Actions

Time Period

Allows the user to select the time period displayed in the charts on this page. The values are

Name

Period

Data Interval

Dynamic Update

Real-Time

1 hour

5 minutes

Yes

Past Day

1 day

5 minutes

No

Past Week

7 days

1 hour

No

Past 2 Weeks

14 days

1 hour

No

Past Month

31 days

1 day

No

Past 90 days

90 days

1 day

No

Past Year

365 days

1 day

No

.

Current Job Count

Shows the maximum number of active jobs of different types within the time period selected.

- Active Outages — Outage jobs in an active state

- Active Non-Outages — Non-outage jobs in an active state

- Active Fuzzy Jobs — Fuzzy jobs in an active state

- Active Momentary Outages — Momentary outage jobs in an active state

Calls

Shows of the total number of calls of different types entered over the time interval displayed. Time intervals may be five minutes, one hour, or one day depending on the Time Period selected. Calls also shows the total number of unprocessed calls at the displayed time period.

- Customer Calls Per Interval — Customer calls during time interval

- AMI Power-offs Per Interval — AMI power-offs during time interval

- Total Calls Per Interval — Total calls during time interval

- Unprocessed Calls — Total number of calls which still need to be processed

Current User Count

Shows the maximum number of logged in users of various user types during the time interval displayed.

- Web Workspace — Web Workspace non-View-Only users

- WW View Only — Web Workspace View Only users

- Storm Management — Storm Management users

- Service Alert — Service Alert users

- Web Call Entry — Web Call Entry users

- Configuration Assistant — Configuration Assistant users

- Web Callbacks — Web Callbacks users

- Model Management — Model Management users

Device Operations

Shows the total number of device operations (open, close) performed during the time interval displayed.

- Sustained Per Interval — Sustained device operations during time interval

- Transient Per Interval — Transient device operations during time interval

- Total Operations Per Interval — Total device operations during time interval

Study Session Count

Shows the maximum number of the number of open study sessions during the time interval displayed.

- Non-Powerflow Sessions — Number of non-powerflow study sessions

- Powerflow Sessions — Number of powerflow study sessions

- Total Sessions — Total number of study sessions

Crew Actions

Shows the total number of crew actions (assign, en route, on-site, release, suspend, relocate, unarrive) performed during the time interval displayed.

- Crew Actions Per Interval — Crew actions during time interval

Detailed Description of Target Operations

Credentials will be required for any action requiring you to interact with the NMS environment. When credentials are required, the Host Credentials panel will be displayed.

The credentials entered must either login as the nmsadmin user where NMS Services run or login as another user and sudo to a user that has group permissions to execute key scripts owned by the nmsadmin user. Another option is to sudo to the nmsadmin user. New credentials can be entered each time or either Preferred Credentials or Named Credentials can be saved and re-used. For more information, see the Preferred Credentials topic in the Oracle Application Management Pack for Oracle E-Business Suite Guide document.

Next in This Section

- Start Up

- Shut Down

- Send Message

- Stop Service

- Restart Service

- Action Command

- Action Command Tabs

Start Up

The NMS system services need to be started.

This operation may be started from any page of the NMS Services target.

1. Click the Start Up... button.
This option is also available from NMS Services > Control > Start Up.... Click the Start Up... button. The Start Up NMS dialog appears.

2. Select or enter host credentials.

3. Click the OK button. The Start Up NMS dialog disappears.

The next two steps are only necessary to see the result of the Start Services job.

4. Optional: Select NMS Services > Job Activity. The Job Activity page is loaded.

5. Optional: Click on the START SERVICES job. The status of the START SERVICES job is shown.

Shut Down

The NMS system services need to be stopped.

This operation may be started from any page of the NMS Services target.

1. Press the Shut Down button.
This option is also available from NMS Services > Control > Shut Down... The Shut Down NMS dialog appears.

2. Optional: Choose additional options.
The additional options are

Shutdown Isis

This will shutdown the Isis message bus.

Stop non-Isis processes

This will shutdown non-Isis processes that are controlled by SMService such as nms-naming-service and nms-lighttpd

Mark all users as logged out

This will mark any users that are currently logged in as logged out in the NMS database.

3. Select or enter host credentials.

4. Click the OK button. The Shut Down NMS dialog disappears.

The next two steps are only necessary to see the result of the Stop Services job.

5. Optional: Select NMS Services > Job Activity. The Job Activity page is loaded.

6. Optional: Click on the STOP SERVICES job. The status of the STOP SERVICES job is shown.

Send Message

Send a message to all of the users logged into NMS. This includes all environment login and user types. The message will be in the form of a modal message dialog displayed over the main window of the NMS environment. This operation may be started from any page of the NMS Services target.

Note: This option is also available from NMS Services > Control > Send Message… >

1. Click the Send Message… button. The Send Message dialog appears.

2. Enter a message in the Message Text window. The message will include the date and time of when the message was sent when it is displayed within the NMS environment.
The dialog’s message text format can be changed by altering the NMS message code OEM_MESSAGE_DIALOG. See the NMS MessageCode_en_US.properties configuration file for more details.

3. Select or enter host credentials.

4. Click the OK button. The Send Message dialog disappears.

Stop Service

An individual service needs to be stopped.

This operation must be started from the Home page of the NMS Services target.

1. Select a service in the Services table.

2. Click the Stop Service button. The Stop Service dialog appears.

3. Select or enter host credentials.

4. Click the OK button. The Stop Service dialog disappears.

Restart Service

An individual service needs to be stopped and restarted. This option cannot be used to start an already stopped service. Use the Start Up option to start stopped services.

This operation must be started from the Home page of the NMS Services target.

1. Select a service in the Services table.

2. Click the Restart Service button. The Restart Service dialog appears.

3. Select or enter host credentials.

4. Click the OK button. The Restart Service dialog disappears.

Action Command

An Action command needs to be performed. See Oracle Utilities Network Management System Configuration Guide for a variety of use cases.

This operation may be started from any page of the NMS Services target.

1. Select NMS Services > Action Command. The Action Command dialog appears.

2. Select the desired tab for type of Action command to be performed

- Command — allows for freeform entry of any Action command command to one or more services

- Client Command — allows for freeform entry of any Action command that will be specific to one or any user clients

- Service Debug — allows setting of debug in services

- EJB Debug — allows setting of debug in the EJB application

- Client Debug — allows setting of debug in user clients

- Recache — common recache/reload operations

3. Populate the fields in the Command Info step.

4. Click the Next button. The Action Command dialog changes to the Credentials step

5. Select or enter host credentials and press the Next button. The Action Command dialog changes to the Confirmation step

6. Verify action to be performed.
The specific command-line to be executed appears in the Command Line field.

7. Optional: Uncheck the Wait for result check-box if you do not want to wait for the Action command result.

8. Click the Finish button. If Wait for result was selected, a dialog appears displaying the return value of the command. This indicates the number of processes which processed the command. Note that action commands sent to Java applications or Java clients will always have a result of 0 .

Action Command Tabs

Command

This tab allows for freeform entry of any Action command

Figure 1. Command options

Field

Description

Process

The process to send the Action command to. This combo box contains all of the services currently recognized by SMService, but also allows user-entered values. A value of "any" will send to all processes.

Command

The command to send

Arguments

The command arguments

Client Command

This tab allows for free-form entry of any Action command to Java clients rather than Isis-connected processes. This typically requires custom configuration for clients to handle these messages. See the Invoking Commands from an External System section of the Oracle Utilities Network Management System Configuration Guide.

Field

Description

User

The NMS user's login id. Specify any to send to all users.

Tool

The JBot java tool to send the command to. Specify any to send to all of the Java tools. As previously specified, this tool has to be configured to accept the command message being sent.

Command

The command to send.

Arguments

The command arguments.

Service Debug

This tab allows for setting of debug in services

Figure 2. Service Debug options

Field

Description

Service

The service for which debug will be set.

Debug Arguments

The arguments can either be a number to set all debug facilities to the same level or a space separate list of debug facilities and their desired debug levels. Examples:

- 1 — set all debug facilities to level 1

- 0 — set all debug facilities to level 0 (disabled)

- messages 0 — set the messages debug facility to level 0

- api 1 timing 2 — set the api debug facility to level 1 and the timing debug facility to level 2.

EJB Debug

This tab allows setting of debug in the EJB application

Figure 3. EJB Debug options

Field

Description

Debug Facility

The name of the debug facility to set. These debug facility names are case-sensitive.

Debug Level

The desired debug level

- On — enables debug and info messages

- Off — disables debug and info messages

Client Debug

This tab allows setting of debug in user clients

Figure 4. Client Debug options

Field

Description

User

The login id of the user to set debug for.

Debug Facility

The name of the debug facility to set. These debug facility names are case-sensitive.

Debug Level

The desired debug level

- On — enables debug and info messages

- Off — disables debug and info messages

Recache

This tab has common recache/reload operations

Figure 5. Recache options

Option

Description

Recache Zones

This tells DDService to update its internal control zone memory structures. It is the equivalent of the following command:

UpdateDDS -recacheZones

Recache Rules

This reloads configuration rules from the srs_rules table. It is the equivalent of the following command:

Action any.any reload_rules

EJB Resync

This command causes the application running in the WebLogic server to reload the event cache. It is the equivalent of the following command:

Action any.publisher* ejb resync

EJB Refresh

This command causes the application running in the WebLogic server to reload the configuration and forces the client to re-request all data that it is currently displaying. This puts significant load on the system, so it should only be done when necessary in a production environment. It is the equivalent of the following command:

Action any.publisher* ejb refresh

Logs

Save Logs

A Cmd snapshot is needed to capture the state of services. This is typically for support or diagnostic purposes.

This operation may be started from any page of the NMS Services target.

1. Click NMS Services > Logs. The Logs dialog appears.

2. Select the Save Logs tab, if not already selected.

3. Select either Cmd snapshot or Cmd snapshot and service logs option.
The Cmd snapshot option performs a Cmd snapshot to capture the current state of all Isis-connected processes and creates a zip file with the snapshot results. The Cmd snapshot and service logs option does the same as the Cmd snapshot option, but also includes the service log files in the resulting zip file.

4. Select or enter host credentials.

5. Click the Save button. The Logs dialog disappears and the Doing snapshot dialog appears indicating the name and location of the zip file being created.

Tips and Troubleshooting

- Discovery and metric configuration collection log information can be found in the agent perl trace file (.../agent_inst/sysman/log/emagent_perl.trc).

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our documentation includes features that make information available to users of assistive technology.

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.