Skip to content

trap_forward_profile

Configuration for Trap Forward Profile resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
trap_destination_port<String>Read-writeSNMP port to forward trap .
Minimum length = 1
Maximum length = 128
trap_community<String>Read-writeSNMP community..
Minimum length = 1
Maximum length = 128
id<String>Read-writeId is system generated key for all the mail profile..
trap_destination<String>Read-writeSMTP server name.
Minimum length = 1
Maximum length = 128
profile_name<String>Read-writeProfile name for the mail setting..
Minimum length = 1
Maximum length = 128
tenant_id<String>Read-onlyTenant 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>.

add

URL: https://<MGMT-IP>/nitro/v1/config/trap_forward_profile?onerror=<String_value>

HTTP Method: null

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>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/trap_forward_profile/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/trap_forward_profile

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/trap_forward_profile/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/trap_forward_profile/id_value<String>

HTTP Method: null

Request Payload:

{trap_forward_profile:{
<b>"id":<String_value></b>,
"trap_destination_port":<String_value>,
"trap_destination":<String_value>,
"trap_community":<String_value>,
"profile_name":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}