doc/ros.pod

   1 =head1 NAME
   2
   3 ros - Command line utility to list information from RouterOS devices
   4
   5 =head1 SYNOPSIS
   6
   7   ros [options] <host> <command> [arguments]
   8
   9 =head1 DESCRIPTION
  10
  11 B<ros> is a command line utility which uses I<librouteros> to connect to a
  12 device running RouterOS and issue a command on the device. The result is
  13 received and displayed on standard output. The tool was initially written as a
  14 simple test application for librouteros but may evolve into something usable.
  15
  16 =head1 OPTIONS
  17
  18 The following options are understood:
  19
  20 =over 4
  21
  22 =item B<-u> I<username>
  23
  24 Use I<username> when authenticating rather than "admin", the default.
  25
  26 =item B<-h>
  27
  28 Display some usage information and exit.
  29
  30 =back
  31
  32 =head1 COMMANDS
  33
  34 You can use one of two possibilities to issue commands. I<Generic commands>
  35 start with a slash and follow the low-level syntax closely. For example:
  36
  37   ros router.example.com '/ip/address/print'
  38
  39 Besides this generic approach, I<ros> can also handle the high-level interfaces
  40 provided by librouteros. Currently the following special "built-in" commands
  41 are available:
  42
  43 =over 4
  44
  45 =item B<interface>
  46
  47 Display information about each interface, including byte counters.
  48
  49 =item B<registration-table>
  50
  51 Display information about current wireless connections.
  52
  53 =item B<system-resource>
  54
  55 Display generic system information, such as memory used and CPU load.
  56
  57 =back
  58
  59 =head1 LICENSE
  60
  61 I<ros> is licensed under the GPLv2. No other version of the license is applicable.
  62
  63 =head1 AUTHOR
  64
  65 I<ros> is written by Florian octo Forster E<lt>octo at verplant.orgE<gt>.
  66 Its homepage can be found at L<http://verplant.org/librouteros/>.
  67
  68 (c) 2009 by Florian octo Forster.