echar-checkdev 1.1.9

A Node-RED check tool to interact with UC20 / M3000 / M4000 for network device monitoring

npm install echar-checkdev

Echar-Check

This checktool will pool by IP or his Network name and returns the trip time in miliseconds as directly configured or by automated via msg.payload input command. It can be used as a triggered or timed configuration!

To a better result Best Practice

Regarding network issues and traffic protections

We will delay 100ms from each host to monitor

this will help to keep in a safe way and not be kicked from the network trafic, caused of fully load the network bandwidth

Ideal work scanning cyclically time window

consider to use injection each 2seconds or more

Ideal host quantities per cycle

keep maximum 20 hosts

If you don't have it, please send a Telegram message to @echarcheck2DerBot with detail information:

• Your information
• UC20 / M3000 / M4000 frontal and side picture.

These informations are needed to we generate the proper Hash and Authorization Key!!

[{"host":"@echarcheck2DerBot","name":"Request"}]

The Pair Hash & Key will be the same to all used nodes

• Hash option
  

  Hash information to get from the supplier, this node will work only after properly set

• Key option
  

  Unlock password to activate the node, this will allow the node to be activated

Output

payload number

the trip time in miliseconds, or boolean false if no response.

topic string

the target host or ip address.

[monitor] object

an object containing host and any other properties sent in the array object.
Note: This object is only appended when using triggered mode and an array for input payload. It is intended for advanced users and permits scenarios where you need additional properties to be tagged into your result for use downstream.

Details

Returns false if no response received, or if the host is unresolveable.

Default monitor is every 20 seconds but can be configured.

Protocol...

• Automatic
  

  Will use any Protocol, IPv4 or IPv6, to reach host; based on your operating system network settings

• IPv4
  

  Forces use of IPv4 to reach host. Will fail if no route availibe

• IPv6
  

  Forces use of IPv6 to reach host. Will fail if no route availibe

Mode...

• Timed
  

  In Timed mode, the fields Target and monitor (S) must be populated.

  Target must be a CSV list of hosts / IPs e.g. "192.168.0.1" or "192.168.0.1, www.google.com"

  monitor (S) is the number of seconds between monitors

• Triggered
  

  In Triggered mode, you must connect an input wire and pass a msg in to trigger the monitor operation.

  If Target is populated, this will be used as the host/ip. The Target must be is a CSV list of hosts / IPs e.g. "192.168.0.1" or "192.168.0.1, www.google.com"

  If Target is left empty, you can pass a CSV string or an array of hosts in msg.payload.

  • string - a CSV list of hosts / IPs e.g. "192.168.0.1" or "192.168.0.1, www.google.com"
  • array - an array of hosts as strings or objects. Note: The object must contain at minimum .host. Optionally, you can add a timeout property between 1000 & 30000 (default is 5000 / 5 seconds). Additionally, you can add whatever other properties you wish to this object and when the monitor result is returned, it will be passed to the next node in msg.monitor for use downstream
  • Example array payload input:

    [
        "192.168.0.99",
        {
            "host":"192.168.0.1",
            "name":"The router"
        },
        {
            "host":"myapiserver.com",
            "name":"external API",
            "timeout": 20000,
            "support":"[email protected]"
        }
    ]