
4.7 Sneak Preview - vsctl Pt.2 Command Line Interface Status Commands by Eskil September 21, 2016 Howto
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.
Usage 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.
Usage: vsctl [SWITCHES] [SUBCOMMAND [SWITCHES]] args... Meta-switches: --help Prints this help message and quits --help-all Print help messages of all subcommands and quit -v, --version Prints the programs version and quits Switches: -a, --auth VALUE:str Vidispine user (and password); the default is admin:admin --color Always print colored output --debug Print HTTP requests and responses -h, --host VALUE:str Vidispine server host; the default is localhost:8080 Subcommands: 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
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
Usage:
vsctl [SWITCHES] [SUBCOMMAND [SWITCHES]] args...
Meta-switches:
--help Prints this help message and quits
--help-all Print help messages of all subcommands and quit
-v, --version Prints the programs version and quits
Switches:
-a, --auth VALUE:str Vidispine user (and password); the default is admin:admin
--color Always print colored output
--debug Print HTTP requests and responses
-h, --host VALUE:str Vidispine server host; the default is localhost:8080
Subcommands:
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.
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 .
Most recent headlines
13/12/2025
Powering Client Growth: Horizon Deepens Nielsen Partnership, Enabling More Effic...
13/12/2025
In a move that will help it offer more flexible and less costly programming options, YouTube TV has announced that it will be launching YouTube TV Plans with mo...
13/12/2025
SINGAPORE Magna Systems has designed, built and completed what is believed to be the first full UHD and IP-based OB truck in Southeast Asia for a Singapore medi...
12/12/2025
SVG Summit 2025 Preview: Everything You Need to Know for Next Week's Big Sho...
12/12/2025
Hailey Gates at the Atropia premiere (photo by George Pimentel / Shutterstock for Sundance Film Festival)...
12/12/2025
Last month, Spotify announced a new collaboration with the ATP Tour, the global governing body of men's professional tennis, aimed at bringing the next gene...
12/12/2025
CONWAY, Ark. In a notable example of how the elimination of Federal federal funding is forcing public stations to make massive cuts and changes in the way they...
12/12/2025
Wisycom and DPA Microphones announce the appointment of Ren Moerch as Group Product Director, Wireless, a strategic leadership role that will guide the combine...
12/12/2025
SMPTE , the home of media professionals, technologists, and engineers, in conjuncture with the European Broadcasting Union (EBU) and the Entertainment Technolog...
12/12/2025
Keepit, the vendor-independent, cloud-native data protection provider, today announced a strategic go-to-market relationship in Poland with Ingram Micro, a lead...
12/12/2025
Atomos announced the immediate availability of a new firmware update for its Ninja TX GO and Ninja TX monitor-recorders, unlocking Open Gate 48P RAW recording w...
12/12/2025
Professional Wireless Systems (PWS) once again played a critical role in delivering flawless wireless coordination and support at the 2025 Latin Grammy Awards a...
12/12/2025
The Alliance for IP Media Solutions (AIMS), together with the Video Services Forum (VSF), the Advanced Media Workflow Association (AMWA) and the European Broadc...
12/12/2025
DHD audio will demonstrate the latest additions to its range of digital audio production solutions on Booth 321 in Hall B6 at Hamburg Open 2026. The show will b...
12/12/2025
Chaos today announces the release of V-Ray for Blender, update 2, bringing its award-winning rendering technology to even more Blender users by adding support f...
12/12/2025
Lighting specialist UltraLEDs has launched Precision LED Tape, a high-CRI lighting solution designed specifically for professional film, TV, and studio use.
P...
12/12/2025
Zixi, the Emmy Award-winning leader in live broadcast-quality video over IP, today announced that Roi Sasson has joined the company as Vice President, Engineer...
12/12/2025
BitFire (bitfire.tv), the leader in software-defined live production and IP transmission, today announced a strategic partnership with Appear, a leader in high-...
12/12/2025
LOS ANGELES The Hollywood Professional Association (HPA) today said futurist Robert Tercek, creative technologist Jessie Hughes from Leonardo.AI and Emmy-winnin...
12/12/2025
HUDSON, Mass. BitFire and Appear have struck a strategic partnership aimed at offering broadcasters, sports leagues and streaming platforms a faster, more flexi...
12/12/2025
The broadcast industry is evolving faster than ever. #IPWorkflows #remoteproduction, and next-gen audio systems are reshaping how teams design, deliver, and sca...
12/12/2025
LOS ANGELES The payroll and production accounting platform Wrapbook has announced the acquisition of Cinapse, a modern scheduling platform for film and televisi...
12/12/2025
DEHLI Ross Video has announced that it is expanding and restructuring its commercial and technical teams in the South Asian Association for Regional Cooperation...
12/12/2025
LONDON Following the success of its UK launch in January 2025, Rise AV, the global not-for-profit initiative dedicated to supporting and advancing women in the ...
12/12/2025
SAN FRANCISCO Ad-supported streaming service Tubi next week will launch Matter Casting, a new casting standard that will enable seamless mobile-to-TV viewing di...
12/12/2025
LOS ANGELES The Hollywood Professional Association (HPA) today said futurist Robert Tercek, creative technologist Jessie Hughes from Leonardo.AI and Emmy-winnin...
12/12/2025
Friday 12 December 2025
Ted is back! Seth MacFarlane's live-action comedic ...
12/12/2025
In Las Vegas's T-Mobile Arena, fans of the Golden Knights are getting more than just hockey - they're getting a taste of the future. ADAM, a robot devel...
12/12/2025
Uachtar n na h ireann, Catherine Connolly visited RT Raidi na Gaeltachta's...
12/12/2025
Ireland AM host Eric Roberts has been revealed as the sixth contestant taking to...
12/12/2025
Scripps Research team pioneers an efficient way to stereoselectively add fluorine to drug-like molecules A new method uses a novel catalyst and inexpensive fluo...
11/12/2025
Thomson and the Center for News, Technology and Innovation (CNTI) convened a two-day workshop in Sarajevo bringing together more than 35 journalists, editors, p...
11/12/2025
ESPN's Aims for Spectacular With Heisman Trophy ShowEvent firsts include 1080p HDR production airing on both national broadcast and cableBy Dan Daley, Audio...
11/12/2025
SVG Students To Watch: Frankie Patton, University of ColoradoThe 2025 grad is hitting the ground running as a PA on national broadcastsBy Brandon Costa, Directo...
11/12/2025
SVG Summit 2025 Technology Exhibits Preview, Part 3By SVG Staff
Thursday, December 11, 2025 - 7:24 am
Print This Story | Subscribe
Story Highlights
The 2...
11/12/2025
SVG Sit-Down: What Makes Gen Z, X, and Y Fans Tick? Dave Gavant of WSC Sports Go...
11/12/2025
SVG Summit 2025 Preview: 5G, MXL, Spectrum Loss, and Outerspace on Tap for Tues...
11/12/2025
2025 Sports Broadcasting Hall of Fame: David Levy, Turner Titan and Master of Al...
11/12/2025
SVG Launches Follow the Money' Podcast: Go Inside the Sports Media Biz with...
11/12/2025
A Deep Dive Inside Game Creek Video's Bird and Magic Mobile Units, Home to A...
11/12/2025
How Sound Effects for Monsters Funday Football' Emulated the Sonic Soul of ...
11/12/2025
SVG New Sponsor Spotlight: CSP Mobile Productions' Len Chase on Upgrading Tr...
11/12/2025
Having the right song soundtrack your moves can make all the difference when gam...
11/12/2025
It's been a big year for Taylor Swift. Her highly anticipated album The Life...
11/12/2025
New satellites for the SDA Tranche 1 Tracking program in production at L3Harris&...
11/12/2025
The Meadowlands system, a compact and mobile version of the CCS, uses ground-based radio frequency units to disrupt satellite communications....
11/12/2025
The L3Harris demonstration united tactical communications devices, counter-UAS c...
11/12/2025
Throughout 2025, L3Harris delivered innovative solutions to U.S. and allied warfighters across every domain.
With an unrelenting commitment to excellence, our...
11/12/2025
A Majority of the World's Population (51%) Identify As Soccer Fans
The 2025 MLB postseason notched 58.2 billion viewing minutes, up +24% from the prior y...
11/12/2025
WALTHAM, Mass. Video-over-IP software provider Zixi said Roi Sasson has joined the company as vice president, engineering....