Metadata-Version: 1.0
Name: l1-tools
Version: 2.0
Summary: Cumulus Linux Layer 1 tools
Home-page: UNKNOWN
Author: Cumulus Networks
Author-email: dev-support@cumulusnetworks.com
License: UNKNOWN
Description: # Cumulus Linux Layer 1 tools
        
        Tools to help with layer 1 testing and development
        
        ## Pre-reqs
        
        - Python 2 or 3
        - pip3
        
        ## Installation
        The tool is already installed on 3.7.7 and 4.x CL switches.
        
        To install on a laptop for offline processing of cl-support files in l1-show:
        
        ```
        pip3 install git+ssh://stash.cumulusnetworks.com:7999/crmc/l1-tools.git
        ```
        
        To install into a virtualenv:
        
        ```
        # Create virtualenv named 'l1-show':
        cd myvenvlocation
        virtualenv l1-show
        # Activate the 'l1-show' venv:
        source myvenvlocation/l1-show/bin/activate
        # Install the executables to that venv:
        pip3 install git+ssh://stash.cumulusnetworks.com:7999/crmc/l1-tools.git
        ```
        
        ## Upgrading to latest
        
        1. Activate your virtualenv if used.
        1. Upgrade l1-tools and its dependencies:
        
        ```
        pip3 install -U --force-reinstall git+ssh://stash.cumulusnetworks.com:7999/crmc/l1-tools.git
        ```
        
        Note: The force reinstall flag will force update of the dependencies also, which might have changed
        
        
        
        
        
        ## Known Install Issues
        
        - Installer is currently incompatible with pip2. The rest of the code should be
          compatible with both versions of python, but you will have to manually
          install the code
        
        ## Usage
        
        `l1-show PORTLIST [--cl-support ROOT] [--json] [--debug MODULES]`
        
        - `PORTLIST`: The list of ports you'd like to see info on. This can either be
          supplied as `all` for all ports, or individual ports separated by commas.
          I.e. `swp1,swp2,swp3` or `1,2,3`.
        
        - `--cl-support ROOT` or `-c ROOT`: The root directory of an untarred
          `cl-support` output. This is an optional argument that is only needed if you
          are running this command to see the output from a `cl-support` output instead
          of from a live system.
        
        - `--json`: If set, format the output as a json file. If not, print the output
          to stdout.
        
        - `--debug MODULES`: Sets debugging info.
        
        ## Tips
        1) For offline processing of the file, redirect the output from ‘all’ ports to a ‘portall.txt’ file:
        
        ```
        l1-show all -c cl_support_switch_20200518_115613 > switch_20200518_115613_portall.txt
        ```
        
        2)  To pre-create all _portall.txt files in ZD Download directory:
        
        ```
        for i in `ls -p | grep '/' | grep cl_supp | sed 's/\///'` ; do l1-show all -c $i > ${i}_portall.txt ; done
        ```
        
        
        
Keywords: l1-tools
Platform: UNKNOWN
