Skip to content

systemmemory

Statistics for Global system memory stats resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
clearstats<String>Read-writeClear the statsistics / counters.
Possible values = basic, full
cacmemmaxmemlimitpcnt<Double>Read-onlyIntegrated Cache memory insue percent.
cacmemmaxmemlimit<Double>Read-onlyIntegrated Cache memory insue, in megabytes.
shmemerrallocfailed<Double>Read-onlyTotal shared memory allocation failed.
shmemallocpcnt<Double>Read-onlyShared memory insue percent.
shmemallocinmb<Double>Read-onlyShared memory insue, in megabytes.
shmemtotinmb<Double>Read-onlyTotal shared memory allowed to allocate, in megabytes.
memtotallocfailed<Double>Read-onlyTotal system memory allocation failed.
memtotfree<Double>Read-onlyTotal Free PE Memory in the System.
memusagepcnt<Double>Read-onlyPercentage of memory utilization on Citrix ADC.
memtotuseinmb<Double>Read-onlyTotal Citrix ADC Memory in use, in megabytes.
memtotallocpcnt<Double>Read-onlyCurrently allocated memory in percent.
memtotallocmb<Double>Read-onlyCurrently allocated memory, in megabytes.
memtotinmb<Double>Read-onlyTotal memory available (grabbed) for use by packet engine (PE), in megabytes.
memtotavail<Double>Read-onlyTotal system memory available for PE to grab from the system.
cacmemmaxsyslimitmb<Double>Read-onlyIntegrated Cache memory, in megabytes.

Operations

(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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/systemmemory

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse 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>
}]}