lots of docs

This commit is contained in:
Oliver Gorwits
2013-06-08 19:24:47 +01:00
parent 4a1ccba71a
commit eda73c7dac
9 changed files with 132 additions and 20 deletions

View File

@@ -183,9 +183,27 @@ or MAC addreses, VLAN numbers, and so on.
When user authentication is disabled (C<no_auth>) the default username is
"guest", which has no special privilege. To grant port and device control
rights to this user, create a row in the C<users> table of the Netdisco
database with a username of C<guest> and the C<port_control> flag set to true:
database with a username of C<guest> and appropriate flags set to true:
netdisco=> insert into users (username, port_control) values ('guest', true);
netdisco=> insert into users (username) values ('guest');
netdisco=> update users set port_control = true where username = 'guest';
netdisco=> update users set admin = true where username = 'guest';
=head2 Command-Line Device and Port Actions
To run a device (discover, etc) or port control job from the command-line, use
the bundled L<netdisco-do> program. For example:
~/bin/netdisco-do -D discover -d 192.0.2.1
=head2 Import Topology
Netdisco 1.x had support for a topology information file to fill in device
port relations which could not be discovered. This is now stored in the
database (and edited in the web interface). To import a legacy topology file,
run:
~/bin/localenv nd-import-topology /path/to/netdisco-topology.txt
=head2 Deployment Scenarios
@@ -202,10 +220,8 @@ documentation for further information.
=head2 Plugins
App::Netdisco includes a Plugin subsystem for building the web user interface.
Items in the navigation bar and the tabs on pages are loaded as Plugins, and
you have control over their appearance and ordering. See
L<App::Netdisco::Web::Plugin> for further information.
App::Netdisco includes a Plugin subsystem for customizing the web user
interface. See L<App::Netdisco::Web::Plugin> for further information.
=head2 Developing

View File

@@ -273,10 +273,23 @@ Value: List of Strings. Default:
- Control Plane Interface
- SPAN (S|R)P Interface
- StackSub
- netflow
- Vlan\d+-mpls layer
- BRI\S+-Bearer Channel
- BRI\S+-Physical
- BRI\S+-Signalling
- Embedded-Service-Engine\d+\/\d+
- Virtual-Template\d+
- Virtual-Access\d+
- (E|T)\d \d\/\d\/\d
- Vlan1
If present, device ports matching any of the items in this list will be
ignored by the discovery process. Note this may have side effects - connected
devices and nodes on those ports will in turn also not be discovered.
If present, device ports whose names match fully any of the items in this list
will be ignored by the discovery process.
Note this may have side effects - connected devices and nodes on those ports
will in turn also not be discovered. Also note that backslashes must be
doubled in the YAML format.
=head3 C<ignore_private_nets>