Plugin Configuration Template

Overview

SWISnap works with tasks that allow us to fully define and configure plugins to perform jobs. Additionally, SWISnap allows defining configuration templates for plugins. Those configurations will be later used when starting plugins as base settings and merged with configuration specified in each task file. It is important to note, that task configuration has a higher priority during the merge. This functionality is very useful when there is a need to define the same setting for a plugin in multiple task files. For example, we use publisher-appoptics.yaml configuration template, to only once set token and other settings common for all tasks that use this publisher. Plugin configuration templates can be written using yaml (default) or json syntax and should be stored in plugins.d folder.

Plugin Configuration Structure

The structure allows defining a single yaml or json configuration for plugins that support both V1 and V2 plugin framework. For V1, only simple key:value settings are allowed. For V2, full yaml or json syntax is supported for configuring the plugin:

## Type of plugin framework. v1 for plugins supporting V1 plugin framework. If not specified, v1 is used as default.
v1:
  ## Type of plugin. Can be collector or publisher.
  publisher:
    ## Name of plugin.
    publisher-appoptics:
      ## Version of plugin for which configuration should be applied. all means that for every version.  
      all:
        ## Plugin configuration template. For v1, only key:value pairs.  
        token: SOLARWINDS_TOKEN
        hostname_alias: myhostname
        
## Type of plugin framework. v2 for plugins supporting V2 plugin framework.
v2:
  ## Type of plugin. Can be collector or publisher.
  publisher:
    ## Name of plugin.
    publisher-appoptics:
      ## Version of plugin for which configuration should be applied. all means that for every version.
      all:
        ## Plugin configuration template. For v2 full yaml syntax is supported.
        endpoint:
          token: SOLARWINDS_TOKEN
        options:
          hostname_alias: myhostname

The scripts are not supported under any SolarWinds support program or service. The scripts are provided AS IS without warranty of any kind. SolarWinds further disclaims all warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The risk arising out of the use or performance of the scripts and documentation stays with you. In no event shall SolarWinds or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the scripts or documentation.