Accompanying syntax

From the hcicmd prompt, the accompanying syntax can be run:

  • conn client_drop conn ID:

    Disconnects a client that is based on the connection ID.

  • conn client_list:

    Shows a list of active client connection IDs. If Save Client IP and Port to DriverControl is enabled on the Multi Server Options dialog box of the TCP/IP or PDL TCP/IP protocol, then this shows the IP and port of each client.

  • dbrate secs:

    Changes the default sample rate of the error database alerts from three minutes to the value that is given by secs. This is the number of seconds that are between samples.

    This command does not permit the setting of this interval to less than 60 seconds. If an interval less than 60 seconds is specified, then an error message is returned and the value remains unchanged.

    This changes the polling rate of all errdb type alerts.

  • .die:

    Stops the engine.

  • disablefilter :

    Disables alerts that match the specified filter. This does not reset an alert, nor does it reset times that are used in alert tests.

    The time-out for the alert to fire is a "test time" of the alert. When it is enabled, that time is used in the test. This continues until a new value is set by the thread or the thread is restarted.

    In general, do not clear the disable until you are sure that an event changes the time in msi or that the alert may fire. In most cases, this is after the thread has been bounced.

    filter can be one of:

    • all disables all loaded alerts.
    • alert name disables the named alert.
    • group group_name disables alerts belonging to group group_name.
    • config file_name disables alerts loaded from the configuration file file_name, and where file_name is the alert configuration file, for example, default.alrt.
  • enable filter:

    This enables alerts that match the specified filter.

    filter can be one of:

    • all enables all loaded alerts.
    • alert name enables the named alert.
    • group group_name enables alerts belonging to group group_name.
    • config file_name enables alerts loaded from the configuration file file_name, and where file_name is the alert configuration file, for example, default.alrt.

    In some situations, an alert is a member of more than one group and more than one group has been disabled. In this case, only the group named in the command list is enabled. For example, an alert is a member of lab-a and clinic-b, and both were disabled by the disable group command. enable group lab-a still leaves the alert disabled as a member of clinic-b. The named and all versions of the command override this type of action.

  • conn eo_alias alias:

    Supplies output alias.

  • conn eo_en eoc_pat:

    Enables trace output.

  • conn eo_dis eoc_pat:

    Disables trace output.

  • conn cycle:

    Cycles the Daemon output file.

    When usingcycle, process is not an engine process, but the MonitorD.

  • conn fwd_start:

    Starts message forwarding.

  • conn fwd_stop:

    Stops message forwarding.

  • conn fwdr_start

    Starts reply message forwarding to the thread that is specified by the Forward Thread entry in the Network Configurator.

  • conn fwdr_stop:

    Stops reply message forwarding.

  • log message :

    Writes message to the hcimonitord.log file and to the alerts.log. This command assumes that there are no escaped characters in message. Example:

    timestamp : User Log Command: user log message
  • output_cycle:

    Cycles engine output file. Example:

    .output_cycle
  • conn purgex:

    Purges translation caches.

    Cleans up the translate caches except the xlate/grm cache objects, which is reloaded when the process is bounced.

  • conn pstart [-h]:

    Starts a connection.

    Using the optional -h starts the thread with an active hold, as if it were started and then the hold command was issued.

  • conn pstop:

    Stops a connection.

  • prestart:

    Restarts thread_name in process after delay interval.

    This example is the delay interval for restarting thread_name in process:

    -p process -c thread_name prestart delay interval

    See hcienginerestart.

  • conn phold_obd:

    Holds outbound data messages.

  • conn phold_obd_reply:

    Holds outbound reply messages.

  • conn prls_obd n:

    Releases outbound data messages.

    Specifying the optional count, n, indicates that prls_obd 2 releases only two messages without releasing the hold on the thread. It does not matter how many are in the outbound queue. If the option is not there or is zero, then the queue hold is released as in previous releases.

    The count (n) is the maximum number of messages to release. If the queue becomes empty when releasing the messages, then the count is reset. When another message arrives, it is not released as part of the count. An empty queue clears the counting.

    The count is the maximum number of messages that are released if there are not enough messages available to release. After the queue is empty, the count supplied is no longer active and the thread outbound data hold stops all messages from being processed.

  • conn prls_obd_reply:

    Releases outbound reply messages.

  • conn reindex:

    Reloads Tcl auto-load indices.

  • conn reload procname:

    Reloads Tcl auto-load procedures.

  • resend:

    Resends messages. Example:

    conn resend \ ib [dest_thread]|ob data|reply priority 
    msgfile_name len10|nl|eof [meta_file_name]

    The optional meta_file_name argument to resend permits metadata resending.

    • meta_file_name is an optional argument. If this argument is not supplied, then the command works the same as version 6.1.
    • msgfile_name is the temp file that stores the message contents, which is unchanged. A new temp file is used to store edited metadata. This is referenced by meta_file_name. The new temp file is deleted after the resend is complete.
  • runnow_schedule:

    If a thread has advanced scheduling that was configured through the Network Monitor, then you can also use this command to run the scheduled task. Example:

    hcicmd -p proc_name -c "conn_name runnow_schedule"