IBM Tivoli Netcool/OMNIbus

https://www.ibm.com/docs/en/netcoolomnibus/8.1.0
Admin
IBM Tivoli Netcool/OMNIbus is an event management software that collects, consolidates, and...
Tokens:859,382
Snippets:12,351
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Start Installation Manager (Options 1 & 2)

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=netcoolomnibus-gui-installation

Navigate to the Installation Manager's eclipse subdirectory and execute the IBMIM command to start the application.

```bash
./IBMIM
```

--------------------------------

### Start Installation Manager

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=gui-installation

Use this command to start Installation Manager from the /eclipse subdirectory. For silent installations, use the -record option to create a response file.

```bash
./IBMIM
```

```bash
IBMIM.exe
```

```bash
IBMIM.exe -record C:\response_files\install_1.xml
```

--------------------------------

### Install and Start Proxy Server Service

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=services-example-installing-running-proxy-server-as-service

These commands install the proxy server as a Windows service and then start the service. Ensure you are in the correct directory and have the necessary permissions.

```bash
cd %NCHOME%\omnibus\bin
nco_proxyserv /install
net start NCOProxyServer
```

--------------------------------

### Start Installation Manager (Alternative)

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=netcoolomnibus-console-installation

An alternative command to start Installation Manager in console mode.

```shell
./imcl -c
```

--------------------------------

### Start IBM Installation Manager GUI

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=gui-removing-components

Navigate to the /eclipse subdirectory of the Installation Manager installation directory and run the IBMIM executable to start the GUI wizard for removal.

```command-line
./IBMIM
```

```command-line
IBMIM.exe
```

--------------------------------

### Example: Install Deescalate Events Trigger

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=tasks-reducing-severity-events-automatically

This is an example of installing the deescalateevents trigger with specific server and user credentials.

```bash
$OMNIHOME/bin/nco_sql -server AGG_P -user root -password netcool < $OMNIHOME/extensions/housekeeping/deescalateevents.sql
```

--------------------------------

### Example: Install expiretime Trigger (Linux/Unix)

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=tasks-setting-events-expire-automatically

An example command demonstrating how to install the expiretime trigger with specific server and user details.

```bash
$OMNIHOME/bin/nco_sql -server AGG_P -user root -password netcool < $OMNIHOME/extensions/housekeeping/expiretime.sql
```

--------------------------------

### Example: Get a list of prompts

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=requests-get-list-prompts

This example demonstrates how to make a method call to get a list of available prompts on the server. Ensure the correct namespace is used.

```xml
<methodCall xmlns:prompt="http://www.ibm.com/tivoli/netcool/webtop/prompts/2.2">

    <!-- Get a list of prompts available in the server. -->
    <method methodName="prompt.getList"/>
</methodCall>
```

--------------------------------

### Example: Install Event Grouping Triggers on Display ObjectServers

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=grouping-installing-scope-based-event

This is an example demonstrating how to run the SQL script to install event grouping triggers on specific display ObjectServers. Adjust server names and passwords as needed.

```bash
$OMNIHOME/bin/nco_sql -server DIS_1 -user root -password netcool < $OMNIHOME/extensions/eventgrouping/objectserver/scope_event_grouping_display.sql
```

```bash
$OMNIHOME/bin/nco_sql -server DIS_2 -user root -password netcool < $OMNIHOME/extensions/eventgrouping/objectserver/scope_event_grouping_display.sql
```

--------------------------------

### Example: Install Aggregation ObjectServer Event Grouping Triggers

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=grouping-installing-scope-based-event

This is an example command demonstrating how to run the SQL script to install event grouping triggers on an Aggregation ObjectServer.

```bash
$OMNIHOME/bin/nco_sql -server AGG_P -user root -password netcool < $OMNIHOME/extensions/eventgrouping/objectserver/scope_event_grouping_aggregation.sql
```

--------------------------------

### Start Installation Manager with Response File Recording

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=netcoolomnibus-gui-installation

Use the '-record' option with Installation Manager to save installation steps to a response file for silent installations. This is not applicable to Installation Option 3.

```bash
./IBMIM -record /tmp/install_1.xml
```

--------------------------------

### Installing a Service with Manual Startup

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=services-installing-configuring-uninstalling-server-components

Use the /INSTALL and /NOAUTO options to install a component as a service that starts manually. This is useful for services that require specific pre-start conditions.

```bash
nco_pad /INSTALL /NOAUTO
```

--------------------------------

### Start Installation Manager

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=netcoolomnibus-gui-update

Use this command to launch the Installation Manager GUI. You can optionally record the update process for silent updates.

```bash
./IBMIM
```

```bash
IBMIM
```

```bash
IBMIM -record response_file
```

--------------------------------

### Start Installation Manager (Administrator Console Mode)

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=netcoolomnibus-console-installation

Use this command to start Installation Manager in administrator console mode.

```shell
su
umask <value>
./imcl -consoleMode
```

--------------------------------

### Example: Install Collection ObjectServer Event Grouping Triggers

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=grouping-installing-scope-based-event

This example shows how to execute the SQL script for installing scope-based event grouping triggers on Collection ObjectServers.

```bash
$OMNIHOME/bin/nco_sql -server COL_P_1 -user root -password netcool < $OMNIHOME/extensions/eventgrouping/objectserver/scope_event_grouping_collection.sql
$OMNIHOME/bin/nco_sql -server COL_B_1 -user root -password netcool < $OMNIHOME/extensions/eventgrouping/objectserver/scope_event_grouping_collection.sql
```

--------------------------------

### Install Installation Manager with Data Location (Linux/UNIX)

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=manager-installing-installation-web-gui

This example shows how to install Installation Manager on Linux/UNIX, specifying a custom data location for the agent data.

```bash
./install -dataLocation /opt/ibm/im/data
```

--------------------------------

### Linux Application Server Profile Example

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=server-viewing-application-profile

This example displays the profile information for an application server installed on a Linux system. It details the installation path, port numbers, and other relevant configuration parameters.

```text
Application server environment to create: Application server
Location: /opt/IBM/JazzSM/profile
Disk space required: 200 MB
Profile name: JazzSMProfile
Make this profile the default: True
Node name: JazzSMNode01
Host name: OMNIbus-8.1.ibm.com
Enable administrative security (recommended): True
Administrative console port: 16315
Administrative console secure port: 16316
HTTP transport port: 16310
HTTPS transport port: 16311
Bootstrap port: 16312
SOAP connector port: 16313
Run application server as a service: False
Create a Web server definition: False
Performance tuning setting: Standard
```

--------------------------------

### Example Command for Configuring an ObjectServer Process

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=processes-creating-editing

This is an example of a command string used to start an ObjectServer process. It specifies the ObjectServer name and the process agent it belongs to.

```bash
$NCHOME/omnibus/bin/nco_objserv -name NCOMS -pa SFOSYS1_PA
```

--------------------------------

### Start Installation Manager Console Mode

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=gui-removing-components

Change to the /eclipse/tools subdirectory and use the imcl -c command to start Installation Manager in console mode for component removal.

```command-line
./imcl -c
```

```command-line
imcl.exe -c
```

--------------------------------

### Windows Application Server Profile Example

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=server-viewing-application-profile

This example shows the profile details for an application server installation on a Windows environment. It includes information such as installation location, port assignments, and configuration settings.

```text
Application server environment to create: Application server 
Location: C:\Program Files\IBM\JazzSM\profile
Disk space required: 200 MB
Profile name: JazzSM Profile 
Make this profile the default: True 
Node name: TIPNode Host name: tivoliadmin.usca.ibm.com 
Enable administrative security (recommended): True 
Administrative consoleport: 16315 
Administrative console secure port: 16316 
HTTP transport port: 16310 
HTTPS transport port: 16311 
Bootstrap port: 16312 
SOAP connector port: 16313 
Run application server as a service: False 
Create a Web server definition: False
Performance tuning setting: Standard JazzSM_HOME\profile
Disk space required: 200 MB
Profile name: JazzSM Profile 
Make this profile the default: True 
Node name: TIPNode Host name: tivoliadmin.usca.ibm.com 


```

--------------------------------

### Example Startup Command File

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=files-startup-command-file

A sample startup command file demonstrating the sequence of commands for configuration, logging, and data transfer.

```text
GET CONFIG;
SET LOG LEVEL TO debug;
TRANSFER FROM 'master.names' TO 'resync.names' VIA FILTER
 'Name != \'nobody\'' DELETE;
```

--------------------------------

### Start Tivoli Netcool/OMNIbus Installation (Option 3)

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=netcoolomnibus-console-installation

This script installs and runs Installation Manager, which then automatically starts the installation of Tivoli Netcool/OMNIbus.

```shell
./install_console.sh
```

--------------------------------

### Start Installation Manager in Console Mode

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=netcoolomnibus-console-installation

Use this command to start Installation Manager in console mode.

```shell
./imcl -consoleMode
```

--------------------------------

### Example: Initialize ObjectServer with Traditional Chinese Desktop File

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=ms-setting-up-objectserver-use-translated-user-interface-text-in-desktop

This example demonstrates initializing the ObjectServer named 'DENCO' using the Traditional Chinese translated desktop.sql file.

```bash
$NCHOME/omnibus/bin/nco_dbinit -server DENCO -desktopfile $NCHOME/omnibus/etc/locale/zh_TW.EUC/desktop.sql
```

--------------------------------

### Example Import to Collection ObjectServers

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=netcoolomnibus-enabling-device-counter-extension

Example commands demonstrating the import of the device counter extension SQL script to specific Collection ObjectServers.

```bash
$OMNIHOME/bin/nco_sql -server COL_P_1 -user root -password netcool < $OMNIHOME/extensions/devicecounter/device_counter_collection.sql
$OMNIHOME/bin/nco_sql -server COL_B_1 -user root -password netcool < $OMNIHOME/extensions/devicecounter/device_counter_collection.sql
```

--------------------------------

### Start Console Installation in Non-Administrator Mode

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=manager-gui-console-installation

Use this command to start the Installation Manager console in non-administrator mode.

```shell
./userinstc -c
```

--------------------------------

### Example init.d script sections for Red Hat and SUSE

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=system-automatically-starting-process-agents-unix

This example shows how the nco startup script is delimited for Red Hat and SUSE Linux versions. Modify the appropriate section based on your Linux distribution.

```shell
### REDHAT ONLY
...
### END REDHAT ONLY


### SUSE ONLY
...
### END SUSE ONLY
```

--------------------------------

### Example: Install Housekeeping Trigger

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=tasks-preventing-core-tables-grow-beyond-limit

An example command to install the rowcountmonitor trigger on a specific Aggregation ObjectServer named AGG_P.

```bash
$OMNIHOME/bin/nco_sql -server AGG_P -user root -password netcool < $OMNIHOME/extensions/housekeeping/rowcountmonitor.sql
```

--------------------------------

### Example: Get List of Menus

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=requests-get-list-menus

This is an example of an XML method call to get a list of all menus defined in the Web GUI.

```xml
<methodCall>
	<method methodName="menu.getList">
	</method> 
</methodCall>

```

--------------------------------

### Start Installation Manager in Nonadministrator Mode

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=netcoolomnibus-gui-installation

In nonadministrator mode, ensure the umask value is set correctly before starting Installation Manager.

```bash
umask
```

--------------------------------

### Example Import to Aggregation ObjectServers

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=netcoolomnibus-enabling-device-counter-extension

Example commands demonstrating the import of the device counter extension SQL script to specific Aggregation ObjectServers.

```bash
$OMNIHOME/bin/nco_sql -server AGG_P -user root -password netcool < $OMNIHOME/extensions/devicecounter/device_counter_aggregation.sql
$OMNIHOME/bin/nco_sql -server AGG_B -user root -password netcool < $OMNIHOME/extensions/devicecounter/device_counter_aggregation.sql
```

--------------------------------

### Example: Create master.properties Table

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=tasks-reducing-severity-events-automatically

This is an example of creating the master.properties table with specific server and user credentials.

```bash
$OMNIHOME/bin/nco_sql -server AGG_P -user root -password netcool < $OMNIHOME/extensions/housekeeping/create_master.properties.sql
```

--------------------------------

### Start Installation Manager (Administrator Mode)

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=netcoolomnibus-console-update

Use this command to start Installation Manager when operating in administrator mode. Ensure you are in the correct directory.

```bash
su - 
# or
sudo sh
umask
./imcl -c
```

--------------------------------

### Run Migration Tool

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=migrating-from-netcoolwebtop-v20-v21

Navigate to the MIGRATION_TOOL_HOME/bin directory and execute this command to start the migration process.

```bash
migration_import -migration
```

--------------------------------

### Example of Creating a Database

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=reference-create-database-command

An example demonstrating how to create a database named 'mydb'.

```sql
create database mydb;
```

--------------------------------

### Start Installation Manager (Nonadministrator or Group Mode)

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=netcoolomnibus-console-update

Use this command to start Installation Manager when operating in nonadministrator or group mode. Ensure you are in the correct directory.

```bash
umask
imcl -c
```

--------------------------------

### User Resource GET Response Example

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=responses-user-resource-get-response

An example of a successful HTTP GET response for a user resource, showcasing the RDF/XML structure containing user details.

```APIDOC
## GET /user/{userId}

### Description
Retrieves the details of a specific user resource.

### Method
GET

### Endpoint
/user/{userId}

### Response
#### Success Response (200)
- **rdf:RDF** (object) - The root element for the RDF document.
  - **foaf:Person** (object) - Represents a person resource.
    - **rdf:about** (string) - The URI of the person resource.
    - **foaf:name** (string) - The full name of the user.
    - **oslcem:userName** (string) - The username of the user.
    - **oslcem:userId** (string) - The unique identifier for the user.

#### Response Example
```xml
<?xml version="1.0" encoding="UTF-8"?>
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
			xmlns:oslc="http://open-services.net/ns/core#"
			xmlns:dcterms="http://purl.org/dc/terms/"
			xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
			xmlns:foaf="http://xmlns.com/foaf/0.1/"
			xmlns:crtv="http://open-services.net/ns/crtv#"
			xmlns:oslcem="http://jazz.net/ns/ism/event/omnibus#">
  <foaf:Person rdf:about="http://localhost/objectserver/oslc/user/500">
    <foaf:name>Test User 01</foaf:name>
    <oslcem:userName>testuser01</oslcem:userName>
    <oslcem:userId>500</oslcem:userId>
  </foaf:Person>
</rdf:RDF>
```
```

--------------------------------

### Example of Loading a Gateway Configuration File

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=commands-load-config

This example demonstrates how to use the LOAD CONFIG command to load a specific gateway configuration file from a given directory path.

```sql
LOAD CONFIG FROM '/disk/config/gateconf.conf';
```

--------------------------------

### Start Console Installation in Group Mode with Data Directory

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=manager-gui-console-installation

Use this command to start the Installation Manager console in group mode, specifying the data directory location.

```shell
./groupinstc -c -dL data_location
```

--------------------------------

### Start GUI Installation in Group Mode with Data Directory

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=manager-gui-console-installation

Use this command to start the Installation Manager GUI in group mode, specifying the data directory location.

```shell
./groupinst -dL data_location
```

--------------------------------

### Start Console Installation with Data Directory Option (Administrator)

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=manager-gui-console-installation

Use this command to start the Installation Manager console in administrator mode, specifying a custom data directory.

```shell
installc -c
```

--------------------------------

### Start Console Installation with Data Directory Option (Administrator)

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=manager-gui-console-installation

Use this command to start the Installation Manager console in administrator mode, specifying a custom data directory.

```shell
./installc -c
```

--------------------------------

### Example: Receive Certificate for Primary ObjectServer

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=cas-using-nc-gskcmd

This example demonstrates receiving a certificate for a primary ObjectServer named 'PSERV'. The command specifies the key database and the certificate file for the primary server.

```bash
$NCHOME/bin/nc_gskcmd -cert -receive -db "$NCHOME/etc/security/keys/omni.kdb" -pw password -file "$NCHOME/etc/security/keys/pservcert.arm"
```

--------------------------------

### Initialize ObjectServer with Translated Desktop File

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=ms-setting-up-objectserver-use-translated-user-interface-text-in-desktop

Use the nco_dbinit command with the -desktopfile option to specify the path and filename of the translated desktop.sql file for your required locale.

```bash
$NCHOME/omnibus/bin/nco_dbinit -server servername -desktopfile string
```

--------------------------------

### Start iKeyman on Windows (Command Line)

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=certificates-starting-ikeyman

Execute this command in the Windows command line to start the iKeyman utility. This method is preferred as it sets the default key database location.

```batch
%NCHOME%\bin\nc_ikeyman.bat
```

--------------------------------

### Non-Administrator Mode Installation

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=manager-silent-installation

Use this command to start the Installation Manager in non-administrator mode.

```bash
./userinstc -acceptLicense
```

--------------------------------

### Example: Setting Log Level to DEBUG

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=fbssc-set-log-level

This example demonstrates how to set the log level to DEBUG and then execute a command. This is useful for detailed troubleshooting.

```sql
1> set log level to DEBUG;
2> go

```

--------------------------------

### Silent Install Netcool/OMNIbus (Option 3)

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=netcoolomnibus-silent-installation

Run the silent installation script for Netcool/OMNIbus. This script also starts Installation Manager.

```bash
./install_silent.sh response_file -acceptLicense
```

--------------------------------

### Initialize ObjectServer

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=objectserver-creating

Use the nco_dbinit utility to create a new ObjectServer named 'MYOBJ'. This command sets up the properties file, default database tables, and initial user accounts.

```bash
nco_dbinit -server MYOBJ
```

--------------------------------

### Installing a Service with Dependencies

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=services-installing-configuring-uninstalling-server-components

Install a service and specify its dependencies using the /DEPEND option. The service will only start after the specified services or groups have run. The service name, not the display name, must be used.

```bash
/DEPEND srv @grp...
```

--------------------------------

### Installing a Service with Specific Account

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=services-installing-configuring-uninstalling-server-components

Install a service and configure it to log on using a specified user account. The /ACCOUNT option requires the user name, and potentially the domain. The /PASSWORD option must also be specified.

```bash
nco_pad /INSTALL /ACCOUNT Administrator
```

--------------------------------

### Start Installation Manager in Administrator Mode

Source: https://www.ibm.com/docs/en/netcoolomnibus/8.1.0?topic=netcoolomnibus-gui-installation

Use the 'su' or 'sudo sh' command to start a superuser shell before launching Installation Manager in administrator mode. Ensure the umask value is set appropriately.

```bash
su
sudo sh
```
Tokens:
Raw