Page tree

/tool

Diagnostics tools

bandwidth-test

Run bandwidth test to remote router
ParameterTypeDescriptionAdditional Notes
address
Type: alt
ip: ip_arg
ipv6: super_arg
IP address of host
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file
as-value
Type: switch
value: True
Prints out output as value (used in scripting)
connection-countnum [1 .. 255]
direction
enum [both | receive | transmit]
Direction of data flow
Enum parameters:
  • both - Monitor both received and transmitted data
doarg_node
Execute given script after each time it prints stats on the screen
durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000000
Duration of the test
file
Type: string
interesting: False
File name where to print output
intervaltime [20000000 .. 5000000000] unit: 1000000
Delay between messages in seconds
local-tx-speednum [0 .. -1]
Transfer test maximum speed
local-udp-tx-size
Type: range_arg
~TODO: True
once
Type: switch
value: True
Execute and print commands output just once
password
Type: string
maxLen: 32
Password for remote user
protocol
enum [tcp | udp]
Protocol to use for test
Enum parameters:
  • tcp - transmission control protocol
random-databool
Whether to use random data sending method or not
If it's enabled the speeds will be lower)
remote-tx-speednum [0 .. -1]
Receive test maximum speed
remote-udp-tx-size
Type: range_arg
~TODO: True
user
Type: string
maxLen: 32
Remote user
without-paging
Type: switch
value: True
Prints out each update as new output instead of overwriting previous one on each update

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults
file
Type: string
File name
Name of the file that will be stored in FTP access area.
hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed
terse
Type: switch
value: True
Creates export with output without line wraps
verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

fetch

ParameterTypeDescriptionAdditional Notes
address
Type: alt
ip: ip_arg
ipv6: ip6_arg
as-value
Type: switch
value: True
Prints out output as value (used in scripting)
asciibool
ftp transfer type
check-certificate
enum [no | yes | yes-without-crl]
https certificate validation
dst-path
Type: string
durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000
host
Type: string
http-data
Type: string
POST or PUT request body data
http-header-field
Type: multi_arg
+arg: {'producer': 'string_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"s0"', 'sub': []}}]}
switchIds: {4294967295}
add http header fields
http-method
enum [delete | get | post | put]
keep-resultbool
depracated, use 'output' argument
mode
enum [ftp | http | https | tftp]
once
Type: switch
value: True
Execute and print commands output just once
output
enum [file | none | user]
where to output data, works for all protocols
Enum parameters:
  • file - store to file
password
Type: string
portnum [0 .. 65535]
src-address
Type: alt
ip: ip_arg
ip6: ip6_arg
source address for HTTP, HTTPS only
src-path
Type: string
uploadbool
ftp and tftp transfer direction
url
Type: string
user
Type: string
without-paging
Type: switch
value: True
Prints out each update as new output instead of overwriting previous one on each update

mac-telnet

MAC Telnet Client
ParameterTypeDescriptionAdditional Notes
host
Host MAC address

ping

profile

ParameterTypeDescriptionAdditional Notes
cpu
enum [all | total]
durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000
file-name
Type: string
sysc: 3
freeze-frame-intervaltime [20000000 .. 30000000000] unit: 1000000

snmp-get

ParameterTypeDescriptionAdditional Notes
address
Type: ipAddr
authentication-password
Type: string
authentication-protocol
enum [MD5 | SHA1]
community
Type: string
encryption-password
Type: string
encryption-protocol
enum [AES | DES]
nextbool
oid
Type: obj_arg
+arg: {'producer': 'string_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"s8"', 'sub': []}}]}
portnum [0 .. 65535]
security
enum [authorized | none | private]
triesnum [1 .. 4294967295]
try-timeouttime [-9223372036854775808 .. 9223372036854775807] unit: 1000000
version
enum [1 | 2c | 3]

snmp-walk

ParameterTypeDescriptionAdditional Notes
address
Type: ipAddr
authentication-password
Type: string
authentication-protocol
enum [MD5 | SHA1]
community
Type: string
encryption-password
Type: string
encryption-protocol
enum [AES | DES]
oid
Type: string
portnum [0 .. 65535]
security
enum [authorized | none | private]
triesnum [1 .. 4294967295]
try-timeouttime [-9223372036854775808 .. 9223372036854775807] unit: 1000000
version
enum [1 | 2c | 3]

speed-test

ParameterTypeDescriptionAdditional Notes
address
Type: alt
ip: ip_arg
ipv6: super_arg
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file
as-value
Type: switch
value: True
Prints out output as value (used in scripting)
connection-countnum [1 .. 255]
doarg_node
Execute given script after each time it prints stats on the screen
durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000
file
Type: string
interesting: False
File name where to print output
intervaltime [20000000 .. 5000000000] unit: 1000000
Delay between messages in seconds
once
Type: switch
value: True
Execute and print commands output just once
password
Type: string
maxLen: 32
test-durationtime [5000000000 .. 9223372036854775807] unit: 1000000000
user
Type: string
maxLen: 32
without-paging
Type: switch
value: True
Prints out each update as new output instead of overwriting previous one on each update

torch

Realtime traffic monitor
ParameterTypeDescriptionAdditional Notes
cpunum [0 .. 999]
dscpnum [0 .. 63]
dst-address
Type: super
Destination address and network mask
dst-address6
Type: super
durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000
freeze-frame-intervaltime [20000000 .. 30000000000] unit: 1000000
Time in seconds for which the screen output is paused
interface
The name of the interface to monitor
ip-protocol
enum [any | dccp | ddp | egp | encap | etherip | ggp | gre | hmp | icmp | icmpv6 | idpr-cmtp | igmp | ipencap | ipip | ipsec-ah | ipsec-esp | ipv6-encap | ipv6-frag | ipv6-nonxt | ipv6-opts | ipv6-route | iso-tp4 | l2tp | ospf | pim | pup | rdp | rspf | rsvp | sctp | st | tcp | udp | udp-lite | vmtp | vrrp | xns-idp | xtp]
mac-protocol
enum [any | 802.2 | arp | homeplug-av | ip | ipv6 | ipx | lldp | loop-protect | mpls-multicast | mpls-unicast | packing-compr | packing-simple | pppoe | pppoe-discovery | rarp | service-vlan | vlan]
port
enum [any | acap | activision | afpovertcp | agentx | aol | apple-licman | appleqtc | appleqtcsrvr | appleugcontrol | arcp | asia | asip-webadmin | asipregistry | aurp | auth | avt-profile-1 | avt-profile-2 | bdp | bftp | bgp | biff | bootpc | bootps | btserv | buddyphone | ccmail | cfdptkt | chargen | cops | cpq-wbem | csnet-ns | daytime | dict | discard | discovery | distributed-net | dixie | dlsrap | dlsrpn | dlswpn | dns | dns2go | doom | dsp | dtspcd | echo | epmap | eppc | esro-emsdp | esro-gen | etftp | fcp-addr-srvr1 | fcp-addr-srvr2 | fcp-cics-gw1 | fcp-srvr-inst1 | fcp-srvr-inst2 | finger | ftp | ftp-data | glimpse | gopher | h323gatestat | h323hostcall | half-life | hbci | hostname | hotsync-1 | hotsync-2 | hsrp | htcp | http | http-alt | https | ica | icabrowser | icpv2 | icq | imail-www | imap3 | imaps | ipp | irc | ircu | isakmp | iso-tsap | kerberos | klogin | l2tp | ldap | ldaps | link | linuxconf | liquidaudio | lotusnote | lpr | mac-srvr-admin | madcap | matip-type-a | matip-type-b | mc-ftp | mgcp-callagent | mgcp-gateway | microcom-sbp | mobileip | mountd | mpp | ms-rpc | ms-sql-m | ms-sql-s | ms-streaming | ms-wbt-server | msbd | msg-auth | msg-icp | msql | mtp | mysql | mzap | name | napster | napster-2 | napster-3 | net-assistant | netbios-dgm | netbios-ns | netbios-ssn | netrek | netstat | nextstep | nfile | nfs | nicname | nntp | nntps | ntp | odette-ftp | odmr | oracle-sql | pcanywheredata | pcanywherestat | pdap-np | pgp5-key | photuris | pop2 | pop3 | pop3s | poppassd | pptp | prospero-np | pwdgen | qotd | quake | quake-world | quake3 | radius | radius-acct | rap | re-mail-ck | realsecure | reftek | rip | ripng | rje | rlogin | rlp | rrp | rsvp-tunnel | rtp | rtsp | rwhois | rwp | secureid | sftp | sgmp | sift-uft | sip | slmail | smb | smtp | smux | snmp | snpp | socks | sql*net | sql-net | squid | ssh | statsrv | sunrpc | supdup | swat | syslog | systat | t.120 | tacacs | talk | tcp-id-port | tcpmux | telnet | tftp | tftp-mcast | timbuktu | timbuktu-srv1 | timbuktu-srv2 | timbuktu-srv3 | timbuktu-srv4 | time | tinc | tlisrv | uls | unreal | uucp-path | vemmi | veracity | virtualuser | vmnet | vnc-1 | vnc-2 | webobjects | whois++ | winbox | winbox-old | winbox-old-tls | wingate | wlbs | x11 | xdmcp | yahoo | z39.50]
The name of the port
src-address
Type: super
Source address and network mask
If source address will be 0.0.0.0/0 then automatically only IP protocols will be filtered
src-address6
Type: super
vlan-id
Type: alt
enum: enum_arg
number: num_arg

traceroute

Trace route to host
ParameterTypeDescriptionAdditional Notes
address
Type: alt
ip-address: ip_arg
ipv6: super_arg
IP address of host
countnum [1 .. 4294967295]
dscpnum [0 .. 63]
durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000
freeze-frame-intervaltime [20000000 .. 30000000000] unit: 1000000
interface
max-hopsnum [1 .. 4294967295]
Maximum hops
portnum [0 .. 65535]
UDP port number
Set the base UDP port number used in probes (default is 33434). Traceroute hopes that nothing is listening on UDP ports base to base+nhops*nqueries-1 at the destination host (so an ICMP PORT_UNREACHABLE message will be returned to terminate the route tracing). If something is listening on a port in the default range, this option can be used to pick an unused port range.
protocol
enum [icmp | udp]
Protocol of sent packets
Use either UDP or ICMP protocol. If one fails (for example, it is blocked by a firewall) try the other.
Enum parameters:
  • icmp - internet control message protocol
routing-table
sizenum [28 .. 1500]
Packet size in bytes
src-address
Type: alt
ip-address: ip_arg
ipv6-address: ip6_arg
Source IP address to make traceroute with
timeouttime [10000000 .. 3000000000] unit: 1000000
Response wait timeout
use-dnsbool
Specifies whether to use DNS server
  • No labels