Skip to content

Quickstart Guide

After installing the container or the RPM, or in a virtualenv, there are several ways to invoke CANU, including:

  • docker run (or other runtime)

  • docker exec (or other runtime)

  • canuctl

  • canu (direct execution of the binary, which will be deprecated in upcoming versions)

  • canu (running the Python code)

For consistency and simplification, the invocations of CANU throughout the documentation will simply be show as

canu <command> --flags

even though you may be invoking CANU via a different method.

Checkout A Fresh System

This procedure requires csi

  1. Make a new directory to save switch IP addresses
mkdir ips_folder
cd ips_folder
  1. Parse CSI files and save switch IP addresses
canu init --sls-file sls_input_file.json --out ips.txt`
  1. Check network firmware
canu report network firmware --csm 1.2 --ips-file ips.txt
  1. Check network cabling
canu report network cabling --ips-file ips.txt
  1. Validate BGP status
canu validate network bgp --ips-file ips.txt --verbose
  1. Validate cabling
canu validate network cabling --ips-file ips.txt

If you have the system’s SHCD, there are even more commands that can be run

  1. Validate the SHCD
canu validate shcd --shcd SHCD.xlsx
  1. Validate the SHCD against network cabling
canu validate shcd-cabling --shcd SHCD.xlsx --ips-file ips.txt
  1. Generate switch config for the network
canu generate network config --shcd SHCD.xlsx --sls-file sls_input_file.json --folder configs
  1. Convert the SHCD to CCJ
canu validate shcd --shcd SHCD.xlsx --json --out paddle.json

If you have the system’s CCJ

  1. Validate the Paddle / CCJ
canu validate paddle --ccj paddle.json
  1. Validate the CCJ against network cabling
canu validate paddle-cabling --ccj paddle.json --ips-file ips.txt
  1. Generate switch config for the network
canu generate network config --ccj paddle.json --sls-file sls_input_file.json --folder configs