Overview
Universal Controller supports the following RESTful-based web services for SNMP Manager operations, which are listed alphabetically on this page.
Formatting specifications for each web service, including details about property requirements, are provided.
Create an SNMP Manager
Description | |
---|---|
URI | |
HTTP Method | POST |
Description | Creates an SNMP Manager. |
Example URI | http://localhost:8080/uc/resources/snmpmanager |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See 5445210, below. |
Example Response |
|
SNMP Manager Properties | See 5445210, below. |
Create an SNMP Manager: Example Request
XML Request | JSON Request |
---|---|
SNMP Manager Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Description | Description of this record. | N | |
| n/a | Universal Controller release that the record was exported from. | read only | N |
| n/a | Record table information. | read only | N |
| Manager Address | Name or IP address of the SNMP Manager. | Y | |
| Manager Port | Port used by the SNMP Manager. | Y | |
| Manager Name | Name used within the Controller to identify this SNMP Manager. | Y | |
| Member of Business Services | Business Services that this record belongs to. | N | |
| n/a | Specification for whether or not the Create an SNMP Manager web service will persist the Note In XML web services, | Valid values: true/false (default is true). | N |
| n/a | System ID field in the database for this SNMP Manager record. | Persisted only if retainSysIds is set to true. | N |
| Trap Community String | Used by the trap receiver to determine which traps to process. | Default is public. | N |
Delete an SNMP Manager
Description | |
---|---|
URI | http://host_name/uc/resources/snmpmanager |
HTTP Method | DELETE |
Description | Deletes an SNMP Manager. |
URI Parameters | See 5445210, below. |
Example URI | http://localhost:8080/uc/resources/snmpmanager?managername=Test4 |
Example Response |
|
Delete an SNMP Manager: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this SNMP Manager. | String; URI parameter. | Y |
|
| Name used within the Controller to identify this SNMP Manager. | String; URI parameter. | Y |
|
List SNMP Managers
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieves information on all SNMP Managers. |
Example URI | http://localhost:8080/uc/resources/snmpmanager/list |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See 5445210, below. |
SNMP Manager Properties | See 5445210. |
List SNMP Managers: Example Response
XML Response | JSON Response |
---|---|
Modify an SNMP Manager
Description | |
---|---|
URI | http://host_name/uc/resources/snmpmanager |
HTTP Method | PUT |
Description | Modifies the SNMP Manager specified by the |
Example URI | |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See 5445210, below. |
SNMP Manager Properties | See 5445210. |
Example Response |
|
Modify an SNMP Manager: Example Request
XML Request | JSON Request |
---|---|
Read an SNMP Manager
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieves information on a specific SNMP Manager. |
URI Parameters | See 5445210, below. |
Example URI | http://localhost:8080/uc/resources/snmpmanager?managername=Test4 |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See 5445210, below. |
SNMP Manager Properties | See 5445210. |
Read an SNMP Manager: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this SNMP Manager. | String; URI parameter. | Y |
|
| Name used within the Controller to identify this SNMP Manager. | String; URI parameter. | Y |
|
Read an SNMP Manager: Example Response
XML Response | JSON Response |
---|---|