Incremental CLI Script

The /files/cliScript/incremental URL provides the ability to upload an incremental (partial) CLI script that can be applied to the device without reset.

The script may contain both configuration and “show” commands. Output of the script will be returned in the response.

The incremental CLI script may not contain “action” commands that require user interaction and/or take long time. For example, the “copy” command is not supported in CLI script passed via REST API. If you need to trigger file transfer initiated by the device, use Automatic Update configuration instead, for example:

configure system

  automatic-update

    firmware http://audc.com/ssbc_7.20A.200.014.cmp

URL

/api/v1/files/cliScript/incremental

HTTP Method

PUT

Request Content-Type

application/json 

HTTP Responses

200 OK
400 Bad request – provided CLI script is incorrect.
409 Conflict – CLI script can’t be loaded due to current device state (e.g. synchronization with the redundant device is in progress).

Example

Request:
PUT /api/v1/files/cliScript/incremental HTTP/1.1
Host: 10.4.219.229
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
 
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="cli.txt"
Content-Type: application/octet-stream
 
show system version
------WebKitFormBoundary7MA4YWxkTrZu0gW-- 
Response:
HTTP/1.1 200 OK
Content-Type: application/json
{
    "description": "Incremental CLI Script file was loaded.",
    "output": ". Version info:. --------------. ;Board: Mediant SW. . ;Board Type: 73. . ;Serial Number: 137172915378947. . ;Slot Number: 1. . ;Software Version: 7.20A.201.357. . ;ISO Version: Mediant Software E-SBC (ver 7.20A.156.028). . ;DSP Software Version: SOFTDSP => 0.00. . ;Board IP Address: 10.4.219.242. . ;Board Subnet Mask: 255.255.0.0. . ;Board Default Gateway: 10.4.0.1. . ;Ram size: 3829M   Flash size: 0M. . ;Num of DSP Cores: 1  Num DSP Channels: 1022. . ;Profile: NONE . . ;;;Key features:;Board Type: Mediant SW ;Max SW Ver: 9.80;FXSPorts=0 ;FXOPorts=0 ;QOE features: VoiceQualityMonitoring MediaEnhancement ;DATA features: ;Channel Type: DspCh=0 ;HA ;IP Media: ExtVoicePrompt=0MB ;Security: MediaEncryption StrongEncryption EncryptControlProtocol ;DSP Voice features: ;Control Protocols: MSFT FEU=3 SIPRec=3 WebRTC MGCP SIP SBC=3 ;Default features:;Coders: G711 G726;. . . . ;MAC Addresses in use:. ;---------------------------. ;GROUP_1 - fa:16:3e:5f:9a:64. ;----------------------------------------------. . . . "
}