Skip to content

snmptrap_snmpuser_binding

Binding object showing the snmpuser that can be bound to snmptrap.

Properties

(click to see Operations)

NameData TypePermissionsDescription
trapclass<String>Read-writeType of trap messages that the Citrix ADC sends to the trap listener: Generic or the enterprise-specific messages defined in the MIB file.
Possible values = generic, specific
securitylevel<String>Read-writeSecurity level of the SNMPv3 trap.
Default value: authNoPriv,
Possible values = noAuthNoPriv, authNoPriv, authPriv
username<String>Read-writeName of the SNMP user that will send the SNMPv3 traps.
td<Double>Read-writeInteger value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.
Minimum value = 0
Maximum value = 4094
trapdestination<String>Read-writeIPv4 or the IPv6 address of the trap listener to which the Citrix ADC is to send SNMP trap messages.
Minimum length = 1
version<String>Read-writeSNMP version, which determines the format of trap messages sent to the trap listener. This setting must match the setting on the trap listener. Otherwise, the listener drops the trap messages.
Default value: V3
Possible values = V1, V2, V3
__count<Double>Read-writecount parameter

Operations

(click to see Properties)

ADD:| DELETE:| GET| GET (ALL)| COUNT

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

add:

URL:http://<Citrix-ADC-IP-address(NSIP)/nitro/v1/config/snmptrap_snmpuser_binding

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{
"snmptrap_snmpuser_binding":{
<b>"trapclass":<String_value>,
</b><b>"trapdestination":<String_value>,
</b>"td":<Double_value>,
"version":<String_value>,
<b>"username":<String_value>,
</b>"securitylevel":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

delete:

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/snmptrap_snmpuser_binding/trapclass_value<String>

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/snmptrap_snmpuser_binding/trapclass_value<String>?args=trapdestination:<String_value>,td:<Double_value>,version:<String_value>,username:<String_value>

HTTP Method:DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/snmptrap_snmpuser_binding

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/snmptrap_snmpuser_binding?args=trapdestination:<String_value>,version:<String_value>,td:<Double_value>,trapclass:<String_value>

Use this query-parameter to get snmptrap_snmpuser_binding resources based on additional properties.

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/snmptrap_snmpuser_binding?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of snmptrap_snmpuser_binding resources configured on Citrix ADC. Filtering can be done on any of the properties of the resource.

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/snmptrap_snmpuser_binding?pagesize=#no;pageno=#no

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

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "snmptrap_snmpuser_binding": [ {
"trapclass":<String_value>,
"securitylevel":<String_value>,
"username":<String_value>,
"td":<Double_value>,
"trapdestination":<String_value>,
"version":<String_value>
}]}

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/snmptrap_snmpuser_binding

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/snmptrap_snmpuser_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "snmptrap_snmpuser_binding": [ {
"trapclass":<String_value>,
"securitylevel":<String_value>,
"username":<String_value>,
"td":<Double_value>,
"trapdestination":<String_value>,
"version":<String_value>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/snmptrap_snmpuser_binding?args=trapdestination:<String_value>,version:<String_value>,td:<Double_value>,trapclass:<String_value>;count=yes

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "snmptrap_snmpuser_binding": [ { "__count": "#no"} ] }