SNMPPolicy¶

SNMPPolicy - Create¶

Creates a new SNMP Policy.

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/SNMPPolicy

Parameter

Field	Label in UI	Type	Description
name	Name	String	SNMP Policy name. Mandatory Field
oid_time	Policy	[json]	SNMP oid key and fetch time in minutes. Mandatory Field

Request Example

{
    "data": {
        "name": "testPolicy",
        "oid_time": [
            {
                "field": "1.3.6.1.2.1.1.5.0",
                "value": 5
            },
            {
                "field": "1.3.6.1.3.2.1.5.0",
                "value": 6
            }
        ]
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

SNMPPolicy - Edit¶

Edits the SNMP Policy with given ID.

PUT

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/SNMPPolicy/{id}

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing SNMP Fetcher id . Mandatory Field
name	Name	String	name of the snmp policy. Mandatory Field
oid_time	Policy	[json]	SNMP oid key and fetch time in minutes. Mandatory Field

Request Example

{
    "data": {
        "name": "testPolicy",
        "oid_time": [
            {
                "field": "1.3.6.1.2.1.1.5.0",
                "value": 5
            },
            {
                "field": "1.3.6.1.3.2.1.5.0",
                "value": 6
            }
        ]
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

SNMPPolicy - Get¶

Fetches an SNMP Policy with given ID.

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/SNMPPolicy/{id}

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing SNMP Policy id .

Success Response

{
    "id": "574fb123d8aaa4625bfe2d23",
    "name": "testPolicy",
    "oid_time": [
        {
            "field": "1.3.6.1.2.1.1.5.0",
            "value": 5
        },
        {
            "field": "1.3.6.1.3.2.1.5.0",
            "value": 6
        }
    ]
}

SNMPPolicy - List¶

Lists all SNMP Policies.

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/SNMPPolicy

Success Response

[
    {
        "id": "574fb123d8aaa4625bfe2d23",
        "name": "testPolicy",
        "oid_time": [
            {
                "field": "1.3.6.1.2.1.1.5.0",
                "value": 5
            },
            {
                "field": "1.3.6.1.3.2.1.5.0",
                "value": 6
            }
        ]
    }
]

SNMPPolicy - Trash¶

Deletes the SNMP Policy with given ID.

DELETE

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/SNMPPolicy/{id}

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing SNMP Policy id . Mandatory Field

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

Helpful?