jevdef_distrib
- Organization of this page
Function
The jevdef_distrib command distributes event service definitions and adds them to a specified destination.
Format
jevdef_distrib {-f [distribution-definition-file-name1] | -e [distribution-definition-file-name2] | -l [distribution-definition-file-name3] | -s [distribution-definition-file-name4]} [-h logical-host-name] [-n]
Required execution permission
In Windows: Administrators (If User Account Control (UAC) for Windows is enabled, you must execute the command from the administrator console.)
In UNIX: Superuser or JP1/Base administrator permission
Command directory
- In Windows:
-
installation-folder\bin\
- In UNIX:
-
/opt/jp1base/bin/
Arguments
-f [distribution-definition-file-name1]
Specify the -f option to distribute definitions in the forwarding settings file (forward). If you create a distribution definition file with the name jev_forward.conf, you do not need to specify the file name. If you have prepared a distribution definition file with another name, specify the name of the file. You cannot specify a directory name. You cannot use the \, /, :, ,, ;, *, ?, ", <, >, |, tab, or space characters when specifying the file name. Create a distribution definition file for each forwarding settings file in the appropriate location, as described in Distribution definition file in 16. Definition Files.
If you specify this option, regular expressions in the definition file on the distribution source host are checked for syntax errors. You can execute the jevreload command to perform a syntax check on the distribution destination host. The syntax check on the source host checks basic regular expressions (JP1-unique regular expressions in Windows). Therefore, if the destination host is set up to use extended regular expressions, use the -n option to suppress the syntax check on the source host.
-e [distribution-definition-file-name2]
Specify the -e option to distribute definitions in the action definition file for event log trapping (ntevent.conf). If you created a distribution definition file with the name jev_ntevent.conf, you do not need to specify the file name. If you have prepared a distribution definition file with another name, specify the name of the file. You cannot specify a directory name. You cannot use the \, /, :, ,, ;, *, ?, ", <, >, |, tab, or space characters when specifying the file name. Create a distribution definition file for each forwarding settings file in the appropriate location, as described in Distribution definition file in 16. Definition Files. This command distributes definitions only to Windows hosts.
If the destination agent is a logical host, the action definition file for event log trapping is distributed. The action definition file is then reloaded onto the physical host (the primary host) of the distribution agent host.
-l [distribution-definition-file-name3]
Specify the -1 option to distribute definitions in the action definition file for log file trapping. If you created a distribution definition file with the name jev_logtrap.conf, you do not need to specify the file name. If you have prepared a distribution definition file with another name, specify that file name. You cannot specify a directory name as the file name. You cannot use the \, /, :, ,, ;, *, ?, ", <, >, |, tab, or space characters when specifying the file name. Create a distribution definition file for each forwarding settings file in the appropriate location, as described in Distribution definition file in 16. Definition Files.
If the destination agent is a logical host, the action definition file for log file trapping is distributed. The action definition file is then reloaded onto the physical host (the primary host) of the distribution agent host.
-s [distribution-definition-file-name4]
Specify the -s option to distribute definitions in a log-file trap startup definition file (jevlog_start.conf). The definitions in the log-file trap startup definition file are not reloaded into the log-file trap management service (daemon). The definitions will be enabled next time the log-file trap management service starts.
If you created a distribution definition file with the name jev_logstart.conf, you do not need to specify the file name. If you gave the file another name, specify the name of the file. You cannot specify a directory name. You cannot use the \, /, :, ,, ;, *, ?, ", <, >, |, tab, or space characters when specifying the file name. Create each distribution definition file in the appropriate location, as described in Distribution definition file in 16. Definition Files. To distribute a log-file trap startup definition file, the distribution source and destination hosts must both be running JP1/Base version 10-00 or later.
-h logical-host-name
Specify this option when executing the command on a logical host. If you omit this option, the host name set in the environment variable JP1_HOSTNAME is assumed. If the environment variable JP1_HOSTNAME is not set, the host name is assumed to be the same as the local host.
If you specify the -e option, the action definition file for event log trapping specified on the physical host of the command-executing host (primary host) is distributed.
If you specify the -l option, the action definition file for log file trapping specified on the physical host of the command-executing host (primary host) is distributed.
-n (valid when the -f option is specified)
If you want to disable syntax checking on the source host, specify this option. Because the regular expression specifications depend on the platform and the regular expression type (basic regular expression or extended regular expression), we recommend specifying this option in the following cases:
-
The distribution definition file for a forwarding settings file (forward) contains a regular expression, and the source platform differs from the destination platform.
-
The destination host is specified to use extended regular expressions.
If you specify the -e or -l option, syntax is not checked on the source host. However, specifying the -n option with either of these two options does not produce an error.
If you specify this option when the event server is running on the destination, a reloading result is output as a command execution result. However, a syntax check on the source host is not performed. If the event server is not running on the destination, no filter condition error can be detected. In order to detect a filter condition error, the event server must be running on the destination. You can use the return value from the jevdef_distrib command to determine whether the event server is running.
Notes
-
You can execute the jevdef_distrib command only from a host where JP1/IM - Central Console Version 7 or JP1/IM - Manager Version 8 or later is installed.
-
If the manager host has a submanager running JP1/IM - Central Console Version 7 or JP1/IM - Manager Version 8 or later in a lower layer, you can also execute the jevdef_distrib command from the submanager. If you execute the jevdef_distrib command concurrently from both the manager host and the submanager, the definitions distributed last are valid.
-
Definitions are distributed to the destinations specified in the distribution definition file.
-
When the jevdef_distrib command is executed, the jbsplugin process (in Windows) or the jbsplugin daemon (in UNIX) must be running on destination hosts.
-
If any of the destination hosts are not started when the jevdef_distrib command is executed, the command displays a message stating that it could not change definitions on those hosts. In such a case, ensure that the hosts are started and then redistribute the definitions.
-
If definitions are already set on a destination host, the jevdef_distrib command first deletes the existing definitions before distributing definitions.
-
If a host specified in the distribution definition file has not been defined in the JP1/IM configuration definition file, the jevdef_distrib command results in an error, distributing definitions to any host.
-
If the same host is specified more than once in the distribution definition file, the jevdef_distrib command results in an error, without distributing definitions to any host.
-
If the version of JP1/Base running on a destination host is 06-71 or earlier, the jevdef_distrib command does not distribute definitions to that host, and proceeds to the next destination.
-
If an error occurs on a destination host due to failed reloading, the command continues processing with the previous definitions being valid but it rewrites the definitions with the distributed definitions. You should re-execute the jevdef_distrib command for a host where reloading has failed.
-
The host names and error messages for destination hosts that have caused an error are output to the standard error output.
-
When you distribute definitions in the action definition file for log file or event log trapping, the jevlogreload or jeveltreload command is executed on the destination host. If trap processing is in progress, the system waits until the trap processing finishes before executing the reload command. If an event occurs while the jevlogreload or jeveltreload command is being executed, the event will be converted according to the newly loaded definitions after the reload command has finished.
-
When you distribute definitions, do not change the attribute parameter values (FILETYPE, HEADLINE, HEADSIZE, and RECTYPE) of the definition file for log file trapping. Use the values specified at startup. If you modify any of these parameters and distribute the definitions, the definitions on destination hosts are updated but an error occurs when the jevlogreload command is executed.
Return values
0 |
Normal end |
1 |
Invalid argument |
2 |
The log-file trap management service or log-file trap management daemon is inactive. |
3 |
An error occurred during acquisition of configuration definition information. |
4 |
Insufficient system resource such as memory |
10 |
The distribution definition file contains an error. |
11 |
An error occurred during opening of the distribution definition file. |
12 |
Error at the destination |
255 |
Other error |