Jump to

• Request
• Response

Get Information of a Targeted Northbound Trap Receiver

get

/rest/{versionId}/fault/trapReceivers/{trapReceiverId}

Use this (GET) method to retrieve the specific information from a northbound trap receiver that was configured in SDM.

Request

Path Parameters

• trapReceiverId: string
• versionId: string

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

successful operation

Body ()

Root Schema : trapReceiver

Type: object

Show Source

• alarmFormat(optional): string
• allDevices(optional): boolean
  Default Value: false
• allowDeviceTrap(optional): boolean
  Default Value: false
• allowServerAlarm(optional): boolean
  Default Value: false
• communityName(optional): string
• devices(optional): array device
• forwardEnabled(optional): boolean
  Default Value: false
• id(optional): string
• ipAddress(optional): string
• severity(optional): string
• snmpVersion(optional): string
• status(optional): string
• udpPort(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "ipAddress":{
            "type":"string"
        },
        "udpPort":{
            "type":"string"
        },
        "communityName":{
            "type":"string"
        },
        "snmpVersion":{
            "type":"string"
        },
        "forwardEnabled":{
            "type":"boolean",
            "default":false
        },
        "status":{
            "type":"string"
        },
        "severity":{
            "type":"string"
        },
        "alarmFormat":{
            "type":"string"
        },
        "allowServerAlarm":{
            "type":"boolean",
            "default":false
        },
        "allowDeviceTrap":{
            "type":"boolean",
            "default":false
        },
        "allDevices":{
            "type":"boolean",
            "default":false
        },
        "devices":{
            "type":"array",
            "xml":{
                "name":"device",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RestDeviceBrief"
            }
        }
    },
    "xml":{
        "name":"trapReceiver"
    }
}

Nested Schema : device

Type: array

Show Source

• Array of: object device

{
    "type":"array",
    "xml":{
        "name":"device",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/RestDeviceBrief"
    }
}

Nested Schema : device

Type: object

Show Source

• id(optional): string
• name(optional): string
• nfName(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "nfName":{
            "type":"string"
        }
    },
    "xml":{
        "name":"device"
    }
}

400 Response

The user input is invalid.

401 Response

The session ID is invalid.

404 Response

The object (resource URI, device, and so on) of your input request cannot be found.

Back to Top