matthew/sonic-buildimage
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Mellanox] Update ECMP calculator README (#13051)

Browse Source 
Why I did it
Update ECMP calculator README file with new instructions how to run the calculator.

How I did it
Update README file.

How to verify it
Read README file.
This commit is contained in:
Lior Avramov 2022-12-15 09:47:33 +02:00 committed by GitHub
parent 33d86bd951
commit bb2e7685c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
platform/mellanox/docker-syncd-mlnx/ecmp_calculator/README.md
View File

@ -14,20 +14,34 @@ Packet is defined by a JSON file given as an argument to the tool.
3. Changes done in the packet classification (e.g. ACL, PBR) are not taken into consideration during calculation. 3. Changes done in the packet classification (e.g. ACL, PBR) are not taken into consideration during calculation.
## Command line interface ## Command line interface
1. User shall provide the following input parameters: 1. User shall enter syncd container to run ECMP calculator.
2. User shall provide the following input parameters:
- JSON file describing a packet - JSON file describing a packet
- Ingress port (e.g. "Ethernet0", must pe a physical interface) - Ingress port (e.g. "Ethernet0", must pe a physical interface)
- Debug option for debug purposes (optional) - Debug option for debug purposes (optional)
- VRF name (optional) - VRF name (optional)
2. Usage example: 3. Usage example:
``` ```
$ show ip ecmp-egress-port --packet /tmp/packet.json --ingress-port Ethernet0 --vrf Vrf_red --debug $ docker exec -it syncd bash
$ /usr/bin/ecmp_calc.py -i Ethernet0 -p ./packet.json -v Vrf_red
Egress port: Ethernet4 Egress port: Ethernet4
``` ```
ECMP calculator is a vendor specific tool. If tool was not implemented and CLI command is being called, the following message will be returned to user:
``` ```
$ show ip ecmp-egress-port --packet /tmp/packet.json --ingress-port Ethernet0 --vrf Vrf_red --debug $ docker exec -it syncd bash
ECMP calculator is not available in this image $ /usr/bin/ecmp_calc.py -h
usage: ecmp_calc.py [-h] -i INTERFACE -p PACKET [-v VRF] [-d]
ECMP calculator
optional arguments:
-h, --help show this help message and exit
-i INTERFACE, --interface INTERFACE
Ingress interface
-p PACKET, --packet PACKET
Packet description
-v VRF, --vrf VRF VRF name
-d, --debug Flag for debug
``` ```
## Packet JSON ## Packet JSON