ipng/vppcfg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add user guide for 'vppcfg dump' command

Browse Source
This commit is contained in:
Pim van Pelt
2022-04-03 13:01:31 +00:00
parent eee47c02b1
commit dfd8c8b8a9
3 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/user-guide.md
View File

@ -108,6 +108,14 @@ fully valid!
### vppcfg dump
The purpose of the **dump** module is to connect to the VPP dataplane, and retrieve its
state, printing most information found in the INFO logs. Although it does contact VPP, it
will perform *readonly* operations and never manipulate state in the dataplane, so it
should be safe to run.
There are no flags to the dump command. It will return 0 if the connection to VPP was
established and its state successfully dumped to the logs, and non-zero otherwise.
### vppcfg plan
### vppcfg apply