Operations

You can refer to the list of operations provided here.

event
Use this option to send custom notification events to a particular server. All listeners registered for the particular event receive this notification. This allows IBM® Security Verify Directory Integrator administrators to trigger listener applications based on planned custom events.

The usage for the event operation is:

tdisrvctl [general_options] -op event -e event_name [-s source ] [-d data]

where:

Example:

To send an event "user.process.X.completed" from "admin".

tdisrvctl -h itditest -op event -e "process.X.completed" -s admin -d "Admin triggered event"

Note: All events sent from tdisrvctl using the -e option are prefixed by "user."

prop
The "prop" option exposes the properties of a config via the TDI-p. It allows the user to get / set / view the properties of a particular config.

The usage for the prop operation is:

tdisrvctl [general_options] -op prop -c config_name
[ [-l ] |
[ -o property_store]
[ -g key | all] |
[ -s key=value] [-e] |
[ -d key] ]

where:

Note:

1. The '-l', '-g', '-s', '-d' options are mutually exclusive, and cannot be used together.

2. The '-e' option can only be used with the '-s' option.

3. Managing properties stored in the password store is NOT supported.

4. While specifying the "-c" option specify the COMPLETE configuration file path on the remote server, or give a path relative to the "configs" folder. To see the relative paths use the "report" option of tdisrvctl:

   tdisrvctl -op report -l 
   

Examples:

To see a list of all the property stores for config C1.xml

tdisrvctl -op prop -c C1.xml -l

To get a list of all the properties for config C1.xml

tdisrvctl -op prop -c C1.xml -g all

To get a list of all the properties for config C1.xml from store MyStore

tdisrvctl -op prop -c C1.xml -o MyStore -g all

To set a property MY_PROP to value MY_VALUE for config C1.xml in store MyStore and mark it as protected:

tdisrvctl -op prop -c C1.xml -o MyStore -s MY_PROP=MY_VALUE -e

queryop
The queryop option returns the list of AL operations exposed in an AssemblyLine.

This option is useful in a scripting environment. An IBM® Security Verify Directory Integrator solution developer can develop a script to automatically query for exposed operations and then use the result to start an AssemblyLine with a specific operation using the start operation's -r -alop flag. The output of this operation is such that it can be grepped for or tokenized easily in a scripted environment.

The usage for the queryop operation is:

tdisrvctl [general_options] -op queryop -c <configFile> -r <ALname> 

where

Output:

ALOp:{attr_1;attr_2...attr_n;}

Note: While specifying the "-c" option specify the COMPLETE configuration file path on the remote server, or give a path relative to the "configs" folder. To see the relative paths use the "report" option of tdisrvctl:

tdisrvctl -op report -l 

Examples:

To query for operations exposed in an AL:

tdisrvctl -h itditest -T trust.kdb 
  -W secret -op queryop 
  -c examples/ADCustomConnector.xml 
  -r ADAssemblyLine

Example Output:

$initialize: {ldapurl;loginPasswd;loginUserName}

reload
This option can be used to reload running Configs on a particular server.

The usage for reload operation is:

tdisrvctl [general_options] -op reload -c [config_list] 

where:

Note: While specifying the "-c" option specify the COMPLETE configuration file path on the remote server, or give a path relative to the "configs" folder. To see the relative paths use the "report" option of tdisrvctl:

tdisrvctl -op report -l    

Example:

To reload Configs C1.xml, C2.xml and C3.xml on remote host itditest:

tdisrvctl -h itditest -T trust.jks -W secret -op reload -c C1.xml,C2.xml,C3.xml

report
This option can be used for generating a report for a particular config or for listing the configs available on the remote server's config folder.

The config report lists details of the particular config. The details are AssemblyLines, Connectors and Parsers in each AssemblyLine, Connector library, Parser library, Script library, Function Library. This option gives a one shot view of all the details of a particular config.

The config listing option helps the user in finding out the list of configs available on the remote server and what their exact names are. Of course, only those configs can be seen that are in the "config" folder of the remote server (see global.properties file for property api.config.folder). This command cannot obtain list of configs located "anywhere" on the system.

The usage for the report operation is:

tdisrvctl [general_options] -op report [-c config | -l] 

where:

The displayed details for each connector or function component part of an AssemblyLine look like this:

Name           : count
Mode           : Iterator
State          : Enabled
Debug          : Disabled
Template       : system:/Connectors/ibmdi.Timer
Parser         : [parent]
Comment        : None

Note:

1. The specified config must be already loaded on the remote server.
2. Only one of the '-c' or '-l' option is allowed. Not both.
3. While specifying the "-c" option specify the COMPLETE configuration file path on the remote server, or give a path relative to the "configs" folder.
4. The argument to the -c option is case-sensitive, and must match the name of the config file exactly as known by the server instance, reported by for example "tdisrvctl -op status".

Examples:

To get a complete listing of the details of C1.xml on remote server:

tdisrvctl -h remoteserver -op report -c C1.xml

To get a list of the configs available in the "config" folder of the remote server:

tdisrvctl -h remoteserver -op report -l 

shutdown
This option can be used to shut down the IBM® Security Verify Directory Integrator server.

The format for this command is:

tdisrvctl [general_options] -op shutdown [-o return_code] [-f]

where:

Examples:

To shut down the local IBM® Security Verify Directory Integrator server:

tdisrvctl -op shutdown

To shut down the local IBM® Security Verify Directory Integrator server, with a controlled shutdown of all AssemblyLines:

tdisrvctl -op shutdown -f

To shut down the server running on remote host itditest which is configured for SSL (server-auth only)

tdisrvctl -h itditest -T trust.kdb -W secret -op shutdown

srvinfo
This option is used to display the information of an IBM® Security Verify Directory Integrator server.

The usage of the command is:

tdisrvctl [general_options] -op srvinfo 

Example:

To view the server information for an IBM® Security Verify Directory Integrator server running on localhost

tdisrvctl -h localhost -op srvInfo

status
This option can be used to view status of AssemblyLines.

The usage for status operation is: tdisrvctl [general_options] -op status -c [config_list | all]
-r [AL_list     | all]
   -listen

where:

Note:

1. At least one of the options ('-c' or '-r') must be specified. -

2. The keyword "all" indicates all configs or AssemblyLines.

3. The -listen option requires exactly one Config or AssemblyLine to be specified.

4. While specifying the "-c" option specify the COMPLETE configuration file path on the remote server, or give a path relative to the "configs" folder. To see the relative paths use the "report" option of tdisrvctl:

   tdisrvctl -op report -l
   

Examples:

To see the status of all configs and ALs:

tdisrvctl [general_options] -op status -c all -r all

You can also write

tdisrvctl [general_options] -op status

To see the status of AL1, AL2:

tdisrvctl -h itditest -op status -c c1.xml -r AL1,AL2

Output:

(Component Type # Component Name # RUNNING / STOPPED # Statistics): 
1 # AL1 # RUNNING # [get:571] [add:571] [del:3] [requests:2333].... 
1 # AL2 # STOPPED #  

The Component Types are:

• 0 for Config
• 1 for Assembly line

The Statistics contain the following details (valid for AssemblyLines only):

• Attribute "add" - total number of "add" operations performed
• Attribute "mod" - total number of "modify" operations performed
• Attribute "del" - total number of "delete" operations performed
• Attribute "get" - total number of "getNext" (Iterations®) performed
• Attribute "request" - total number of requests accepted when there is a Server mode Connector in the AssemblyLine.
• Attribute "callReply" - total number of "callReply" operations performed
• Attribute "err" - total number of errors encountered
• Attribute "skip" - total number of 'skip' operations performed
• Attribute "lookup" - total number of "lookup" operations performed
• Attribute "ignore" - total number of "ignore" operations performed
• Attribute "reconnect" - total number of "reconnect" operations performed
• Attribute "exception" - the exception text if the component terminated with an exception

To see the details of Configs (running and stopped) on a particular server:

tdisrvctl -h itditest -op status -c all

To see the details of a running AssemblyLine on a particular server and start receiving its logs:

tdisrvctl -h itditest -op status  -c rs.xml -r al1 -listen

start
This option can be used to start a config or AssemblyLines.

The usage for the start operation is: tdisrvctl [general_options] -op start -c [config]
-e [password]
   -r [AL_list | all] -alop <alop_Name> [{requiredAttr_1;
requiredAttr_2; ... requiredAttr_n}] | [-f filename]
-s [Simulate mode]
-m [run name] -o [propStore1=filename1,propStore2=filename2...]
-t [temp config instance]
-listen
-sync

where

Note:

1. The '-c' option is mandatory. -
2. The keyword "all" indicates all AssemblyLines.
3. Required attributes list is mandatory with -alop option.
4. -alop option cannot be used with -r all option. It works only with a specific AL.
5. When running a temp config with solution or run name it is not possible to check if another config with the same name is already running on the server. If this happens an exception will occur. You could check the running config instances using the status command.
6. The -t option expects the Config specified in the -c option to be located on the client machine.
7. If the -t option is used and the config specified in the -c option is relative then it will be searched in the current folder.
8. The -listen option requires exactly one Config or AssemblyLine to be specified.
9. The -listen option executes an AssemblyLine synchronously. There is no need to combine it with the -sync option.
10. The -sync option requires exactly one AssemblyLine to be specified.

Examples:

1. To start assembly line AL1 and AL2 of config C1 on remote server itditest:

   tdisrvctl -h itditest -T trust.kdb -W secret -op start -c C1.xml -r AL1,Al2
   

   The -r option requires that -c option should also be specified. This is because the AssemblyLines mentioned in the command must belong to one of the Configs in the -c option.

2. To start assembly line AL1 on remote server itditest with AL operation:

   tdisrvctl -h itditest -T trust.kdb -W secret -op start 
     -c examples/ADCustomConnector.xml
     -r ADAssemblyLine 
     -alop $initialize {ldapurl:ldap://9.182.190.149:390;loginPasswd:password;loginUsrname:cn=root}
   

3. To start AssemblyLine AL1 on remote server itditest with AL operation update:

   tdisrvctl -h itditest -T trust.kdb -W secret -op start 
       -c examples/ADCustomConnector.xml  -r ADAssemblyLine 
       -alop search {$init.ldapurl:ldap://9.182.190.149:390;$init.loginPasswd:password;
        $init.loginUsrname:cn=root;searchBase:o=ibm,c=us}
   

   Note: All initialization attributes are to be prefixed with $init.

4. tdisrvctl -h itditest -T trust.kdb -W secret -op start -c examples/ADCustomConnector.xml  
        -r ADAssemblyLine -alop search -f inputFile
   

   Input file format:

   Key1:value1
   Key2:value2

5. Command to run an AssemblyLine AL1 in simulate mode:

   tdisrvctl -h itditest -T trust.kdb -W secret -op start -c examples/ADCustomConnector.xml -r AL1 -s
   

6. Command to load multiple config instances:

   tdisrvctl -op start -c C1.xml -m test -f PropertyStorename=TestProp.properties, 
        PropStore2=propfile2 ... -r AL1,AL2 
   

7. Command to run temp config instance:

   tdisrvctl -op  start -c C1.xml -t -r AL1
   

8. Command to start a config on a particular server and receive its logs:

   tdisrvctl -h itditest -op start -c rs.xml -listen
   

9. Command to start an AssemblyLine on a particular server and receive its logs:

   tdisrvctl -h itditest -op start -c rs.xml -r AL1 -listen
   

10. Command to execute an assembly line synchronously on a particular server:

    tdisrvctl -h itditest -op start -c rs.xml -r AL1 -sync
    

11. Command to designate a property file or a list of property files at the time of AssemblyLine startup:

    tdisrvctl -h itditest -op start -c SyncTDS -o A=c:\temp\abc.properties
    

    In this scenario you want the A store to use the file c:\temp\abc.properties.

    You must use the -o parameter of the -op start operation to declare a list of property files. When declaring the -o, you must specify a key=value pair for the UserPropertyStore and property file respectively:

    -o <UserPropertyStore declared in xml project>=<Location of Properties File>    
    

    You must use a comma to separate the key value pairs.

    The following example is applicable in a scenario where you want the A store to use the file c:\temp\abc.properties and another property store B to use another file C:\temp\def.properties:

    tdisrvctl -h itditest -op start -c SyncTDS -o 
         A=c:\temp\abc.properties,B=C:\temp\def.properties
    

    For example:

    tdisrvctl -K serverapi\testadmin.jks -P administrator -T
    testserver.jks -W server -op start -c SyncTDS 
    -o SyncTDSProp=c:\SyncTDS.properties,SyncADProp=c:\SyncAD.properties -r SyncData     
    

stop
The usage for the stop operation is:

tdisrvctl [general_options] -op stop -c [config]
-r [AL_list | all]

where:

Note:

1. The '-c' option is mandatory.

2. While specifying the "-c" option specify the COMPLETE configuration file path on the remote server, or give a path relative to the "configs" folder. To see the relative paths use the "report" option of tdisrvctl:

   tdisrvctl -op report -l 
   

3. The keyword "all"' indicates all AssemblyLines.

4. The -r option requires that -c option should also be specified. This is because the AssemblyLines mentioned in the command must belong to one of the Configs in the -c option.

5. The -f option is optional.

6. The argument to the -c option is case-sensitive, and must match the name of the config file exactly as known by the server instance, reported by for example "tdisrvctl -op status".

Example:

To stop assembly line AL1 and AL2, of Config C1 on remote server itditest:

tdisrvctl -h itditest -T trust.jks -W secret -op stop -c C1.xml -r AL1,Al2 

tombstone
This option can be used to view tombstone details of previously run Configs, AssemblyLines and EventHandlers (historical).

The usage for the tombstone operation is: tdisrvctl [general_options] -op tombstone  -c [config]
[ -r [AL_name] ]
   [-age n]
[[attribute_list] | all ]

where:

attribute_list:

Note:

1. The '-c' option is mandatory.

2. While specifying the "-c" option specify the COMPLETE configuration file path on the remote server, or give a path relative to the "configs" folder. To see the relative paths use the "report" option of tdisrvctl:

   tdisrvctl -op report -l 
   

3. The argument to the -c option is case-sensitive, and must match the name of the config file exactly as known by the server instance, reported by for example "tdisrvctl -op status".

Examples:

1. To see the last 2 days tombstone entries (all attributes) for config C1.xml

   tdisrvctl [general_options] -op tombstone -c C1.xml -age 2 all
   

2. To see tombstone entries for config C1 for the past 3 days:

   tdisrvctl -h itdiserver -op tombstone -c C1 -age 3 all
   

3. To see tombstone entries for config C1 for the last 24 hours (specific attributes):

   tdisrvctl -h itdiserver -op tombstone -c C1 -ct -ctime -cn -um
   

4. To see the tombstone entry for AL1 of "rs.xml"

   tdisrvctl -h itdiserver -op tombstone -c C1 -r AL1
   

deletetombstone
This option can be used to delete tombstone entries for previously run AssemblyLines.

The usage for the delete tombstone operation is:

tdisrvctl [general_options] -op deletetombstone -guid <GUID number>

where

-guid "GUID number" is the unique identifier for the tombstone to be deleted. The GUID for a tombstone can be obtained by viewing the contents of the tombstone; see the entry about the tombstone option for details as to how to obtain the GUID.

debug
This option can be used to set the Debug mode values of connectors and function components of a running AssemblyLine. When you set the Debug mode of a connector with specified parser, the Debug mode of the parser is also initialized with the same value.

The usage for the debug operation is as follows: tdisrvctl [general_options] -op debug -c config
-r assembly_line
[ -alc al_component]
-on/off

where:

Note:

1. The '-c' and '-r' options are mandatory and require exactly one Config/AssemblyLine to be specified.

2. While specifying the "-c" option specify the COMPLETE configuration file path on the remote server, or give a path relative to the "configs" folder. To see the relative paths use the "report" option of tdisrvctl:

   tdisrvctl -op report -l
   

3. The argument to the -c option is case-sensitive, and must match the name of the config file exactly as known by the server instance, reported by for example "tdisrvctl -op status".

4. If the -alc option is not specified all components in the specified AssemblyLine will be affected.

Examples:

1. To view the Debug mode value of the components in the AssemblyLines of a specified Config:

   tdisrvctl -op report -c C1
   

2. To enable the debug mode for all components in the running AssemblyLine al2:

   tdisrvctl -op debug -c C1-r al2 -on C1-r al2 -on
   

3. To disable the debug mode for specified components in the running AssemblyLine al3:

   tdisrvctl -op debug -c C1-r al3 -alc comp1,comp2 -off