PDF

NCCLI NetCrunch Utilities

You can use NCCLI to execute commands served by the NetCrunch Server

The nccli command-line utility is a powerful tool designed for administrators and advanced users to perform various tasks, such as exporting trend and event data from nodes in a network. This utility offers flexibility in specifying time ranges, output formats, and other parameters to ensure that the exported data meets your specific needs. The following documentation outlines the usage, parameters, and examples for effectively using the nccli utility.

Usage

nccli.exe <command> [parameters]

Supported Commands:
  • reset-admin-password
  • generate-web-certificate
  • run-task run-task -task backup | auto-scan | reports | trend-compress
  • export-trend
  • export-events

export-trend

Usage

nccli.exe export-trend -node node -counter counter -from fromDate [-to toDate] [-file fileName] [-date-format format]

Parameters:
  • node: Node name, address, or ID.
  • counter: Counter path, e.g.: Processor(_Total)\% Processor Time.
  • from: Starting date.
  • to: End date. If the parameter is not specified, the program will only export data for a single day.
  • hour-from: Starting hour (0-23). Default: 0.
  • hour-to: Ending hour (0-23). Default: 23.
  • file: Output file name (full path). Default <Atlas data folder>\TrendExport.
  • local-date: Save trend time using local date.
  • date-format: Date output format. Available options are:
    • iso: 2024-06-03T08:17:48.291Z
    • local: 6/3/2024 10:17:48 AM
    • sql (default): 2024-06-03 10:17:48

export-events

Usage

nccli.exe export-events -node node -from fromDate [-to toDate] [-file fileName] [-output dataFormat] [-local-time] [-date-format format]

Parameters:
  • node: Node name, address, or ID.
  • from: Starting date.
  • to: End date. If the parameter is not specified, the program will only export data for a single day.
  • hour-from: Starting hour (0-23). Default: 0.
  • hour-to: Ending hour (0-23). Default: 23.
  • file: Output file name (full path). Default <Atlas data folder>\EventExport.
  • output: Output data format. Available options:
    • CSV (default)
    • JSONL: Event parameters will be included only in JSONL format.
  • local-date: Save event raise time using local date.
  • date-format: Date output format. Available options are:
    • iso: 2024-06-03T08:17:48.291Z
    • local: 6/3/2024 10:17:48 AM
    • sql (default): 2024-06-03 10:17:48

Examples

Export Trends

nccli.exe export-trend -node Node01 -counter "Processor(_Total)\% Processor Time" -from 2024-06-01 -to 2024-06-02 -file C:\Export\TrendData.csv -local-date -date-format iso

Export Events

nccli.exe export-events -node Node01 -from 2024-06-01 -to 2024-06-02 -file C:\Export\EventData.csv -output CSV -local-date -date-format iso

admincertificateclieventsexportexport eventsexport trendsexport-eventsimportpasswordpassword resetperformanceperformance exportresetreset admin passwordreset passwordtasktrends