diff options
Diffstat (limited to 'config.php.example')
| -rw-r--r-- | config.php.example | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/config.php.example b/config.php.example index d5ac948..fc093c1 100644 --- a/config.php.example +++ b/config.php.example @@ -30,6 +30,24 @@ $config['misc']['allow_private_asn'] = false; $config['filters'][] = '/(client1|client2)/'; $config['filters'][] = '/^NotToShow/'; +// Documentation for commands (must be HTML) + +// Documentation for the 'show route' query +$config['doc']['bgp']['query'] = 'Show the best routes to a given destination.'; +$config['doc']['bgp']['parameter'] = 'The parameter must be a valid destination. Destination means an IPv4/IPv6 address or a subnet. Masks are also accepted as part of a valid IPv4/IPv6 address.<br />Please note that some routers always need a mask to be given when looking for an IPv6 address.<br /><br />Example of valid arguments:<br /><ul><li>10.1.1.1</li><li>172.16.0.0/12</li><li>2001:db8:1337::42</li><li>2001:db8::/32</li>'; +// 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.<br />Please note that these expression can change depending on the router and its software.<br /><br />Here are some examples:<ul><li><strong>Juniper</strong> - ^AS1 AS2 .*$</li><li><strong>Cisco</strong> - ^AS1_</li><li><strong>BIRD</strong> - AS1 AS2 AS3 … ASZ</li></ul><br />You may find some help with the following link:<br /><ul><li><a href="http://www.juniper.net/techpubs/en_US/junos13.3/topics/reference/command-summary/show-route-aspath-regex.html" title="Juniper Documentation">Juniper Documentation</a></li><li><a href="http://www.cisco.com/c/en/us/support/docs/ip/border-gateway-protocol-bgp/26634-bgp-toc.html#asregexp" title="Cisco Documentation">Cisco Documentation</a></li><li><a href="http://bird.network.cz/?get_doc&f=bird-5.html" title="BIRD Documentation">BIRD Documentation</a> (search for bgpmask)</li></ul>'; +// 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.<br />Be careful, 32-bit ASN are not handled by old routers or old router softwares.<br />Unless specified, private ASN will be considered as invalid.<br /><br />Example of valid argument:<br /><ul><li>15169</li><li>29467</li></ul>'; +// 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.<br /><br />Example of valid arguments:<br /><ul><li>10.1.1.1</li><li>2001:db8:1337::42</li><li>example.com</li></ul>'; +// 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.<br /><br />Example of valid arguments:<br /><ul><li>10.1.1.1</li><li>2001:db8:1337::42</li><li>example.com</li></ul>'; + // Routers definitions // Authentication based on SSH or Telnet with password |