update_config
To update retranslator configuration, use the retranslator/update_config command:
svc=retranslator/update_config¶ms={"itemId":<long>,
"config":{
"protocol":<text>,
"server":<text>,
"port":<ushort>,
"v6type":<text>,
"auth":<text>,
"attach_sensors":<bool>,
"ssl":<text>,
"login":<text>,
"password":<text>,
"notauth":<int>
}}
Parameters
The request can contain the following parameters. The required parameters are marked with an asterisk (*).
| Name | Description |
|---|---|
| itemId* | Retranslator ID. |
| config* | Configuration. The set of parameters in the object config depends on the protocol type. |
| protocol* | Protocol name (see below). |
| server* | Server for retransmission. |
| port* | Port (for all protocols except NIS) |
| v6type* | Use protocol v.6 (only for Granit Navigator): |
| auth* | Authorization (only for NIS and Wialon IPS) |
| attach_sensors | Retranslate calculated sensor values (for Wialon IPS & Wialon Retranslator) The parameter is optional. |
| ssl* | Secure connection (for NIS): |
| login* | Login. |
| password* | Password. |
| notauth* | Disable authorization (only for EGTS): |
Protocols
| Value | Protocol |
|---|---|
| wialon | Wialon Retranslator |
| wialon_ips | Wialon IPS |
| nis | Nis |
| granit3 | Granit Navigator |
| skaut | Skaut |
| cyber_glx | Cyber GLX |
| vt300 | VT300 |
| egts | EGTS |
| soap | SOAP |
Response
If the request is completed successfully, a response of the following format is returned:
{
"rtrc":{
"port":<ushort>, /* Port (for all except NIS). */
"protocol":<text>, /* Protocol. */
"server":<text>, /* Server for retransmission. */
"v6type":<text>, /* Protocol v.6 (only for Granit Navigator): 1 — yes, 0 — no. */
"auth":<text>, /* Authorization (only for NIS and Wialon IPS). */
"ssl":<text>, /* Secure connection (for NIS): 1 — yes, 0 — no */
"login":<text>, /* Login. */
"password":<text>, /* Password. */
"notauth":<int> /* Disable authorization (only for EGTS): 0 — no, 1 — yes. */
}
}
Otherwise, an error code is returned.
Error codes
| Error code | Description |
|---|---|
| 4 | Failed to parse input parameters or failed to set the configuration. |
| 7 | No ADF_ACL_AVL_RETR_EDIT_SETTINGS access right to the retranslator. |
| 6 | Failed to generate the response. |