add deviceport_vlan_membership_threshold documentation

This commit is contained in:
Oliver Gorwits
2015-02-15 15:45:25 +00:00
parent 6335a49a99
commit a5c7d8ed3a

View File

@@ -346,6 +346,81 @@ format is two lists: one of the values and one of the labels in the web
interface. You can see in the default that a value of "C<-1>" means Show All
Records.
=head3 C<vlanctl>
Value: Boolean. Default: C<true>.
Set to false to prevent users from changing the default VLAN on an interface.
This setting has no effect when C<portctl_nameonly> below is set to true.
=head3 C<portctl_nameonly>
Value: Boolean. Default: C<false>.
Set to true to limit port control action to only changing the interface name
(description).
=head3 C<portctl_nophones>
Value: Boolean. Default: C<false>.
Set to true to make sure an IP Phone port never can be turned off/on.
=head3 C<portctl_vlans>
Value: Boolean. Default: C<false>.
Set to true to allow Netdisco to be able to disable VLAN trunk interfaces.
B<EXTREMELY VERY DANGEROUS>: Turning off a VLAN trunk link could take out most
of your network.
=head3 C<portctl_uplinks>
Value: Boolean. Default: C<false>.
Set to true to allow Netdisco to be able to disable Uplinks. (Router
Interfaces too)
B<EXTREMELY VERY DANGEROUS>: Turning off uplinks will take out chunks of your
network.
=head3 C<port_control_reasons>
Value: Hash of Strings. Default:
port_control_reasons:
address: 'Address Allocation Abuse'
copyright: 'Copyright Violation'
dos: 'Denial of Service'
bandwidth: 'Excessive Bandwidth'
polling: 'Excessive Polling of DNS/DHCP/SNMP'
noserv: 'Not In Service'
exploit: 'Remote Exploit Possible'
compromised: 'System Compromised'
other: 'Other'
resolved: 'Issue Resolved'
When a user has Port Control rights and shuts down a port, they are asked for
a reason. This configuration lists those reasons, and can be overridden to add
or remove any entries.
=head3 C<check_userlog>
Value: Boolean. Default: C<true>.
Set to false to disable the periodic AJAX check for completed entries in the
job queue for this user. Mainly useful for development to suppress noisy web
frontend activity.
=head3 C<deviceport_vlan_membership_threshold>
Value: Number. Default: C<150>.
When showing Device Ports, Netdisco calculates first an average number of
VLANs across all device ports. If this is above this configurable threshold,
the VLAN Membership is I<not> shown (regardless of Display Columns setting.
=head2 Netdisco Core
=head3 C<mibhome>
@@ -865,73 +940,6 @@ Value: Boolean. Default: C<false>.
Turn this on to have Netdisco do a reverse lookup of the device C<sysName.0>
field to use as the management IP address for a device.
=head3 C<vlanctl>
Value: Boolean. Default: C<true>.
Set to false to prevent users from changing the default VLAN on an interface.
This setting has no effect when C<portctl_nameonly> below is set to true.
=head3 C<portctl_nameonly>
Value: Boolean. Default: C<false>.
Set to true to limit port control action to only changing the interface name
(description).
=head3 C<portctl_nophones>
Value: Boolean. Default: C<false>.
Set to true to make sure an IP Phone port never can be turned off/on.
=head3 C<portctl_vlans>
Value: Boolean. Default: C<false>.
Set to true to allow Netdisco to be able to disable VLAN trunk interfaces.
B<EXTREMELY VERY DANGEROUS>: Turning off a VLAN trunk link could take out most
of your network.
=head3 C<portctl_uplinks>
Value: Boolean. Default: C<false>.
Set to true to allow Netdisco to be able to disable Uplinks. (Router
Interfaces too)
B<EXTREMELY VERY DANGEROUS>: Turning off uplinks will take out chunks of your
network.
=head3 C<check_userlog>
Value: Boolean. Default: C<true>.
Set to false to disable the periodic AJAX check for completed entries in the
job queue for this user. Mainly useful for development to suppress noisy web
frontend activity.
=head3 C<port_control_reasons>
Value: Hash of Strings. Default:
port_control_reasons:
address: 'Address Allocation Abuse'
copyright: 'Copyright Violation'
dos: 'Denial of Service'
bandwidth: 'Excessive Bandwidth'
polling: 'Excessive Polling of DNS/DHCP/SNMP'
noserv: 'Not In Service'
exploit: 'Remote Exploit Possible'
compromised: 'System Compromised'
other: 'Other'
resolved: 'Issue Resolved'
When a user has Port Control rights and shuts down a port, they are asked for
a reason. This configuration lists those reasons, and can be overridden to add
or remove any entries.
=head2 Backend Daemon
=head3 C<workers>