Skip to main content

transfer

The transfer command is used to manage exporting of files to an external storage location.

Synopsis

transfer create [source=ssd] [dest=text] [file=txt][remove=yes,no] 
transfer id/name/all start
transfer id/name/all delete
transfer id/name/all stop
transfer id/name/all get [config/stats/all] 

Actions

ActionDescription

create

Creates a file transfer from the encoder. A series of one or more parameter=value pairs can be specified at once.

start

Starts the transfer.

delete

Removes the transfer.

stop

Stops the transfer.

get

Displays information about the transfer. See Parameters below. You can specify the config, status, or all.

Parameters

ParameterDefaultDescription/Values

source

ssd

The source device: ssd only in the current release.

dest

n/a 

The destination ID or name from the preconfigured destination list, or usb, sd, or nfs

file

n/a

The name of the file to transfer.

remove

no

If yes, removes the source file if the transfer is successful.

Example

# transfer create dest=usb file=NewOne-2015-06-23-18

Transfer to copy small recording to USB (completed right away). Returns information such as:

Transfer created successfully - ID: 1.
# transfer 1 get all
Transfer ID : 1
Name : (None)
Configuration :
Source : SSD
Destination Device : USB
File : NewOne-2015-06-23-18h18m00s.mp4
Remove Source File : No
Status :
Status : SUCCESS
Transfer Type : COPY
Transferred : 100%
Start Time : 2015-6-23 18:29:37
End Time : 2015-6-23 18:29:39
# transfer create dest=1 file=Stream#1-2015-06-22-18h02m56s.mp4

Transfer using a preconfigured FTP destination (ID=1) to export a larger file. Returns information such as:

Transfer created successfully - ID: 2.
# transfer 2 get all
Transfer ID : 2
Name : (None)
Configuration:
Source : SSD
Destination ID : 1
File : Stream#1-2015-06-22-18h02m56s.mp4
Remove Source File : No
Status:
Status : IN PROGRESS
Transfer Type : FTP
Transferring File : /mnt/storage1/recordings/
Stream#1-2015-06-22-18h02m56s.mp4
Start Time : 2015-6-23 18:31:7

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.