-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[config][show] CLI support for interacting with muxcable (#1221)
* Cli support for muxcable to integrate with hardware_proxy What is the motivation for this PR? To add the support for Cli for muxcable to be utilized for configuring and showing the status of all the Port/Ports on a muxcable. How did you do it? Added the changes inside sonic-utilities and tested it on the testbed How did you verify/test it? Ran the cli commands on an Arista7260cx3 testbed with Gemini cable Signed-off-by: vaibhav-dahiya [email protected]
- Loading branch information
Showing
13 changed files
with
1,271 additions
and
0 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,190 @@ | ||
import json | ||
import os | ||
import sys | ||
|
||
import click | ||
import utilities_common.cli as clicommon | ||
from sonic_py_common import multi_asic | ||
from swsssdk import ConfigDBConnector | ||
from swsscommon import swsscommon | ||
from tabulate import tabulate | ||
from utilities_common import platform_sfputil_helper | ||
|
||
platform_sfputil = None | ||
|
||
REDIS_TIMEOUT_MSECS = 0 | ||
|
||
CONFIG_SUCCESSFUL = 100 | ||
CONFIG_FAIL = 1 | ||
|
||
|
||
# Helper functions | ||
|
||
|
||
def get_value_for_key_in_dict(mdict, port, key, table_name): | ||
value = mdict.get(key, None) | ||
if value is None: | ||
click.echo("could not retrieve key {} value for port {} inside table {}".format(key, port, table_name)) | ||
sys.exit(CONFIG_FAIL) | ||
return value | ||
|
||
# | ||
# 'muxcable' command ("config muxcable") | ||
# | ||
|
||
|
||
def get_value_for_key_in_config_tbl(config_db, port, key, table): | ||
info_dict = {} | ||
info_dict = config_db.get_entry(table, port) | ||
if info_dict is None: | ||
click.echo("could not retrieve key {} value for port {} inside table {}".format(key, port, table)) | ||
sys.exit(CONFIG_FAIL) | ||
|
||
value = get_value_for_key_in_dict(info_dict, port, key, table) | ||
|
||
return value | ||
|
||
|
||
@click.group(name='muxcable', cls=clicommon.AliasedGroup) | ||
def muxcable(): | ||
"""SONiC command line - 'show muxcable' command""" | ||
|
||
if os.geteuid() != 0: | ||
click.echo("Root privileges are required for this operation") | ||
sys.exit(CONFIG_FAIL) | ||
|
||
global platform_sfputil | ||
# Load platform-specific sfputil class | ||
platform_sfputil_helper.load_platform_sfputil() | ||
|
||
# Load port info | ||
platform_sfputil_helper.platform_sfputil_read_porttab_mappings() | ||
|
||
platform_sfputil = platform_sfputil_helper.platform_sfputil | ||
|
||
|
||
def lookup_statedb_and_update_configdb(per_npu_statedb, config_db, port, state_cfg_val, port_status_dict): | ||
|
||
muxcable_statedb_dict = per_npu_statedb.get_all(per_npu_statedb.STATE_DB, 'MUX_CABLE_TABLE|{}'.format(port)) | ||
configdb_state = get_value_for_key_in_config_tbl(config_db, port, "state", "MUX_CABLE") | ||
ipv4_value = get_value_for_key_in_config_tbl(config_db, port, "server_ipv4", "MUX_CABLE") | ||
ipv6_value = get_value_for_key_in_config_tbl(config_db, port, "server_ipv6", "MUX_CABLE") | ||
|
||
state = get_value_for_key_in_dict(muxcable_statedb_dict, port, "state", "MUX_CABLE_TABLE") | ||
if (state == "active" and configdb_state == "active") or (state == "standby" and configdb_state == "active") or (state == "unknown" and configdb_state == "active") : | ||
if state_cfg_val == "active": | ||
# status is already active, so right back error | ||
port_status_dict[port] = 'OK' | ||
if state_cfg_val == "auto": | ||
# display ok and write to cfgdb auto | ||
port_status_dict[port] = 'OK' | ||
config_db.set_entry("MUX_CABLE", port, {"state": "auto", | ||
"server_ipv4": ipv4_value, "server_ipv6": ipv6_value}) | ||
elif state == "active" and configdb_state == "auto": | ||
if state_cfg_val == "active": | ||
# make the state active and write back OK | ||
config_db.set_entry("MUX_CABLE", port, {"state": "active", | ||
"server_ipv4": ipv4_value, "server_ipv6": ipv6_value}) | ||
port_status_dict[port] = 'OK' | ||
if state_cfg_val == "auto": | ||
# dont write anything to db, write OK to user | ||
port_status_dict[port] = 'OK' | ||
|
||
elif (state == "standby" and configdb_state == "auto") or (state == "unknown" and configdb_state == "auto"): | ||
if state_cfg_val == "active": | ||
# make the state active | ||
config_db.set_entry("MUX_CABLE", port, {"state": "active", | ||
"server_ipv4": ipv4_value, "server_ipv6": ipv6_value}) | ||
port_status_dict[port] = 'INPROGRESS' | ||
if state_cfg_val == "auto": | ||
# dont write anything to db | ||
port_status_dict[port] = 'OK' | ||
|
||
|
||
# 'muxcable' command ("config muxcable mode <port|all> active|auto") | ||
@muxcable.command() | ||
@click.argument('state', metavar='<operation_status>', required=True, type=click.Choice(["active", "auto"])) | ||
@click.argument('port', metavar='<port_name>', required=True, default=None) | ||
@click.option('--json', 'json_output', required=False, is_flag=True, type=click.BOOL) | ||
def mode(state, port, json_output): | ||
"""Show muxcable summary information""" | ||
|
||
port_table_keys = {} | ||
y_cable_asic_table_keys = {} | ||
per_npu_configdb = {} | ||
per_npu_statedb = {} | ||
mux_tbl_cfg_db = {} | ||
|
||
# Getting all front asic namespace and correspding config and state DB connector | ||
|
||
namespaces = multi_asic.get_front_end_namespaces() | ||
for namespace in namespaces: | ||
asic_id = multi_asic.get_asic_index_from_namespace(namespace) | ||
# replace these with correct macros | ||
per_npu_configdb[asic_id] = ConfigDBConnector(use_unix_socket_path=True, namespace=namespace) | ||
per_npu_configdb[asic_id].connect() | ||
per_npu_statedb[asic_id] = swsscommon.SonicV2Connector(use_unix_socket_path=True, namespace=namespace) | ||
per_npu_statedb[asic_id].connect(per_npu_statedb[asic_id].STATE_DB) | ||
|
||
mux_tbl_cfg_db[asic_id] = per_npu_configdb[asic_id].get_table("MUX_CABLE") | ||
|
||
port_table_keys[asic_id] = per_npu_statedb[asic_id].keys( | ||
per_npu_statedb[asic_id].STATE_DB, 'MUX_CABLE_TABLE|*') | ||
|
||
if port is not None and port != "all": | ||
|
||
asic_index = None | ||
if platform_sfputil is not None: | ||
asic_index = platform_sfputil.get_asic_id_for_logical_port(port) | ||
if asic_index is None: | ||
# TODO this import is only for unit test purposes, and should be removed once sonic_platform_base | ||
# is fully mocked | ||
import sonic_platform_base.sonic_sfp.sfputilhelper | ||
asic_index = sonic_platform_base.sonic_sfp.sfputilhelper.SfpUtilHelper().get_asic_id_for_logical_port(port) | ||
if asic_index is None: | ||
click.echo("Got invalid asic index for port {}, cant retreive mux status".format(port)) | ||
sys.exit(CONFIG_FAIL) | ||
|
||
if per_npu_statedb[asic_index] is not None: | ||
y_cable_asic_table_keys = port_table_keys[asic_index] | ||
logical_key = "MUX_CABLE_TABLE"+"|"+port | ||
if logical_key in y_cable_asic_table_keys: | ||
port_status_dict = {} | ||
lookup_statedb_and_update_configdb( | ||
per_npu_statedb[asic_index], per_npu_configdb[asic_index], port, state, port_status_dict) | ||
|
||
if json_output: | ||
click.echo("{}".format(json.dumps(port_status_dict, indent=4))) | ||
else: | ||
headers = ['port', 'state'] | ||
data = sorted([(k, v) for k, v in port_status_dict.items()]) | ||
click.echo(tabulate(data, headers=headers)) | ||
|
||
sys.exit(CONFIG_SUCCESSFUL) | ||
|
||
else: | ||
click.echo("this is not a valid port present on mux_cable".format(port)) | ||
sys.exit(CONFIG_FAIL) | ||
else: | ||
click.echo("there is not a valid asic table for this asic_index".format(asic_index)) | ||
sys.exit(CONFIG_FAIL) | ||
|
||
elif port == "all" and port is not None: | ||
|
||
port_status_dict = {} | ||
for namespace in namespaces: | ||
asic_id = multi_asic.get_asic_index_from_namespace(namespace) | ||
for key in port_table_keys[asic_id]: | ||
logical_port = key.split("|")[1] | ||
lookup_statedb_and_update_configdb( | ||
per_npu_statedb[asic_id], per_npu_configdb[asic_id], logical_port, state, port_status_dict) | ||
|
||
if json_output: | ||
click.echo("{}".format(json.dumps(port_status_dict, indent=4))) | ||
else: | ||
data = sorted([(k, v) for k, v in port_status_dict.items()]) | ||
|
||
headers = ['port', 'state'] | ||
click.echo(tabulate(data, headers=headers)) | ||
|
||
sys.exit(CONFIG_SUCCESSFUL) |
Oops, something went wrong.