Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

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://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 5445210, 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 5445210, below.

Create an SNMP Manager: Example Request

XML Request

JSON Request

 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>
 JSON Request
{
    "description": "description",
    "managerAddress": "Junk.com",
    "managerPort": 123,
    "name": "Test4",
    "opswiseGroups": null,
    "retainSysIds": true,
    "sysId": "62701879a6264107bb757a952bcc65cc",
    "trapCommunity": "public"
}

SNMP Manager Properties

Property

UI Field Name

Description

Specifications

Required

description

Description

Description of this record.


N

managerAddress

Manager Address

Name or IP address of the SNMP Manager.


Y

managerPort

Manager Port

Port used by the SNMP Manager.


Y

name

Manager Name                               

Name used within the Controller to identify this SNMP Manager.


Y

opswiseGroups

Member of Business Services

Business Services that this record belongs to.
 
XML



 
JSON




N

retainSysIds

n/a

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




Note

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

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

N

sysId

n/a

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

Persisted only if retainSysIds is set to true.

N

trapCommunity

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

  • 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.

Delete an SNMP Manager: URI Parameters

Parameter

Description

Specifications

Required

Mutually Exclusive With

managerid

ID used within the Controller to identify this SNMP Manager.

String; URI parameter.

Y
(unless managername
is specified)

managername

managername

Name used within the Controller to identify this SNMP Manager.

String; URI parameter.

Y
(unless managerid
is specified)

managerid

List SNMP Managers


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 5445210, below.

SNMP Manager Properties

See 5445210.

List SNMP Managers: Example Response

XML Response

JSON Response

 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>

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

Modify an SNMP Manager


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 5445210, below.

SNMP Manager Properties

See 5445210.

Example Response

  • Status 200 /OK
    Successfully updated the SNMP Manager with sysId <sysId> to version <version>.

Modify an SNMP Manager: Example Request

XML Request

JSON Request

 XML Request
<snmpManager>
    <description>description</description>
    <managerAddress>Junk.com</managerAddress>
    <managerPort>123</managerPort>
    <name>Test4</name>
    <opswiseGroups>
          <opswiseGroup>Accounting</opswiseGroup>
    </opswiseGroups>
    <sysId>62701879a6264107bb757a952bcc65cc</sysId>
    <trapCommunity>Test4</trapCommunity>
</snmpManager>
 JSON Request
{
    "description": "description",
    "managerAddress": "Junk.com",
    "managerPort": 123,
    "name": "Test4",
    "opswiseGroups": [ "Accounting" ],
    "sysId": "62701879a6264107bb757a952bcc65cc",
    "trapCommunity": "public"
}

Read an SNMP Manager


Description

URI

http://host_name/uc/resources/snmpmanager

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

managerid

ID used within the Controller to identify this SNMP Manager.

String; URI parameter.

Y
(unless managername
is specified)

managername

managername

Name used within the Controller to identify this SNMP Manager.

String; URI parameter.

Y
(unless managerid
is specified)

managerid

Read an SNMP Manager: Example Response

XML Response

JSON Response

 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>
 JSON Response
{
    "description": "description",
    "managerAddress": "Junk.com",
    "managerPort": 123,
    "name": "Test4",
    "opswiseGroups": null,
    "sysId": "62701879a6264107bb757a952bcc65cc",
    "trapCommunity": "public",
    "version": 1
}

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

  • No labels