Discover Capabilities

Discover Capabilities

This API performs two functions:

  • Discovers capabilities on all agents.
  • Distributes agents to collectors and generates polling groups based on the capabilities discovered. Note: A call to this API might re-distribute an agent to another collector. In order to avoid this, a specific collector can be provided while adding the agent in the "collectorName" field. In doing so the agent will always be assigned to the same collector.
Request
URI
POST
https://{api_host}/tcsa.host.com/tcsa/api/v1/snmp/agents/discover
COPY
Query Parameters
string
snmpIntegration
Optional

The name of the current snmp integration

snmpIntegration example 
snmp-integration
Authentication
This operation uses the following authentication methods.
Responses
200

OK Retruned list of all the generated polling groups

Returns Array of SnmpAgentResponse of type(s) application/json 
[
    {
        "devType": "Router",
        "collectorNameList": [
            "checking-Direct.Creation"
        ],
        "agentId": "10.106.232.55:161",
        "doNotUseGetBulkRequests": false,
        "snmpVersion": "v2c",
        "ipAddress": "10.106.232.55",
        "v1TableRowPolling": false,
        "pollingPeriod": 0,
        "capabilitiesWithPollingPeriod": [
            {
                "capabilityName": "CISCO-MEMORY-OLD",
                "pollingPeriod": 0
            },
            {
                "capabilityName": "GENERIC-SYSUPTIME",
                "pollingPeriod": 0
            },
            {
                "capabilityName": "GENERIC-INTERFACES",
                "pollingPeriod": 0
            }
        ],
        "useV3ContextEnginedId": false,
        "discoveryStarted": false,
        "doNotUseCapabilityList": [],
        "maxBulkSize": 50,
        "snmpCommunityOrUserV3Name": "{FB4571C1E38F7FEE40E3768BE0277A7365563DD06438D934B63FEF7865490E8EA3E6E47C0FC874926F8DC4D15FA98696}",
        "transportProtocol": "udp",
        "name": "Agent45",
        "snmpPort": 161,
        "snmpTimeout": 3000,
        "onFailTryWith": "v1",
        "snmpNumberOfRetries": 2,
        "snmpV3Constraint": true,
        "useV3ContextName": false
    }
]

400

BAD REQUEST Error in the request sent

Returns SnmpError of type(s) application/json 
{
    "code": "SNMP_COLLECTOR_API_006",
    "reason": "No Snmp collector running, discovery cannot be performed",
    "status": "404 Not Found"
}
string
code
Optional

This code refers to the internal error codes used in the code base.

string
reason
Optional

This specifies the reason for failure.

string
status
Optional

This specifies the HTTP status code error


500

INTERNAL SERVER ERROR Error on the server

Returns SnmpError of type(s) application/json 
{
    "code": "SNMP_COLLECTOR_API_006",
    "reason": "No Snmp collector running, discovery cannot be performed",
    "status": "404 Not Found"
}
string
code
Optional

This code refers to the internal error codes used in the code base.

string
reason
Optional

This specifies the reason for failure.

string
status
Optional

This specifies the HTTP status code error


On This Page
Snmp Operations
POST
Add Polling Group
POST
Add Snmp Agent
POST
Add Snmp Mask
POST
Cancel Discovery
DELETE
Delete Polling Groups
DELETE
Delete Snmp Agent
DELETE
Delete Snmp Collector
DELETE
Delete Snmp Mask
POST
Discover Capabilities
GET
Download Snmp Agents
GET
Get All Mib Files
GET
Get All Snmp Agents
GET
Get All Snmp Collectors
GET
Get Entire Snmp Integration
GET
Get Polling Groups
GET
Get Snmp Actions
GET
Get Snmp Masks
GET
Get Snmp Translations
POST
Initialize Snmp Collector
POST
Poll Agents For Affected Polling Groups
POST
Poll Collectors For Affected Polling Groups
POST
Poll Masks For Affected Polling Groups
GET
Retrieve Polling Group
GET
Retrieve Snmp Action
GET
Retrieve Snmp Agent
GET
Retrieve Snmp Collectors
GET
Retrieve Snmp Mask
POST
Send Collector Configurations
PUT
Update Polling Group
PUT
Update Snmp Agent
PUT
Update Snmp Collector
POST
Update Snmp Integration
PUT
Update Snmp Mask
POST
Upload Mib
POST
Upload Snmp Actions
POST
Upload Snmp Agents
POST
Upload Snmp Mask
POST
Upload Snmp Translations