The command line-to-DFC utility enables you to send DFC calls from within a shell script or from other types of applications that are not designed to use the normal DFC routing function commands.
You must create the DFC functions using MSG-IDE, and the DFCs must contain the strings you try to pass when you use the command line-to-DFC utility. Once you create the DFCs, they are saved to the AIM application’s configuration file and are available for you to call from the command line.
WARNING! When you define the function, the argument must have an [in] attribute.
To execute the utility, you can set the parameters in a configuration file or pass the options as command line arguments.
To run these command use the ims wrapper
scripts, see “Adding the wrapper scripts directory to the PATH variable”.
You must also run this program from a directory where you have write permission since this program creates an xlog file in the directory from which you execute it.
ims cmdlinedfc -cluster.name clusterName
-cluster.server clusterServer
-domain.type domainType
-domain.name domainName
-env.snmp.port snmpPort
-env.trap.port trapPort
-file fileName
-dfc.function dfcFunctionName
-dfc.flavor dfcFlavor
-dfc.args[n]
The following parameters are required in a command-line DFC call:
-mgr clusterName – name of the cluster to receive the DFC call.
-server clusterServer – the name of the machine on which the cluster is running. The default is “localhost” if not specified.
-type domainType – type of the domain under which the cluster is running. The default value is “Impact.”
-name domainName – the name of the domain under which the cluster is running. The default value is “Impact.”
-function dfcFunctionName – name of the DFC function to call.
-flavor dfcFlavor – flavor of the DFC to call. The default value is “0.”
-dfc.args n – list of string arguments to the DFC function. For example:
-dfc.args arg1, arg2, arg3
When arguments are provided on the command line, the -dfc.args parameter and its arguments must be the last arguments on the command line.
These parameters are optional:
-file fileName – the name of a configuration file that contains all or some command line arguments. Commands issued at the command line take precedence over the same commands in this file.
-snmp.port snmpPort – the SNMP port to which the cluster publishes telemetries. The default value of is 161.
-trap.port trapPort – the SNMP trap port to which the cluster publish alerts. The default value is 162.
The cluster.name, domain.type and domain.name arguments
allow e-Biz Impact to identify the cluster external port using SNMP.
When the CNC utility is executed, the dfc.xlog log file is created. The log file contains debug, success, and error messages that occur during execution.
The return values are:
0 – the command is executed successfully. However, this does not mean that the command itself works, just that the command has executed properly. Check the actual command return value to verify that the command not only executed, but also did what it was supposed to do.
1 – the command failed to execute due to a DFC error.
2 – the command failed to execute due to an invalid configuration; for example, bad or missing arguments.
3 – the command failed to execute due to an SNMP error.
4 – the command failed to execute due to a failed connection to the e-Biz Impact server.
5 – the command failed to execute due to a failed login to the e-Biz Impact server.
100 – the command failed to execute due to an unknown error.
| Copyright © 2005. Sybase Inc. All rights reserved. |
|
|
