ADC NITRO APIs

snmpmib

August 17, 2023

Contributed by:

Configuration for SNMP mib resource.

Properties

(click to see Operations )

Name	Permissions	Description
contact	Read-write	Name of the administrator for this Citrix ADC. Along with the name, you can include information on how to contact this person, such as a phone number or an email address. Can consist of 1 to 127 characters that include uppercase and lowercase letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore (_) characters. The following requirement applies only to the Citrix ADC CLI If the information includes one or more spaces, enclose it in double or single quotation marks (for example, “my contact” or ‘my contact’). Default value: “WebMaster (default)” Minimum length = 1
name	Read-write	Name for this Citrix ADC. Can consist of 1 to 127 characters that include uppercase and lowercase letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore (_) characters. You should choose a name that helps identify the Citrix ADC appliance. The following requirement applies only to the Citrix ADC CLI If the name includes one or more spaces, enclose it in double or single quotation marks (for example, “my name” or ‘my name’). Default value: “NetScaler” Minimum length = 1
location	Read-write	Physical location of the Citrix ADC. For example, you can specify building name, lab number, and rack number. Can consist of 1 to 127 characters that include uppercase and lowercase letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore (_) characters. The following requirement applies only to the Citrix ADC CLI If the location includes one or more spaces, enclose it in double or single quotation marks (for example, “my location” or ‘my location’). Default value: “POP (default)” Minimum length = 1
customid	Read-write	Custom identification number for the Citrix ADC. Can consist of 1 to 127 characters that include uppercase and lowercase letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore (_) characters. You should choose a custom identification that helps identify the Citrix ADC appliance. The following requirement applies only to the Citrix ADC CLI If the ID includes one or more spaces, enclose it in double or single quotation marks (for example, “my ID” or ‘my ID’). Default value: “Default” Minimum length = 1
ownernode	Read-write	ID of the cluster node for which we are setting the mib. This is a mandatory argument to set snmp mib on CLIP. Default value: -1 Minimum value = 0 Maximum value = 31
sysdesc	Read-only	The description of the system.
sysuptime	Read-only	The UP time of the system in 100th of a second.
sysservices	Read-only	The services offered by the system.
sysoid	Read-only	The OID of the system’s management system.
__count	Read-only	count parameter

Operations

(click to see Properties )

UPDATE
UNSET
GET (ALL)
GET
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 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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/snmpmib

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"snmpmib":{
      "contact":<String_value>,
      "name":<String_value>,
      "location":<String_value>,
      "customid":<String_value>,
      "ownernode":<Double_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

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

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/snmpmib? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"snmpmib":{
      "contact":true,
      "name":true,
      "location":true,
      "customid":true,
      "ownernode":<Double_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/snmpmib

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/snmpmib? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/snmpmib? filter=property-name1:property-val1,property-name2:property-val2

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

view

http:// <netscaler-ip-address> /nitro/v1/config/snmpmib? view=summary

Use this query-parameter to get the summary output of snmpmib resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/snmpmib? pagesize=#no;pageno=#no

Use this query-parameter to get the snmpmib 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 NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "snmpmib": [ {
      "ownernode":<Double_value>,
      "contact":<String_value>,
      "name":<String_value>,
      "location":<String_value>,
      "sysdesc":<String_value>,
      "sysuptime":<Double_value>,
      "sysservices":<Double_value>,
      "sysoid":<String_value>,
      "customid":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/snmpmib/ ownernode_value<Double>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/snmpmib/ ownernode_value<Double> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/snmpmib/ ownernode_value<Double> ? view=summary

Use this query-parameter to get the summary output of snmpmib resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

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 NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "snmpmib": [ {
      "ownernode":<Double_value>,
      "contact":<String_value>,
      "name":<String_value>,
      "location":<String_value>,
      "sysdesc":<String_value>,
      "sysuptime":<Double_value>,
      "sysservices":<Double_value>,
      "sysoid":<String_value>,
      "customid":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/snmpmib? 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 NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

snmpmib

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

snmpmib

Properties

Operations

update

unset

get (all)

get

count

In this article