broadbandforum/report-pl repository overview

⁠Tags

• latest (the latest official release)
• nnn (a specific official release; nnn is the integer release number; corresponds to https://github.com/BroadbandForum/cwmp-xml-tools/releases/tag/report.pl%23nnn; note that %23 is a percent-escaped # character)
• branch (e.g., develop, master, or of the form user-feature-XXX-nnn-foo; whatever was most recently pushed to the corresponding private Bitbucket branch; most people should ignore these tags, which will be tidied up periodically)

⁠Quick reference

The Broadband Forum report.pl CWMP / USP data model report tool lives here in GitHub⁠.

⁠How to use this image

The image contains perl, all the necessary perl packages, and /usr/local/bin/report.pl (a soft link that points to /opt/bbf/bin/report.pl).

You should install the necessary CWMP and/or USP data models on your computer. For example, here I've cloned the public usp-data-models repository and the private BBF install repository (which requires credentials). I'll assume that you also have your own data models in a my-models folder.

% git clone https://github.com/BroadbandForum/usp-data-models
Cloning into 'usp-data-models'...
...
% git clone ssh://[email protected]:7999/software/install.git
Cloning into 'install'...
...

Here we create a report-pl container and use the -v (--volume) option to mount usp-data-models and my-models (be aware that you have to use absolute paths).

% docker run --rm -v ~/docker/usp-data-models:/opt/bbf/usp-data-models \
        -v ~/docker/my-models:/home/william/my-models \
        broadbandforum/report-pl:latest report.pl \
        --nowarnuniquekeys --include /opt/bbf/usp-data-models event-test.xml --report html >test.html

This will spin up the container, run the report.pl and remove any temporary content so every time you re-run the command it'll start with a pristine environment. This should work fine for any cases where report.pl outputs directly on the command line. If you want to use plugins or capture generated files it may be necessary to add additional mountpoints to the command line.