シンプルなpingツール。 TCP/UDP/ICMPプロトコルをサポートします。
ピングスはできる...
ICMP エコー要求と ttl トレースルートを送信します。
ping の送信、TCP / UDP ポートへのスキャン、およびバナー取得。
UDP pingを使用してマジックパケット(Wake on LAN)を送信します。
pingus.Ping
'ready'
'result'
'error'
ping.send()
pingus.PingTCP
拡張: pingus.Ping
new PingTCP(options)
pingtcp.send()
pingtcp.scan()
pingus.PingUDP
拡張: pingus.Ping
new PingUDP(options)
pingudp.send()
pingudp.scan()
pingus.PingICMP
拡張: pingus.Ping
new PingICMP(options)
pingicmp.send()
pingicmp.traceroute()
Callback
またはPromise
の使用 ( async/await
)pingus.tcp(options[, callback])
pingus.tcpscan(options[, callback])
pingus.udp(options[, callback])
pingus.udpscan(options[, callback])
pingus.wol(mac, options[, callback])
pingus.icmp(options[, callback])
pingus.traceroute(options[, callback])
npm i pingus
インストール中にエラーが発生する場合は、以下のパッケージのインストールに失敗している可能性があります。
この問題は、GCC コンパイラをインストールすることで修正できます。
Ubuntuの場合:
sudo apt-get install -y build-essential
Windows の場合:
Desktop development with C++
を含むVisual Studio
インストールします。
// TCP Ping to localhost:22
import pingus from 'pingus' ; // ESM, Typescript
const pingus = require ( 'pingus' ) ; // CJS
pingus . tcp ( { host : 'localhost' , port : 22 } ) . then ( console . log ) ;
// Result
{
type : 'ping/tcp' ,
status : 'open' ,
host : 'localhost' ,
ip : IP { label : '127.0.0.1' } ,
ips : [ IP { label : '127.0.0.1' } ] ,
time : 2 ,
port : 22 ,
name : 'ssh' ,
banner : 'SSH-2.0-OpenSSH_8.9p1 Ubuntu-3'
toPrimitiveJSON : [ Function ( anonymous ) ]
}
pingus.Ping
pingus.Ping
次のイベントを持つEventEmitter
です。
'ready'
result
<Object>
ping.send()
の呼び出し後に ping を送信する準備ができたときに (DNS を解決し、Bogon IP をフィルターして) 発行されます。
import pingus from 'pingus' ;
const ping = new pingus . PingTCP ( {
host : 'example.com' ,
} ) ;
ping . on ( 'ready' , ( result ) => {
const data = result . toPrimitiveJSON ( ) ;
console . log ( 'pingttarget:t' , data . host ) ;
console . log ( 'tips:t' , data . ips ) ;
} ) ;
ping . send ( ) ;
ping target: example.com
ips: [ '93.184.215.14', '2606:2800:021f:cb07:6820:80da:af6b:8b2c' ]
'result'
result
<Object>
pingデータの結果。
import pingus from 'pingus' ;
const ping = new pingus . PingTCP ( {
host : 'example.com' ,
} ) ;
ping . on ( 'result' , ( result ) => {
const data = result . toPrimitiveJSON ( ) ;
console . log ( result ) ;
} ) ;
ping . send ( ) ;
{
type : 'ping/tcp' ,
status : 'open' ,
host : 'example.com' ,
ip : '93.184.215.14' ,
ips : [ '93.184.215.14' , '2606:2800:021f:cb07:6820:80da:af6b:8b2c' ] ,
time : 134 ,
port : 80 ,
name : 'http' ,
banner : ''
}
'error'
<Error>
result
<Object>
エラーが発生したときに発行されます。 result
エラーが発生する前の最後のステートメントとエラー コードが含まれています。
ping.send()
pingを送信します。 「使用法」の例をいくつか参照してください。
pingus.PingTCP
拡張: pingus.Ping
TCP ping のクラス。
pingus.PingTCP
pingus.Ping
のタイプです
new PingTCP(options)
options
<Object>
host
<string>
ターゲットのホスト名 (ドメイン) または IP アドレスを設定します。port
<number>
pingtcp.send()
を使用する場合のターゲット ポートを設定します。デフォルト: 80
ports
<Array>
| <string>
pingtcp.scan()
使用するときにターゲット ポートを設定します。ポート番号またはクエリ文字列の配列を使用します。例を参照してください。timeout
<number>
タイムアウトを設定します。デフォルト: 2000
resolveDNS
<boolean>
host
がドメイン アドレスの場合に、DNS A
およびAAAA
レコードを解決します。デフォルト: true
dnsServer
<string>
DNS レコードを解決する DNS サーバーを設定します。filterBogon
<boolean>
host
内の bogon IP アドレスをフィルターします。デフォルト: true
options.ports
の例ports: [ 21 , 22 , 80 , 443 ] ; // Scan port 21, 22, 80, 443
ports: '21,22,80,443' ; // Scan port 21, 22, 80, 443
ports: '21-80' ; // Scan ports in range 21 to 80 (21, 22, 23 ... 78, 79, 80)
ports: '21-25,80,443' ; // Scan ports in range 21 to 25 and 80, 443
ports: '@' ; // Scan most used 1024 ports in protocol
ports: '*' ; // Scan all ports (1 to 65535)
pingtcp.send()
ping.send()
参照してください。使用例のいくつか。
pingtcp.scan()
TCP ping を使用してポートをスキャンします。イベントの結果を返します: 'result'
。 「使用法」でいくつかの例を参照してください。
pingus.PingUDP
拡張: pingus.Ping
UDP ping のクラス。
pingus.PingUDP
pingus.Ping
のタイプです
new PingUDP(options)
options
<Object>
host
<string>
ターゲットのホスト名 (ドメイン) または IP アドレスを設定します。port
<number>
pingudp.send()
を使用する場合のターゲット ポートを設定します。デフォルト: 68
ports
<Array>
| <string>
pingudp.scan()
使用するときにターゲット ポートを設定します。ポート番号またはクエリ文字列の配列を使用します。 PingTCPと同じです。例を参照してください。buffer
<Buffer>
接続されている UDP ping ソケットで送信するときにバッファを設定します。body
<string>
接続されている UDP ping ソケットで送信するときに本文を設定します。 buffer
オプションが設定されている場合は無視されます。bytes
<number>
接続された UDP ping ソケットで送信するときのランダムなバイト長を設定します。 body
オプションが設定されている場合は無視されます。デフォルト: 32
timeout
<number>
タイムアウトを設定します。デフォルト: 2000
resolveDNS
<boolean>
host
がドメイン アドレスの場合に、DNS A
およびAAAA
レコードを解決します。デフォルト: true
dnsServer
<string>
DNS レコードを解決する DNS サーバーを設定します。filterBogon
<boolean>
host
内の bogon IP アドレスをフィルターします。デフォルト: true
pingudp.send()
ping.send()
参照してください。使用例のいくつか。
pingudp.scan()
pingtcp.scan()
と同様です。
UDP ping を使用してポートをスキャンします。イベントの結果を返します: 'result'
。 「使用法」でいくつかの例を参照してください。
pingus.PingICMP
拡張: pingus.Ping
ICMP ping のクラス。
pingus.PingICMP
pingus.Ping
のタイプです。
new PingICMP(options)
options
<Object>
host
<string>
ターゲットのホスト名 (ドメイン) または IP アドレスを設定します。ttl
<number>
ttlを設定します。デフォルト: 128
ttln
<number>
pingicmp.traceroute()
を使用する場合の開始 ttl を設定します。デフォルト: 1
ttlx
<number>
pingicmp.traceroute()
を使用する場合の最大 ttl を設定します。デフォルト: 64
timeout
<number>
タイムアウトを設定します。デフォルト: 2000
timeoutx
<number>
pingicmp.traceroute()
を使用する場合の最大タイムアウトスタックを設定します。デフォルト: 8
resolveDNS
<boolean>
host
がドメイン アドレスの場合に、DNS A
およびAAAA
レコードを解決します。デフォルト: true
dnsServer
<string>
DNS レコードを解決する DNS サーバーを設定します。filterBogon
<boolean>
host
内の bogon IP アドレスをフィルターします。デフォルト: true
pingicmp.send()
ping.send()
参照してください。使用例のいくつか。
pingicmp.traceroute()
トレースルートを実行します。使用例のいくつか。
Callback
またはPromise
の使用 ( async/await
)「Ping スタイルの送信」の例を参照してください。
pingus.tcp(options[, callback])
TCP pingを送信します。
pingus.tcpscan(options[, callback])
TCP ping を使用してポートをスキャンします。
pingus.udp(options[, callback])
UDP pingを送信します。
pingus.udpscan(options[, callback])
UDP ping を使用してポートをスキャンします。
pingus.wol(mac, options[, callback])
mac
<string>
ターゲットの MAC アドレスを設定します。options
<Object>
new PingUDP(options)
WOL 機能を使用するには、マジック パケット UDP ping を送信します。
pingus.icmp(options[, callback])
ICMP pingを送信します。
pingus.traceroute(options[, callback])
トレースルートを実行します。
ESM (タイプスクリプト)
import pingus from 'pingus' ;
CJS
const pingus = require ( 'pingus' ) ;
Class
使用してEventEmitter
拡張する // TCP ping to localhost:80
new pingus . PingTCP ( { host : 'localhost' } )
. on ( 'result' , ( result ) => {
console . log ( result . toPrimitiveJSON ( ) ) ;
} )
. on ( 'error' , ( err , result ) => {
throw err ;
} )
. send ( ) ;
Callback
の使用 // TCP ping to localhost:80
pingus . tcp ( { host : 'localhost' } , ( err , result ) => {
if ( err ) {
throw err ;
}
console . log ( result ) ;
} ) ;
Promise
の使用 // TCP ping to localhost:80
pingus
. tcp ( { host : 'localhost' } )
. then ( ( result ) => {
console . log ( result . toPrimitiveJSON ( ) ) ;
} )
. catch ( ( err ) => {
throw err ;
} ) ;
async/await
の使用 // TCP ping to localhost:80
const result = await pingus . tcp ( { host : 'localhost' } ) ;
console . log ( result . toPrimitiveJSON ( ) ) ;
{
type : 'ping/tcp' ,
status : 'open' ,
host : 'localhost' ,
ip : '127.0.0.1' ,
ips : [ '127.0.0.1' ] ,
time : 2 ,
port : 80 ,
name : 'http' ,
banner : ''
}
// TCP ping to localhost:22
new pingus . PingTCP ( { host : 'localhost' , port : 22 } )
. on ( 'result' , ( result ) => {
console . log ( result . toPrimitiveJSON ( ) ) ;
} )
. on ( 'error' , ( err , result ) => {
throw err ;
} )
. send ( ) ;
{
type : 'ping/tcp' ,
status : 'open' ,
host : 'localhost' ,
ip : '127.0.0.1' ,
ips : [ '127.0.0.1' ] ,
time : 2 ,
port : 22 ,
name : 'ssh' ,
banner : 'SSH-2.0-OpenSSH_8.9p1 Ubuntu-3'
}
// TCP ping scan to localhost
new pingus . PingTCP ( {
host : 'localhost' ,
ports : [ 21 , 22 , 80 , 443 , 3306 , 8080 ] ,
} )
. on ( 'result' , ( result ) => {
console . log ( result . toPrimitiveJSON ( ) ) ;
} )
. on ( 'error' , ( err , result ) => {
throw err ;
} )
. scan ( ) ;
{
type : 'ping/tcp/scan' ,
status : 'finish' ,
host : 'localhost' ,
ip : '127.0.0.1' ,
ips : [ '127.0.0.1' ] ,
time : 2009 ,
port : 80 ,
name : 'http' ,
banner : '' ,
ports : [ 21 , 22 , 80 , 443 , 3306 , 8080 ] ,
statuses : {
open : [ 22 , 80 , 8080 ] ,
reset : [ ] ,
close : [ 21 , 443 , 3306 ] ,
filtered : [ ] ,
error : [ ]
} ,
names : {
'21' : 'ftp' ,
'22' : 'ssh' ,
'80' : 'http' ,
'443' : 'https' ,
'3306' : 'mysql' ,
'8080' : 'http-alt'
} ,
banners : { '22' : 'SSH-2.0-OpenSSH_8.9p1 Ubuntu-3' } ,
errors : { }
}
// UDP ping to localhost:19132
new pingus . PingUDP ( { host : 'localhost' , port : 19132 } )
. on ( 'result' , ( result ) => {
console . log ( result . toPrimitiveJSON ( ) ) ;
} )
. on ( 'error' , ( err , result ) => {
throw err ;
} )
. send ( ) ;
{
type : 'ping/udp' ,
status : 'close' ,
host : 'localhost' ,
ip : '127.0.0.1' ,
ips : [ '127.0.0.1' ] ,
time : 2 ,
port : 19132 ,
name : 'minecraft-be'
}
// UDP ping scan to localhost
new pingus . PingUDP ( {
host : 'localhost' ,
ports : [ 67 , 68 , 161 , 162 , 445 ] ,
} )
. on ( 'result' , ( result ) => {
console . log ( result . toPrimitiveJSON ( ) ) ;
} )
. on ( 'error' , ( err , result ) => {
throw err ;
} )
. scan ( ) ;
{
error : undefined ,
type : 'ping/udp/scan' ,
status : 'finish' ,
host : 'localhost' ,
ip : '127.0.0.1' ,
ips : [ '127.0.0.1' ] ,
time : 2003 ,
ports : [ 67 , 68 , 161 , 162 , 445 ] ,
statuses : {
open : [ 68 ] ,
reset : [ ] ,
close : [ 67 , 161 , 162 , 445 ] ,
filtered : [ ] ,
error : [ ]
} ,
names : {
'67' : 'bootps' ,
'68' : 'bootpc' ,
'161' : 'snmp' ,
'162' : 'snmptrap' ,
'445' : 'microsoft-ds'
} ,
banners : { } ,
errors : { }
}
// Send magic packet using UDP ping to 00-00-00-00-00-00
pingus
. wol ( '00-00-00-00-00-00' )
. then ( ( result ) => {
console . log ( result . toPrimitiveJSON ( ) ) ;
} )
. catch ( ( error ) => {
throw error ;
} ) ;
{
type : 'ping/udp' ,
status : 'open' ,
host : '255.255.255.255' ,
ip : '255.255.255.255' ,
ips : [ '255.255.255.255' ] ,
time : 2 ,
port : 9 ,
name : 'discard'
}
// ICMP ping to example.com
new pingus . PingICMP ( { host : 'example.com' } )
. on ( 'result' , ( result ) => {
console . log ( result . toPrimitiveJSON ( ) ) ;
} )
. on ( 'error' , ( err , result ) => {
throw err ;
} )
. send ( ) ;
{
type : 'ping/icmp' ,
status : 'reply' ,
host : 'example.com' ,
ip : '93.184.215.14' ,
ips : [ '93.184.215.14' , '2606:2800:021f:cb07:6820:80da:af6b:8b2c' ] ,
time : 130 ,
ttl : 128 ,
bytes : 32 ,
reply : {
source : '93.184.216.34' ,
type : 0 ,
code : 0 ,
typestr : 'ECHO_REPLY' ,
codestr : 'NO_CODE' ,
body : '767284c4'
}
}
// ICMP ping to example.com using ttl = 10
new pingus . PingICMP ( { host : 'example.com' , ttl : 10 } )
. on ( 'result' , ( result ) => {
console . log ( result . toPrimitiveJSON ( ) ) ;
} )
. on ( 'error' , ( err , result ) => {
throw err ;
} )
. send ( ) ;
{
type : 'ping/icmp' ,
status : 'exception' ,
host : 'example.com' ,
ip : '93.184.215.14' ,
ips : [ '93.184.215.14' , '2606:2800:021f:cb07:6820:80da:af6b:8b2c' ] ,
time : 133 ,
ttl : 10 ,
bytes : 32 ,
reply : {
source : '152.195.76.133' ,
type : 11 ,
code : 0 ,
typestr : 'TIME_EXCEEDED' ,
codestr : 'NO_CODE' ,
body : ']8X"bx00CQx00x00x00x00'
}
}
// Traceroute to example.com
new pingus . PingICMP ( { host : 'example.com' , timeout : 500 } )
. on ( 'result' , ( result ) => {
console . log ( result . toPrimitiveJSON ( ) ) ;
} )
. on ( 'error' , ( err , result ) => {
throw err ;
} )
. traceroute ( ) ;
{
type : 'ping/icmp/traceroute' ,
status : 'finish' ,
host : 'example.com' ,
ip : '93.184.215.14' ,
ips : [ '93.184.215.14' , '2606:2800:021f:cb07:6820:80da:af6b:8b2c' ] ,
time : 7614 ,
ttl : 128 ,
bytes : 32 ,
hops : [
{
status : 'time_exceeded' ,
ip : '172.19.80.1' ,
ttl : 1 ,
rtt : { min : 0 , max : 1 , avg : 1 }
} ,
{
status : 'time_exceeded' ,
ip : '172.30.1.254' ,
ttl : 2 ,
rtt : { min : 0 , max : 1 , avg : 1 }
} ,
{
status : 'timeout' ,
ip : null ,
ttl : 3 ,
rtt : { min : 2001 , max : 2002 , avg : 2002 }
} ,
{
status : 'time_exceeded' ,
ip : '112.188.59.77' ,
ttl : 4 ,
rtt : { min : 2 , max : 3 , avg : 3 }
} ,
{
status : 'time_exceeded' ,
ip : '112.188.53.13' ,
ttl : 5 ,
rtt : { min : 1 , max : 2 , avg : 2 }
} ,
{
status : 'time_exceeded' ,
ip : '112.174.47.177' ,
ttl : 6 ,
rtt : { min : 7 , max : 8 , avg : 8 }
} ,
{
status : 'time_exceeded' ,
ip : '112.174.91.130' ,
ttl : 7 ,
rtt : { min : 7 , max : 8 , avg : 8 }
} ,
{
status : 'time_exceeded' ,
ip : '112.174.87.102' ,
ttl : 8 ,
rtt : { min : 129 , max : 130 , avg : 130 }
} ,
{
status : 'time_exceeded' ,
ip : '206.72.210.112' ,
ttl : 9 ,
rtt : { min : 127 , max : 128 , avg : 128 }
} ,
{
status : 'time_exceeded' ,
ip : '152.195.76.151' ,
ttl : 10 ,
rtt : { min : 132 , max : 134 , avg : 133 }
} ,
{
status : 'reply' ,
ip : '93.184.215.14' ,
ttl : 11 ,
rtt : { min : 126 , max : 126 , avg : 126 }
}
]
}