4.7 Sneak Preview – vsctl Pt.2 – Command Line Interface Status Commands

By Eskil - September 21, 2016 (Last updated: April 9, 2017)

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. This is part 2 of this sneak preview.

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.

    vsctl [SWITCHES] [SUBCOMMAND [SWITCHES]] args...

    --help                    Prints this help message and quits
    --help-all                Print help messages of all subcommands and quit
    -v, --version             Prints the program's version and quits

    -a, --auth VALUE:str      Vidispine user (and password); the default is 'admin:admin'
    --color                   Always print colored output
    --debug                   Print https requests and responses
    -h, --host VALUE:str      Vidispine server host; the default is 'localhost:8080'

    audit                     Query the audit log; see 'vsctl audit --help' for more info
    find                      Find items matching keywords or query; see 'vsctl find --help' for more info
    health                    Show current Vidispine health; see 'vsctl health --help' for more info
    import                    Import files by path or by direct upload; see 'vsctl import --help' for more info
    indexing                  View reindex status; see 'vsctl indexing --help' for more info
    jobs                      Show job status; see 'vsctl jobs --help' for more info
    property                  Manage configuration properties; see 'vsctl property --help' for more info
    service                   Manage services; see 'vsctl service --help' for more info
    stats                     Display various internal statistics; see 'vsctl.py stats --help' for more info
    status                    Show current Vidispine status; see 'vsctl status --help' for more info
    storage                   Displays the status of storages in Vidispine; see 'vsctl.py storage --help' for more info
    test                      Show current Vidispine selftest status; see 'vsctl.py test --help' for more info
    threads                   Print stack trace from Vidispine; see 'vsctl threads --help' for more info

Below we’ll present a few of the commands in more detail. This is second part of the vsctl blog post, and you can find the first vsctl post here.

System status

The status command displays a high level overview of the activity and the status of resources, jobs and storages.

Storage status

The status command will list any offline storage and the storage errors. Details on the storages can be seen using the storage command.

System statistics

Vidispine server exposes system metrics using StatsD, JMX and on the metrics resource on the admin port. Here we use watch to continuously poll and display the latest statistics.

vsctl system stats

Open for suggestions

This was part 2 of the sneak preview. You can find part 1 of here. 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”.