vcli provides a special wrapper to the bash shell that allows seemless access to the Vyatta CLI commands. This shell operates as if it is in configuration mode, with the caveat that one has to setup and teardown sessions before manipulating the candidate data tree.

Invocation

vcli has the following options

$ vcli -h
Invalid option: -h
vcli [ OPTIONS ]
	OPTIONS: { -s SID | -c COMMAND | -i | -f FILE | -- SCRIPT_OPTIONS }
		-i interactive modeless shell
		-s SID configuration session id if not provided uses PID
		-c COMMAND one shot command
		-f FILE file to run
	NOTES:
		'-f FILE' is treated as a delimiter for SCRIPT_OPTIONS as well
		vcli will read a full script from standard in if no options are provided

Following the 'awk' convention the '#!' for vcli invocation is as follows

#!/bin/vcli -f

Session ID

When invoking vcli one may use the '-s' option to specify the session id to use. by default if no '-s' is provided vcli uses its pid. The '-s' option is useful for connecting to an existing session such as invoking a script from an existing configuration session or for debugging a NETCONF transaction.

Session establishment

If one is not connecting vcli to an existing session then in order to manipulate a candidate configuration one must enter a configuration session.

This is done using the:

configure

command. This will be a persistent session and therefore must be cleaned up when the shell exits or it will persist until the device reboots. This is done with the

end_configure

command.

Configuration manipulation

The following CLI commands are available in VCLI and function exactly as they do in the Vyatta CLI.

edit
up
top
 
set
delete
show
 
validate
commit
 
load
save

Note: all vcli commands require full configuration paths. The shortest unambiguous match abbreviations do not work since these scripts are meant to be run non interactively.

Additional convenience commands

In addition to the standard CLI commands there are a few additional convenience commands

The

list <path>

command takes a path and returns its values a space separated list. This is convenient and allows one to programatically walk the configuration tree.

[edit]
vyatta@vyatta# vcli -c 'list interfaces'
bridge dataplane loopback
[edit]
vyatta@vyatta# vcli -c 'list interfaces dataplane'
dp0p0s20f0
[edit]
vyatta@vyatta# vcli -c 'list interfaces dataplane dp0p0s20f0'
address ip ipv6 mtu
[edit]
vyatta@vyatta#

The

interactive

and

noninteractive

commands control the way operational commands prompt a user. When noninteractive is run any following operational mode command will not prompt for input but will accept all defaults. When interactive is run it changes back to the normal mode of operation and prompts for input.

Operational commands

Operational commands must be invoked by using the

run

command as is the case from configuration mode in the Vyatta CLI.

[edit]
vyatta@vyatta# vcli -c 'run show interfaces'
Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down
Interface        IP Address                        S/L  Description
---------        ----------                        ---  -----------
br0              192.168.1.1/24                    u/u  
dp0p0s20f0       172.22.20.142/24                  u/u  
dp0p0s20f1       -                                 A/D  
dp0p0s20f2       -                                 A/D  
dp0p0s20f3       -                                 A/D  
dp0vhost0        -                                 u/u  
dp0vhost1        -                                 u/u

Control structure

All control structures such as conditionals and loops are done using normal bash syntax. This shell simply provides some the required wrappers to enable Vyatta CLI commands to be scriptable. I would refer one to http://wiki.bash-hackers.org/doku.php for an introduction to bash scripting.

Example

#!/bin/vcli -f
configure
trap "{ end_configure; }" EXIT HUP
set interfaces bridge br1 description "bridge to nowhere"
set interfaces bridge br1 address 1.1.1.1/32
if ! validate; then
    exit 1
fi
if ! commit; then
    exit 1
fi
run show interfaces bridge br1
run show bridge br1
[edit]
vyatta@vyatta# ./test.vcli
br1@NONE: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc noqueue state LOWERLAYERDOWN group default 
    link/ether e2:4d:d8:13:c9:38 brd ff:ff:ff:ff:ff:ff
    inet 1.1.1.1/32 scope global br1
       valid_lft forever preferred_lft forever
    inet6 fe80::e04d:d8ff:fe13:c938/64 scope link 
       valid_lft forever preferred_lft forever
    Description: bridge to nowhere
    RX:  bytes    packets     errors    ignored    overrun      mcast
             0          0          0          0          0          0
    TX:  bytes    packets     errors    dropped    carrier collisions
           188          2          0          0          0          0
bridge name	bridge id		STP enabled	interfaces
br1		0000.000000000000	no		
[edit]
vyatta@vyatta#

DANOS

VCLI -- Bash Configd Client Library