IBM Tivoli Application Dependency Discovery Manager

https://www.ibm.com/docs/en/taddm/7.3.0
Admin
IBM Tivoli Application Dependency Discovery Manager (TADDM) is a configuration management tool that...
Tokens:818,365
Snippets:6,931
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Start WebSphere Application Server example

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=management-troubleshooting-oslc

Example command to start the WebSphere Application Server with sample parameters.

```bash
./startServer.sh server1 -user wasadmin -p passw0rd
```

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

### automation_provider install examples

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=ioeaspi-installing-oslc-execute-automation-service-provider-tivoli-monitoring

Example invocations of the automation_provider install command on Linux and Windows. The first specifies all optional parameters; the second uses only the ITM home directory.

```bash
automation_provider.sh install -t /tmp/log -i /opt/IBM/ITM -h 9.100.100.200 -p 15210
```

```powershell
automation_provider.ps1 install -i /opt/IBM/ITM
```

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

### Start Integration Plugin with ./plugin.sh start

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=its-appendix-b-integration-plugin-parameter-help-different-modes

Shows the usage and an example for starting the Integration plugin with the 'start' argument. The -p option is not recommended for security purposes.

```bash
usage: ./plugin.sh -u <username> -p <password> start [-h] 
where,
-u <username>	Provide TADDM user name
-p <password>	Provide TADDM user password. Not recommended for security purpose.
-h,--help	    show help.

Example to check Integration plugin execution 
Start: 
./plugin.sh start

```

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

### Run the TADDM installation wizard setup command for your operating system

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=wizard-installing-primary-storage-server-using-installation

Run the appropriate setup command from the DVD drive or the directory where the zip files were saved. On Windows, select 'Run as administrator' or the installation will fail. If insufficient temp disk space occurs, use the -t option to specify a different temp directory.

```text
setupAix.bin
```

```text
setupLinux.bin
```

```text
setupZLinux.bin
```

```text
setupWin.bat
```

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

### Start load-balanced discovery from directory

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=api-load-balanced-discover-command

Starts continuous, load-balanced discovery against each file in the specified directory, similar to the --files example.

```bash
api.sh -u <user> -p <password> discoverloadbalanced startFromDirectory --dir <directory path> --maxScopeSize <size> [--profile <profileName>]
```

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

### Example keytool command to create truststore

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=cs-configuring-access-list-23

Example command that creates a truststore named ze_sensor_truststore with passphrase Fa8asTek using the ECC JRE. Replace <ECC install path> with the actual path.

```bash
ecc_install_path/jre/jre/bin/keytool -import -noprompt 
-alias key_alias -file <ECC install path>/certificates/key_alias.cert 
-keystore ze_sensor_truststore -storepass Fa8asTek -storetype JKS
```

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

### getChangeHistoryInXML(Guid[] Guids, long start, long end, int filterType)

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=summary-change-history

Gets the change history for multiple GUIDs, filtered by filterType.

```APIDOC
## getChangeHistoryInXML(Guid[] Guids, long start, long end, int filterType)

### Description
Gets the change history for multiple GUIDs, filtered by filterType. This method is like the getChangeHistory() with the addition of filterType, which can be set to the following values: DataApi.CREATED, DataApi.DELETED, DataApi.UPDATED, DataApi.UPDATECREATE, DataApi.ANYCHANGE.

### Method
SDK method

### Parameters
- **Guids** (Guid[]) - Required - Array of GUIDs for which to retrieve change history.
- **start** (long) - Required - Start time for the change history range.
- **end** (long) - Required - End time for the change history range.
- **filterType** (int) - Required - Filter type for the change history. Can be one of: DataApi.CREATED, DataApi.DELETED, DataApi.UPDATED, DataApi.UPDATECREATE, DataApi.ANYCHANGE.

### Response
Returns the change history for the specified GUIDs, filtered by filterType.
```

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

### getChangeHistory(Guid[] Guids, long start, long end, int filterType)

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=summary-change-history

Gets the change history for multiple GUIDs, filtered by the filterType parameter.

```APIDOC
## getChangeHistory(Guid[] Guids, long start, long end, int filterType)

### Description
Gets the change history for multiple GUIDs, filtered by the filterType parameter. This method is like the getChangeHistory() with the addition of filterType, which can be set to the following values: DataApi.CREATED, DataApi.DELETED, DataApi.UPDATED, DataApi.UPDATECREATE, DataApi.ANYCHANGE.

### Method
SDK method

### Parameters
- **Guids** (Guid[]) - Required - Array of GUIDs for which to retrieve change history.
- **start** (long) - Required - Start time for the change history range.
- **end** (long) - Required - End time for the change history range.
- **filterType** (int) - Required - Filter type for the change history. Can be one of: DataApi.CREATED, DataApi.DELETED, DataApi.UPDATED, DataApi.UPDATECREATE, DataApi.ANYCHANGE.

### Response
Returns the change history for the specified GUIDs, filtered by the filterType parameter.
```

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

### Example CURL command with actual GUIDs

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=tool-actions-managing-grouping-pattern-schedules

Example CURL command using actual GUIDs for the grouping pattern and scheduler. The grouping pattern GUID is 392B42E1C31F3F5C8A7974D58DCFC725 and the scheduler GUID is 5FD7DBBFB220394895D4F02A5AF693BC.

```bash
curl -X PUT -H "Content-Type: application/json" -d '{"_class":"GroupingPattern","guid":"392B42E1C31F3F5C8A7974D58DCFC725","schedule":{"_class":"PatternSchedule","guid":"5FD7DBBFB220394895D4F02A5AF693BC"}}'http://10.160.162.231:9430/rest/model/GroupingPattern?guid=42E1C31F3F5C8A7974D58DCFC725-u administrator:collation
```

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

### Example runPattern command with actual GUID

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=tool-actions-managing-grouping-pattern-schedules

Example runPattern command using the actual grouping pattern GUID 392B42E1C31F3F5C8A7974D58DCFC725.

```bash
bizappscli.sh runPattern -g 392B42E1C31F3F5C8A7974D58DCFC725
```

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

### Start and verify discovery with api.sh

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=kit-verifying-sdk-installation

Start a discovery for the host 10.10.10.12, then check the discovery status to verify that the discovery is running.

```shell
% ./api.sh -u user -p password -H host discover start 10.10.10.12
```

```shell
% ./api.sh -u user -p password -H host discover status
```

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

### getChangeHistoryInXML(Guid Guid, long start, long end)

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=summary-change-history

Returns the change history for the specified GUID.

```APIDOC
## getChangeHistoryInXML(Guid Guid, long start, long end)

### Description
Returns the change history for the specified GUID.

### Method
SDK method

### Parameters
- **Guid** (Guid) - Required - GUID for which to retrieve change history.
- **start** (long) - Required - Start time for the change history range.
- **end** (long) - Required - End time for the change history range.

### Response
Returns the change history for the specified GUID.
```

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

### syncstart

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=api-sync-command

Starts a domain server synchronization using the sync command with the start subcommand.

```APIDOC
## [SYNC] syncstart

### Description
Starts a domain server synchronization.

### Method
syncstart

### Endpoint
api.sh|api.bat -u|--user user -p|--password password [-H|--host host] [-P|--port port] [-T|--truststorefile] syncstart domain

### Parameters
#### Command Parameters
- **sync** (string) - Required - Runs the sync command.
- **start** (string) - Required - Starts a domain server synchronization.
- **domain** (string) - Required - The name of the domain that is added to the synchronization server, not the host name of the domain server.

### Request Example
```
api.sh -u user -p password -H host syncstart domain
```

### Response
#### Success Response
No response body is documented.

```

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

### Generate response file by recording input (Linux on System z)

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=servers-silently-installing-taddm-server

Runs the Linux on System z installer with the record option to capture input values into /tmp/install.rsp. The folder must already exist. Password information is not saved, so you must manually edit the response file to include database passwords before silent installation.

```bash
setupZLinux.bin -r /tmp/install.rsp
```

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

### getChangeHistory(Guid Guid, long start, long end)

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=summary-change-history

Returns the change history for the specified GUID.

```APIDOC
## getChangeHistory(Guid Guid, long start, long end)

### Description
Returns the change history for the specified GUID.

### Method
SDK method

### Parameters
- **Guid** (Guid) - Required - GUID for which to retrieve change history.
- **start** (long) - Required - Start time for the change history range.
- **end** (long) - Required - End time for the change history range.

### Response
Returns the change history for the specified GUID.
```

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

### GET /cdm/api/groupingpatterns/{GUID}

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=api-maintaining-grouping-patterns-using-rest

Returns grouping patterns with the given GUID.

```APIDOC
## GET /cdm/api/groupingpatterns/{GUID}

### Description
Returns grouping patterns with the given GUID.

### Method
GET

### Endpoint
/cdm/api/groupingpatterns/{GUID}

### Parameters
#### Path Parameters
- **GUID** (string) - Required - The GUID of the grouping pattern to retrieve.

### Response
#### Success Response (200)
- Returns the grouping pattern with the specified GUID.

#### Response Example
(No example provided in source)

```

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

### Generate response file by recording input (Linux)

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=servers-silently-installing-taddm-server

Runs the Linux installer with the record option to capture input values into /tmp/install.rsp. The folder must already exist. Password information is not saved, so you must manually edit the response file to include database passwords before silent installation.

```bash
setupLinux.bin -r /tmp/install.rsp
```

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

### checkinstall output for TADDM 7.3.0

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=taddm-verifying-server-installation

Example output from the checkinstall script for a successful TADDM 7.3.0 installation. It shows the run-as user, database user, archive DB user, DB type, and DB URL, followed by the checked paths and database connections marked [ok]. The final line indicates the installation check passed.

```text
Run-as user:taddmuser
DB User:db2admin
Archive DB User:archuser
DB type:db2
DB url:jdbc:db2://localhost:50000/cmdb

CHECKED AND PASSED:
/opt/IBM/taddm1234/dist/external/jdk                                   [ok]
/opt/IBM/taddm1234/dist/lib                                            [ok]
/opt/IBM/taddm1234/dist/deploy-tomcat                                  [ok]
/opt/IBM/taddm1234/dist/etc/collation.properties                       [ok]
db2admin jdbc:db2://localhost:50000/cmdb                              [ok]
archuser jdbc:db2://localhost:50000/cmdb                              [ok]
taddmuser                                                             [ok]

EXCEPTIONS RAISED:

ERROR LIST:


Basic TADDM installation check: Passed
```

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

### getChangeHistory(Guid[] Guids, long start, long end)

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=summary-change-history

Returns the change history for the specified array of GUIDs.

```APIDOC
## getChangeHistory(Guid[] Guids, long start, long end)

### Description
Returns the change history for the specified array of GUIDs.

### Method
SDK method

### Parameters
- **Guids** (Guid[]) - Required - Array of GUIDs for which to retrieve change history.
- **start** (long) - Required - Start time for the change history range.
- **end** (long) - Required - End time for the change history range.

### Response
Returns the change history for the specified GUIDs.
```

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

### Example status commands for automation_provider

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=ioeaspi-checking-status-itm-oslc-execute-automation-service-provider

These examples show how to run the automation_provider script with various optional parameters. The first command checks status with no parameters, the second specifies the ITM home directory, and the third specifies both the temporary directory and ITM home. All parameters are optional and can be in any order.

```bash
automation_provider.sh status
```

```powershell
automation_provider.ps1 status -i /opt/IBM/ITM
```

```bash
automation_provider.sh status -t /tmp/log -i /opt/IBM/ITM
```

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

### Start Integration Plugin with User and Password (Option 3)

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=servicenow-running-integration-plugin

Starts the Integration Plugin with both a TADDM user ID and password provided on the command line.

```bash
./plugin.sh -u <username> -p <password> start
```

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

### Run TADDM installer on System z

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=installing-troubleshooting-installation-problems

Run this script from the local directory where the TADDM install image was copied to start the installation on System z.

```bash
setupZLinux.bin
```

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

### Delete multiple objects by GUIDs

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=api-delete-command

Deletes multiple objects by specifying several GUIDs as arguments. Replace the example GUIDs with the ones you want to remove.

```bash
api.sh -u user -p password -H host -P port delete C172810FD1CF3E108B8127BC47D2667B 059E4D85B34C32D1B5A80D9E2DB09EBD 35D21D3CA08539908DC1762D26897FB6
```

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

### Run deltabooks.sh example

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=program-using-delta-books-utility

Example command that runs the delta books utility with the first discovery output in /first_output/, the second discovery output in /second_output/, and the delta books output in /delta_books/.

```bash
deltabooks.sh -f /first_output/ -t /second_output/ -o /delta_books/
```

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

### Run wsadmin to connect to TIP

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=have-security-problems

Start the wsadmin command-line tool with the TIP user credentials to manage the TIP server.

```bash
wsadmin.sh -username TIP_user -password password
```

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

### startDiscovery(Guid[] guidList, String runName)

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=summary-discovery-management

Starts a rediscovery of the objects with the specified globally unique identifiers (GUIDs).

```APIDOC
## startDiscovery(Guid[] guidList, String runName)

### Description
Starts a rediscovery of the objects with the specified globally unique identifiers (GUIDs).

### Method
startDiscovery

### Parameters
- **guidList** (Guid[]) - Required - The list of GUIDs of objects to rediscover.
- **runName** (String) - Required - The name of the discovery run.

### Response
No return value.
```

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

### Remote installation: Specify console mode

Source: https://www.ibm.com/docs/en/taddm/7.3.0?topic=installing-troubleshooting-installation-problems

Command to start the installer in console mode when using telnet or SSH.

```bash
setupAix.bin -i console
```
Tokens:
Raw