4.7 Sneak Preview vsctl The Improved Command Line Interface by Eskil September 14, 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.
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 status Show current Vidispine status; see vsctl status --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
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
status Show current Vidispine status; see vsctl status --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, 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.
$ ./vsctl import media/squirrel.jpg VX-128963
1
2
$ ./vsctl import media/squirrel.jpg
VX-128963
Item search The find command can be used to perform simple queries by field.
$ ./vsctl find originalFilename=squirrel.jpg VX-491810
1
2
$ ./vsctl find originalFilename=squirrel.jpg
VX-491810
$ ./vsctl find -f title originalFilename=squirrel.jpg VX-491810 Small squirrel
1
2
$ ./vsctl find -f title originalFilename=squirrel.jpg
VX-491810 Small squirrel
Job status The job command displays the status of all running jobs.
$ vsctl jobs $ vsctl import media/squirrel.jpg VX-128958
1
2
3
$ vsctl jobs
$ vsctl import media/squirrel.jpg
VX-128958
$ vsctl jobs VX-128958 - PLACEHOLDER_IMPORT STARTED [== ] 11%
1
2
$ vsctl jobs
VX-128958 - PLACEHOLDER_IMPORT STARTED [== ] 11%
$ vsctl jobs VX-128958 - PLACEHOLDER_IMPORT STARTED [===== ] 29%
1
2
$ vsctl jobs
VX-128958 - PLACEHOLDER_IMPORT STARTED [===== ] 29%
$ vsctl jobs VX-128958 - PLACEHOLDER_IMPORT STARTED [======= ] 35%
1
2
$ vsctl jobs
VX-128958 - PLACEHOLDER_IMPORT STARTED [======= ] 35%
$ vsctl jobs $
1
2
$ vsctl jobs
$
As you can see, the program displays the status and then exits. To avoid having to run the program repeatedly, use watch.
$ watch -n1 vsctl jobs
1
$ watch -n1 vsctl jobs
Configuration A common task in setting up a Vidispine system is tuning the configuration properties. The property command is meant to aid with this.
$ ./vsctl property solrpath=http://localhost:8983/solr validatexml=false
1
2
3
$ ./vsctl property
solrpath=http://localhost:8983/solr
validatexml=false
$ ./vsctl property solrpath solrpath=http://localhost:8983/solr
1
2
$ ./vsctl property solrpath
solrpath=http://localhost:8983/solr
$ ./vsctl property solrpath=http://solr.example.com:8983/solr solrpath=http://solr.example.com:8983/solr
1
2
$ ./vsctl property solrpath=http://solr.example.com:8983/solr
solrpath=http://solr.example.com:8983/solr
Open for suggestions The vsctl is very much open for suggestions, so i
Most recent headlines
17/02/2025
TVBEurope talks to the team who brought a piece of broadcasting history back to life on BBC Wales last night
By Jenny Priestley
Published: February 14, 2025 ...
17/02/2025
Eligible studios will receive the relief directly from their local authorities, with no need to submit a claim
By Matthew Corrigan
Published: February 17, 20...
17/02/2025
As DEI initiatives come under pressure in the USA, supporters of Rise, which promotes diversity in the media and entertainment sector, discuss the continuing im...
17/02/2025
EIB Global loan will partially fund SES's continued O3b mPOWER medium earth orbit (MEO) fleet expansion enabling additional capacity worldwide. O3b mPOWER s...
15/02/2025
At Nielsen, Business Resource Groups (BRGs) play a critical role in nurturing a ...
15/02/2025
Innovation to empower creativity: Explore the latest in Lightroom
Rob Christensen February 15, 2025
0 Comments
Whether you want to remove distracting ...
15/02/2025
Wisycom, a worldwide leader in RF technology and provider of wireless solutions, announces a new distribution agreement with EQUAPHON. An Argentinian profession...
15/02/2025
DPA Microphones, the leading manufacturer of high-quality microphone solutions, is pleased to welcome Nicholas Nick Mariano and Vincent Vince Divine to the ...
15/02/2025
Tuxera, a leading provider of quality-assured file systems and networking solutions, will showcase how Tuxera Fusion SMB enables unprecedented performance for m...
15/02/2025
Bitmovin's latest Video Developer Report indicates an increasing role of AI, the slow adoption of next-generation codecs, and continuing challenges when it ...
15/02/2025
When Michelin Enterprises set out to promote its prestigious Hotel Guide in the new Sleepless in the Kitchen , campaign, veteran German/Slovenian gaffer Robert...
15/02/2025
Formula E, the world's first all-electric racing series, revolutionizing motorsport with cutting-edge technology and a commitment to sustainability has sele...
15/02/2025
Agile Content, a global leader in TV and video technology solutions, announces its rebranding to AgileTV.
The transition to AgileTV stems from a commitment to ...
15/02/2025
Hiltron Communications will promote the latest additions to its range of satellite communication products, systems and supporting services at GovSatCom 2025. Th...
15/02/2025
Following the success of the original Airglow Booklight, DoPchoice debuts a new addition to their inflatable line the Float. This lightweight, inflatable, round...
15/02/2025
LAS VEGAS Marshall Electronics has announced that it will debut its newest camera controller, the RCP Plus, at the 2025 NAB Show at Booth N2649 between April 5 ...
15/02/2025
ATLANTA Gray Media has named Blake Sebo as the next general manager of KTUU and KYES, Gray's NBC and CBS affiliates in Anchorage, Alaska....
15/02/2025
KOKKEDAL, Denmark DPA Microphones will feature its new CORE+ technology for distortion-free microphone sound at the 2025 NAB Show, April 5-9, in Las Vegas....
15/02/2025
SWANSEA, U.K. QuickLink will launch StudioPro-NDI and StudioPro-3, two new models of its QuickLine StudioPro video production platform, at the 2025 NAB Show, Ap...
15/02/2025
Live From 2025 NBA All-Star Game Weekend: After 25 Years, Turner Sports All-In F...
15/02/2025
NASCAR Driver Cam on Max Embraces Cloud-Based Workflow for 2025 Season Chris Brown of WBD Sports says Mobii will play key part in delivering signals from the tr...
14/02/2025
Last month, we officially launched the Spotify Partner Program, a powerful new m...
14/02/2025
From an island off the coast of Lutruwita to the global stage in France SBS & ...
14/02/2025
The future of electro-optical/infrared (EO/IR) land systems is evolving so that ...
14/02/2025
Here are 5 reasons why you should attend ISE 2025
Discover more about Calrec: Learn more about Calrec's legacy of innovation in broadcast audio solutions ...
14/02/2025
World Radio Day: On the same wavelength
By Graham Murray, International Sales Manager at Calrec
To mark World Radio Day, Calrec's International Sales Ma...
14/02/2025
DALLAS and TYSONS, Va. Tegna has concluded a broadcast rights agreement that makes Tegna's KFAA in Dallas the exclusive local television partner of the Dall...
14/02/2025
Amazon's Prime Video has released a new app for Apple TV that the streamer said delivers an improved streaming experiences with faster scrolling, improved s...
14/02/2025
CLEVELAND Telos Alliance announced a software update for its Axia Quasar XR and SR line of audio-over-IP (AoIP) mixing consoles and will show the offering at th...
14/02/2025
Puget Systems Returns to HPA Tech Retreat 2025 with New Analysis Tools for Puge...
14/02/2025
Glass Animals: Tour of Earth Uses Blackmagic Live Production Workflow
Brie Clayton February 14, 2025
0 Comments
80six deploys Blackmagic URSA Broadcas...
14/02/2025
A dispute between Paramount and Youtube TV that would have pulled CBS stations and Paramount's cable channels from the streaming service has been temporaril...
14/02/2025
Colourist Deidre (Dee) McClelland details how she helped shape the distinct look and feel of whimsical Oscar-nominated stop-motion film, Memoir of a Snail
By C...
14/02/2025
BitFire said it intends to introduce forward-looking services that simplify the launch of live production workflows, and enhance real-time collaboration
By Jen...
14/02/2025
The claim by the liquidators is the latest twist in the ongoing saga of the companys collapse at the end of 2021
By Matthew Corrigan
Published: February 14, ...
14/02/2025
A carriage dispute between YouTube TV and Paramount could come to a head today (Feb. 13), with the virtual pay TV provider threatening to pull all of the progra...
14/02/2025
ENGLEWOOD CLIFFS, N.J. LG Electronics USA has opened a new in-house, state-of-the-art virtual production studio at its 360,000-square-foot North American headqu...
14/02/2025
NEW YORK In a bid to help local broadcasters find new ways of monetizing their content, the Coalition for Innovative Media Measurement (CIMM) and TVB have relea...
14/02/2025
WASHINGTON Three Democratic U.S. Senators have sent a stern letter blasting FCC Chair Brendan Carr for the weaponization of the agency for attacking broadcast...
14/02/2025
Years after launching the streaming service Apple TV+ in November of 2019, Apple has finally released a version of its steaming app for Android devices....
14/02/2025
FOOTHILL RANCH, Calif. Red Digital Cinema will make its V-RAPTOR [X] and KOMODO-X camera systems available with Nikon's premier Z Mount, providing filmmaker...
14/02/2025
DAYTONA, Fla. The Fox Sports production of this year's Daytona 500 will see the addition of a few new tech elements and the continued unfolding of the broad...
14/02/2025
Watch Bryson Battles Blind Audition on The Voice Get a Four-Chair Turn Michael Bubl said the Boston Conservatory at Berklee musical theater senior might have...
14/02/2025
2025 Daytona 500: FOX Sports Looks To Ride Super Bowl LIX Momentum Into NASCAR S...
14/02/2025
14 Feb 2025
VEON's Kyivstar and the Come Back Alive Foundation Raise USD 2....
14/02/2025
Max Renews THE PITT, Starring Noah Wyle, For A Second Season
Max
Warner Bros. Television Group
The Pitt
New Episodes Of The Medical Drama From John...
14/02/2025
This year, Technicolor proudly celebrates 110 years of shaping the magic of cinema pioneering color, visual effects, and innovation that bring unforgettable l...
14/02/2025
NBA All-Star: More Games, More Teams, More Music, More Sound From the Court Turner Sports' team will deploy familiar tech to capture all the audio By Dan D...
14/02/2025
LIV Golf Continues To Innovate With Drones, Data-Driven Graphics, and All-Access...
4.7 Sneak Preview vsctl The Improved Command Line Interface by Eskil September 14, 2016 Howto 
