Collect_NetScaler_System_Stats

The Collect_NetScaler_System_Stats collection extension collects NetScaler System Statistics data from a Citrix NetScaler.

  • Type: Collection

  • Source of data: Citrix NetScaler NitroAPI: /nitro/v1/stat/system

  • Tables created: DYNC_CitrixNetScalerSystemStats

  • Log files created: Collect_NetScaler_System_Stats.log

Columns

The following table explains the columns created by Collect_NetScaler_System_Stats:

Name

Type

Display Name

Description

name

String

name

This is the NetScaler device.

cpuusage

Double

cpuusage

CPU utilization percentage.

rescpuusage

Double

rescpuusage

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

slavecpuusage

Double

slavecpuusage

CPU 1 utilization, as percentage of capacity. Not applicable for a single-CPU system.

mastercpuusage

Double

mastercpuusage

CPU 0 utilization, as percentage of capacity.

numcpus

Double

numcpus

The number of CPUs on the NetScaler appliance.

memusagepcnt

Double

memusagepcnt

Percentage of memory utilization on NetScaler.

memuseinmb

Double

memuseinmb

Main memory currently in use, in megabytes.

addimgmtcpuusagepcnt

Double

addimgmtcpuusagepcnt

Additonal Management CPU utilization percentage.

mgmtcpu0usagepcnt

Double

mgmtcpu0usagepcnt

Management CPU0 utilization percentage.

mgmtcpuusagepcnt

Double

mgmtcpuusagepcnt

Average Management CPU utilization percentage.

pktcpuusagepcnt

Double

pktcpuusagepcnt

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

cpuusagepcnt

Double

cpuusagepcnt

CPU utilization percentage.

rescpuusagepcnt

Double

rescpuusagepcnt

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

starttime

String

starttime

Time when the NetScaler appliance was last started.

disk0perusage

Double

disk0perusage

Used space in flash partition of the disk, as a percentage.

disk1perusage

Double

disk1perusage

Used space in var partition of the disk, as a percentage.

disk0size

Double

disk0size

Size of flash partition of the hard disk.

disk0used

Double

disk0used

Used space in flash partition of the hard disk.

disk0avail

Double

disk0avail

Available space in flash partition of the hard disk.

disk1size

Double

disk1size

Size of var partition of the hard disk.

disk1used

Double

disk1used

Used space in var partition of the hard disk.

disk1avail

Double

disk1avail

Available space in var partition of the hard disk.

timesincestart

String

timesincestart

Seconds since the NetScaler appliance started.

memsizemb

Double

memsizemb

Total amount of system memory, in megabytes.

Files

The following files are created for Collect_NetScaler_System_Stats:

  • Collect_NetScaler_System_Stats.bat: Calls the PowerShell script that is doing the actual collection.

  • Collect_NetScaler_System_Stats.metadata: Collection extension instructions used by SysTrack.

  • Collect_NetScaler_System_Stats.ps1: PowerShell script that does the collections.