Merge remote-tracking branch 'github-tokkee/sh/netapp'
authorFlorian Forster <octo@collectd.org>
Tue, 29 Jan 2013 09:40:24 +0000 (10:40 +0100)
committerFlorian Forster <octo@collectd.org>
Tue, 29 Jan 2013 09:40:24 +0000 (10:40 +0100)
1  2 
src/collectd.conf.pod

diff --combined src/collectd.conf.pod
@@@ -2516,6 -2516,14 +2516,14 @@@ Required capabilities are documented be
        IgnoreSelectedSnapshot false
      </VolumeUsage>
      
+     <Quota>
+       Interval 60
+     </Quota>
+     
+     <Snapvault>
+       Interval 30
+     </Snapvault>
+     
      <System>
        Interval 30
        GetCPULoad     true
        GetDiskOps     true
        GetDiskIO      true
      </System>
+     <VFiler vfilerA>
+       Interval 60
+       SnapVault true
+       # ...
+     </VFiler>
     </Host>
   </Plugin>
  
@@@ -2533,7 -2548,27 +2548,27 @@@ The netapp plugin accepts the followin
  =item B<Host> I<Name>
  
  A host block defines one NetApp filer. It will appear in collectd with the name
- you specify here which does not have to be its real name nor its hostname.
+ you specify here which does not have to be its real name nor its hostname (see
+ the B<Address> option below).
+ =item B<VFiler> I<Name>
+ A B<VFiler> block may only be used inside a host block. It accepts all the
+ same options as the B<Host> block (except for cascaded B<VFiler> blocks) and
+ will execute all NetApp API commands in the context of the specified
+ VFiler(R). It will appear in collectd with the name you specify here which
+ does not have to be its real name. The VFiler name may be specified using the
+ B<VFilerName> option. If this is not specified, it will default to the name
+ you specify here.
+ The VFiler block inherits all connection related settings from the surrounding
+ B<Host> block (which appear before the B<VFiler> block) but they may be
+ overwritten inside the B<VFiler> block.
+ This feature is useful, for example, when using a VFiler as SnapVault target
+ (supported since OnTap 8.1). In that case, the SnapVault statistics are not
+ available in the host filer (vfiler0) but only in the respective VFiler
+ context.
  
  =item B<Protocol> B<httpd>|B<http>
  
@@@ -2577,6 -2612,19 +2612,19 @@@ Mandator
  
  Type: string
  
+ =item B<VFilerName> I<Name>
+ The name of the VFiler in which context to execute API commands. If not
+ specified, the name provided to the B<VFiler> block will be used instead.
+ Optional
+ Type: string
+ Default: name of the B<VFiler> block
+ B<Note:> This option may only be used inside B<VFiler> blocks.
  =item B<Interval> I<Interval>
  
  B<TODO>
@@@ -2907,6 -2955,38 +2955,38 @@@ capacities will be selected anyway
  
  =back
  
+ =head3 The Quota block
+ This will collect (tree) quota statistics (used disk space and number of used
+ files). This mechanism is useful to get usage information for single qtrees.
+ In case the quotas are not used for any other purpose, an entry similar to the
+ following in C</etc/quotas> would be sufficient:
+   /vol/volA/some_qtree tree - - - - -
+ After adding the entry, issue C<quota on -w volA> on the NetApp filer.
+ =over 4
+ =item B<Interval> I<Seconds>
+ Collect SnapVault(R) statistics every I<Seconds> seconds.
+ =back
+ =head3 The SnapVault block
+ This will collect statistics about the time and traffic of SnapVault(R)
+ transfers.
+ =over 4
+ =item B<Interval> I<Seconds>
+ Collect SnapVault(R) statistics every I<Seconds> seconds.
+ =back
  =head2 Plugin C<netlink>
  
  The C<netlink> plugin uses a netlink socket to query the Linux kernel about
@@@ -5372,16 -5452,13 +5452,16 @@@ minimize the number of network packets
  Synopsis:
  
   <Plugin write_graphite>
 -   <Carbon>
 +   <Node "example">
       Host "localhost"
       Port "2003"
       Prefix "collectd"
 -   </Carbon>
 +   </Node>
   </Plugin>
  
 +The configuration consists of one or more E<lt>B<Node>E<nbsp>I<Name>E<gt>
 +blocks. Inside the B<Node> blocks, the following options are recognized:
 +
  =over 4
  
  =item B<Host> I<Address>
@@@ -5549,9 -5626,7 +5629,9 @@@ Synopsis
     <Node "example">
       Host "localhost"
       Port "5555"
 -     StoreRates false
 +     Protocol UDP
 +     StoreRates true
 +     AlwaysAppendDS false
       Delay 10
     </Node>
     Tag "foobar"
@@@ -5578,12 -5653,7 +5658,12 @@@ Hostname or address to connect to. Defa
  
  Service name or port number to connect to. Defaults to C<5555>.
  
 -=item B<StoreRates> B<false>|B<true>
 +=item B<Protocol> B<UDP>|B<TCP>
 +
 +Specify the protocol to use when communicating with I<Riemann>. Defaults to
 +B<UDP>.
 +
 +=item B<StoreRates> B<true>|B<false>
  
  If set to B<true> (the default), convert counter values to rates. If set to
  B<false> counter values are stored as is, i.e. as an increasing integer number.