Defining TADDM Observer jobs

The TADDM Observer is installed as part of the core installation procedure. Using the TADDM Observer, you can retrieve network topology data from the TADDM database and use this data to create topologies within the topology service.

Before you begin

Important: The TADDM Observer supports the on-premise TADDM version.

To connect to a TADDM Oracle database, you must place the Oracle JDBC Driver into the $ASM_HOME/lib folder, and then restart the observer for it to take effect. You can download the driver from the Oracle website, or copy it them from the Oracle server (not the Oracle client) from the following location: ../app/oracle/product/Oracle_version/dbhome/jdbc/lib/ojdbc6.jar

Ensure you have the TADDM Rest API login access details in hand, such as the TADDM API URL, username and password.

All prerequisites are deployed during the Agile Service Manager core installation. This includes the TADDM Observer docker container, which has been installed and should be running, as well as the required scripts to manage jobs. All observers have scripts to start and stop all available jobs, to list the status of a current job, to set its logging levels, and to configure its job parameters.

You can verify that the TADDM Observer's docker container is running using the following command:

$ASM_HOME/bin/docker-compose ps

The system should return text indicating that asm_taddm-observer_1 has a state of Up and therefore is running.

Remember: Swagger documentation for the observer is available at the following default location: https://<your host>/1.0/taddm-observer/swagger

About this task

The TADDM Observer is built on the Observer framework:

A computer system can be a host, server, router or switch
A computer system contains CPU, L2Interface and storage
Operating system, application server and service run on a computer system
A computer system can connect to another computer system
A SAPSystem contains collection
An application server can be a member of a collection

Table 1. Mapping TADDM model objects to Agile Service Manager entity types
TADDM model object	Agile Service Manager entity types
AppServer	application
ComputerSystem	host, server, router, switch
CPU	cpu
L2Interface	networkinterface
IpInterface	networkinterface
IpAddress	ipaddress
OperatingSystem	os
Service	service
StorageExtent	storage
Function	service
SAPSystem	application
Collection	group

The TADDM Observer job retrieves topology data using the TADDM REST API. The observer loads and updates the resources and their relationships within the Netcool Agile Service Manager core topology service.

taddm_observer_common.sh: The config file you use to customize TADDM Observer settings.; The parameters defined here are then used by the taddm_observer_load_start.sh script to trigger the TADDM Observer job.; Tip: Alternatively, you can set the appropriate environment variables. If an environment variable is set, it takes precedence over the configuration file settings.

You define and start the following job. You must edit the parameters in the config file before running a job.

Load job: A transient (one-off) job that loads all requested topology data.; This job is started by the taddm_observer_load_start.sh script.

Procedure

To edit the parameters in the config file

Open the $ASM_HOME/bin/taddm_observer_common.sh configuration file and edit (at least) the following parameters:
username

TADDM user

password

TADDM password in encrypted form.
For encryption: Run the encrypt_password.sh script in the ASM_HOME/bin directory:
./bin/encrypt_password.sh
Enter and then confirm the password. The encryption utility returns an encrypted version.
api_url

TADDM API URL

model_objects

Optional

List of supported TADDM model object names to be observed.

Keep the default to let the observer fetch all the supported model objects. Supported model objects are ["AppServer", "ComputerSystem", "CPU", "StorageExtent", "L2Interface", "IpInterface", "IpAddress", "OperatingSystem", "Function", "SAPSystem", "Collection"]

To start the Load job

To start the TADDM Observer load job, use the following command:
```
$ASM_HOME/bin/taddm_observer_load_start.sh
```
This job loads all requested topology data. Run this job whenever you need the TADDM topology data refreshed.

Results

You can now use data retrieved from the TADDM database to create topologies in the Agile Service Manager topology service.

Remember: As an alternative to being configured using the Observer Configuration UI, observer jobs have scripts to start and stop all available jobs, to list the status of a current job, and to set its logging levels. These scripts can be run with -h or --help to display help information, and with -v or --verbose to print out the details of the actions performed by the script, including the full cURL command. For the on-prem version of Agile Service Manager, observer scripts are configured for specific jobs by editing the script configuration files.

What to do next

You can also use the following scripts:

taddm_observer_load_stop.sh: Stops the Load job
taddm_observer_job_list.sh: Lists the status of current jobs
taddm_observer_log_level.sh: Sets the log level