RouterOS API console.
GIT: $Id$
Hostname of the RouterOS to connect to.
Username to log in with. If left empty, no login will be performed.
true
Password to log in with.
true
-p
--port
Port to connect to. Default is either 8728 or 8729, depending on whether an encryption is specified.
StoreInt
--cTimeout
Time in seconds to wait for the connection to be established. If "--timeout" is specified, its value will be used when this option is not specified.
Defaults to PHP's default_socket_timeout ini option.
StoreInt
--enc
Encryption to use, if at all. Currently, RouterOS supports only "TLS".
(Default: "")
StoreString
--ca
Path to a file or folder to use for certification authority, when using encryption. Ignored when not using encryption. This option should not be set when not using a certificate. It can be set to an empty string to enable certificate checking with the default certification authority.
StoreString
--ciphers
Cipher string to use when using encrypted connections. Ignored otherwise. If neither the "--ca" or "--fingerprint" option is specified, "ADH" is used.
StoreString
--fingerprint
SHA256 fingerprint of the "api-ssl" certificate (as shown in RouterOS). Connection will fail on mismatch, thus fully protecting you from impersonators that might otherwise use a recognized certification authority. If not specified, the given fingerprint will be displayed. This option requires the openssl_x509_fingerprint() function (available in the OpenSSL extension for PHP 5.6 and later), and will silently be ignored if that function is not available.
StoreString
-t
--timeout
Time in seconds to wait when receiving. If this time passes without data awaiting, control is passed back for further input.
(Default: 3)
StoreInt
-v
--verbose
Turn on verbose output.
StoreTrue
--colors
Choose whether to color output (requires PEAR2_Console_Color). Possible values:
"auto" - color is always enabled, except on Windows, where ANSICON must be installed (detected via the ANSICON_VER environment variable).
"yes" - force colored output.
"no" - force no coloring of output.
(Default: "auto")
StoreString
auto
yes
no
auto
-w
--width
Width of console screen. Used in verbose mode to wrap output in this length.
(Default: 80)
StoreInt
80
--command-mode
Mode to send commands in. Can be one of:
"w" - send every word as soon as it is entered
"s" - wait for a sentence to be formed, and send all its words then
"e" - wait for an empty sentence, and send all previous sentences then. You can send an empty sentence by sending two consecutive empty words.
(Default: "s")
StoreString
w
s
e
s
--reply-mode
Mode to get replies in. Can be one of:
"w" - after every send, try to get a word
"s" - after every send, try to get a sentence
"e" - after every send, try to get all sentences until a timeout.
(Default: "s")
StoreString
w
s
e
s
-m
--multiline
Turn on multiline mode. Without this mode, every line of input is considered a word. With it, every line is a line within the word, and the end of the word is marked instead by an "end of text" character as the only character on a line. To write out such a character, you can use ALT+Numpad3. If you want to write this character as part of the word, you can write two such characters on a line.
StoreTrue