Skip to content

tikomatic Man Page

Jump to bottom Edit New page
JC edited this page Oct 3, 2015 · 9 revisions

Tikomatic

###Available Commands

export                  Export configuration of remote device
help                    Displays help for a command
license                 Display Software License
list                    Lists commands
update                  Updates tikomatic to the latest version
user                    Create/Read/Update/Delete users on remote device
ip:address              Work with /ip address(es)
ip:fw:address-list      Work with /ip firewall address-list lists
sys:cpuload             Get CPU load of remote device
sys:reboot              Reboot Remote Device
sys:res                 Get System/Resource info from remote device
sys:res:uptime          Get uptime of remote device
sys:version             Get ROS version of remote device
user:active             Get list of active users on remote device
user:group              Create/Read/Update/Delete user groups on remote device
user:ssh-keys           Get list of user ssh keys on remote device
user:ssh-keys:private   Get list of user private ssh keys on remote device

export

  • Description: Export configuration of remote device

  • Usage:

    • export [-c|--conf CONF] [--host HOST] [-u|--username [USERNAME]] [-p|--password [PASSWORD]] [-P|--port [PORT]] [-s|--ssl] [-ff|--fformat]

Export configuration of remote device

Options:

conf:

  • Name: --conf
  • Shortcut: -c
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Path to ini file containing host,username,password
  • Default: NULL

host:

  • Name: --host
  • Shortcut:
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Hostname or IP Address
  • Default: NULL

username:

  • Name: --username
  • Shortcut: -u
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login username
  • Default: NULL

password:

  • Name: --password
  • Shortcut: -p
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login password
  • Default: NULL

port:

  • Name: --port
  • Shortcut: -P
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Port providing RouterOS API
  • Default: 8728

ssl:

  • Name: --ssl
  • Shortcut: -s
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Try to use SSL/TLS for the connection
  • Default: false

fformat:

  • Name: --fformat
  • Shortcut: -ff
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Output Format (xml,json,tab,csv
  • Default: false

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false

help

  • Description: Displays help for a command

  • Usage:

    • help [--format FORMAT] [--raw] [--] [<command_name>]

The help command displays help for a given command:

php C:\dev\projects\tikomatic\build\tikomatic.phar help list

You can also output the help in other formats by using the --format option:

php C:\dev\projects\tikomatic\build\tikomatic.phar help --format=xml list

To display the list of available commands, please use the list command.

Arguments:

command_name:

  • Name: command_name
  • Is required: no
  • Is array: no
  • Description: The command name
  • Default: 'help'

Options:

format:

  • Name: --format
  • Shortcut:
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: The output format (txt, xml, json, or md)
  • Default: 'txt'

raw:

  • Name: --raw
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: To output raw command help
  • Default: false

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false

license

  • Description: Display Software License

  • Usage:

    • license

Display Software License

Options:

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false

list

  • Description: Lists commands

  • Usage:

    • list [--raw] [--format FORMAT] [--] [<namespace>]

The list command lists all commands:

php C:\dev\projects\tikomatic\build\tikomatic.phar list

You can also display the commands for a specific namespace:

php C:\dev\projects\tikomatic\build\tikomatic.phar list test

You can also output the information in other formats by using the --format option:

php C:\dev\projects\tikomatic\build\tikomatic.phar list --format=xml

It's also possible to get raw list of commands (useful for embedding command runner):

php C:\dev\projects\tikomatic\build\tikomatic.phar list --raw

Arguments:

namespace:

  • Name: namespace
  • Is required: no
  • Is array: no
  • Description: The namespace name
  • Default: NULL

Options:

raw:

  • Name: --raw
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: To output raw command list
  • Default: false

format:

  • Name: --format
  • Shortcut:
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: The output format (txt, xml, json, or md)
  • Default: 'txt'

update

  • Description: Updates tikomatic to the latest version

  • Usage:

    • update

Updates tikomatic to the latest version

Options:

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false

user

  • Description: Create/Read/Update/Delete users on remote device

  • Usage:

    • user [-c|--conf CONF] [--host HOST] [-u|--username [USERNAME]] [-p|--password [PASSWORD]] [-P|--port [PORT]] [-s|--ssl] [-ff|--fformat]

Create/Read/Update/Delete users on remote device

Options:

conf:

  • Name: --conf
  • Shortcut: -c
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Path to ini file containing host,username,password
  • Default: NULL

host:

  • Name: --host
  • Shortcut:
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Hostname or IP Address
  • Default: NULL

username:

  • Name: --username
  • Shortcut: -u
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login username
  • Default: NULL

password:

  • Name: --password
  • Shortcut: -p
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login password
  • Default: NULL

port:

  • Name: --port
  • Shortcut: -P
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Port providing RouterOS API
  • Default: 8728

ssl:

  • Name: --ssl
  • Shortcut: -s
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Try to use SSL/TLS for the connection
  • Default: false

fformat:

  • Name: --fformat
  • Shortcut: -ff
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Output Format (xml,json,tab,csv
  • Default: false

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false

ip:address

  • Description: Work with /ip address(es)

  • Usage:

    • ip:address [-c|--conf CONF] [--host HOST] [-u|--username [USERNAME]] [-p|--password [PASSWORD]] [-P|--port [PORT]] [-s|--ssl] [-ff|--fformat] [-f|--format FORMAT]

Work with /ip address(es)

Options:

conf:

  • Name: --conf
  • Shortcut: -c
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Path to ini file containing host,username,password
  • Default: NULL

host:

  • Name: --host
  • Shortcut:
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Hostname or IP Address
  • Default: NULL

username:

  • Name: --username
  • Shortcut: -u
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login username
  • Default: NULL

password:

  • Name: --password
  • Shortcut: -p
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login password
  • Default: NULL

port:

  • Name: --port
  • Shortcut: -P
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Port providing RouterOS API
  • Default: 8728

ssl:

  • Name: --ssl
  • Shortcut: -s
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Try to use SSL/TLS for the connection
  • Default: false

fformat:

  • Name: --fformat
  • Shortcut: -ff
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Output Format (xml,json,tab,csv
  • Default: false

format:

  • Name: --format
  • Shortcut: -f
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Output Format
  • Default: NULL

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false

ip:fw:address-list

  • Description: Work with /ip firewall address-list lists

  • Usage:

    • ip:fw:address-list [-c|--conf CONF] [--host HOST] [-u|--username [USERNAME]] [-p|--password [PASSWORD]] [-P|--port [PORT]] [-s|--ssl] [-ff|--fformat]

Work with /ip firewall address-list lists

Options:

conf:

  • Name: --conf
  • Shortcut: -c
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Path to ini file containing host,username,password
  • Default: NULL

host:

  • Name: --host
  • Shortcut:
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Hostname or IP Address
  • Default: NULL

username:

  • Name: --username
  • Shortcut: -u
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login username
  • Default: NULL

password:

  • Name: --password
  • Shortcut: -p
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login password
  • Default: NULL

port:

  • Name: --port
  • Shortcut: -P
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Port providing RouterOS API
  • Default: 8728

ssl:

  • Name: --ssl
  • Shortcut: -s
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Try to use SSL/TLS for the connection
  • Default: false

fformat:

  • Name: --fformat
  • Shortcut: -ff
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Output Format (xml,json,tab,csv
  • Default: false

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false

sys:cpuload

  • Description: Get CPU load of remote device

  • Usage:

    • sys:cpuload [-c|--conf CONF] [--host HOST] [-u|--username [USERNAME]] [-p|--password [PASSWORD]] [-P|--port [PORT]] [-s|--ssl] [-ff|--fformat]

Get CPU load of remote device

Options:

conf:

  • Name: --conf
  • Shortcut: -c
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Path to ini file containing host,username,password
  • Default: NULL

host:

  • Name: --host
  • Shortcut:
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Hostname or IP Address
  • Default: NULL

username:

  • Name: --username
  • Shortcut: -u
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login username
  • Default: NULL

password:

  • Name: --password
  • Shortcut: -p
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login password
  • Default: NULL

port:

  • Name: --port
  • Shortcut: -P
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Port providing RouterOS API
  • Default: 8728

ssl:

  • Name: --ssl
  • Shortcut: -s
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Try to use SSL/TLS for the connection
  • Default: false

fformat:

  • Name: --fformat
  • Shortcut: -ff
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Output Format (xml,json,tab,csv
  • Default: false

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false

sys:reboot

  • Description: Reboot Remote Device

  • Usage:

    • sys:reboot [-c|--conf CONF] [--host HOST] [-u|--username [USERNAME]] [-p|--password [PASSWORD]] [-P|--port [PORT]] [-s|--ssl] [-ff|--fformat] [--] [<action>]...

Reboot Remote Device

Arguments:

action:

  • Name: action
  • Is required: no
  • Is array: yes
  • Description: now | in | status | cancel
  • Default: array ()

Options:

conf:

  • Name: --conf
  • Shortcut: -c
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Path to ini file containing host,username,password
  • Default: NULL

host:

  • Name: --host
  • Shortcut:
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Hostname or IP Address
  • Default: NULL

username:

  • Name: --username
  • Shortcut: -u
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login username
  • Default: NULL

password:

  • Name: --password
  • Shortcut: -p
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login password
  • Default: NULL

port:

  • Name: --port
  • Shortcut: -P
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Port providing RouterOS API
  • Default: 8728

ssl:

  • Name: --ssl
  • Shortcut: -s
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Try to use SSL/TLS for the connection
  • Default: false

fformat:

  • Name: --fformat
  • Shortcut: -ff
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Output Format (xml,json,tab,csv
  • Default: false

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false

sys:res

  • Description: Get System/Resource info from remote device

  • Usage:

    • sys:res [-c|--conf CONF] [--host HOST] [-u|--username [USERNAME]] [-p|--password [PASSWORD]] [-P|--port [PORT]] [-s|--ssl] [-ff|--fformat]

Get System/Resource info from remote device

Options:

conf:

  • Name: --conf
  • Shortcut: -c
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Path to ini file containing host,username,password
  • Default: NULL

host:

  • Name: --host
  • Shortcut:
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Hostname or IP Address
  • Default: NULL

username:

  • Name: --username
  • Shortcut: -u
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login username
  • Default: NULL

password:

  • Name: --password
  • Shortcut: -p
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login password
  • Default: NULL

port:

  • Name: --port
  • Shortcut: -P
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Port providing RouterOS API
  • Default: 8728

ssl:

  • Name: --ssl
  • Shortcut: -s
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Try to use SSL/TLS for the connection
  • Default: false

fformat:

  • Name: --fformat
  • Shortcut: -ff
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Output Format (xml,json,tab,csv
  • Default: false

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false

sys:res:uptime

  • Description: Get uptime of remote device

  • Usage:

    • sys:res:uptime [-c|--conf CONF] [--host HOST] [-u|--username [USERNAME]] [-p|--password [PASSWORD]] [-P|--port [PORT]] [-s|--ssl] [-ff|--fformat]

Get uptime of remote device

Options:

conf:

  • Name: --conf
  • Shortcut: -c
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Path to ini file containing host,username,password
  • Default: NULL

host:

  • Name: --host
  • Shortcut:
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Hostname or IP Address
  • Default: NULL

username:

  • Name: --username
  • Shortcut: -u
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login username
  • Default: NULL

password:

  • Name: --password
  • Shortcut: -p
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login password
  • Default: NULL

port:

  • Name: --port
  • Shortcut: -P
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Port providing RouterOS API
  • Default: 8728

ssl:

  • Name: --ssl
  • Shortcut: -s
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Try to use SSL/TLS for the connection
  • Default: false

fformat:

  • Name: --fformat
  • Shortcut: -ff
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Output Format (xml,json,tab,csv
  • Default: false

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false

sys:version

  • Description: Get ROS version of remote device

  • Usage:

    • sys:version [-c|--conf CONF] [--host HOST] [-u|--username [USERNAME]] [-p|--password [PASSWORD]] [-P|--port [PORT]] [-s|--ssl] [-ff|--fformat]

Get ROS version of remote device

Options:

conf:

  • Name: --conf
  • Shortcut: -c
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Path to ini file containing host,username,password
  • Default: NULL

host:

  • Name: --host
  • Shortcut:
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Hostname or IP Address
  • Default: NULL

username:

  • Name: --username
  • Shortcut: -u
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login username
  • Default: NULL

password:

  • Name: --password
  • Shortcut: -p
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login password
  • Default: NULL

port:

  • Name: --port
  • Shortcut: -P
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Port providing RouterOS API
  • Default: 8728

ssl:

  • Name: --ssl
  • Shortcut: -s
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Try to use SSL/TLS for the connection
  • Default: false

fformat:

  • Name: --fformat
  • Shortcut: -ff
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Output Format (xml,json,tab,csv
  • Default: false

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false

user:active

  • Description: Get list of active users on remote device

  • Usage:

    • user:active [-c|--conf CONF] [--host HOST] [-u|--username [USERNAME]] [-p|--password [PASSWORD]] [-P|--port [PORT]] [-s|--ssl] [-ff|--fformat]

Get list of active users on remote device

Options:

conf:

  • Name: --conf
  • Shortcut: -c
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Path to ini file containing host,username,password
  • Default: NULL

host:

  • Name: --host
  • Shortcut:
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Hostname or IP Address
  • Default: NULL

username:

  • Name: --username
  • Shortcut: -u
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login username
  • Default: NULL

password:

  • Name: --password
  • Shortcut: -p
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login password
  • Default: NULL

port:

  • Name: --port
  • Shortcut: -P
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Port providing RouterOS API
  • Default: 8728

ssl:

  • Name: --ssl
  • Shortcut: -s
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Try to use SSL/TLS for the connection
  • Default: false

fformat:

  • Name: --fformat
  • Shortcut: -ff
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Output Format (xml,json,tab,csv
  • Default: false

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false

user:group

  • Description: Create/Read/Update/Delete user groups on remote device

  • Usage:

    • user:group [-c|--conf CONF] [--host HOST] [-u|--username [USERNAME]] [-p|--password [PASSWORD]] [-P|--port [PORT]] [-s|--ssl] [-ff|--fformat]

Create/Read/Update/Delete user groups on remote device

Options:

conf:

  • Name: --conf
  • Shortcut: -c
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Path to ini file containing host,username,password
  • Default: NULL

host:

  • Name: --host
  • Shortcut:
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Hostname or IP Address
  • Default: NULL

username:

  • Name: --username
  • Shortcut: -u
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login username
  • Default: NULL

password:

  • Name: --password
  • Shortcut: -p
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login password
  • Default: NULL

port:

  • Name: --port
  • Shortcut: -P
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Port providing RouterOS API
  • Default: 8728

ssl:

  • Name: --ssl
  • Shortcut: -s
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Try to use SSL/TLS for the connection
  • Default: false

fformat:

  • Name: --fformat
  • Shortcut: -ff
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Output Format (xml,json,tab,csv
  • Default: false

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false

user:ssh-keys

  • Description: Get list of user ssh keys on remote device

  • Usage:

    • user:ssh-keys [-c|--conf CONF] [--host HOST] [-u|--username [USERNAME]] [-p|--password [PASSWORD]] [-P|--port [PORT]] [-s|--ssl] [-ff|--fformat]

Get list of user ssh keys on remote device

Options:

conf:

  • Name: --conf
  • Shortcut: -c
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Path to ini file containing host,username,password
  • Default: NULL

host:

  • Name: --host
  • Shortcut:
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Hostname or IP Address
  • Default: NULL

username:

  • Name: --username
  • Shortcut: -u
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login username
  • Default: NULL

password:

  • Name: --password
  • Shortcut: -p
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login password
  • Default: NULL

port:

  • Name: --port
  • Shortcut: -P
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Port providing RouterOS API
  • Default: 8728

ssl:

  • Name: --ssl
  • Shortcut: -s
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Try to use SSL/TLS for the connection
  • Default: false

fformat:

  • Name: --fformat
  • Shortcut: -ff
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Output Format (xml,json,tab,csv
  • Default: false

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false

user:ssh-keys:private

  • Description: Get list of user private ssh keys on remote device

  • Usage:

    • user:ssh-keys:private [-c|--conf CONF] [--host HOST] [-u|--username [USERNAME]] [-p|--password [PASSWORD]] [-P|--port [PORT]] [-s|--ssl] [-ff|--fformat]

Get list of user private ssh keys on remote device

Options:

conf:

  • Name: --conf
  • Shortcut: -c
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Path to ini file containing host,username,password
  • Default: NULL

host:

  • Name: --host
  • Shortcut:
  • Accept value: yes
  • Is value required: yes
  • Is multiple: no
  • Description: Hostname or IP Address
  • Default: NULL

username:

  • Name: --username
  • Shortcut: -u
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login username
  • Default: NULL

password:

  • Name: --password
  • Shortcut: -p
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Login password
  • Default: NULL

port:

  • Name: --port
  • Shortcut: -P
  • Accept value: yes
  • Is value required: no
  • Is multiple: no
  • Description: Port providing RouterOS API
  • Default: 8728

ssl:

  • Name: --ssl
  • Shortcut: -s
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Try to use SSL/TLS for the connection
  • Default: false

fformat:

  • Name: --fformat
  • Shortcut: -ff
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Output Format (xml,json,tab,csv
  • Default: false

help:

  • Name: --help
  • Shortcut: -h
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this help message
  • Default: false

quiet:

  • Name: --quiet
  • Shortcut: -q
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not output any message
  • Default: false

verbose:

  • Name: --verbose
  • Shortcut: -v|-vv|-vvv
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • Default: false

version:

  • Name: --version
  • Shortcut: -V
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Display this application version
  • Default: false

ansi:

  • Name: --ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Force ANSI output
  • Default: false

no-ansi:

  • Name: --no-ansi
  • Shortcut:
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Disable ANSI output
  • Default: false

no-interaction:

  • Name: --no-interaction
  • Shortcut: -n
  • Accept value: no
  • Is value required: no
  • Is multiple: no
  • Description: Do not ask any interactive question
  • Default: false
Add a custom footer
Add a custom sidebar
Clone this wiki locally