Skip to content

Commit

Permalink
Add VRF-related commands to Command Reference Document (sonic-net#778)
Browse files Browse the repository at this point in the history
  • Loading branch information
@kannankvs @jleveque
kannankvs authored and jleveque committed Jan 2, 2020
1 parent 6d0dee0 commit 0bdc3fd
Showing 1 changed file with 219 additions and 6 deletions.
225 changes: 219 additions & 6 deletions doc/Command-Reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@
* [Reloading Configuration](#reloading-configuration)
* [Loading Management Configuration](#loading-management-configuration)
* [Saving Configuration to a File for Persistence](saving-configuration-to-a-file-for-persistence)
* [Management VRF](#Management-VRF)
* [Management VRF Show commands](#management-vrf-show-commands)
* [Management VRF Config commands](#management-vrf-config-commands)
* [Mirroring](#mirroring)
* [Mirroring Show commands](#mirroring-show-commands)
* [Mirroring Config commands](#mirroring-config-commands)
Expand Down Expand Up @@ -183,16 +186,16 @@ Go Back To [Beginning of the document](#) or [Beginning of this section](#basic-
The management interface (eth0) in SONiC is configured (by default) to use DHCP client to get the IP address from the DHCP server. Connect the management interface to the same network in which your DHCP server is connected and get the IP address from DHCP server.
The IP address received from DHCP server can be verified using the `/sbin/ifconfig eth0` Linux command.

SONiC does not provide a CLI to configure the static IP for the management interface. There are few alternate ways by which a static IP address can be configured for the management interface.
1. Use the `/sbin/ifconfig eth0 ...` Linux command. NOTE: This configuration **will not** be preserved across reboots.
SONiC provides a CLI to configure the static IP for the management interface. There are few ways by which a static IP address can be configured for the management interface.
1. Use the `config interface ip add eth0` command.
- Example:
```
admin@sonic:~$ /sbin/ifconfig eth0 10.11.12.13/24
admin@sonic:~$ sudo config interface ip add eth0 20.11.12.13/24 20.11.12.254
```
2. Use config_db.json and configure the MGMT_INTERFACE key with the appropriate values. Refer [here](https://github.com/Azure/SONiC/wiki/Configuration#Management-Interface)
3. Use minigraph.xml and configure "ManagementIPInterfaces" tag inside "DpgDesc" tag as given at the [page](https://github.com/Azure/SONiC/wiki/Configuration-with-Minigraph-(~Sep-2017))

Once the IP address is configured, the same can be verified using "/sbin/ifconfig eth0" linux command.
Once the IP address is configured, the same can be verified using either `show management_interface address` command or the `/sbin/ifconfig eth0` linux command.
Users can SSH login to this management interface IP address from their management network.

- Example:
Expand Down Expand Up @@ -2270,12 +2273,13 @@ The syntax for all such interface_subcommands are given below under each command
NOTE: In older versions of SONiC until 201811 release, the command syntax was `config interface <interface_name> interface_subcommand`
**config interface ip add <interface_name> <ip_addr> (Versions >= 201904)**
**config interface ip add <interface_name> <ip_addr> [default_gw] (Versions >= 201904)**
**config interface <interface_name> ip add <ip_addr> (Versions <= 201811)**
This command is used for adding the IP address for an interface.
IP address for either physical interface or for portchannel or for VLAN interface can be configured using this command.
IP address for either physical interface or for portchannel or for VLAN interface can be configured using this command.
While configuring the IP address for the management interface "eth0", users can provide the default gateway IP address as an optional parameter from release 201911.
- Usage:
Expand All @@ -2294,6 +2298,7 @@ IP address for either physical interface or for portchannel or for VLAN interfac
*Versions >= 201904*
```
admin@sonic:~$ sudo config interface ip add Ethernet63 10.11.12.13/24
admin@sonic:~$ sudo config interface ip add eth0 20.11.12.13/24 20.11.12.254
```
*Versions <= 201811*
```
Expand Down Expand Up @@ -2334,6 +2339,7 @@ VLAN interface names take the form of `vlan<vlan_id>`. E.g., VLAN 100 will be na
*Versions >= 201904*
```
admin@sonic:~$ sudo config interface ip remove Ethernet63 10.11.12.13/24
admin@sonic:~$ sudo config interface ip remove eth0 20.11.12.13/24
```
*Versions <= 201811*
```
Expand Down Expand Up @@ -3027,6 +3033,213 @@ Saved file can be transferred to remote machines for debugging. If users wants t
Go Back To [Beginning of the document](#) or [Beginning of this section](#loading-reloading-and-saving-configuration)
## Management VRF
### Management VRF Show commands
**show mgmt-vrf**
This command displays whether the management VRF is enabled or disabled. It also displays the details about the the links (eth0, mgmt, lo-m) that are related to management VRF.
- Usage:
```
show mgmt-vrf
```
- Example:
```
root@sonic:/etc/init.d# show mgmt-vrf

ManagementVRF : Enabled

Management VRF interfaces in Linux:
348: mgmt: <NOARP,MASTER,UP,LOWER_UP> mtu 65536 qdisc noqueue state UP mode DEFAULT group default qlen 1000
link/ether f2:2a:d9:bc:e8:f0 brd ff:ff:ff:ff:ff:ff
2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc mq master mgmt state UP mode DEFAULT group default qlen 1000
link/ether 4c:76:25:f4:f9:f3 brd ff:ff:ff:ff:ff:ff
350: lo-m: <BROADCAST,NOARP,UP,LOWER_UP> mtu 1500 qdisc noqueue master mgmt state UNKNOWN mode DEFAULT group default qlen 1000
link/ether b2:4c:c6:f3:e9:92 brd ff:ff:ff:ff:ff:ff

NOTE: The management interface "eth0" shows the "master" as "mgmt" since it is part of management VRF.
```
**show mgmt-vrf routes**
This command displays the routes that are present in the routing table 5000 that is meant for management VRF.
- Usage:
```
show mgmt-vrf routes
```
- Example:
```
root@sonic:/etc/init.d# show mgmt-vrf routes

Routes in Management VRF Routing Table:
default via 10.16.210.254 dev eth0 metric 201
broadcast 10.16.210.0 dev eth0 proto kernel scope link src 10.16.210.75
10.16.210.0/24 dev eth0 proto kernel scope link src 10.16.210.75
local 10.16.210.75 dev eth0 proto kernel scope host src 10.16.210.75
broadcast 10.16.210.255 dev eth0 proto kernel scope link src 10.16.210.75
broadcast 127.0.0.0 dev lo-m proto kernel scope link src 127.0.0.1
127.0.0.0/8 dev lo-m proto kernel scope link src 127.0.0.1
local 127.0.0.1 dev lo-m proto kernel scope host src 127.0.0.1
broadcast 127.255.255.255 dev lo-m proto kernel scope link src 127.0.0.1
```
**show management_interface address**
This command displays the IP address(es) configured for the management interface "eth0" and the management network default gateway.
- Usage:
```
show management_interface address
```
- Example:
```
root@sonic:/etc/init.d# show management_interface address
Management IP address = 10.16.210.75/24
Management NetWork Default Gateway = 10.16.210.254
Management IP address = FC00:2::32/64
Management Network Default Gateway = fc00:2::1
```
**show snmpagentaddress**
This command displays the configured SNMP agent IP addresses.
- Usage:
```
show snmpagentaddress
```
- Example:
```
root@sonic-s6100-07:~# show snmpagentaddress
ListenIP ListenPort ListenVrf
---------- ------------ -----------
1.2.3.4 787 mgmt
```
**show snmptrap**
This command displays the configured SNMP Trap server IP addresses.
- Usage:
```
show snmptrap
```
- Example:
```
root@sonic-s6100-07:~# show snmptrap
Version TrapReceiverIP Port VRF Community
--------- ---------------- ------ ----- -----------
2 31.31.31.31 456 mgmt public
```
### Management VRF Config commands
**config vrf add mgmt**
This command enables the management VRF in the system. This command restarts the "interfaces-config" service which in turn regenerates the /etc/network/interfaces file and restarts the "networking" service. This creates a new interface and l3mdev CGROUP with the name as "mgmt" and enslaves the management interface "eth0" into this master interface "mgmt". Note that the VRFName "mgmt" (or "management") is reserved for management VRF. i.e. Data VRFs should not use these reserved VRF names.
- Usage:
```
config vrf add mgmt
```
- Example:
```
root@sonic-s6100-07:~# config vrf add mgmt
```
**config vrf del mgmt**
This command disables the management VRF in the system. This command restarts the "interfaces-config" service which in turn regenerates the /etc/network/interfaces file and restarts the "networking" service. This deletes the interface "mgmt" and deletes the l3mdev CGROUP named "mgmt" and puts back the management interface "eth0" into the default VRF. Note that the VRFName "mgmt" (or "management") is reserved for management VRF. i.e. Data VRFs should not use these reserved VRF names.
- Usage:
```
config vrf del mgmt
```
- Example:
```
root@sonic-s6100-07:~# config vrf del mgmt
```
**config snmpagentaddress add**
This command adds the SNMP agent IP address on which the SNMP agent is expected to listen. When SNMP agent is expected to work as part of management VRF, users should specify the optional vrf_name parameter as "mgmt". This configuration goes into snmpd.conf that is used by SNMP agent. SNMP service is restarted to make this configuration effective in SNMP agent.
- Usage:
```
config snmpagentaddress add [-p <port_num>] [-v <vrf_name>] agentip
```
- Example:
```
root@sonic-s6100-07:~#config snmpagentaddress add -v mgmt -p 123 21.22.13.14

For this example, configuration goes into /etc/snmp/snmpd.conf inside snmp docker as follows. When "-v" parameter is not used, the additional "%" in the following line will not be present.

agentAddress 21.22.13.14:123%mgmt
```
**config snmpagentaddress del**
This command deletes the SNMP agent IP address on which the SNMP agent is expected to listen. When users had added the agent IP as part of "mgmt" VRF, users should specify the optional vrf_name parameter as "mgmt" while deleting as well. This configuration is removed from snmpd.conf that is used by SNMP agent. SNMP service is restarted to make this configuration effective in SNMP agent.
- Usage:
```
config snmpagentaddress del [-p <port_num>] [-v <vrf_name>] agentip
```
- Example:
```
root@sonic-s6100-07:~#config snmpagentaddress del -v mgmt -p 123 21.22.13.14

```
**config snmptrap modify**
This command modifies the SNMP trap server IP address to which the SNMP agent is expected to send the traps. Users can configure one server IP addrss for each SNMP version to send the traps. When SNMP agent is expected to send traps as part of management VRF, users should specify the optional vrf_name parameter as "mgmt". This configuration goes into snmpd.conf that is used by SNMP agent. SNMP service is restarted to make this configuration effective in SNMP agent.
- Usage:
```
config snmptrap modify <snmp_version> [-p <port_num>] [-v <vrf_name>] [-c <community>] trapserverip
```
- Example:
```
root@sonic-s6100-07:~#config snmptrap modify 2 -p 456 -v mgmt 21.21.21.21

For this example, configuration goes into /etc/snmp/snmpd.conf inside snmp docker as follows. When "-v" parameter is not used, the additional "%" in the following line will not be present. In case of SNMPv1, "trapsink" will be updated, in case of v2, "trap2sink" will be updated and in case of v3, "informsink" will be updated.

trap2sink 31.31.31.31:456%mgmt public

```
**config snmptrap del**
This command deletes the SNMP Trap server IP address to which SNMP agent is expected to send TRAPs. When users had added the trap server IP as part of "mgmt" VRF, users should specify the optional vrf_name parameter as "mgmt" while deleting as well. This configuration is removed from snmpd.conf that is used by SNMP agent. SNMP service is restarted to make this configuration effective in SNMP agent.
- Usage:
```
config snmptrap del [-p <port_num>] [-v <vrf_name>] [-c <community>] trapserverip
```
- Example:
```
root@sonic-s6100-07:~#config snmptrap del -v mgmt -p 123 21.22.13.14

```
Go Back To [Beginning of the document](#) or [Beginning of this section](#management-vrf)
## Mirroring
### Mirroring Show commands
Expand Down

0 comments on commit 0bdc3fd

Please sign in to comment.