4.7 Sneak Preview – vsctl – The Improved Command Line Interface

With Vidispine 4.7 you’ll get a new and improved command line interface called vsvtl. vsctl can be used to inspect and control a running Vidispine server. It is targeted at operations and developers working with Vidispine.

All information and operations are performed using the API, so this can also be seen as an example on how to interact with Vidispine from Python. We have selected a few commands that we believe are of importance to you, and will slowly but steady continue to improve on the tool.


Let’s start with an overview of everything you can do with vsctl. Just run the command without any arguments to see the full help, and you’ll get this list.

Below we’ll present a few of the commands in more detail, and as we continue to work on it we’ll present more commands in another blog post.

File import

The import commands imports a single file and displays the job id, which could then be checked using GET API/job/{id} or using the job command.

Item search

The find command can be used to perform simple queries by field.

Job status

The job command displays the status of all running jobs.

As you can see, the program displays the status and then exits. To avoid having to run the program repeatedly, use watch.


A common task in setting up a Vidispine system is tuning the configuration properties. The property command is meant to aid with this.

Open for suggestions

The vsctl is very much open for suggestions, so if you have any suggestions on commands or arguments that would be useful to you, then please don’t hesitate to get in contact with us. A very good way to make suggestions is to use our support portal and add a new ticket of the type “Suggestion”.

This was part 1 of the sneak preview. Part 2 of the vsctl sneak preview is here.