SnmpAgentRequest

SnmpAgentRequest
SnmpAgentRequest

The Snmp Agent object. When creating an agent only the required parameters need to be entered, others can be skipped. When creating a v1/v2c agent, the v3 credential attributes need not be passed.

JSON Example 
{
    "name": "V2Agent",
    "ipAddress": "10.106.126.64",
    "snmpPort": 161,
    "transportProtocol": "udp",
    "snmpTimeout": 1000,
    "snmpNumberOfRetries": 5,
    "snmpVersion": "v2c",
    "snmpCommunityOrUserV3Name": "public",
    "maxBulkSize": 50,
    "devType": "Switch",
    "onFailTryWith": "v1",
    "doNotUseGetBulkRequests": false,
    "doNotUseCapabilityList": [],
    "collectorNameList": [
        "check-1"
    ],
    "pollingPeriod": 200
}
string
name
Required

This required attribute will set the device property to this value for all polled RawValues on this agent.

string
agentId
Optional

The id of the agent. The ID is a combination of 4 attributes "ipAddress" , "port", "v3ContextName" and "v3ContextEnginedId". The id is not required while adding/uploading an agent. This is only filled in the response of an API call

string
ipAddress
Required
Constraints: default: 0.0.0.0

This contains the IP address of the polled agent which will be used to contact the device.The pair IP address and port must be unique among all defined agents for this collector.

integer
snmpPort
Required
Constraints: default: 161

This port will be used in order to contact the SNMP agent on the polled device. Default one is 161.Please note that the pair IP address and port must be unique among all defined agents for this collector.

string
transportProtocol
Required
Constraints: default: udp

The protocol to use for data transportation. Default is UDP.

Possible values are : tcp, udp,
integer
snmpTimeout
Required
Constraints: default: 1000

The timeout, in milliseconds, before giving up while waiting for the agent response. 1000 is a good value that will fit most of the cases.

integer
snmpNumberOfRetries
Required
Constraints: default: 2

The number of retries before giving up while contacting the agent. 2 retries, which mean 3 attempts will be made, should be enough.

string
snmpVersion
Required
Constraints: default: v2c

The SNMP version to use when polling the agent. Most SNMP agents support v2c, which offers better efficiency than v1. Please note that SNMP v2c (or v3) must be used when polling 64 bits counters.

Possible values are : v1, v2c, v3,
string
snmpCommunityOrUserV3Name
Required
Constraints: default: public

The community string or SNMP v3 username, depending on the selected SNMP version. Filling this attribute is mandatory.

string
snmpV3AuthenticationProtocol
Optional
Constraints: default: noAuth

Only used with SNMP v3. It defines the protocol to use for authentication process.

Possible values are : md5, sha, noAuth,
string
snmpV3AuthenticationPassword
Optional

Only used with SNMP v3. It defines the authentication password. Leave blank if not using authentication.

string
snmpV3PrivacyProtocol
Optional

Only used with SNMP v3. It defines the protocol to use for privacy.

Possible values are : aes, des, aes192, aes256, noPriv,
string
snmpV3PrivacyPassword
Optional

Only used with SNMP v3. It defines the privacy password. SNMP v3 Authentication only is used when this password is not provided.

integer
maxBulkSize
Required
Constraints: default: 50

The maximum number of varbind in a snmpGetBulk request issued to this device. This applies only to SNMP v2c and v3 column-based polling. The default value is 50, which covers most cases. However, it may be required to lower this value if the devices SNMP agent times out when receiving oversized request instead of replying with the largest number of varbinds that may fit in the pdu.

string
v3ContextName
Optional

Only used with SNMP v3. It specifies the context name. Leave it empty for default context.

string
v3ContextEngineId
Optional

Only used with SNMP v3. It specifies the engine ID, as a hexadecimal format character string (i.e. : 0102AAAF ). Leave it empty for default engine ID.

boolean
useV3ContextName
Optional

Only used with SNMP v3 Include the context name as part of the raw values variable for this agent.

boolean
useV3ContextEnginedId
Optional

Only used with SNMP v3 Include the context engined ID as part of the raw values variable for this agent.

string
devType
Required
Constraints: default: Node

This attribute is required and describes the type of device this agent represents. All polled values from this agent will be tagged with this property.

boolean
v1TableRowPolling
Optional

This attribute affects the way SNMP v1 agents are polled. false is the standard failsafe mode: table polling will be column-based, while true enables a more efficient row-based polling model. However, this feature is not correctly supported by all SNMP v1 agents.

string
onFailTryWith
Required
Constraints: default: v1

This options give the opportunity to issue another call when all retries have failed, using either snmpGet (v1) or snmpGetBulk (v2c) requests.

Possible values are : v1, v2c, disabled,
boolean
doNotUseGetBulkRequests
Optional

Use only get and getNext requests on agent.

array of string
doNotUseCapabilityList
Optional

The names of the capabilities not to be used on this agent

array of string
collectorNameList
Optional

The names of the collectors to which this agent can be distributed

integer
pollingPeriod
Optional
Constraints: default: 0

The polling period of the polling group that contains this agent

array of CapabilityModel
capabilitiesWithPollingPeriod
Optional

The capabilities assigned to the agent along with their polling periods. By default the polling period assigned to each capability is 0

string
discoveryStatus
Optional

The status of the discovery that was performed on the agent

Possible values are : SUCCESS, FAILED,
array of string
discoveryMessage
Optional

A list of error messages in case of failure of discovery.

Property Of
Parameter To