Update Snmp Agent
API to update a single agent
The name of the current snmp integration
snmp-integrationThe snmpAgentRequest object containing the details of the agent to be updated
Show optional properties
{
"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"
}{
"name": "Agent1",
"agentId": "0.0.0.0:161",
"ipAddress": "0.0.0.0",
"snmpPort": 161,
"transportProtocol": "udp",
"snmpTimeout": 1000,
"snmpNumberOfRetries": 2,
"snmpVersion": "v2c",
"snmpCommunityOrUserV3Name": "public",
"snmpV3AuthenticationProtocol": "sha",
"snmpV3AuthenticationPassword": "changeme",
"snmpV3PrivacyProtocol": "aes",
"snmpV3PrivacyPassword": "aespass",
"maxBulkSize": 50,
"v3ContextName": "string",
"v3ContextEngineId": "string",
"useV3ContextName": false,
"useV3ContextEnginedId": false,
"devType": "Node",
"v1TableRowPolling": false,
"onFailTryWith": "string",
"doNotUseGetBulkRequests": false,
"doNotUseCapabilityList": [
"CISCO-MEMORY-OLD"
],
"collectorNameList": [
"collector-a",
"collector-b"
],
"pollingPeriod": 300,
"capabilitiesWithPollingPeriod": [
{
"capabilityName": "CISCO-MEMORY-OLD",
"pollingPeriod": "number"
}
],
"discoveryStatus": "string",
"discoveryMessage": [
"string"
]
}This required attribute will set the device property to this value for all polled RawValues on this agent.
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
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.
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.
The protocol to use for data transportation. Default is UDP.
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.
The number of retries before giving up while contacting the agent. 2 retries, which mean 3 attempts will be made, should be enough.
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.
The community string or SNMP v3 username, depending on the selected SNMP version. Filling this attribute is mandatory.
Only used with SNMP v3. It defines the protocol to use for authentication process.
Only used with SNMP v3. It defines the authentication password. Leave blank if not using authentication.
Only used with SNMP v3. It defines the protocol to use for privacy.
Only used with SNMP v3. It defines the privacy password. SNMP v3 Authentication only is used when this password is not provided.
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.
Only used with SNMP v3. It specifies the context name. Leave it empty for default context.
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.
Only used with SNMP v3 Include the context name as part of the raw values variable for this agent.
Only used with SNMP v3 Include the context engined ID as part of the raw values variable for this agent.
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.
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.
This options give the opportunity to issue another call when all retries have failed, using either snmpGet (v1) or snmpGetBulk (v2c) requests.
Use only get and getNext requests on agent.
The names of the capabilities not to be used on this agent
The names of the collectors to which this agent can be distributed
The polling period of the polling group that contains this agent
The capabilities assigned to the agent along with their polling periods. By default the polling period assigned to each capability is 0
The status of the discovery that was performed on the agent
A list of error messages in case of failure of discovery.
OK Returned updated configuration of snmpAgent
{
"name": "10.107.119.4",
"agentId": "10.107.119.4:161",
"snmpV3Constraint": true,
"ipAddress": "10.107.119.4",
"snmpPort": 161,
"transportProtocol": "udp",
"snmpTimeout": 1000,
"snmpNumberOfRetries": 5,
"snmpVersion": "v3",
"snmpCommunityOrUserV3Name": "autoshaaes256user!@#$",
"snmpV3AuthenticationProtocol": "sha",
"snmpV3AuthenticationPassword": "{8D36C853D676D96BC7570135AA9099681325844251C17FB1318B98C62FFEED95027C5015FDB8C5C597D333B0DC4AFD5A}",
"snmpV3PrivacyProtocol": "aes256",
"snmpV3PrivacyPassword": "{EEB7ED4CA8459627329D28EBB548F1B570A4A15D2FF230FDC441B11830268548220834677189B98E95614D111227E32F}",
"maxBulkSize": 50,
"v3ContextName": null,
"v3ContextEngineId": null,
"useV3ContextName": false,
"useV3ContextEnginedId": false,
"devType": "Switch",
"contactPropertyValue": null,
"devdescPropertyValue": null,
"locationPropertyValue": null,
"modelPropertyValue": null,
"discoveryStarted": false,
"v1TableRowPolling": false,
"lastSysUpTimeValue": null,
"lastSysUpTimePollTimestamp": null,
"shortestPollingPeriod": null,
"port": null,
"onFailTryWith": "v1",
"doNotUseGetBulkRequests": false,
"refreshPropertiesLastRequestTime": null,
"capabilitiesWithPollingPeriod": [
{
"capabilityName": "GENERIC-INTERFACES",
"pollingPeriod": 10
},
{
"capabilityName": "CISCO-MEMORY-OLD",
"pollingPeriod": 0
},
{
"capabilityName": "CISCO-IPSLA-JITTER-STATSTABLE",
"pollingPeriod": 0
},
{
"capabilityName": "GENERIC-SYSUPTIME",
"pollingPeriod": 0
},
{
"capabilityName": "CISCO-IPSLA-HTTP-LATEST",
"pollingPeriod": 0
},
{
"capabilityName": "CISCO-IPSLA-INVENTORY",
"pollingPeriod": 0
},
{
"capabilityName": "CISCO-IPSLA-JITTER-LATEST",
"pollingPeriod": 0
},
{
"capabilityName": "CISCO-MEMORY",
"pollingPeriod": 0
},
{
"capabilityName": "CISCO-IPSLA-STATSTABLE",
"pollingPeriod": 0
},
{
"capabilityName": "CISCO-PROCESS-POST12.2(3.5)",
"pollingPeriod": 0
}
],
"doNotUseCapabilityList": [
"cap1",
"cap2"
],
"collectorNameList": [
"collector-a"
],
"pollingPeriod": 300,
"discoveryStatus": null,
"discoveryMessage": null
}This required attribute will set the device property to this value for all polled RawValues on this agent.
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
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.
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.
The protocol to use for data transportation. Default is UDP.
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.
The number of retries before giving up while contacting the agent. 2 retries, which mean 3 attempts will be made, should be enough.
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.
The community string or SNMP v3 username, depending on the selected SNMP version. Filling this attribute is mandatory.
Only used with SNMP v3. It defines the protocol to use for authentication process.
Only used with SNMP v3. It defines the authentication password. Leave blank if not using authentication.
Only used with SNMP v3. It defines the protocol to use for privacy.
Only used with SNMP v3. It defines the privacy password. SNMP v3 Authentication only is used when this password is not provided.
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.
Only used with SNMP v3. It specifies the context name. Leave it empty for default context.
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.
Only used with SNMP v3 Include the context name as part of the raw values variable for this agent.
Only used with SNMP v3 Include the context engined ID as part of the raw values variable for this agent.
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.
The SMARTS contact (sysContact) property for a specific snmpAgent. This is polled as soon as the polling group is created.
devdescPropertyValue
locationPropertyValue
modelPropertyValue
discoveryStarted
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.
lastSysUpTimeValue
lastSysUpTimePollTimestamp
shortestPollingPeriod
port
This options give the opportunity to issue another call when all retries have failed, using either snmpGet (v1) or snmpGetBulk (v2c) requests.
Use only get and getNext requests on agent.
refreshPropertiesLastRequestTime
The names of the capabilities not to be used on this agent
The names of the collectors to which this agent can be distributed
The polling period of the polling group that contains this agent
The capabilities assigned to the agent along with their polling periods. By default the polling period assigned to each capability is 0
The status of the discovery that was performed on the agent
A list of error messages in case of failure of discovery.
BAD REQUEST Error in the request sent
"SnmpError Object"This code refers to the internal error codes used in the code base.
This specifies the reason for failure.
This specifies the HTTP status code error
NOT FOUND Requested object not found
"SnmpError Object"This code refers to the internal error codes used in the code base.
This specifies the reason for failure.
This specifies the HTTP status code error
INTERNAL SERVER ERROR Error on the server
"SnmpError Object"This code refers to the internal error codes used in the code base.
This specifies the reason for failure.
This specifies the HTTP status code error
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","ipAddress:"string","snmpPort:"integer","snmpVersion:"string","snmpCommunityOrUserV3Name:"string","snmpTimeout:"integer","snmpNumberOfRetries:"integer","transportProtocol:"string","maxBulkSize:"integer","onFailTryWith:"string","devType:"string"}' https://{api_host}/tcsa/api/v1/snmp/agents