Statistics for Global system memory stats resource.


(click to see Operations )

Name Data Type Permissions Description
clearstats Read-write Clear the statsistics / counters.

Possible values = basic, full
cacmemmaxmemlimitpcnt Read-only Integrated Cache memory insue percent.
cacmemmaxmemlimit Read-only Integrated Cache memory insue, in megabytes.
shmemerrallocfailed Read-only Total shared memory allocation failed.
shmemallocpcnt Read-only Shared memory insue percent.
shmemallocinmb Read-only Shared memory insue, in megabytes.
shmemtotinmb Read-only Total shared memory allowed to allocate, in megabytes.
memtotallocfailed Read-only Total system memory allocation failed.
memtotfree Read-only Total Free PE Memory in the System.
memusagepcnt Read-only Percentage of memory utilization on Citrix ADC.
memtotuseinmb Read-only Total Citrix ADC Memory in use, in megabytes.
memtotallocpcnt Read-only Currently allocated memory in percent.
memtotallocmb Read-only Currently allocated memory, in megabytes.
memtotinmb Read-only Total memory available (grabbed) for use by packet engine (PE), in megabytes.
memtotavail Read-only Total system memory available for PE to grab from the system.
cacmemmaxsyslimitmb Read-only Integrated Cache memory, in megabytes.


(click to see Properties )

  • GET (ALL)

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

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.

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

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

HTTP Method: GET

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

Response Header:


Response Payload:

{  "systemmemory": [ {