Retrieve Snmp Action

Retrieve Snmp Action

API to get a particular action given the name.

Request
URI
GET
https://{api_host}/tcsa.host.com/tcsa/api/v1/snmp/actions/{actionName}
COPY
Path Parameters
string
actionName
Required

The name of the action being requested

Query Parameters
string
snmpIntegration
Optional

The name of the current snmp integration


Authentication
This operation uses the following authentication methods.
Responses
200

OK Returned configuration of snmp action requested

Returns SnmpAction of type(s) application/json
{
    "loadFactor": 5,
    "capabilityName": "CISCO-IPSLA-STATSTABLE",
    "defaultPollingPeriod": 0,
    "discoveryPasses": [
        {
            "capabilityConditionGroup": [
                {
                    "invertResult": false,
                    "name": "SingleOidContainsSnmpCondition",
                    "matchValue": "\\\\.1\\\\.3\\\\.6\\\\.1\\\\.4\\\\.1\\\\.9\\\\..*",
                    "oid": ".1.3.6.1.2.1.1.2.0"
                }
            ]
        },
        {
            "capabilityConditionGroup": [
                {
                    "invertResult": false,
                    "name": "TableColumnExistsSnmpCondition",
                    "matchValue": "",
                    "oid": ".1.3.6.1.4.1.9.9.42.1.3.1.1.5"
                },
                {
                    "invertResult": false,
                    "name": "TableColumnExistsSnmpCondition",
                    "matchValue": "",
                    "oid": ".1.3.6.1.4.1.9.9.42.1.3.2.1.1"
                }
            ]
        }
    ]
}
string
capabilityName
Required

The name of the action/capability

integer
loadFactor
Optional

The load this capability will have on a collector

integer
defaultPollingPeriod
Optional

The polling period for all polling groups which use this capability

discoveryPasses
Required

The list of rules for this action


400

BAD REQUEST Error in 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


404

NOT FOUND Requested object not found

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