Skip to content
Was this article helpful?

ns_snmp_config

Configuration for SNMP configuration resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
save_config <Boolean> Read-write true, if save config is required.
trapdestination <String> Read-write State of configuration (enable/disable).
snmpauthprotocol <String> Read-write SNMP v3 auth protocol.
snmpsecurityname <String> Read-write SNMP v3 security name.

Maximum length = 31
snmpprivprotocol <String> Read-write SNMP v3 priv protocol.
ns_ip_address_arr <String[]> Read-write List of Citrix ADC IP Address.

Maximum length = 64
state <String> Read-write State of configuration (enable/disable).
ns_ip_address <String> Read-write Citrix ADC IP Address.

Minimum length = 1

Maximum length = 64
snmpsecuritylevel <String> Read-write SNMP v3 security level.
snmpcommunity <String> Read-write SNMP community.

Maximum length = 31
snmpprivpassword <String> Read-write SNMP v3 priv password.

Minimum length = 8

Maximum length = 31
snmpversion <String> Read-write SNMP version.
snmpauthpassword <String> Read-write SNMP v3 auth password.

Minimum length = 8

Maximum length = 31

Operations

(click to see Properties )

  • ADD
  • 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/ns_snmp_config?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:

{"ns_snmp_config": {
<b>"ns_ip_address":<String_value></b>,
<b>"snmpversion":<String_value></b>,
"snmpsecurityname":<String_value>,
"snmpauthprotocol":<String_value>,
"state":<String_value>,
"snmpsecuritylevel":<String_value>,
"snmpcommunity":<String_value>,
"save_config":<Boolean_value>,
"trapdestination":<String_value>,
"snmpprivprotocol":<String_value>,
"ns_ip_address_arr":<String_value[]>,
"snmpprivpassword":<String_value>,
"snmpauthpassword":<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:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_snmp_config":[{
"save_config":<Boolean_value>,
"trapdestination":<String_value>,
"snmpauthprotocol":<String_value>,
"snmpsecurityname":<String_value>,
"snmpprivprotocol":<String_value>,
"ns_ip_address_arr":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"snmpsecuritylevel":<String_value>,
"snmpcommunity":<String_value>,
"snmpprivpassword":<String_value>,
"snmpversion":<String_value>,
"snmpauthpassword":<String_value>}]}

update

URL: https://<MGMT-IP>/nitro/v2/config/ns_snmp_config/ 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:

{"ns_snmp_config":{
"snmpsecurityname":<String_value>,
"snmpauthprotocol":<String_value>,
"ns_ip_address":<String_value>,
"state":<String_value>,
"snmpsecuritylevel":<String_value>,
"snmpcommunity":<String_value>,
"save_config":<Boolean_value>,
"trapdestination":<String_value>,
"snmpprivprotocol":<String_value>,
"ns_ip_address_arr":<String_value[]>,
"snmpprivpassword":<String_value>,
"snmpversion":<String_value>,
"snmpauthpassword":<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:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_snmp_config":[{
"save_config":<Boolean_value>,
"trapdestination":<String_value>,
"snmpauthprotocol":<String_value>,
"snmpsecurityname":<String_value>,
"snmpprivprotocol":<String_value>,
"ns_ip_address_arr":<String_value>,
"state":<String_value>,
"ns_ip_address":<String_value>,
"snmpsecuritylevel":<String_value>,
"snmpcommunity":<String_value>,
"snmpprivpassword":<String_value>,
"snmpversion":<String_value>,
"snmpauthpassword":<String_value>}]}
Was this article helpful?