Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


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

...

XML Request

JSON Request


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


Anchor
SNMP Manager Properties
SNMP Manager Properties
SNMP Manager Properties

...


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

SNMP Manager Properties

See 13041668SNMP Manager Properties.

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

XML Response

JSON Response


Expand
titleXML 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
titleJSON 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 13041668Modify an SNMP Manager Example Request, below.

SNMP Manager Properties

See 13041668SNMP Manager Properties.

Example Response

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

...

XML Request

JSON Request


Expand
titleXML 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>



Expand
titleJSON Request
{
    "description": "description",
    "managerAddress": "Junk.com",
    "managerPort": 123,
    "name": "Test4",
    "opswiseGroups": [ "Accounting" ],
    "sysId": "62701879a6264107bb757a952bcc65cc",
    "trapCommunity": "public"
}


Anchor
Read an SNMP Manager
Read an SNMP Manager
Read an SNMP Manager


Description

URI

HTTP Method

GET

Description

Retrieves information on a specific SNMP Manager.

URI Parameters

See 13041668Read 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 13041668Read an SNMP Manager Example Response, below.

SNMP Manager Properties

See 13041668SNMP 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
titleXML 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
titleJSON 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 }


...