SnmpCollectorRequest

SnmpCollectorRequest
SnmpCollectorRequest

The Snmp Collector configuration object. It contains the entire structure of an SNMP collector including the agents, masks, mibs, translations and polling groups.

JSON Example
{
    "distributionFactor": 20,
    "loadFactor": 5000,
    "dcName": "_core",
    "collectorConfiguration": {
        "name": "collectora"
    }
}
string
dcName
Required

The name of the data-center where this collector runs

collectorConfiguration
Required

All collector configurations are listed here

snmpAgents
Optional

All the configured agents for this collector can be listed here, alongside with their respective properties and polling settings

snmpMasks
Optional

The snmpMask configurations are listed here

translations
Optional

The Snmp Translations are listed here.

pollingGroups
Optional

All Polling group configurations associated with the particular collector are listed here.

integer
loadFactor
Optional

This number indicates the maximum load which should be applied to the linked SNMP Collector. This load may be exceeded depending upon the Device distribution weight assigned to this collector.

integer
distributionFactor
Optional

This is the proportional weight of the Collector when Device distribution and configuration generation takes place. This Collector will poll its share of the Device set, proportional to the sum of all applicable Collector distribution weights.

integer
pollingPeriod
Optional

The default polling period with which polling groups will be generated for this particular collector after discovery. Note: There is an order of precedence followed when assigning polling periods to generated polling groups - 1] Polling period of the Capability 2] Polling Period of Agent 3] Polling Period of the Collector