Citrix ADC 12.1 NITRO API Reference

system

August 17, 2023

Contributed by:

Statistics for system.

Properties

(click to see Operations)

Name	Permissions	Description
clearstats	Read-write	Clear the statsistics / counters. Possible values = basic, full
voltagev12n	Read-only	Power supply -12V output. Acceptable range is -13.20 through -10.80 volts. 9800 and 9960 platforms display standard value of -12.0V.
voltagev5n	Read-only	Power supply -5V output. Acceptable range is -5.50 through -4.50 volts. 9800 and 9960 platforms display standard value of -5.0V.
cpuusage	Read-only	CPU utilization percentage.
rescpuusage	Read-only	Shows average CPU utilization percentage if more than 1 CPU is present.
slavecpuusage	Read-only	CPU 1 (currently the slave CPU) utilization, as percentage of capacity. Not applicable for a single-CPU system.
mastercpuusage	Read-only	CPU 0 (currently the master CPU) utilization, as percentage of capacity.
auxvolt7	Read-only	Voltage of a device connected to health monitoring chip through pin 7.
auxvolt6	Read-only	Voltage of a device connected to health monitoring chip through pin 6.
auxvolt5	Read-only	Voltage of a device connected to health monitoring chip through pin 5.
auxvolt4	Read-only	Voltage of a device connected to health monitoring chip through pin 4.
auxvolt3	Read-only	Voltage of a device connected to health monitoring chip through pin 3.
auxvolt2	Read-only	Voltage of a device connected to health monitoring chip through pin 2.
auxvolt1	Read-only	Voltage of a device connected to health monitoring chip through pin 1.
auxvolt0	Read-only	Voltage of a device connected to health monitoring chip through pin 0.
voltagevsen2	Read-only	Voltage Sensor 2 Input. Currently only 13k Platforms will have valid value for this counter and for older platforms this will be 0.
voltagev5sb	Read-only	Power Supply 5V Standby Voltage. Currently only 13k Platforms will have valid value for this counter and for older platforms this will be 0.
voltagevtt	Read-only	Intel CPU Vtt power. Currently only 13k Platforms will have valid value for this counter and for older platforms this will be 0.
voltagevbat	Read-only	Onboard battery power supply output. 9800 and 9950 platforms display standard value of 5.0V.
voltagev12p	Read-only	Power supply +12V output. Acceptable range is 10.80 through 13.20 volts.
voltagev5p	Read-only	Power supply +5V output. Acceptable range is 4.50 through 5.50 volts.
voltagev33stby	Read-only	Standby power supply +3.3V output. Acceptable range is 2.970 through 3.630 volts. 9800 and 9960 platforms display standard value of 3.3V. You can configure Standby 3.3V Supply Voltage by using the Set snmp alarm VOLTAGE-LOW command to set the lower limit and the Set snmp alarm VOLTAGE-HIGH command to set the upper limit.
voltagev33main	Read-only	Main power supply +3.3V output. Acceptable range is 2.970 through 3.630 volts. This is a critical counter. You can configure Main 3.3V Supply Voltage, by using the Set snmp alarm VOLTAGE-LOW command to set the lower limit and the Set snmp alarm VOLTAGE-HIGH command to set the upper limit.
voltagevcc1	Read-only	CPU core 1 voltage. Acceptable range is 1.080 through 1.650 volts. If CPU 1 is not connected to the health monitoring chip, display shows voltage of CPU 0.
voltagevcc0	Read-only	CPU core 0 voltage. Acceptable range is 1.080 through 1.650 volts.
numcpus	Read-only	The number of CPUs on the Citrix ADC.
memusagepcnt	Read-only	Percentage of memory utilization on Citrix ADC.
memuseinmb	Read-only	Main memory currently in use, in megabytes.
addimgmtcpuusagepcnt	Read-only	Additonal Management CPU utilization percentage.
mgmtcpu0usagepcnt	Read-only	Management CPU-0 utilization percentage.
mgmtcpuusagepcnt	Read-only	Average Management CPU utilization percentage.
pktcpuusagepcnt	Read-only	Average CPU utilization percentage for all packet engines excluding management PE.
cpuusagepcnt	Read-only	CPU utilization percentage.
rescpuusagepcnt	Read-only	Average CPU utilization percentage. Not applicable for a single-CPU system.
starttimelocal	Read-only	Time (in local timezone format) when the Citrix ADC was last started.
starttime	Read-only	Time when the Citrix ADC was last started.
disk0perusage	Read-only	Used space in /flash partition of the disk, as a percentage. This is a critical counter. You can configure /flash Used (%) by using the Set snmp alarm DISK-USAGE-HIGH command.
disk1perusage	Read-only	Used space in /var partition of the disk, as a percentage. This is a critical counter. You can configure /var Used (%) by using the Set snmp alarm DISK-USAGE-HIGH command.
cpufan0speed	Read-only	CPU Fan 0 speed. Acceptable range is 3000 through 6000 RPM. This is a critical counter. You can configure CPU Fan 0 Speed by using the Set snmp alarm FAN-SPEED-LOW command to set the lower limit.
cpufan1speed	Read-only	CPU Fan 1 speed. Acceptable range is 3000 through 6000 RPM. 7000 platform displays speed of CPU fan 0. This is a critical counter. You can configure CPU Fan 1 Speed by using the Set snmp alarm FAN-SPEED-LOW command to set the lower limit.
systemfanspeed	Read-only	System fan speed. Acceptable range is 3000 through 6000 RPM. This is a critical counter. You can configure System Fan Speed by using the Set snmp alarm FAN-SPEED-LOW command to set the lower limit.
fan0speed	Read-only	System fan 1 speed. For new platforms associated pin is connected to CPU supporting fans. For platforms in which it is not connected, it will point to System Fan.
fanspeed	Read-only	System fan 2 speed. For new platforms associated pin is connected to CPU supporting fans. For platforms in which it is not connected, it will point to System Fan
cpu0temp	Read-only	CPU 0 temperature. 9800 and 9960 platforms display internal chip temperature. This is a critical counter. You can configure CPU 0 Temperature by using the Set snmp alarm TEMPERATURE-HIGH command to set the upper limit.
cpu1temp	Read-only	CPU 1 temperature. 9800 and 9960 platforms display internal chip temperature. 7000, 9010 and 10010 platforms display CPU 0 temperature. This is a critical counter. You can configure CPU 1 Temperature by using the Set snmp alarm TEMPERATURE-HIGH command to set the upper limit.
internaltemp	Read-only	Internal temperature of health monitoring chip. This is a critical counter. You can configure Internal Temperature by using the Set snmp alarm TEMPERATURE-HIGH command to set the upper limit.
powersupply1status	Read-only	Power supply 1 failure status.
powersupply2status	Read-only	Power supply 2 failure status.
powersupply3status	Read-only	Power supply 3 failure status.
powersupply4status	Read-only	Power supply 4 failure status.
disk0size	Read-only	Size of /flash partition of the hard disk.
disk0used	Read-only	Used space in /flash partition of the hard disk.
disk0avail	Read-only	Available space in /flash partition of the hard disk.
disk1size	Read-only	Size of /var partition of the hard disk.
disk1used	Read-only	Used space in /var partition of the hard disk.
disk1avail	Read-only	Available space in /var partition of the hard disk.
fan2speed	Read-only	Speed of Fan 0 if associated pin is connected to health monitoring chip.
fan3speed	Read-only	Speed of Fan 1 if associated pin is connected to health monitoring chip.
fan4speed	Read-only	Speed of Fan 2 if associated pin is connected to health monitoring chip.
fan5speed	Read-only	Speed of Fan 3 if associated pin is connected to health monitoring chip.
auxtemp0	Read-only	Temperature of a device connected to health monitoring chip through pin 0.
auxtemp1	Read-only	Temperature of a device connected to health monitoring chip through pin 1.
auxtemp2	Read-only	Temperature of a device connected to health monitoring chip through pin 2.
auxtemp3	Read-only	Temperature of a device connected to health monitoring chip through pin 3.
timesincestart	Read-only	Seconds since the Citrix ADC started.
memsizemb	Read-only	Total amount of system 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/system

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/stat/system?args=detail:<Boolean_value>,fullvalues:<Boolean_value>,ntimes:<Double_value>,logfile:<String_value>,clearstats:<String_value>

Use this query-parameter to get system 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:

{ "system": [ {
"voltagevbat":<Double_value>,
"auxvolt2":<Double_value>,
"addimgmtcpuusagepcnt":<Double_value>,
"voltagev5n":<Double_value>,
"auxvolt7":<Double_value>,
"cpu0temp":<Double_value>,
"fan0speed":<Double_value>,
"disk1perusage":<Double_value>,
"rescpuusagepcnt":<Double_value>,
"disk1used":<Double_value>,
"disk1avail":<Double_value>,
"fan4speed":<Double_value>,
"rescpuusage":<Double_value>,
"powersupply3status":<String_value>,
"auxvolt5":<Double_value>,
"auxvolt3":<Double_value>,
"disk0perusage":<Double_value>,
"fan2speed":<Double_value>,
"powersupply4status":<String_value>,
"auxvolt1":<Double_value>,
"fanspeed":<Double_value>,
"fan5speed":<Double_value>,
"disk0size":<Double_value>,
"mgmtcpuusagepcnt":<Double_value>,
"cpuusage":<Double_value>,
"voltagev5sb":<Double_value>,
"disk0used":<Double_value>,
"powersupply1status":<String_value>,
"cpufan0speed":<Double_value>,
"disk1size":<Double_value>,
"auxtemp1":<Double_value>,
"numcpus":<Double_value>,
"pktcpuusagepcnt":<Double_value>,
"voltagev5p":<Double_value>,
"voltagevsen2":<Double_value>,
"auxvolt0":<Double_value>,
"auxtemp2":<Double_value>,
"memsizemb":<Double_value>,
"voltagev33main":<Double_value>,
"cpu1temp":<Double_value>,
"voltagev12n":<Double_value>,
"memuseinmb":<Double_value>,
"auxtemp3":<Double_value>,
"internaltemp":<Double_value>,
"voltagev12p":<Double_value>,
"disk0avail":<Double_value>,
"voltagev33stby":<Double_value>,
"voltagevcc1":<Double_value>,
"fan3speed":<Double_value>,
"voltagevtt":<Double_value>,
"auxtemp0":<Double_value>,
"cpufan1speed":<Double_value>,
"voltagevcc0":<Double_value>,
"auxvolt4":<Double_value>,
"starttime":<String_value>,
"systemfanspeed":<Double_value>,
"starttimelocal":<String_value>,
"cpuusagepcnt":<Double_value>,
"mastercpuusage":<Double_value>,
"timesincestart":<String_value>,
"mgmtcpu0usagepcnt":<Double_value>,
"auxvolt6":<Double_value>,
"slavecpuusage":<Double_value>,
"memusagepcnt":<Double_value>,
"powersupply2status":<String_value>
}]}

<!--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

system

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

system

Properties

Operations

get (all)

In this article