Overview#

knlcli is the command line tool to manage KNL labs.

KNL CLI tool

Usage:
  knlcli [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  config      save/load configuration
  console     connect to the console of specified node in the specified lab
  create      create a lab via the specified YAML file
  exec        run a command on the specified node and print output
  help        Help about any command
  rm          remove a lab
  shell       connect to the specified node in the specified lab
  show        show existing Lab info
  topo        generate lab topology in D2 format

Flags:
  -h, --help              help for knlcli
      --kubeconf string   path to k8s config (default "/home/hj/.kube/config")
  -n, --ns string         k8s namespace (default "knl-system")
  -v, --version           version for knlcli

Use "knlcli [command] --help" for more information about a command.

Installation#

see here

Shell completion#

knlcli supports bash completion, enable it via following:

sudo apt-get install -y bash-completion # install bash-completion if not already installed
knlcli completion bash | sudo tee /etc/bash_completion.d/knlcli # install the knlcli completion script
source <(knlcli completion bash) # activate the completion for current shell session

Create a lab#

knlcli create <labdef.yaml>, this is equivalent to kubectl apply -f <labdef.yaml>.

List existing labs#

knlcli show by default list name of existing labs:

user@svr-1:~$ knlcli show
example-lab
srl-basic
srsim  

knlcli show <labname> -v show lab details:

user@svr-1:~$ knlcli show example-lab -v
example-lab:
   Node      Type    Chassis   Pods                                       Worker/PodIP
   srsim-1   SRSIM   SR-7      example-lab-srsim-1                        worker-1/10.244.2.92
   vsim-1    VSIM    SR-7      virt-launcher-example-lab-vsim-1-1-cjfn6   worker-2/10.244.0.95
                               virt-launcher-example-lab-vsim-1-a-lvhqd   worker-2/10.244.0.115
   
   Link      Nodes    Port
   link1     srsim-1
             vsim-1

Access a lab node via shell command#

knlcli shell <lab> <node>

• vSIM, VSR, MAG-c, SR-SIM, SRLinux: this command creates a SSH session to the control card (e.g. CPM).
• General VM: this command creates a SSH sesion to the VM
• General pod: this command command trys to execute bash inside the pod

Run a command on a lab node#

knlcli exec <lab> <node> "<cmd>" [--username <user>] [--passwd <pass>]

Run a single command on the specified node, print its output, and exit. Unlike shell, this does not open an interactive session. Quote the command when it contains spaces.

• --username and --passwd override the defaults above (same flags as shell).
• General pod requires kubectl on the client machine (same dependency as console for pod types).

user@svr-1:~$ knlcli exec ipsec-basic srsim-1 "show version"
TiMOS-C-25.10.R2 ...

user@svr-1:~$ knlcli exec quickstart srl-1 "show version"
...

Access a lab node via console command#

knlcli console <lab> <node>

• vSIM, VSR, MAG-c: this command creates a console session to the control card (e.g. CPM).
• General VM: this command creates a console sesion to the VM
• SR-SIM, SRLinux, general pod: this command command trys to execute bash inside the pod

Remove lab#

• knlcli remove <lab>: remove the specified lab

• knlcli remove --all: remove all labs

  Note
  Removing a lab won’t remove the perisisten storage of nodes in the lab.

Lab save/load#

see Lab save/load

Show lab topology#

knlcli topo <lab> displays lab topology in following formats:

1. visualization render in ASCII format (this requires installation of D2 command line): knlcli topo <lab>
2. D2 file: knlcli topo <lab> --render=false

user@svr-1:~$ knlcli topo example-lab
    ┌───────┐
    │vsim-1 │
    │       │
    └───────┘
        │  │
        │  └─┐
        │    │
 ┌──────┐    │
 │srl-1 │    │
 │      │    │
 └──────┘    │
        │    │
        │  ┌─┘
        │  │
    ┌────────┐
    │srsim-1 │
    │        │
    └────────┘