Product Documentation

systemmemory

Sep 08, 2016

Statistics for Global system memory stats resource.

Properties (click to see Operations)

Name Data Type Permissions Description
clearstats
<String>
Read-write
Clear the statsistics / counters.
Possible values = basic, full
cacmemmaxmemlimitpcnt
<Double>
Read-only
Integrated Cache memory insue percent.
cacmemmaxmemlimit
<Double>
Read-only
Integrated Cache memory insue, in megabytes.
shmemerrallocfailed
<Double>
Read-only
Total shared memory allocation failed.
shmemallocpcnt
<Double>
Read-only
Shared memory insue percent.
shmemallocinmb
<Double>
Read-only
Shared memory insue, in megabytes.
shmemtotinmb
<Double>
Read-only
Total shared memory allowed to allocate, in megabytes.
memtotallocfailed
<Double>
Read-only
Total system memory allocation failed.
memtotfree
<Double>
Read-only
Total Free PE Memory in the System.
memusagepcnt
<Double>
Read-only
Percentage of memory utilization on NetScaler.
memtotuseinmb
<Double>
Read-only
Total NetScaler Memory in use, in megabytes.
memtotallocpcnt
<Double>
Read-only
Currently allocated memory in percent.
memtotallocmb
<Double>
Read-only
Currently allocated memory, in megabytes.
memtotinmb
<Double>
Read-only
Total memory available (grabbed) for use by packet engine (PE), in megabytes.
memtotavail
<Double>
Read-only
Total system memory available for PE to grab from the system.
cacmemmaxsyslimitmb
<Double>
Read-only
Integrated Cache memory, in megabytes.

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/stat/systemmemory

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/stat/systemmemory?args=detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

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

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

Content-Type:application/json

Response Payload:

{ "systemmemory": [ {
      "memtotallocpcnt":<Double_value>,
      "memtotfree":<Double_value>,
      "shmemallocpcnt":<Double_value>,
      "cacmemmaxmemlimitpcnt":<Double_value>,
      "shmemallocinmb":<Double_value>,
      "memtotuseinmb":<Double_value>,
      "cacmemmaxmemlimit":<Double_value>,
      "memusagepcnt":<Double_value>,
      "memtotinmb":<Double_value>,
      "cacmemmaxsyslimitmb":<Double_value>,
      "memtotallocfailed":<Double_value>,
      "memtotallocmb":<Double_value>,
      "shmemerrallocfailed":<Double_value>,
      "memtotavail":<Double_value>,
      "shmemtotinmb":<Double_value>
}]}