Adapter - NVS
This page describes version 2.0.7 of the adapter.
Overview
This adapter connects to an NVS Cloud SIP Interface to provide remote maintenance features.
This initial release can gather logs, system status information, restart the OpenSIPS service, gather software versions, and collect process data.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| serviceAddress | NVS API Service Address | True | The hostname or IP address for the NVS system | string | 1024 | ||||
| servicePort | NVS API Service Port | True | The port used to connect to the NVS API service. | integer | 7281 | 65535 | 1 | ||
| serviceSsl | Use Secure Connection (SSL) | False | Checked if secured connection with certificate is required. | boolean | false | ||||
| apiKey | NVS API Key | True | The NVS API Key necessary to access the API service. | password | 1024 | ||||
| If the NVS web service where the adapter connects does not use an SSL connection, the API Key entered is not checked by NVS and does not apply. |
Commands
Get Logs (getLogs)
Used to gather logs from the NVS system. Returns a zipped TAR file (.tgz) as a base64 encoded string that contains the logs and other data that engineering can use to debug when needed.
Response Properties
| Name | Description | Type |
|---|---|---|
| tgzFile | Returns a Base64 encoded zipped TAR (.tgz) file that contains the log files. | string |
Get OpenSIPS Status (getOpenSIPSStatus)
Gets the status of the OpenSIPS process.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status returned from API call. | string |
| data.running | Indicates whether the process is running. | string |
| data.exit_code | Exit code. | string |
| data.first | . | string |
| data.loaded | . | string |
| data.Active | . | string |
| data.main_pid | . | string |
| data.tasks | . | string |
| message | Message returned from the API call. | string |
| error | Error message in case of failure. | string |
Get SIP Status (getSIPStatus)
Gets the status of all the SIP components the local PJ SIP stack and the forward facing OpenSIPs stack.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status returned from API call. | string |
| data.internalSipStatus.id | Internal SIP ID assigned in the database. | string |
| data.internalSipStatus.active_gw_url | Address and port of the active server. | string |
| data.internalSipStatus.gw_url_list | List of gateway URLs same format as Active Gateway Server URL just in list format. | array |
| data.internalSipStatus.gw_status_list | One to one list of the connected state of the Gateway Server URLs. | array |
| data.internalSipStatus.active_call_count | Number of active calls. | string |
| data.internalSipStatus.tls_cert_installed | Indicates if TLS certificate is installed (not needed). | boolean |
| data.internalSipStatus.tls_pkey_installed | Used for doing private key authentication (not needed). | boolean |
| data.internalSipStatus.tls_ca_installed | Indicates if a certificate authority was installed (not needed). | boolean |
| data.internalSipStatus.tls_crl_installed | Indicates if a certificate revocation list was installed (not needed). | boolean |
| data.internalUACStatus.id | Internal UAC Id assigned in the database. | string |
| data.internalUACStatus.app_number | The Id assigned to the application. | string |
| data.internalUACStatus.app_type | The type of application. By default only NVS is needed. | string |
| data.internalUACStatus.capacity | Number of circuits. | string |
| data.internalUACStatus.reg_name | The name of the registered account. | string |
| data.internalUACStatus.reg_active | Indicates whether the account is registered. | boolean |
| data.internalUACStatus.reg_sip_status | SIP status code of the last registered message. | string |
| data.internalUACStatus.reg_expires | Seconds until we expire should retry before it hits zero. | string |
| data.internalUACStatus.circuits_active | Indicates whether there is an active call on one of the circuits. | boolean |
| data.sbcUACs.Records | UAC Records. | array |
| message | Message returned from the API call. | string |
| error | Error message in case of failure. | string |
Get Software Versions (getVersion)
Retrieves the software package version.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status of the API call. | string |
| data.pkgVersion | The software package version returned from the NVS. | string |
| data.apiVersions | A string array of the API versions available. | array |
| message | Message returned from the API call. | string |
| error | Error message in case of failure | string |
List OpenSIPS Statistics (listStats)
Request list of available statistics from OpenSIPS.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status of the API call. | string |
| data | List of statistic data. | array |
| message | Message returned from the API call. | string |
| error | Error message in case of failure | string |
Request Process Data (requestProcessData)
List all OpenSIPS processes.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status returned from API call. | string |
| data.Processes | List of the OpenSIPS processes. | array |
| data.Processes.ID | Assigned process Id. | string |
| data.Processes.PID | Process PID. | string |
| data.Processes.Type | Process type. | string |
| message | Message returned from the API call. | string |
| error | Error message in case of failure | string |
Restart OpenSIPS (restartOpenSIPS)
OpenSIPs is not running by default this will kill it if needed and restart it
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status of the API call. | string |
| message | Message returned from the API call. | string |
| error | Error message in case of failure | string |
Update Registrant Data (updateData)
Updates local registrant data table from the cloud and reloads the database into OpenSIPS.
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status of the API call. | string |
| message | Message returned from the API call. | string |
| data | Data field returned from NVS. | string |
Get Statistics (getStats)
Request specific statistics from OpenSIPS.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| statistics | Statistics | A list of desired statistics to gather, separated by commas. Ex: rcv_requests, rcv_replies | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status of the API call. | string |
| message | Message returned from the API call. | string |
| data | Data field returned from NVS. | array |
Reset Statistics (resetStats)
Reset specific statistics in OpenSIPS.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| statistics | Statistics | A list of desired statistics to reset, separated by commas. Ex: rcv_requests, rcv_replies | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status of the API call. | string |
| message | Message returned from the API call. | string |
| data | Data field returned from NVS. | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.3 | Initial | First release in the Adapter Type store. | ||
| 2.0.5 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.7 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-30 |