trap_settings

Configuration for trap severities resource.

Read/write properties

user_defined_severity<String>

user defined severity of trap.

default_severity<String>

default severity of trap.

id<String>

Id is system generated key.

trap_category<String>

Trap Category.

trap_description<String>

Trap Description.

device_family<String>

Device Family.

source<String>

Source.

oid<String>

Trap OID.

is_suppress<Boolean>

if trap needs to be suppressed or not.

source_array<String[]>

Source list.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

The following parameters can be used in the nitro request :

onerror   <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

update

URL:https://<MGMT-IP>/nitro/v2/config/trap_settings/id_value<String>

HTTPS Method:PUT

Request Headers:

Content-Type:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:JSON

{"trap_settings":{
      "id":<String_value>,
      "is_suppress":<Boolean_value>,
      "trap_category":<String_value>,
      "user_defined_severity":<String_value>,
      "device_family":<String_value>,
      "source":<String_value>,
      "default_severity":<String_value>,
      "oid":<String_value>,
      "source_array":<String_value[]>,
      "trap_description":<String_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "trap_settings":[{
      "user_defined_severity":<String_value>,
      "default_severity":<String_value>,
      "id":<String_value>,
      "trap_category":<String_value>,
      "trap_description":<String_value>,
      "device_family":<String_value>,
      "source":<String_value>,
      "oid":<String_value>,
      "is_suppress":<Boolean_value>,
      "source_array":<String_value>}]}

get (all)

URL:https://<MGMT-IP>/nitro/v2/config/trap_settings

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/trap_settings?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of trap_settings resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no&pageno=#no

https://<MGMT-IP>/nitro/v2/config/trap_settings?pagesize=#no&pageno=#no

Use this query-parameter to get the trap_settings resources in chunks.

count

https://<MGMT-IP>/nitro/v2/config/trap_settings?count=yes

Use this query-parameter to get the count of trap_settings resources.

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "trap_settings":[{
      "user_defined_severity":<String_value>,
      "default_severity":<String_value>,
      "id":<String_value>,
      "trap_category":<String_value>,
      "trap_description":<String_value>,
      "device_family":<String_value>,
      "source":<String_value>,
      "oid":<String_value>,
      "is_suppress":<Boolean_value>,
      "source_array":<String_value>}]}

get

URL:https://<MGMT-IP>/nitro/v2/config/trap_settings/id_value<String>

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "trap_settings":[{
      "user_defined_severity":<String_value>,
      "default_severity":<String_value>,
      "id":<String_value>,
      "trap_category":<String_value>,
      "trap_description":<String_value>,
      "device_family":<String_value>,
      "source":<String_value>,
      "oid":<String_value>,
      "is_suppress":<Boolean_value>,
      "source_array":<String_value>}]}