Page Comparison

...

Universal Controller supports the following RESTful-based web services for SNMP Manager operations, which are listed alphabetically on this page.

Create an SNMP Manager
Delete an SNMP Manager
List SNMP Managers
Modify an SNMP Manager
Read an SNMP Manager

Formatting specifications for each web service, including details about property requirements, are provided.

...

	Description
URI	http://host_name/uc/resources/snmpmanager
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 Create an SNMP Manager: Example Request, below.
Example Response	Status 200 /OK Successfully created the SNMP Manager with sysId {sysId}. Status 400 /Bad Request Create SNMP Manager failed. A duplicate value has been detected. Name must be unique.
SNMP Manager Properties	See SNMP Manager Properties, below below.

Anchor
Create an SNMP Manager Example Request
Create an SNMP Manager Example Request
Create an SNMP Manager: Example Request

XML Request

JSON Request

Expand

title	XML Request

<snmpManager retainSysIds="true">
    <description>description</description>
    <managerAddress>Junk.com</managerAddress>
    <managerPort>123</managerPort>
    <name>Test4</name>
    <opswiseGroups />
    <sysId>62701879a6264107bb757a952bcc65cc</sysId>
    <trapCommunity>Test4</trapCommunity>
</snmpManager>

Expand

title	JSON Request

{
    "description": "description",
    "managerAddress": "Junk.com",
    "managerPort": 123,
    "name": "Test4",
    "opswiseGroups": null,
    "retainSysIds": true,
    "sysId": "62701879a6264107bb757a952bcc65cc",
    "trapCommunity": "public"
}

...

Property

UI Field Name

Description

Specifications

Required

Anchor

	description - SNMP
	description - SNMP

description

Description

Description of this record.

N

Anchor

	exportReleaseLevel - SNMP
	exportReleaseLevel - SNMP

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read only

N

Anchor

	exportTable - SNMP
	exportTable - SNMP

exportTable

n/a

Record table information.

read only

N

Anchor

	managerAddress - SNMP
	managerAddress - SNMP

managerAddress

Manager Address

Name or IP address of the SNMP Manager.

Y

Anchor

	managerPort - SNMP
	managerPort - SNMP

managerPort

Manager Port

Port used by the SNMP Manager.

Y

Anchor

	name - SNMP
	name - SNMP

name

Manager Name

Name used within the Controller to identify this SNMP Manager.

Y

Anchor

	opswiseGroups - SNMP
	opswiseGroups - SNMP

opswiseGroups

Member of Business Services

Business Services that this record belongs to.

XML

Panel
<opswiseGroups> <opswiseGroup>group1</opswiseGroup> <opswiseGroup>group2</opswiseGroup> </opswiseGroups>

JSON

Panel
"opswiseGroups": ["group1","group2"]

N

Anchor

	retainSysIds - SNMP
	retainSysIds - SNMP

retainSysIds

n/a

Specification for whether or not the Create an SNMP Manager web service will persist the sysId property.

If retainSysIds="true" and sysId is included in the request/response, sysId will be persisted to the database.
If retainSysIds="false" and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.

Note

title	Note

In XML web services, retainSysIds is specified as an attribute in the <snmpManager> element.

Valid values: true/false (default is true).

N

Anchor

	sysId - SNMP
	sysId - SNMP

sysId

n/a

System ID field in the database for this SNMP Manager record.

Persisted only if retainSysIds is set to true.

N

Anchor

	trapCommunity - SNMP
	trapCommunity - SNMP

trapCommunity

Trap Community String

Used by the trap receiver to determine which traps to process.

Default is public.

N

...

	Description
URI	http://host_name/uc/resources/snmpmanager
HTTP Method	DELETE
Description	Deletes an SNMP Manager.
URI Parameters	See Delete an SNMP Manager : URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/snmpmanager?managername=Test4
Example Response	Status 200 /OK SNMP Manager deleted successfully. Status 400 /Bad Request Mutual exclusion violation. Cannot specify `managername` and `managerid` at the same time. Status 404 /Not Found An SNMP Manager with {name/id} "test" does not exist.

...

	Description
URI	http://host_name/uc/resources/snmpmanager/list
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 List SNMP Managers : Example Response, below.
SNMP Manager Properties	See SNMP Manager Properties.

Anchor
List SNMP Managers Example Response
List SNMP Managers Example Response
List SNMP Managers: Example Response

XML Response

JSON Response

Expand

title	XML Response

<snmpManagers>
    <snmpManager exportReleaseLevel="7.2.0.0" exportTable="ops_snmp_connection" version="7">
        <description>description</description>
        <managerAddress>qa.stone.branch</managerAddress>
        <managerPort>162</managerPort>
        <name>qa.stone.branch1</name>
        <opswiseGroups />
        <sysId>3d7a03053ad64de1b21b6849e6deafd9</sysId>
        <trapCommunity>Test4</trapCommunity>
    </snmpManager>
    <snmpManager exportReleaseLevel="7.2.0.0" exportTable="ops_snmp_connection" version="2">
        <description>description</description>
        <managerAddress>qa.stone.branch</managerAddress>
        <managerPort>162</managerPort>
        <name>qa.stone.branch2</name>
        <opswiseGroups />
        <sysId>94640cb62679407692cb41091e5c73fe</sysId>
        <trapCommunity>Test4</trapCommunity>
    </snmpManager>
<snmpManagers>

Expand

title	JSON Response

[ {
    "description": "description",
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_snmp_connection",
    "managerAddress": "qa.stone.branch",
    "managerPort": 162,
    "name": "qa.stone.branch1",
    "opswiseGroups": null,
    "sysId": "3d7a03053ad64de1b21b6849e6deafd9",
    "trapCommunity": "public",
    "version": 7
    },
    {
    "description": "description",
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_snmp_connection",
    "managerAddress": "qa.stone.branch",
    "managerPort": 162,
    "name": "qa.stone.branch",
    "opswiseGroups": null,
    "sysId": "94640cb62679407692cb41091e5c73fe",
    "trapCommunity": "public",
    "version": 2
    }
]

...

	Description
URI	http://host_name/uc/resources/snmpmanager
HTTP Method	PUT
Description	Modifies the SNMP Manager specified by the `sysId`.
Example URI	http://localhost:8080/uc/resources/snmpmanager
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Request	See Modify an SNMP Manager : Example Request, below.
SNMP Manager Properties	See SNMP Manager Properties.
Example Response	Status 200 /OK Successfully updated the SNMP Manager with sysId <sysId> to version <version>.

...

	Description
URI	http://host_name/uc/resources/snmpmanager
HTTP Method	GET
Description	Retrieves information on a specific SNMP Manager.
URI Parameters	See Read an SNMP Manager : URI Parameters, 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 Read an SNMP Manager : Example Response, below.
SNMP Manager Properties	See SNMP Manager Properties.

Anchor
Read an SNMP Manager URI Parameters
Read an SNMP Manager URI Parameters
Read an SNMP Manager: URI Parameters

...

XML Response

JSON Response

Expand

title	XML Response

<snmpManager exportReleaseLevel="7.2.0.0" exportTable="ops_snmp_connection" retainSysIds="true" version="1">
    <description>description</description>
    <managerAddress>Junk.com</managerAddress>
    <managerPort>123</managerPort>
    <name>Test4</name>
    <opswiseGroups />
    <sysId>62701879a6264107bb757a952bcc65cc</sysId>
    <trapCommunity>Test4</trapCommunity>
</snmpManager>

Expand

title	JSON Response

{
    "description": "description",
    "exportReleaseLevel": "7.2.0.0",
    "exportTable": "ops_snmp_connection",
    "managerAddress": "Junk.com",
    "managerPort": 123,
    "name": "Test4",
    "opswiseGroups": null,
    "sysId": "62701879a6264107bb757a952bcc65cc",
    "trapCommunity": "public",
    "version": 1
}

...

Versions Compared

Old Version 2

New Version Current

Key

Anchor
Create an SNMP Manager Example Request
Create an SNMP Manager Example Request
Create an SNMP Manager: Example Request

Anchor
List SNMP Managers Example Response
List SNMP Managers Example Response
List SNMP Managers: Example Response

Anchor
Read an SNMP Manager URI Parameters
Read an SNMP Manager URI Parameters
Read an SNMP Manager: URI Parameters

Page Comparison

Versions Compared

Old Version 2

New Version Current

Key

AnchorCreate an SNMP Manager Example RequestCreate an SNMP Manager Example RequestCreate an SNMP Manager: Example Request

AnchorList SNMP Managers Example ResponseList SNMP Managers Example ResponseList SNMP Managers: Example Response

AnchorRead an SNMP Manager URI ParametersRead an SNMP Manager URI ParametersRead an SNMP Manager: URI Parameters

Anchor
Create an SNMP Manager Example Request
Create an SNMP Manager Example Request
Create an SNMP Manager: Example Request

Anchor
List SNMP Managers Example Response
List SNMP Managers Example Response
List SNMP Managers: Example Response

Anchor
Read an SNMP Manager URI Parameters
Read an SNMP Manager URI Parameters
Read an SNMP Manager: URI Parameters