Get a Polling Policy
get
/api/metric/PollingPolicies/{id}
Gets the polling policy that matches the specified ID. The polling policy can be used by the Metric Poller Discovery scheduled job.
Request
Path Parameters
-
id(required): integer(int32)
The ID of the polling policy to get.Example:
1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The polling policy that matches the specified ID.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : metricPollingPoliciesRead
Type:
Show Source
object
-
Category: string
CategoryExample:
Any
-
CIDR: integer
CIDR |Allowed Values: |0 => Disabled |1 => EnabledExample:
1
-
CIDRDisplayName: string
A descriptive label for the CIDR flag. Allowed Values are "Disabled" and "Enabled"Example:
Disabled
-
DeviceDisplayName: string
Device Display NameExample:
Any
-
DeviceMetaTypeID: integer
Device MetaType IDExample:
0
-
DeviceMetaTypeName: string
Device MetaType NameExample:
ADBaseDN
-
DeviceName: string
Device NameExample:
router.example.com
-
DeviceNameMatchTypeID: integer
The operator to match device names. Allowed Values: - 0 => LIKE - 1 => NOT LIKE - 2 => REGEXP - 3 => NOT REGEXPExample:
0
-
DeviceType: string
Device TypeExample:
Any
-
DeviceTypeCategoryID: integer
Device Type Category IDExample:
0
-
DeviceTypeMatchTypeID: integer
Device Type Match Type Allowed Values: - 0 => LIKE - 1 => NOT LIKE - 2 => REGEXP - 3 => NOT REGEXPExample:
0
-
InstanceDisplayName: string
Instance Display NameExample:
LIKE/ens3/
-
InstanceName: string
Instance NameExample:
ens3
-
InstanceNameMatchTypeID: integer
The operator to match instance names. Allowed Values: - 0 => LIKE - 1 => NOT LIKE - 2 => REGEXP - 3 => NOT REGEXPExample:
0
-
InstanceTypeID: integer
Instance Type IDExample:
1
-
InstanceTypeName: string
Instance Type NameExample:
SNMP Interface
-
IPRange: string
IP Range (e.g. 10.*.0-9.1,2,3,4 or 172.16.10.0/24 for CIDR Scan)Example:
-
IPRangeDisplayName: string
IP Range Display Name. It will be the same as IP Range unless IP Range is blank. Then the display name will be "Any".Example:
Any
-
MetaData: string
MetaDataExample:
-
MetaDataDisplay: string
The meta data operator and value unless the value is blank. then the display will be "Any".Example:
Any
-
MetaDataMatchTypeID: integer
Meta Data Match Type Allowed Values: - 0 => LIKE - 1 => NOT LIKE - 2 => REGEXP - 3 => NOT REGEXPExample:
0
-
MethodID: integer
MethodID |Allowed Values: |0 => NA |1 => SNMP |2 => WMI |3 => Other |5 => TransactionExample:
1
-
MethodName: string
Method NameExample:
SNMP
-
PolicyDescription: string
Policy DescriptionExample:
-
PolicyID: integer
Policy IDExample:
5
-
PolicyName: string
Policy NameExample:
Configure Network Interface Polling - ens3
-
PollerTemplateID: integer
Poller Template IDExample:
3
-
PollTime: integer
PollTime in secondsExample:
300
-
StatusIcon: string
Status IconExample:
OrbGreen.png
-
StatusID: boolean
Status IDExample:
1
-
StatusName: string
Status NameExample:
Enabled
-
SysObjectID: integer
The device type ID to matchExample:
NONE
-
TemplateName: string
Template NameExample:
Default Network Interface
-
ThresholdGroupID: integer
Threshold Group IDExample:
3
-
ThresholdGroupName: string
Threshold Group NameExample:
Default Network Interface
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object