Statistics sub-tree overview

The statistics sub-tree (enterprises.nCipher.nC-series.statistics) contains rapidly changing information about such topics as the state of the nShield modules, the work they are doing, and the commands being submitted.

Do not rely on information returned from the agent to change instantaneously on re-reading the value. To avoid loading the nShield module with multiple time-consuming statistics commands, the agent can choose to cache the values over a specified period. You can configure this period in the agent configuration file see Basic configuration.

Statistics sub-tree

The following table gives details of the nodes in the statistics sub-tree, and the module statistics table (enterprises.nCipher.nC-series.statistics.moduleStatsTable):

Node name R/W Type Remarks

moduleStatsIndex

R

Integer

Module number of this row (for moduleStatsTable).

hsUptime

R

Counter32

Uptime of the hardserver.

cmdCountAll

R

Counter32

Returned aggregated for all modules and all commands.

cmdBytesAll

R

Counter32

cmdErrorsAll

R

Counter32

Returned as for cmdCount, returned value is combined module errors added to hardserver marshalling/unmarshalling errors.

replyCountAll

R

Counter32

replyBytesAll

R

Counter32

replyErrorsAll

R

Counter32

See notes above for cmdErrors.

clientCount

R

Gauge32

maxClients

R

Counter32

deviceFails

R

Counter32

deviceRestarts

R

Counter32

outstandingCmds

R

Counter32

Total number of outstanding commands over all modules.

loadAll

R

Counter32

Module statistics table

The following table gives details of the nodes in the module statistics table (enterprises.nCipher.nC-series.statistics.moduleStatsTable):

Node name R/W Type Remarks

moduleStatsIndex

R

Integer

Module number of this row (for moduleStatsTable).

uptime

R

Counter32

Uptime of the module.

cmdCount

R

Counter32

Returned aggregated for all commands.

cmdBytes

R

Counter32

cmdErrors

R

Counter32

Returned as for cmdCount all the different error states aggregated into one counter.

replyCount

R

Counter32

replyBytes

R

Counter32

replyErrors

R

Counter32

See notes above for cmdErrors.

loadModule

R

Counter32

objectCount

R

Gauge32

clock

R

DisplayString

Depending on the module settings, this can require KNSO permissions to read (and therefore depend on the installation parameters of the agent).

currentTemp

R

DisplayString

Character representation of the current temperature value (SNMP does not provide for a floating-point type). Not available on XC or nShield 5 variants.

maxTemp

R

DisplayString

Maximum temperature the module has ever reached. Not available on XC or nShield 5 variants.

nvRAMInUse

R

Gauge32

volatileRAMInUse

R

Gauge32

tempSP

R

DisplayString

Only available on XC variants.

currentCPUTemp1

R

DisplayString

Only available on XC variants.

currentCPUTemp2

R

DisplayString

Only available on XC variants.

currentFanSpeed

R

DisplayString

Only available on XC variants.

currentFanDuty

R

DisplayString

Only available on XC variants.

cpuVoltage1

R

DisplayString

Only available on XC variants.

cpuVoltage2

R

DisplayString

Only available on XC variants.

cpuVoltage3

R

DisplayString

Only available on XC variants.

cpuVoltage4

R

DisplayString

Only available on XC variants.

cpuVoltage5

R

DisplayString

Only available on XC variants.

cpuVoltage6

R

DisplayString

Only available on XC variants.

cpuVoltage7

R

DisplayString

Only available on XC variants.

tempSP

R

DisplayString

Only available on nShield 5 variants.

currentCPUTemp1

R

DisplayString

Only available on nShield 5 variants.

currentCPUTemp2

R

DisplayString

Only available on nShield 5 variants.

currentFanSpeed

R

DisplayString

Only available on nShield 5 variants.

currentFanDuty

R

DisplayString

Only available on nShield 5 variants.

cpuVoltage1

R

DisplayString

Only available on nShield 5 variants.

cpuVoltage2

R

DisplayString

Only available on nShield 5 variants.

cpuVoltage3

R

DisplayString

Only available on nShield 5 variants.

cpuVoltage4

R

DisplayString

Only available on nShield 5 variants.

cpuVoltage5

R

DisplayString

Only available on nShield 5 variants.

cpuVoltage6

R

DisplayString

Only available on nShield 5 variants.

cpuVoltage7

R

DisplayString

Only available on nShield 5 variants.

cpuVoltage8

R

DisplayString

cpuVoltage8

R

DisplayString

cpuVoltage9

R

DisplayString

cpuVoltage10

R

DisplayString

cpuVoltage11

R

DisplayString

nvmFreeSpace

R

Counter32

Free space available on the HSM’s NVRAM, in bytes

Only available on XC and nShield 5 variants.

nvmWearLevel

R

DisplayString

Wear level of the HSM’s NVRAM

Only available on XC and nShield 5 variants.

nvmWornBlocks

R

DisplayString

Worn blocks in the HSM’s NVRAM

Only available on XC and nShield 5 variants.

nShield network-attached HSM statistics table

The following table gives details of the nodes in the nShield network-attached HSM statistics table (enterprises.nCipher.nC-series.statistics.netHSMStatsTable):

Node name R/W Type Remarks

netHSMStatsIndex

R

Integer

Table index (not module number).

netHSMUptime

R

Counter32

Host system uptime.

netHSMCPUUsage

R

Gauge32

CPU usage of unit host processor.

netHSMUserMem

R

Gauge32

Total user memory of unit.

netHSMKernelMem

R

Gauge32

Total kernel memory of unit.

netHSMCurrentTemp

R

DisplayString

Internal unit temperature (sensor 1).

netHSMMaxTemp

R

DisplayString

Maximum recorded temperature (sensor 1).

netHSMCurrentTemp2

R

DisplayString

Internal unit temperature (sensor 2).

netHSMMaxTemp2

R

DisplayString

Maximum recorded temperature (sensor 2).

netHSMVoltage5V

R

DisplayString

unit 5V power reading.

netHSMVoltage12V

R

DisplayString

unit 12V power reading.

netHSMFan1Speed

R

Gauge32

Fan 1 speed (RPM).

netHSMFan2Speed

R

Gauge32

Fan 2 speed (RPM).

netHSMFan3Speed

R

Gauge32

Fan 3 speed (RPM).

netHSMIPAddress

R

IpAddress

IP address of unit.

netHSMDescription

R

DisplayString

Textual description of module (for example, Local module 3).

netHSMFan4Speed

R

Gauge32

Fan 4 speed (RPM).

netHSMVoltage3p3V

R

DisplayString

3.3V Supply Rail Voltage

netHSMCurrent3p3V

R

DisplayString

3.3V Supply Rail Current

netHSMCurrent5V

R

DisplayString

5V Supply Rail Current

netHSMCurrent12V

R

DisplayString

12V Supply Rail Current

netHSMVoltage5VSB

R

DisplayString

5V Supply Rail Voltage (Standby)

netHSMCurrent5VSB

R

DisplayString

5V Supply Rail Current (Standby)

netHSMTamperBattery1

R

DisplayString

Voltage of Tamper Battery 1

netHSMTamperBattery2

R

DisplayString

Voltage of Tamper Battery 2

netHSMPSUFailure

R

TruthValue

Power Supply failure status

Per connection statistics table

The following table gives details of the nodes in the per connection statistics table (enterprises.nCipher.nC-series.statistics.connStatsTable):

Node name R/W Type Remarks

connStatsIndex

R

Integer32

Index of this entry.

connNumber

R

Integer32

Hardserver connection number.

connUptime

R

Counter32

Uptime of the connection.

connCmdCount

R

Counter32

Number of commands submitted through this connection.

connCmdBytes

R

Counter32

Number of bytes submitted through this connection.

connCmdErrors

R

Counter32

Number of marshalling errors on commands through this connection.

connReplyCount

R

Counter32

Number of replies received by this connection.

connReplyBytes

R

Counter32

Number of bytes received by this connection.

connReplyErrors

R

Counter32

Number of marshalling errors on replies through this connection.

connDevOutstanding

R

Gauge32

Number of commands outstanding on this connection.

connQOutstanding

R

Gauge32

Number of commands outstanding in the hardserver queue.

connLongOutstanding

R

Gauge32

Number of long jobs outstanding for this connection.

connRemoteIPAddress

R

IpAddress

IP Address of connection client.

connProcessID

R

Integer32

Process identifier reported by connection client.

connProcessName

R

DisplayString

Process name reported by connection client.

connObjectTotal

R

Gauge32

The total object count for a connection

Module/connection statistics table

The following table gives details of the nodes in the per module, per connection statistics table (enterprises.nCipher.nC-series.statistics.connModuleStatsTable).

Node name R/W Type Remarks

connModuleStatsConnId

R

Integer

Identity of this connection

connModuleStatsModuleIndex

R

Integer

Index of the module entry

connModuleStatsObjectCount

R

Gauge32

The object count on this module for this connection

Fan table

The fan table provides the speeds of each fan on the remote module (HSM). The following table gives details of the nodes in the fan table (enterprises.nCipher.softwareVersions.netHSMFanTable):

Node name R/W Type Remarks

netHSMModuleIndex

R

Integer32

Module number

netHSMFanIndex

R

Integer32

Fan number

netHSMFanSpeed

R

Gauge32

Fan speed (RPM)

Software versions table

The following table gives details of the nodes in the software versions table (enterprises.nCipher.softwareVersions.softwareVersionsTable):

Node name R/W Type Remarks

compIndex

R

Integer

Table index.

compName

R

DisplayString

Component name.

compOutput

R

Component output name

Component name.

compMajorVersion

R

Gauge

compMinorVersion

R

Gauge

compPatchVersion

R

Gauge

compRepository

R

DisplayString

Repository name.

compBuildNumber

R

Gauge