PollingGroupRequest

PollingGroupRequest
PollingGroupRequest

This is the polling group request object. It contains the exact attributes required to create the polling group object

JSON Example 
{
    "pollingMaskNames": [
        "GENERIC-SYSUPTIME",
        "GENERIC-INTERFACES"
    ],
    "pollingPeriod": 300,
    "startAtDefinedPeriod": false,
    "startTimeOffset": 0,
    "enabled": true,
    "assignedTo": "collector-a",
    "groupName": "group",
    "uniformTimestamps": false,
    "name": "GEN-VEIVN9SWIB-300-check",
    "snmpAgentNames": [
        "10.106.232.11:161"
    ],
    "tableDiscoveryTime": "00:00:00"
}
string
name
Required

he polling group's name. As stated before, this name must be unique as it is an identifier. The value of this attribute is used to set the pollgrp property of the raw values resulting from this polling group.

integer
pollingPeriod
Required

The polling group's polling period, specified in seconds. This value indicates the time interval between each polling.

string
tableDiscoveryTime
Required

This is the time at which, every day, the metric properties will be refreshed (as well as any reference table resident in the collector) and sent to the backend.Refreshing the raw value's properties may be slightly more demanding on the database side of the backend, therefore, it is recommended to set this value at some off-hour time.Please note that this value is formatted in 24h time, 00:00:00 being midnight, 08:00:00 being 8:00AM, 20:00:00 being 8:00PM and so on.

string
groupName
Optional

This is a notion specific to the backend. This is an optional parameter that will be taken from the collector if not filled here. Note: If the groupName is explicitly provided empty or null, polling will not take place. So if groupName is not being explicitly set to any value, ommit it from the request object.

boolean
uniformTimestamps
Optional

When set to true, the polling will start at the next "round" period (0:04, 0:08... if polling period is set to 4 minutes) and all timestamps for the generated raw values will be the rounded to the polling cycle start time (0:04, 0:08...).

boolean
startAtDefinedPeriod
Optional

When set to true, the polling will start at the next "round" period (0:04, 0:08... if polling period is set to 4 minutes). Raw value timestamps will be accurate.

integer
startTimeOffset
Optional

This defines a waiting period before the polling group starts collecting data. The polling load may be spread through time by assigning different values to polling groups.

array of string
pollingMaskNames
Required

This is the list of masks that will be used for this polling group. These masks contain both single OIDs and columns of tables.At least one mask must be provided for the polling group to be valid.

array of string
snmpAgentNames
Required

This is the list of IDs of the SNMP agents on which the polling will be done. Note: This is a list of the snpAgent ids and not their names. The ID is a combination of 4 attributes "ipAddress" , "port", "v3ContextName" and "v3ContextEnginedId"

boolean
enabled
Optional

When set to false, then this polling group will be ignored, and no polling will occur for it.

string
assignedTo
Required

The name of the collector this polling group is assigned to. Only one collector can be assigned.

Property Of
Parameter To