forked from sonic-net/sonic-utilities
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Switch Port Modes and VLAN CLI Enhancement (sonic-net#2419)
#### What I did
- Modified "/config/vlan.py" to add support for multiple vids, range of vids in ```vlan add|del``` and ```vlan member add|del```
- Creation of "/config/switchport.py" which will deal with port modes for interfaces i.e. access, trunk and routed
- Created the ```show interface switchport status``` and ```show interface switchport config``` commands so that it shows the status of port either being access, trunk or routed.
- Modified ```Command-Reference.md``` to add new commands in it with usage and examples
- Added new utility functions in "/utilities_common/cli.py" to use in vlan.py and switchport.py commands
- Modified test cases and added new test cases for the new commands
#### How I did it
- Added new commands and modified the existing commands in "/config/vlan.py" to
- accept multiple vids
- accept range of vids
- ```except_flag``` and ```all option``` in vlan member command
- Creation of "/config/switchport.py" file to add commands which will deal with port modes i.e. access, trunk or routed which we were unable to define or assign in SONiC before
- New utility functions in "/utilities_common/cli.py"
- Using ```show interface switchport status``` and ```show interface switchport config``` commands, it will display if an interface is in access or trunk or routed mode.
#### How to verify it
New commands have been added in Command-Reference.md All the syntax and examples have been added there and they can be verified by running the specific command- Loading branch information
1 parent
c523ff2
commit a0b1cdc
Showing
19 changed files
with
1,982 additions
and
209 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| import click | ||
| from .utils import log | ||
| import utilities_common.cli as clicommon | ||
|
|
||
| # | ||
| # 'switchport' mode ('config switchport ...') | ||
| # | ||
|
|
||
|
|
||
| @click.group(cls=clicommon.AbbreviationGroup, name='switchport') | ||
| def switchport(): | ||
| """Switchport mode configuration tasks""" | ||
| pass | ||
|
|
||
|
|
||
| @switchport.command("mode") | ||
| @click.argument("type", metavar="<mode_type>", required=True, type=click.Choice(["access", "trunk", "routed"])) | ||
| @click.argument("port", metavar="port", required=True) | ||
| @clicommon.pass_db | ||
| def switchport_mode(db, type, port): | ||
| """switchport mode help commands.Mode_type can be access or trunk or routed""" | ||
|
|
||
| ctx = click.get_current_context() | ||
|
|
||
| log.log_info("'switchport mode {} {}' executing...".format(type, port)) | ||
| mode_exists_status = True | ||
|
|
||
| # checking if port name with alias exists | ||
| if clicommon.get_interface_naming_mode() == "alias": | ||
| alias = port | ||
| iface_alias_converter = clicommon.InterfaceAliasConverter(db) | ||
| port = iface_alias_converter.alias_to_name(port) | ||
| if port is None: | ||
| ctx.fail("cannot find port name for alias {}".format(alias)) | ||
|
|
||
| if clicommon.is_port_mirror_dst_port(db.cfgdb, port): | ||
| ctx.fail("{} is configured as mirror destination port".format(port)) | ||
|
|
||
|
|
||
| if clicommon.is_valid_port(db.cfgdb, port): | ||
| is_port = True | ||
| elif clicommon.is_valid_portchannel(db.cfgdb, port): | ||
| is_port = False | ||
| else: | ||
| ctx.fail("{} does not exist".format(port)) | ||
|
|
||
| portchannel_member_table = db.cfgdb.get_table('PORTCHANNEL_MEMBER') | ||
|
|
||
| if (is_port and clicommon.interface_is_in_portchannel(portchannel_member_table, port)): | ||
| ctx.fail("{} is part of portchannel!".format(port)) | ||
|
|
||
| if is_port: | ||
| port_data = db.cfgdb.get_entry('PORT',port) | ||
| else: | ||
| port_data = db.cfgdb.get_entry('PORTCHANNEL',port) | ||
|
|
||
| # mode type is either access or trunk | ||
| if type != "routed": | ||
|
|
||
| if "mode" in port_data: | ||
| existing_mode = port_data["mode"] | ||
| else: | ||
| existing_mode = "routed" | ||
| mode_exists_status = False | ||
| if (is_port and clicommon.is_port_router_interface(db.cfgdb, port)) or \ | ||
| (not is_port and clicommon.is_pc_router_interface(db.cfgdb, port)): | ||
| ctx.fail("Remove IP from {} to change mode!".format(port)) | ||
|
|
||
| if existing_mode == "routed": | ||
| if mode_exists_status: | ||
| # if the port in an interface | ||
| if is_port: | ||
| db.cfgdb.mod_entry("PORT", port, {"mode": "{}".format(type)}) | ||
| # if not port then is a port channel | ||
| elif not is_port: | ||
| db.cfgdb.mod_entry("PORTCHANNEL", port, {"mode": "{}".format(type)}) | ||
|
|
||
| if not mode_exists_status: | ||
| port_data["mode"] = type | ||
| if is_port: | ||
| db.cfgdb.set_entry("PORT", port, port_data) | ||
| # if not port then is a port channel | ||
| elif not is_port: | ||
| db.cfgdb.set_entry("PORTCHANNEL", port, port_data) | ||
|
|
||
| if existing_mode == type: | ||
| ctx.fail("{} is already in the {} mode".format(port,type)) | ||
| else: | ||
| if existing_mode == "access" and type == "trunk": | ||
| pass | ||
| if existing_mode == "trunk" and type == "access": | ||
| if clicommon.interface_is_tagged_member(db.cfgdb,port): | ||
| ctx.fail("{} is in {} mode and have tagged member(s).\nRemove tagged member(s) from {} to switch to {} mode".format(port,existing_mode,port,type)) | ||
| if is_port: | ||
| db.cfgdb.mod_entry("PORT", port, {"mode": "{}".format(type)}) | ||
| # if not port then is a port channel | ||
| elif not is_port: | ||
| db.cfgdb.mod_entry("PORTCHANNEL", port, {"mode": "{}".format(type)}) | ||
|
|
||
| click.echo("{} switched from {} to {} mode".format(port, existing_mode, type)) | ||
|
|
||
| # if mode type is routed | ||
| else: | ||
|
|
||
| if clicommon.interface_is_tagged_member(db.cfgdb,port): | ||
| ctx.fail("{} has tagged member(s). \nRemove them to change mode to {}".format(port,type)) | ||
|
|
||
| if clicommon.interface_is_untagged_member(db.cfgdb,port): | ||
| ctx.fail("{} has untagged member. \nRemove it to change mode to {}".format(port,type)) | ||
|
|
||
| if "mode" in port_data: | ||
| existing_mode = port_data["mode"] | ||
| else: | ||
| existing_mode = "routed" | ||
| mode_exists_status = False | ||
|
|
||
| if not mode_exists_status: | ||
| port_data["mode"] = type | ||
| if is_port: | ||
| db.cfgdb.set_entry("PORT", port, port_data) | ||
|
|
||
| # if not port then is a port channel | ||
| elif not is_port: | ||
| db.cfgdb.set_entry("PORTCHANNEL", port, port_data) | ||
| pass | ||
|
|
||
| elif mode_exists_status and existing_mode == type: | ||
| ctx.fail("{} is already in {} mode".format(port,type)) | ||
|
|
||
| else: | ||
| if is_port: | ||
| db.cfgdb.mod_entry("PORT", port, {"mode": "{}".format(type)}) | ||
| # if not port then is a port channel | ||
| elif not is_port: | ||
| db.cfgdb.mod_entry("PORTCHANNEL", port, {"mode": "{}".format(type)}) | ||
|
|
||
| click.echo("{} switched from {} to {} mode".format(port,existing_mode,type)) | ||
|
|
Oops, something went wrong.