Skip to content

ns_snmp_config

Configuration for SNMP configuration resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
save_config<Boolean>Read-writetrue, if save config is required.
trapdestination<String>Read-writeState of configuration (enable/disable).
snmpauthprotocol<String>Read-writeSNMP v3 auth protocol.
snmpsecurityname<String>Read-writeSNMP v3 security name.
Maximum length = 31
snmpprivprotocol<String>Read-writeSNMP v3 priv protocol.
ns_ip_address_arr<String[]>Read-writeList of NS IP Address.
Maximum length = 64
state<String>Read-writeState of configuration (enable/disable).
ns_ip_address<String>Read-writeNetScaler IP Address.
Minimum length = 1
Maximum length = 64
snmpsecuritylevel<String>Read-writeSNMP v3 security level.
snmpcommunity<String>Read-writeSNMP community.
Maximum length = 31
snmpprivpassword<String>Read-writeSNMP v3 priv password.
Minimum length = 8
Maximum length = 31
snmpversion<String>Read-writeSNMP version.
snmpauthpassword<String>Read-writeSNMP 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>.

add

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

HTTP Method: null

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 Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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/v1/config/ns_snmp_config/

HTTP Method: null

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 Payload:

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