2. Public NGCP tools

NameDescription

Configuration tools:

ngcpcfg

main NGCP configuration tool

ngcp-initial-configuration

tool to configure bare node as NGCP (cluster) member

ngcp-insert-pbx-devices

tool to handle PBX hardware phone firmare/configurations

ngcp-network

command line interface to ngcp-config network configuration settings

ngcp-support-access

tool to enable/disable Sipwise Support team access to NGCP

ngcp-toggle-performance-config

tool to switch NGCP performance modes: low/high

Maintenance tools:

ngcp-approx-cache-helper

helper to update cached APT metadata in Approx

ngcp-customtt-diff-helper

helper to prepare local customtt/patchtt files for Sipwise analyses

ngcp-loglevel

tool to show/set debug level per component in run-time

ngcp-ppa

tool to handle Sipwise PPA APT repositories for NGCP customization

ngcp-prepare-upgrade

tool to prepare NGCP to upgrade to the new release/build

ngcp-reset-db

tool to reset MariaDB database. NOTE: think twice before calling it!

ngcp-sync-db

tool to sync MariaDB instances and configure replication between them

ngcp-update

wrapper for the latest hotfixes installations inside the same release

ngcp-update-cfg-schema

tool to update ngcp-config YML files. Safe to re-execute

ngcp-update-db-schema

tool to upgrade MariaDB. Safe to re-execute

ngcp-upgrade

Sipwise NGCP platform upgrade framework to upgrade on new release/build. Execute with caution!

ngcp-upgrade-pre-checks

tool to check possible issues/misconfigurations before the upgrade

Operational tools:

ngcp-active-calls

show/drop active calls matching search criteria

ngcp-cdr-md5

tool to validate the integrity of exported CDR files

ngcp-check-active

show HA node status (active/standby)

ngcp-check-redis-dialogs

script to check stalled Kamailio dialogs in Redis DB

ngcp-clish

CISCO-like CLI on a UNIX system. Provides various cluster helpers

ngcp-collective-check

main self-monitoring tool

ngcp-debug-subscriber

forward particular subscriber to "debug proxy" node

ngcp-disk-usage

disk usage statistic tool (symlink to ncdu)

ngcp-kamcmd

Kamailio console debug tool

ngcp-kamctl

Kamailio command-line interface

ngcp-log-flow

create a call flow of a single Call-ID taking NGCP logs as input

ngcp-logs

search a string in NGCP logs. Useful to retrieve Kamailio and SEMS logs given a call-id

ngcp-lookup-obfuscated

GDPR related tool to show unobfuscated plain text string from its obfuscated version

ngcp-make-active

make HA node active (revoke standby HA state from the peer)

ngcp-make-standby

make HA node standby (revoke active HA state from the peer)

ngcp-mariadb-replication-check

check the status of MariaDB replications

ngcp-memory-usage

tool to report processes with the biggest RAM/SWAP usage

ngcp-mysql-compare-dbs

fast tool to compare MariaDB schemas between two hosts

ngcp-mysql-central

helper to connect to central MariaDB instance

ngcp-mysql-local

helper to connect to local MariaDB instance

ngcp-mysql-pair

helper to connect to pair MariaDB instance

ngcp-parallel-scp

tool for parallel copying of local file(s) to cluster nodes

ngcp-parallel-ssh

tool for parallel execution of commands on NGCP cluster nodes

ngcp-redis-helper

tool for easier various data requests from Redis DB

ngcp-service

tool to manage NGCP system services. See man ngcp-service for more details

ngcp-status

tool to show general overall NGCP status. It is a wrapper for many NGCP tools

ngcp-support-upload

tool to upload files to the ticket on support.sipwise.com

ngcp-sync-db-wrapper

wrapper to run ngcp-sync-db easier

ngcp-system-tests

main self-check tool. Safe to execute in production

ngcp-usr-location

tool to show the correct VoIP registrations (from Redis DB). See ngcp-usr-location --help

REST API tools:

ngcp-api-admins

tool to manage NGCP Administrators

ngcp-api-delete

tool to send arbitrary DELETE request to NGCP REST API

ngcp-api-get

tool to send arbitrary GET request to NGCP REST API

ngcp-api-patch

tool to send arbitrary PATCH request to NGCP REST API

ngcp-api-ping

self-test tool to ping NGCP REST API availability

ngcp-api-post

tool to send arbitrary POST request to NGCP REST API

ngcp-api-put

tool to send arbitrary PUT request to NGCP REST API

ngcp-create-customer

tool to create NGCP Customer

ngcp-create-domain

tool to create NGCP Domain

ngcp-create-subscriber

tool to create NGCP Subscriber

ngcp-delete-domain

tool to delete an NGCP Domain. Execute with caution (subscribers are deleted with a domain)!

ngcp-get-customer

tool to get customer info by the customer ID

ngcp-terminate-customer

tool to terminate an NGCP Customer

ngcp-terminate-subscriber

tool to terminate an NGCP Subscriber

Deprecated tools (will be removed soon):

ngcp-delete-subscriber

backward compatibility symlink to ngcp-terminate-subscriber

ngcp-delete-voip-account

backward compatibility symlink to ngcp-terminate-customer

ngcp-get-voip-account

backward compatibility symlink to ngcp-get-customer

ngcp-mysql-replication-check

backward compatibility symlink to ngcp-mariadb-replication-check

ngcp-voicemail-table-cleanup

backward compatibility symlink to ngcp-cleanup-voicemail-table