statsystemResult Structure Definition

The statsystemResult structure defines the return type for statsystem API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

systemList

Pointer to the system List.


systemstats Structure Definition

The systemstats structure defines the actual return type values for statsystem API.

Syntax



Members

clearstats

Clear the statsistics / counters

_nextgenapiresource


voltagev12n

Power supply -12V output. Acceptable range is -13.20 through -10.80 volts. 9800 and 9960 platforms display standard value of -12.0V.

voltagev5n

Power supply -5V output. Acceptable range is -5.50 through -4.50 volts. 9800 and 9960 platforms display standard value of -5.0V.

cpuusage

CPU utilization percentage.

rescpuusage

Shows average CPU utilization percentage if more than 1 CPU is present.

slavecpuusage

CPU 1 (currently the slave CPU) utilization, as percentage of capacity. Not applicable for a single-CPU system.

mastercpuusage

CPU 0 (currently the master CPU) utilization, as percentage of capacity.

auxvolt7

Voltage of a device connected to health monitoring chip through pin 7.

auxvolt6

Voltage of a device connected to health monitoring chip through pin 6.

auxvolt5

Voltage of a device connected to health monitoring chip through pin 5.

auxvolt4

Voltage of a device connected to health monitoring chip through pin 4.

auxvolt3

Voltage of a device connected to health monitoring chip through pin 3.

auxvolt2

Voltage of a device connected to health monitoring chip through pin 2.

auxvolt1

Voltage of a device connected to health monitoring chip through pin 1.

auxvolt0

Voltage of a device connected to health monitoring chip through pin 0.

voltagevsen2

Voltage Sensor 2 Input. Currently only 13k Platforms will have valid value for this counter and for older platforms this will be 0.

voltagev5sb

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

Intel CPU Vtt power. Currently only 13k Platforms will have valid value for this counter and for older platforms this will be 0.

voltagevbat

Onboard battery power supply output. 9800 and 9950 platforms display standard value of 5.0V.

voltagev12p

Power supply +12V output. Acceptable range is 10.80 through 13.20 volts.

voltagev5p

Power supply +5V output. Acceptable range is 4.50 through 5.50 volts.

voltagev33stby

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

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

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

CPU core 0 voltage. Acceptable range is 1.080 through 1.650 volts.

numcpus

The number of CPUs on the Citrix ADC.

memusagepcnt

Percentage of memory utilization on Citrix ADC.

memuseinmb

Main memory currently in use, in megabytes.

addimgmtcpuusagepcnt

Additonal Management CPU utilization percentage.

mgmtcpu0usagepcnt

Management CPU-0 utilization percentage.

mgmtcpuusagepcnt

Average Management CPU utilization percentage.

pktcpuusagepcnt

Average CPU utilization percentage for all packet engines excluding management PE.

cpuusagepcnt

CPU utilization percentage.

rescpuusagepcnt

Average CPU utilization percentage. Not applicable for a single-CPU system.

starttimelocal

Time (in local timezone format) when the Citrix ADC was last started.

starttime

Time when the Citrix ADC was last started.

disk0perusage

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

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

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

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

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

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

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

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

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

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

Power supply 1 failure status.
Possible Values : NORMAL, NOT PRESENT, FAILED, NOT SUPPORTED.

powersupply2status

Power supply 2 failure status.
Possible Values : NORMAL, NOT PRESENT, FAILED, NOT SUPPORTED.

powersupply3status

Power supply 3 failure status.
Possible Values : NORMAL, NOT PRESENT, FAILED, NOT SUPPORTED.

powersupply4status

Power supply 4 failure status.
Possible Values : NORMAL, NOT PRESENT, FAILED, NOT SUPPORTED.

disk0size

Size of /flash partition of the hard disk.

disk0used

Used space in /flash partition of the hard disk.

disk0avail

Available space in /flash partition of the hard disk.

disk1size

Size of /var partition of the hard disk.

disk1used

Used space in /var partition of the hard disk.

disk1avail

Available space in /var partition of the hard disk.

fan2speed

Speed of Fan 0 if associated pin is connected to health monitoring chip.

fan3speed

Speed of Fan 1 if associated pin is connected to health monitoring chip.

fan4speed

Speed of Fan 2 if associated pin is connected to health monitoring chip.

fan5speed

Speed of Fan 3 if associated pin is connected to health monitoring chip.

auxtemp0

Temperature of a device connected to health monitoring chip through pin 0.

auxtemp1

Temperature of a device connected to health monitoring chip through pin 1.

auxtemp2

Temperature of a device connected to health monitoring chip through pin 2.

auxtemp3

Temperature of a device connected to health monitoring chip through pin 3.

timesincestart

Seconds since the Citrix ADC started.

memsizemb

Total amount of system memory, in megabytes.

cpuuse

CPU utilization: percentage * 10.

numcpus

The number of CPUs on the Citrix ADC.

mgmtcpuuse

Management CPU utilization: percentage * 10.

mgmtcpu0use

Management CPU-0 utilization: percentage * 10.

mgmtadditionalcpuuse

Additonal Management CPU utilization: percentage * 10.

voltagevcc0

CPU core 0 voltage. Acceptable range is 1.080 through 1.650 volts.

voltagevcc1

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.

voltagev33main

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.

voltagev33stby

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.

voltagev5p

Power supply +5V output. Acceptable range is 4.50 through 5.50 volts.

voltagev12p

Power supply +12V output. Acceptable range is 10.80 through 13.20 volts.

voltagevbat

Onboard battery power supply output. 9800 and 9950 platforms display standard value of 5.0V.

voltagevtt

Intel CPU Vtt power. Currently only 13k Platforms will have valid value for this counter and for older platforms this will be 0.

voltagev5sb

Power Supply 5V Standby Voltage. Currently only 13k Platforms will have valid value for this counter and for older platforms this will be 0.

voltagevsen2

Voltage Sensor 2 Input. Currently only 13k Platforms will have valid value for this counter and for older platforms this will be 0.

auxvolt0

Voltage of a device connected to health monitoring chip through pin 0.

auxvolt1

Voltage of a device connected to health monitoring chip through pin 1.

auxvolt2

Voltage of a device connected to health monitoring chip through pin 2.

auxvolt3

Voltage of a device connected to health monitoring chip through pin 3.

auxvolt4

Voltage of a device connected to health monitoring chip through pin 4.

auxvolt5

Voltage of a device connected to health monitoring chip through pin 5.

auxvolt6

Voltage of a device connected to health monitoring chip through pin 6.

auxvolt7

Voltage of a device connected to health monitoring chip through pin 7.

mastercpuuse

CPU0 utilization: percentage * 10.

slavecpuuse

CPU1 utilization, percentage * 10.

voltagev5n

Power supply -5V output. Acceptable range is -5.50 through -4.50 volts. 9800 and 9960 platforms display standard value of -5.0V.

voltagev12n

Power supply -12V output. Acceptable range is -13.20 through -10.80 volts. 9800 and 9960 platforms display standard value of -12.0V.

See Also