Difference between revisions of "Gateways"

From RackTables Wiki
Jump to navigation Jump to search
m
(added section on breeds)
Line 1: Line 1:
 
==What are RackTables gateways==
 
==What are RackTables gateways==
 
RackTables is a PHP web application. Gateways are special executables residing on the same web-server, but not belonging to RackTables. The executables may be command-line scripts written in PHP, Perl, Python or any other language, or even binary files. Although PHP itself allows execution of arbitrary external commands, RackTables API provides helper functions to make such interaction ordered and convenient.
 
RackTables is a PHP web application. Gateways are special executables residing on the same web-server, but not belonging to RackTables. The executables may be command-line scripts written in PHP, Perl, Python or any other language, or even binary files. Although PHP itself allows execution of arbitrary external commands, RackTables API provides helper functions to make such interaction ordered and convenient.
 +
==What is device "breed"==
 +
In RackTables source code a '''breed''' stands for a distinguished type of a managed device. There are currently the following breeds implemented:
 +
* <tt>air12</tt> (Cisco Aironet IOS release 12.x)
 +
* <tt>eos4</tt> (Arista EOS release 4.x)
 +
* <tt>fdry5</tt> (Foundry Networks IronWare release 5.x)
 +
* <tt>ftos8</tt> (Force10 FTOS release 8.x)
 +
* <tt>ios12</tt> (Cisco Catalyst IOS release 12.x)
 +
* <tt>iosxr4</tt> (Cisco XR IOS release 4.2)
 +
* <tt>jun10</tt> (Juniper JunOS releases 10, 11 and 12)
 +
* <tt>nxos4</tt> (Cisco Nexus NX-OS releases 4.x, 5.x and 6.x)
 +
* <tt>ros11</tt> (Marvell ROS release 1.1)
 +
* <tt>vrp53</tt> (Huawei VRP release 5.3)
 +
* <tt>vrp55</tt> (Huawei VRP releases 5.5 and 5.7)
 
==Using gateways API==
 
==Using gateways API==
 
There are two core functions:
 
There are two core functions:

Revision as of 12:02, 10 September 2012

What are RackTables gateways

RackTables is a PHP web application. Gateways are special executables residing on the same web-server, but not belonging to RackTables. The executables may be command-line scripts written in PHP, Perl, Python or any other language, or even binary files. Although PHP itself allows execution of arbitrary external commands, RackTables API provides helper functions to make such interaction ordered and convenient.

What is device "breed"

In RackTables source code a breed stands for a distinguished type of a managed device. There are currently the following breeds implemented:

  • air12 (Cisco Aironet IOS release 12.x)
  • eos4 (Arista EOS release 4.x)
  • fdry5 (Foundry Networks IronWare release 5.x)
  • ftos8 (Force10 FTOS release 8.x)
  • ios12 (Cisco Catalyst IOS release 12.x)
  • iosxr4 (Cisco XR IOS release 4.2)
  • jun10 (Juniper JunOS releases 10, 11 and 12)
  • nxos4 (Cisco Nexus NX-OS releases 4.x, 5.x and 6.x)
  • ros11 (Marvell ROS release 1.1)
  • vrp53 (Huawei VRP release 5.3)
  • vrp55 (Huawei VRP releases 5.5 and 5.7)

Using gateways API

There are two core functions:

function queryTerminal ($object_id, $commands, $tolerate_remote_errors = TRUE)
function callScript ($gwname, $params, $in, &$out, &$errors)