Please note that some routers always need a mask to be given when looking for an IPv6 address.

Example of valid arguments:

• 10.1.1.1
• 172.16.0.0/12
• 2001:db8:1337::42
• 2001:db8::/32
'; // Documentation for the 'as-path-regex' query $config['doc']['as-path-regex']['query'] = 'Show the routes matching the given AS path regular expression.'; $config['doc']['as-path-regex']['parameter'] = 'The parameter must be a valid AS path regular expression.
Please note that these expression can change depending on the router and its software.

Here are some examples:
• Juniper - ^AS1 AS2 .*$
• Cisco - ^AS1_
• BIRD - AS1 AS2 AS3 … ASZ

You may find some help with the following link:

• Juniper Documentation
• Cisco Documentation
• BIRD Documentation (search for bgpmask)
'; // Documentation for the 'as' query $config['doc']['as']['query'] = 'Show the routes received from a given AS number.'; $config['doc']['as']['parameter'] = 'The parameter must be a valid 16-bit or 32-bit autonomous system number.
Be careful, 32-bit ASN are not handled by old routers or old router softwares.
Unless specified, private ASN will be considered as invalid.

Example of valid argument:

• 15169
• 29467
'; // Documentation for the 'ping' query $config['doc']['ping']['query'] = 'Send 10 pings to the given destination.'; $config['doc']['ping']['parameter'] = 'The parameter must be an IPv4/IPv6 address (without mask) or a fully qualified domain name.

Example of valid arguments:

• 10.1.1.1
• 2001:db8:1337::42
• example.com
'; // Documentation for the 'traceroute' query $config['doc']['traceroute']['query'] = 'Display the path to a given destination.'; $config['doc']['traceroute']['parameter'] = 'The parameter must be an IPv4/IPv6 address (without mask) or a fully qualified domain name.

Example of valid arguments:

• 10.1.1.1
• 2001:db8:1337::42
• example.com
'; // Routers definitions // Authentication based on SSH or Telnet with password // The hostname or the IP address $config['routers']['router1']['host'] = 'r1.example.net'; // The user to use to connect to the router $config['routers']['router1']['user'] = 'readonlyuser'; // The password of the given user $config['routers']['router1']['pass'] = 'readonlypassword'; // The authentication mecanism to use (can be ssh-password or telnet) $config['routers']['router1']['auth'] = 'ssh-password'; // The router type (can be cisco, ios, juniper or junos) $config['routers']['router1']['type'] = 'juniper'; // The router description to be displayed in the router list $config['routers']['router1']['desc'] = 'Example\'s Router 1'; // Authentication based on SSH with key // The hostname or the IP address $config['routers']['router2']['host'] = 'r2.example.net'; // The user to use to connect to the router $config['routers']['router2']['user'] = 'readonlyuser'; // The public key of the given user $config['routers']['router2']['private_key'] = '/home/user/.ssh/key'; // The passphrase of the key (optional if the key has no passphrase) $config['routers']['router2']['pass'] = 'mypassphrase'; // The authentication mecanism to use (ssh-key for SSH based on keys) $config['routers']['router2']['auth'] = 'ssh-key'; // The router type (can be cisco, ios, juniper or junos) $config['routers']['router2']['type'] = 'juniper'; // The router description to be displayed in the router list $config['routers']['router2']['desc'] = 'Example\'s Router 2'; // Router based on BIRD // The hostname or the IP address $config['routers']['router3']['host'] = 'r3.example.net'; // The user to use to connect to the router $config['routers']['router3']['user'] = 'birduser'; // The password of the given user $config['routers']['router3']['pass'] = 'birduserpassword'; // The authentication mecanism to use (can be ssh-password or ssh-key) $config['routers']['router3']['auth'] = 'ssh-password'; // The router type (can only be bird) $config['routers']['router3']['type'] = 'bird'; // The router description to be displayed in the router list $config['routers']['router3']['desc'] = 'Example\'s Router 3'; // End of config.php