CollectorConfigurationRequest

CollectorConfigurationRequest
CollectorConfigurationRequest

All collector configurations are listed here

JSON Example
{
    "name": "collector-a",
    "pollerPrefix": "string",
    "groupName": "string",
    "oidsThreads": 0,
    "tableThreads": 0,
    "alwaysPushProperties": false,
    "handleCounterWrapAround": false,
    "oidAsPropertyInRawValues": false,
    "usePollerPrefixInVariable": false,
    "pollingGroupsWereSplit": false,
    "localCommunicationSettings": {
        "hostIpAddress": "localhost",
        "communicationPort": 2008,
        "communicationInterfaceIpAddress": "string",
        "outInterfaceIPAddresses": [
            "string"
        ],
        "maxConcurrentSessions": 0,
        "acceptCommandsFromIPAddresses": [
            "string"
        ]
    }
}
string
name
Required

This attribute identifies the Collector in a distributed environment and is also used to identify the list of SNMP agents to use in the Polling Distribution file.This name must be unique among all used Collectors.

string
pollerPrefix
Optional
Constraints: default: SNMP Poller

This attribute contains the value for source property in Watch4net. All raw values generated by this collector will have their source property set to this value.

string
groupName
Optional
Constraints: default: group

This attribute contains the retention group name (this notion is Backend-related only). Valid group names are defined in the config.xml file.All raw values generated by this collector will have their group property set to this value, unless it is overridden in the polling group where the raw value comes from.

integer
oidsThreads
Optional
Constraints: default: 100

The maximum number of threads that will be used for handling the polling of simple OIDs.Providing values that are too small will cause contention at the thread level, therefore dramatically slowing down the polling process, while providing an excessively large value may have adverse consequences on system performance due to memory consumption and thread scheduling.

integer
tableThreads
Optional
Constraints: default: 100

The maximum number of threads that will be used for handling the polling of Tables.Providing values that are too small will cause contention at the thread level, therefore dramatically slowing down the polling process, while providing an excessively large value may have adverse consequences on system performance due to memory consumption and thread scheduling.

boolean
alwaysPushProperties
Optional
Constraints: default: true

Always include properties with every generated raw value. This should be left on as most collecting filters depend upon properties to perform their duties correctly.

boolean
handleCounterWrapAround
Optional
Constraints: default: true

Counter overflow must be handled in a mathematically correct way when calculating Delta and Rate. Switching this off will result in using only the current value in the calculation.

boolean
oidAsPropertyInRawValues
Optional

Include the raw values source OID as a property with every polled value.

boolean
usePollerPrefixInVariable
Optional
Constraints: default: true

The variables will contain the collector prefix when enabled. They will not contain it if disabled. This is disabled by default and is also the default behavior on standard installation. Warning: changing this feature state WILL create new variables on the backend. This can only be modified using the API.

boolean
pollingGroupsWereSplit
Optional

When true: this indicates that the polling groups were split. It is no longer possible to add target devices directly in this case.

localCommunicationSettings
Optional

These properties will setup any communication with the collector, especially the interfaces for SNMP polling and the IPs allowed to send commands.