Product documentation Docs
    • English
    • Deutsch
    • 日本語
    • 한국어
    • Français
  • More Sites
    • Now Community
    • Developer Site
    • Knowledge Base
    • Product Information
    • ServiceNow.com
    • Training
    • Customer Success Center
    • ServiceNow Support Videos
  • Log in

Product documentation

  • Home
How search works:
  • Punctuation and capital letters are ignored
  • Special characters like underscores (_) are removed
  • Known synonyms are applied
  • The most relevant topics (based on weighting and matching to search terms) are listed first in search results
Topics are ranked in search results by how closely they match your search terms
  • A match on the entire phrase you typed
  • A match on part of the phrase you typed
  • A match on ALL of the terms in the phrase you typed
  • A match on ANY of the terms in the phrase you typed

Note: Matches in titles are always highly ranked.

  • Release version
    Table of Contents
    • Now Platform capabilities
Table of Contents
Choose your release version
    Home Orlando Now Platform Capabilities Now Platform capabilities MID Server MID Server reference information MID Server ECC Queue

    MID Server ECC Queue

    • Save as PDF Selected topic Topic & subtopics All topics in contents
    • Unsubscribe Log in to subscribe to topics and get notified when content changes.
    • Share this page

    MID Server ECC Queue

    The External Communication Channel (ECC) Queue is a connection point between an instance and the MID Server. Jobs that the MID Server needs to perform are saved in this queue until the MID Server is ready to handle them.

    Links to each of the MID Server sectionsEnsure that the MID Server can connect to elements inside and outside your networkDownload and install the MID Server on a Linux or Windows hostConfigure your MID ServerConfigure MID Server securityEnsure that the MID Server can connect to elements inside and outside your networkDownload and install the MID Server on a Linux or Windows hostConfigure your MID ServerConfigure MID Server security

    Asynchronous Message Bus

    The MID Server subscribes to messages published by the Asynchronous Message Bus (AMB), which notifies the MID Server that it has pending tasks in the ECC Queue. If a job exists in the ECC Queue for that MID Server, the MID Server sets the status to "I'm working on it." When finished working on a requested job, the MID Server reports back to the ECC queue with the results.

    The MID Server opens a persistent connection to the instance through the AMB)Client and listens on the /mid/server/<mid_sys_id> AMB channel. When an output record is inserted into the Queue [ecc_queue] table, an AMB message is sent to the MID Server's channel. The MID Server receives this message and immediately polls the ecc_queue table for work.

    The MID Server polls the ECC queue on the regular interval defined in the mid.poll.time configuration parameter, regardless of AMB message activity. The default polling interval is set to 40 seconds, but can be reconfigured. This polling of the ECC queue at a regular interval is done in case the AMB connection is dropped.

    Figure 1. MID Server ECC queue polling process
    MID Server ECC queue polling process
    Note: The AMB client on the MID Server does not work in all environments and might need to be disabled to avoid performance issues. To disable AMB in your environment, set the mid.disable_amb parameter to true. When you disable AMB, the MID Server reverts to a default polling interval of 5 seconds, unless the mid.poll.time parameter is set to a different value.

    ECC Queue information

    You can access the ECC Queue by navigating any of these paths:
    • Discovery > Output and Artifacts > ECC Queue
    • Discovery > Discovery Schedules > {schedule name} > {Discovery status record}
    • ECC > Queue
    • {Discovery Status record} > ECC Queue
    An ECC Queue provides the following information:
    Field Input value
    Agent The name of the external system that this messages is either from or to. If the message is from or to a MID Server, the agent name is in the form mid.server.xxx, where xxx is the name of a particular MID Server.
    Topic The name of the probe the MID server ran. If you are using a pattern for discovery, the Horizontal Pattern probeHorizontal Pattern probe appears.
    Name The actual command the probe ran. For example, if Topic is SSHCommand, then the Name field contains the actual shell command to run. If you are using a pattern for discovery, the following appears:

    Pattern Launcher: followed by the name of the pattern and the multipage number.

    Source The IP address that the discovery is to run against. A few probes run against multiple IP addresses; in those cases, this field contains a human-readable description.
    Response to This optional field contains a reference (sys_id) to the ECC Queue message that this message is in response to. Discovery makes extensive use of this field to track the hierarchy of messages that result from a given scheduled Discovery. Click the record icon for the value in this field to open the ECC Queue record for the activity that spawned the current probe or sensor record.
    Queue An indicator of whether this message was is an input message or an output message.
    State The state of the current ECC queue record. States update automatically.
    Processed The time when this message was processed.
    Created The time when this message was created.
    Sequence The unique sequence number for this message. This value is automatically generated when an ECC Queue record is inserted. Its use is deprecated.
    Error string An error message, if an error occurred during processing. This field is hidden on the standard form unless there was an error.
    Payload The body of the message in XML format. The returned XML has a root tag of <results> containing one or more <result> tags and a single <parameters> tag. The parameters are simply an echo of those sent to the MID server in the probe; they vary from probe to probe, but in general they tell the probe the details of what it is to do and how it should behave. The result tags are the most interesting ones: they contain the actual data generated by the probe.

    ECC queue controls

    The ECC Queue form contains these related links:
    Related link Description
    Run again Runs the probe again. You can re-run probes when you encounter a failed discovery or other unexpected results.
    Go to CMDB item Open the CI record for the CI that was updated during the discovery.
    Go to Sensor Open the record for the associated sensor.

    Manage ECC Queue content for a MID Server

    The ECC Queue allows you to create ECC Queue messages, access MID Server log entries, and retrieve statistics from an individual MID Server record.

    Before you begin

    Role required: admin, mid_server

    Procedure

    1. Send remote commands through a MID Server to a hosting device directly from the ECC Queue without running Discovery.
      1. Navigate to the ECC Queue and click New.
      2. Create a message with these settings:
        • Agent: The name of the MID Server that executes the command.
        • Topic: Command
        • Name: The actual command that you want to process. For Windows, this is expressed in a DOS command line structure. For Linux, the structure could be a bash command line entry.
        • Queue: Output
        • Payload: With proper XML tags, you can specify the command here instead of in the Name field. The advantage to this is that the command is not restricted by the Name field length of 120 characters. Use the following XML format for the command:
        <parameters>
           <parameter name="name" value="ACTUAL_COMMAND_LINE"/>
        </parameters>
    2. Access entries in the ECC Queue that show agent0.log.0 logs and wrapper.log logs for an individual MID Server.
      1. Open a MID Server record.
      2. Under Related Links, click Grab MID Logs.
        ECC queue records appear in the list using the following filter:
        • [Topic] [is] [SystemCommand]
        • [Source] [is] [grabLog]
        • [Agent] [is] [your MID Server]

        Only agent0.log.0 and wrapper.log entries appear. These logs are also accessible in the ~\agent\logs\ file path.

      3. To open a log entry, click the link under the Created column.
    3. Access the queue.stats topic for useful information about individual MID Servers, such as memory and CPU usage data.
      1. Open a MID Server record.
      2. Under Related Links, click MID Statistics.
        ECC queue records appear in the list using the following filter:
        • [Topic] [is] [queue.stats]
        • [Agent] [is] [your MID Server]
    Related concepts
    • MID Server Reference
    Related reference
    • MID Server Issues Home

    Tags:

    Feedback
    On this page

    Previous topic

    Next topic

    • Contact Us
    • Careers
    • Terms of Use
    • Privacy Statement
    • Sitemap
    • © ServiceNow. All rights reserved.

    Release version
    Choose your release version

      MID Server ECC Queue

      • Save as PDF Selected topic Topic & subtopics All topics in contents
      • Unsubscribe Log in to subscribe to topics and get notified when content changes.
      • Share this page

      MID Server ECC Queue

      The External Communication Channel (ECC) Queue is a connection point between an instance and the MID Server. Jobs that the MID Server needs to perform are saved in this queue until the MID Server is ready to handle them.

      Links to each of the MID Server sectionsEnsure that the MID Server can connect to elements inside and outside your networkDownload and install the MID Server on a Linux or Windows hostConfigure your MID ServerConfigure MID Server securityEnsure that the MID Server can connect to elements inside and outside your networkDownload and install the MID Server on a Linux or Windows hostConfigure your MID ServerConfigure MID Server security

      Asynchronous Message Bus

      The MID Server subscribes to messages published by the Asynchronous Message Bus (AMB), which notifies the MID Server that it has pending tasks in the ECC Queue. If a job exists in the ECC Queue for that MID Server, the MID Server sets the status to "I'm working on it." When finished working on a requested job, the MID Server reports back to the ECC queue with the results.

      The MID Server opens a persistent connection to the instance through the AMB)Client and listens on the /mid/server/<mid_sys_id> AMB channel. When an output record is inserted into the Queue [ecc_queue] table, an AMB message is sent to the MID Server's channel. The MID Server receives this message and immediately polls the ecc_queue table for work.

      The MID Server polls the ECC queue on the regular interval defined in the mid.poll.time configuration parameter, regardless of AMB message activity. The default polling interval is set to 40 seconds, but can be reconfigured. This polling of the ECC queue at a regular interval is done in case the AMB connection is dropped.

      Figure 1. MID Server ECC queue polling process
      MID Server ECC queue polling process
      Note: The AMB client on the MID Server does not work in all environments and might need to be disabled to avoid performance issues. To disable AMB in your environment, set the mid.disable_amb parameter to true. When you disable AMB, the MID Server reverts to a default polling interval of 5 seconds, unless the mid.poll.time parameter is set to a different value.

      ECC Queue information

      You can access the ECC Queue by navigating any of these paths:
      • Discovery > Output and Artifacts > ECC Queue
      • Discovery > Discovery Schedules > {schedule name} > {Discovery status record}
      • ECC > Queue
      • {Discovery Status record} > ECC Queue
      An ECC Queue provides the following information:
      Field Input value
      Agent The name of the external system that this messages is either from or to. If the message is from or to a MID Server, the agent name is in the form mid.server.xxx, where xxx is the name of a particular MID Server.
      Topic The name of the probe the MID server ran. If you are using a pattern for discovery, the Horizontal Pattern probeHorizontal Pattern probe appears.
      Name The actual command the probe ran. For example, if Topic is SSHCommand, then the Name field contains the actual shell command to run. If you are using a pattern for discovery, the following appears:

      Pattern Launcher: followed by the name of the pattern and the multipage number.

      Source The IP address that the discovery is to run against. A few probes run against multiple IP addresses; in those cases, this field contains a human-readable description.
      Response to This optional field contains a reference (sys_id) to the ECC Queue message that this message is in response to. Discovery makes extensive use of this field to track the hierarchy of messages that result from a given scheduled Discovery. Click the record icon for the value in this field to open the ECC Queue record for the activity that spawned the current probe or sensor record.
      Queue An indicator of whether this message was is an input message or an output message.
      State The state of the current ECC queue record. States update automatically.
      Processed The time when this message was processed.
      Created The time when this message was created.
      Sequence The unique sequence number for this message. This value is automatically generated when an ECC Queue record is inserted. Its use is deprecated.
      Error string An error message, if an error occurred during processing. This field is hidden on the standard form unless there was an error.
      Payload The body of the message in XML format. The returned XML has a root tag of <results> containing one or more <result> tags and a single <parameters> tag. The parameters are simply an echo of those sent to the MID server in the probe; they vary from probe to probe, but in general they tell the probe the details of what it is to do and how it should behave. The result tags are the most interesting ones: they contain the actual data generated by the probe.

      ECC queue controls

      The ECC Queue form contains these related links:
      Related link Description
      Run again Runs the probe again. You can re-run probes when you encounter a failed discovery or other unexpected results.
      Go to CMDB item Open the CI record for the CI that was updated during the discovery.
      Go to Sensor Open the record for the associated sensor.

      Manage ECC Queue content for a MID Server

      The ECC Queue allows you to create ECC Queue messages, access MID Server log entries, and retrieve statistics from an individual MID Server record.

      Before you begin

      Role required: admin, mid_server

      Procedure

      1. Send remote commands through a MID Server to a hosting device directly from the ECC Queue without running Discovery.
        1. Navigate to the ECC Queue and click New.
        2. Create a message with these settings:
          • Agent: The name of the MID Server that executes the command.
          • Topic: Command
          • Name: The actual command that you want to process. For Windows, this is expressed in a DOS command line structure. For Linux, the structure could be a bash command line entry.
          • Queue: Output
          • Payload: With proper XML tags, you can specify the command here instead of in the Name field. The advantage to this is that the command is not restricted by the Name field length of 120 characters. Use the following XML format for the command:
          <parameters>
             <parameter name="name" value="ACTUAL_COMMAND_LINE"/>
          </parameters>
      2. Access entries in the ECC Queue that show agent0.log.0 logs and wrapper.log logs for an individual MID Server.
        1. Open a MID Server record.
        2. Under Related Links, click Grab MID Logs.
          ECC queue records appear in the list using the following filter:
          • [Topic] [is] [SystemCommand]
          • [Source] [is] [grabLog]
          • [Agent] [is] [your MID Server]

          Only agent0.log.0 and wrapper.log entries appear. These logs are also accessible in the ~\agent\logs\ file path.

        3. To open a log entry, click the link under the Created column.
      3. Access the queue.stats topic for useful information about individual MID Servers, such as memory and CPU usage data.
        1. Open a MID Server record.
        2. Under Related Links, click MID Statistics.
          ECC queue records appear in the list using the following filter:
          • [Topic] [is] [queue.stats]
          • [Agent] [is] [your MID Server]
      Related concepts
      • MID Server Reference
      Related reference
      • MID Server Issues Home

      Tags:

      Feedback

          Share this page

          Got it! Feel free to add a comment
          To share your product suggestions, visit the Idea Portal.
          Please let us know how to improve this content

          Check any that apply

          To share your product suggestions, visit the Idea Portal.
          Confirm

          We were unable to find "Coaching" in Jakarta. Would you like to search instead?

          No Yes
          • Contact Us
          • Careers
          • Terms of Use
          • Privacy Statement
          • Sitemap
          • © ServiceNow. All rights reserved.

          Subscribe Subscribed Unsubscribe Last updated: Tags: January February March April May June July August September October November December No Results Found Versions Search preferences successfully updated My release version successfully updated My release version successfully deleted An error has occurred. Please try again later. You have been unsubscribed from all topics. You are now subscribed to and will receive notifications if any changes are made to this page. You have been unsubscribed from this content Thank you for your feedback. Form temporarily unavailable. Please try again or contact  docfeedback@servicenow.com  to submit your comments. The topic you requested does not exist in the release. You were redirected to a related topic instead. The available release versions for this topic are listed There is no specific version for this documentation. Explore products Click to go to the page. Release notes and upgrades Click to open the dropdown menu. Delete Remove No selected version Reset This field is required You are already subscribed to this topic Attach screenshot The file you uploaded exceeds the allowed file size of 20MB. Please try again with a smaller file. Please complete the reCAPTCHA step to attach a screenshot
          Log in to personalize your search results and subscribe to topics
          No, thanks Login