Snmp APIs
- An SNMP (Simple Network Management Protocol) collector is designed to gather and process information from devices that support SNMP. SNMP is a protocol widely used for network management and monitoring.
- Telco Cloud Service Assurance offers a list of APIs to manage the entire lifecycle of SNMP collectors.
- Users can provide configurations for agents, masks, actions, polling groups and translations. MIB files can aso be uploaded.
- All SNMP collectors and their related elements are created under a single default integration - "snmp-integration". As a result the query parameter "snmpIntegration" can be skipped for all APIs.
- Capability discovery can be performed to automaticaly assign Masks to agents.
- After discovery agents are alloted to collectors and polling groups are generated.
Operations
POST
Initialize Snmp Collector
Initializes an snmp collector. This is the First step in creating an SNMP collector.
PUT
Update Snmp Collector
Updates the snmp collector configuration with the configuration provided
GET
Get All Snmp Collectors
Gets all the snmp collectors created
DELETE
Delete Snmp Collector
Deletes a list of the given snmp collectors
POST
Send Collector Configurations
API to send the configuration of the snmp Collectors to the collector manager
GET
Retrieve Snmp Collectors
Gets a single snmpCollector based on the id provided
POST
Poll Collectors For Affected Polling Groups
API to check the polling groups associated with the collectors selected.
POST
Update Snmp Integration
Creates an entire snmp integration.
GET
Get Entire Snmp Integration
To get the entire configuration of a single snmp integration
POST
Add Snmp Agent
API to add a single agent
PUT
Update Snmp Agent
API to update a single agent
GET
Get All Snmp Agents
API to get a list of agents.
DELETE
Delete Snmp Agent
Deletes a list of the given snmp Agents
GET
Retrieve Snmp Agent
API to get a particular agent given an agent ID.
POST
Poll Agents For Affected Polling Groups
API to check the polling groups associated with the agents selected.
POST
Discover Capabilities
API to discover capabilities on an agent
GET
Download Snmp Agents
API to download the all the agents.
POST
Cancel Discovery
API to cancel discovery of capabilities on agents
POST
Upload Snmp Agents
API to upload a seed file containing agents
POST
Upload Snmp Mask
API to upload a seed file containing masks and agents
POST
Add Snmp Mask
API to add a single mask
PUT
Update Snmp Mask
API to update a single mask
GET
Get Snmp Masks
API to get a list of masks.
DELETE
Delete Snmp Mask
Deletes a list of the given snmp masks.
GET
Retrieve Snmp Mask
API to get a particular mask given the mask name.
POST
Poll Masks For Affected Polling Groups
API to check the polling groups associated with the masks selected.
POST
Upload Snmp Translations
API to upload a seed file containing translations
GET
Get Snmp Translations
API to get a list of translations.
POST
Upload Mib
API to upload a mib file
GET
Get All Mib Files
API to get all the mib files uploaded
POST
Upload Snmp Actions
API to upload a seed file containing a single action
GET
Get Snmp Actions
API to get a list of actions.
GET
Retrieve Snmp Action
API to get a particular action given the name.
POST
Add Polling Group
API to add a single polling group
PUT
Update Polling Group
API to update a single polling group
GET
Get Polling Groups
API to get a list of polling groups.
DELETE
Delete Polling Groups
Deletes a list of the given polling groups
GET
Retrieve Polling Group
API to get a particular pollingGroup given the pollingGroup name.