REST API for Oracle SD-WAN Edge Release 9.1.1

Save alarm information

post

http://<SDWAN_TENANT_IP>/v1/admin/event_management/alarms

Request

There are no request parameters for this operation.

Supported Media Types

application/json

A JSON object containing the alarm details

Root Schema : schema

Type: object

Example:

{
    "emails_enabled":"off",
    "email_address":"",
    "src_email_address":"",
    "email_server":"",
    "email_port":25,
    "enable_auth":"off",
    "email_user":"",
    "email_password":"",
    "email_password_verify":"",
    "syslog_enabled":"off",
    "syslog_server_ip":"",
    "syslog_auth_to_enabled":"off",
    "syslog_firewall_enabled":"off",
    "snmp_port":161,
    "sysdescr_string":"Talari Networks Adaptive Private Network Appliance",
    "syscontact_string":"support@talari.com",
    "syslocation_string":"Talari Networks",
    "snmp_enabled":"off",
    "community_string":"public",
    "snmp_traps_enabled":"off",
    "snmp_trap_ip":"",
    "snmp_trap_port":162,
    "snmp_v3_enabled":"off",
    "snmp_v3_user_name":"",
    "snmp_v3_user_password":"",
    "snmp_v3_user_password_verify":"",
    "snmp_v3_auth_type":"MD5",
    "snmp_v3_encryption":"None",
    "snmp_v3_traps_enabled":"off",
    "snmp_v3_trap_ip":"",
    "snmp_v3_trap_port":162,
    "snmp_v3_trap_user_name":"",
    "snmp_v3_trap_user_password":"",
    "snmp_v3_trap_user_password_verify":"",
    "snmp_v3_trap_auth_type":"MD5",
    "snmp_v3_trap_encryption":"None",
    "num_alarms":1,
    "alarm-config-id_0":2,
    "object-type_0":1,
    "trigger-state_0":13,
    "trigger-duration_0":0,
    "clear-state_0":1,
    "clear-duration_0":0,
    "email_0":"off",
    "snmp_0":"off",
    "sysLog_0":"off",
    "severity_0":0,
    "delete-alarm_0":"off",
    "timestamp":"MTYyNjE4MDMyNQ=="
}

Response

Supported Media Types

application/json

200 Response

Result OK

Root Schema : schema

Type: object

401 Response

Not Logged into the SDWAN-Edge device

Root Schema : 401NotLoggedin

Type: object

Show Source

message: string

Example: Not logged in.
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Not logged in."
        }
    }
}

403 Response

Insufficient Userlevel

Root Schema : 403InsufficientUserLevel

Type: object

Show Source

message: string

Example: User Level for user <user_name> is not sufficient for this <URL value> operation.
required_user_level: string

Example: ADMIN
status: string

Example: fail
user_level: string

Example: GUEST
user_name: string

Example: username

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "user_name":{
            "type":"string",
            "example":"username"
        },
        "user_level":{
            "type":"string",
            "example":"GUEST"
        },
        "required_user_level":{
            "type":"string",
            "example":"ADMIN"
        },
        "message":{
            "type":"string",
            "example":"User Level for user <user_name> is not sufficient for this <URL value> operation."
        }
    }
}

405 Response

Invalid request method

Root Schema : 405ExpectedPost

Type: object

Show Source

message: string

Example: Operation must use a POST
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Operation must use a POST"
        }
    }
}

Examples

Example of Accessing the API with cURL

The following example shows how to save alarm information by submitting a POST request on the REST resource using cURL. If the request requires a timestamp, use the timestamp from the response of the /login API. For more information about cURL, see Use cURL.

curl -X POST \
    -b cookies.txt \
    -d@request.json \
    --header "Content-Type: application/json" \
    "https://$IPADDR/v1/admin/event_management/alarms"

The following shows an example of the contents of the request.json file sent as the request body.

{
  "emails_enabled":"off",
  "email_address":"",
  "src_email_address":"",
  "email_server":"",
  "email_port":25,
  "enable_auth":"off",
  "email_user":"",
  "email_password":"",
  "email_password_verify":"",
  "syslog_enabled":"off",
  "syslog_server_ip":"",
  "syslog_auth_to_enabled":"off",
  "syslog_firewall_enabled":"off",
  "snmp_port":161,
  "sysdescr_string":"Talari Networks Adaptive Private Network Appliance",
  "syscontact_string":"support@talari.com",
  "syslocation_string":"Talari Networks",
  "snmp_enabled":"off",
  "community_string":"public",
  "snmp_traps_enabled":"off",
  "snmp_trap_ip":"",
  "snmp_trap_port":162,
  "snmp_v3_enabled":"off",
  "snmp_v3_user_name":"",
  "snmp_v3_user_password":"",
  "snmp_v3_user_password_verify":"",
  "snmp_v3_auth_type":"MD5",
  "snmp_v3_encryption":"None",
  "snmp_v3_traps_enabled":"off",
  "snmp_v3_trap_ip":"",
  "snmp_v3_trap_port":162,
  "snmp_v3_trap_user_name":"",
  "snmp_v3_trap_user_password":"",
  "snmp_v3_trap_user_password_verify":"",
  "snmp_v3_trap_auth_type":"MD5",
  "snmp_v3_trap_encryption":"None",
  "num_alarms":1,
  "alarm-config-id_0":2,
  "object-type_0":1,
  "trigger-state_0":13,
  "trigger-duration_0":0,
  "clear-state_0":1,
  "clear-duration_0":0,
  "email_0":"off",
  "snmp_0":"off",
  "sysLog_0":"off",
  "severity_0":0,
  "delete-alarm_0":"off",
  "timestamp":"MTYyNjE4MDMyNQ=="
}

Example of the Response Body

The following example shows the contents of the response body in JSON format.

{
  "data": {
    "Clear States": [
      {
        "eventType id": 4,
        "id": 4,
        "index": 0,
        "name": "GOOD"
      },
      {
        "eventType id": 4,
        "id": 1,
        "index": 0,
        "name": "DISABLED"
      },
      {
        "eventType id": 4,
        "id": 3,
        "index": 0,
        "name": "BAD"
      },
      {
        "eventType id": 4,
        "id": 2,
        "index": 0,
        "name": "DEAD"
      }
    ]
  },
  "status": "success"
}