trap_forward_profile
Configuration for Trap Forward Profile resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| trap_destination_port | <String> | Read-write | SNMP port to forward trap.
Minimum length = 1 Maximum length = 128 |
| trap_community | <String> | Read-write | SNMP community name using which we want to forward the trap.
Minimum length = 1 Maximum length = 128 |
| id | <String> | Read-write | Id is system generated key for all the mail profile.. |
| trap_destination | <String> | Read-write | SMTP server IP.
Minimum length = 1 Maximum length = 128 |
| profile_name | <String> | Read-write | Profile name for the mail setting..
Minimum length = 1 Maximum length = 128 |
| tenant_id | <String> | Read-only | Tenant Id . |
Operations
(click to see Properties )
- ADD
- DELETE
- GET (ALL)
- GET
- UPDATE
Some options that you can use for each operations:
-
Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes
If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
-
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
To do this, you must specify the username and password in the request header of the NITRO request as follows:
X-NITRO-USER: <username>
X-NITRO-PASS: <password>
Note: In such cases, make sure that the request header DOES not include the following:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
*Note:
*
Mandatory parameters are marked in
red
and placeholder content is marked in
green
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
add
URL: https://<MGMT-IP>/nitro/v2/config/trap_forward_profile?onerror=<String_value> HTTPS Method: POST
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:
{"trap_forward_profile": {
<b>"trap_destination_port":<String_value></b>,
<b>"trap_community":<String_value></b>,
<b>"trap_destination":<String_value></b>,
<b>"profile_name":<String_value></b>,
"id":<String_value>}}
<!--NeedCopy-->
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:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "trap_forward_profile":[{
"trap_destination_port":<String_value>,
"tenant_id":<String_value>,
"trap_community":<String_value>,
"id":<String_value>,
"trap_destination":<String_value>,
"profile_name":<String_value>}]}
<!--NeedCopy-->
delete
URL: https://<MGMT-IP>/nitro/v2/config/trap_forward_profile/id_value<String> HTTPS Method: DELETE
Request Headers: 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 Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }
<!--NeedCopy-->
get (all)
URL: https://<MGMT-IP>/nitro/v2/config/trap_forward_profile Query-parameters:
filter https://<MGMT-IP>/nitro/v2/config/trap_forward_profile ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of trap_forward_profile 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_forward_profile ?pagesize=#no;pageno=#no Use this query-parameter to get the trap_forward_profile resources in chunks.
count https://<MGMT-IP>/nitro/v2/config/trap_forward_profile ?count=yes Use this query-parameter to get the count of trap_forward_profile 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:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "trap_forward_profile":[{
"trap_destination_port":<String_value>,
"tenant_id":<String_value>,
"trap_community":<String_value>,
"id":<String_value>,
"trap_destination":<String_value>,
"profile_name":<String_value>}]}
<!--NeedCopy-->
get
URL: https://<MGMT-IP>/nitro/v2/config/trap_forward_profile/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:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "trap_forward_profile":[{
"trap_destination_port":<String_value>,
"tenant_id":<String_value>,
"trap_community":<String_value>,
"id":<String_value>,
"trap_destination":<String_value>,
"profile_name":<String_value>}]}
<!--NeedCopy-->
update
URL: https://<MGMT-IP>/nitro/v2/config/trap_forward_profile/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:
{"trap_forward_profile":{
<b>"id":<String_value></b>,
"trap_destination_port":<String_value>,
"profile_name":<String_value>,
"trap_destination":<String_value>,
"trap_community":<String_value>}}
<!--NeedCopy-->
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:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "trap_forward_profile":[{
"trap_destination_port":<String_value>,
"tenant_id":<String_value>,
"trap_community":<String_value>,
"id":<String_value>,
"trap_destination":<String_value>,
"profile_name":<String_value>}]}
<!--NeedCopy-->