kdump-Remote-SSH-Configurations

config/kdump.py

@@ -1,18 +1,17 @@
 import sys
-
 import click
-from utilities_common.cli import AbbreviationGroup, pass_db
-
 
+from utilities_common.cli import AbbreviationGroup, pass_db
+from pathlib import Path
 #
 # 'kdump' group ('sudo config kdump ...')
 #
+
 @click.group(cls=AbbreviationGroup, name="kdump")
 def kdump():
  """Configure the KDUMP mechanism"""
  pass
 
-
 def check_kdump_table_existence(kdump_table):
  """Checks whether the 'KDUMP' table is configured in Config DB.
 
@@ -32,9 +31,15 @@ def check_kdump_table_existence(kdump_table):
  sys.exit(2)
 
 
+def echo_reboot_warning():
+ """Prints the warning message about reboot requirements."""
+ click.echo("KDUMP configuration changes may require a reboot to take effect.")
+ click.echo("Save SONiC configuration using 'config save' before issuing the reboot command.")
 #
 # 'disable' command ('sudo config kdump disable')
 #
+
+
 @kdump.command(name="disable", short_help="Disable the KDUMP mechanism")
 @pass_db
 def kdump_disable(db):
@@ -43,13 +48,13 @@ def kdump_disable(db):
  check_kdump_table_existence(kdump_table)
 
  db.cfgdb.mod_entry("KDUMP", "config", {"enabled": "false"})
- click.echo("KDUMP configuration changes may require a reboot to take effect.")
- click.echo("Save SONiC configuration using 'config save' before issuing the reboot command.")
-
+ echo_reboot_warning()
 
 #
 # 'enable' command ('sudo config kdump enable')
 #
+
+
 @kdump.command(name="enable", short_help="Enable the KDUMP mechanism")
 @pass_db
 def kdump_enable(db):
@@ -58,13 +63,13 @@ def kdump_enable(db):
  check_kdump_table_existence(kdump_table)
 
  db.cfgdb.mod_entry("KDUMP", "config", {"enabled": "true"})
- click.echo("KDUMP configuration changes may require a reboot to take effect.")
- click.echo("Save SONiC configuration using 'config save' before issuing the reboot command.")
-
+ echo_reboot_warning()
 
 #
 # 'memory' command ('sudo config kdump memory ...')
 #
+
+
 @kdump.command(name="memory", short_help="Configure the memory for KDUMP mechanism")
 @click.argument('kdump_memory', metavar='<kdump_memory>', required=True)
 @pass_db
@@ -74,13 +79,13 @@ def kdump_memory(db, kdump_memory):
  check_kdump_table_existence(kdump_table)
 
  db.cfgdb.mod_entry("KDUMP", "config", {"memory": kdump_memory})
- click.echo("KDUMP configuration changes may require a reboot to take effect.")
- click.echo("Save SONiC configuration using 'config save' before issuing the reboot command.")
-
+ echo_reboot_warning()
 
 #
-# 'num_dumps' command ('sudo config keump num_dumps ...')
+# 'num_dumps' command ('sudo config kdump num_dumps ...')
 #
+
+
 @kdump.command(name="num_dumps", short_help="Configure the maximum dump files of KDUMP mechanism")
 @click.argument('kdump_num_dumps', metavar='<kdump_num_dumps>', required=True, type=int)
 @pass_db
@@ -90,3 +95,110 @@ def kdump_num_dumps(db, kdump_num_dumps):
  check_kdump_table_existence(kdump_table)
 
  db.cfgdb.mod_entry("KDUMP", "config", {"num_dumps": kdump_num_dumps})
+ echo_reboot_warning()
+
+
+# 'remote' command ('sudo config kdump remote ...')
+@kdump.command(name="remote", short_help="Enable or Disable Kdump Remote")
+@click.argument('action', required=True, type=click.Choice(['enable', 'disable'], case_sensitive=False))
+@pass_db
+def kdump_remote(db, action):
+
+ """Enable or Disable Kdump Remote Mode"""
+ kdump_table = db.cfgdb.get_table("KDUMP")
+ check_kdump_table_existence(kdump_table)
+ current_remote_status = kdump_table.get("config", {}).get("remote", "false").lower()
+
+ if action.lower() == 'enable' and current_remote_status == 'true':
+ click.echo("INFO: Kdump Remote Mode is already enabled.")
+ return
+
+ elif action.lower() == 'disable' and current_remote_status == 'false':
+ click.echo("Error: Kdump Remote Mode is already disabled.")
+ return
+
+ if action.lower() == 'disable':
+ ssh_string = kdump_table.get("config", {}).get("ssh_string", None)
+ ssh_key = kdump_table.get("config", {}).get("ssh_key", None)
+ if ssh_string or ssh_key:
+ click.echo("Error: Remove SSH_string, SSH_key from Config DB before disabling Kdump Remote Mode.")
+ return
+
+ remote = 'true' if action.lower() == 'enable' else 'false'
+ db.cfgdb.mod_entry("KDUMP", "config", {"remote": remote})
+ file_path = Path('/etc/default/kdump-tools')
+
+ # Values to be set for SSH and SSH_KEY
+ DEFAULT_SSH = "<user at server>"
+ DEFAULT_SSH_KEY = "<path>"
+
+ with open(file_path, 'r') as file:
+ lines = file.readlines()
+ updated_lines = []
+
+ for line in lines:
+ if remote:
+ if line.startswith("#SSH="):
+ updated_lines.append(f'SSH={DEFAULT_SSH}\n')
+ elif line.startswith("#SSH_KEY="):
+ updated_lines.append(f'SSH_KEY={DEFAULT_SSH_KEY}\n')
+ else:
+ updated_lines.append(line)
+ else:
+ if line.startswith("SSH="):
+ updated_lines.append(f'#SSH={DEFAULT_SSH}\n')
+ elif line.startswith("SSH_KEY="):
+ updated_lines.append(f'#SSH_KEY={DEFAULT_SSH_KEY}\n')
+ else:
+ updated_lines.append(line)
+
+ with open(file_path, 'w') as file:
+ file.writelines(updated_lines)
+ echo_reboot_warning()
+
+
+# 'add' command ('sudo config kdump add ...')
+@kdump.command(name="add", short_help="Add SSH connection string or SSH key path.")
+@click.argument('item', type=click.Choice(['ssh_string', 'ssh_path']))
+@click.argument('value', metavar='<value>', required=True)
+@pass_db
+def add_kdump_item(db, item, value):
+ """Add SSH connection string or SSH key path for kdump"""
+ kdump_table = db.cfgdb.get_table("KDUMP")
+ check_kdump_table_existence(kdump_table)
+
+ # Check if remote mode is enabled
+ remote_mode_enabled = kdump_table.get("config", {}).get("remote", "false").lower()
+ if remote_mode_enabled != "true":
+ click.echo("Error: Enable remote mode first.")
+ return
+
+ # Check if the item is already added
+ existing_value = kdump_table.get("config", {}).get(item)
+ if existing_value:
+ click.echo(f"Error: {item} is already added.")
+ return
+
+ # Add item to config_db
+ db.cfgdb.mod_entry("KDUMP", "config", {item: value})
+ echo_reboot_warning()
+
+
+@kdump.command(name="remove", short_help="Remove SSH connection string or SSH key path.")
+@click.argument('item', type=click.Choice(['ssh_string', 'ssh_path']))
+@pass_db
+def remove_kdump_item(db, item):
+ """Remove SSH connection string or SSH key path for kdump"""
+ kdump_table = db.cfgdb.get_table("KDUMP")
+ check_kdump_table_existence(kdump_table)
+
+ # Check if the item is already configured
+ existing_value = kdump_table.get("config", {}).get(item)
+ if not existing_value:
+ click.echo(f"Error: {item} is not configured.")
+ return
+
+ # Remove item from config_db
+ db.cfgdb.mod_entry("KDUMP", "config", {item: ""})
+ click.echo(f"{item} removed successfully.")
+ echo_reboot_warning()

scripts/sonic-kdump-config

@@ -172,9 +172,10 @@ def cmd_dump_config_json():
  kdump_enabled = get_kdump_administrative_mode()
  kdump_memory = get_kdump_memory()
  kdump_num_dumps = get_kdump_num_dumps()
+ # remote SSH variables
  data = { "enable" : kdump_enabled, \
  "memory" : kdump_memory, \
- "max-dumps" : int(kdump_num_dumps) }
+ "max-dumps" : int(kdump_num_dumps)}
  print(json.dumps(data, indent=4))
 
 def cmd_dump_kdump_records_json():
@@ -223,6 +224,7 @@ def cmd_dump_status_json():
  kdump_oper_state = get_kdump_oper_mode(kdump_enabled)
  kdump_memory = get_kdump_memory()
  kdump_num_dumps = get_kdump_num_dumps()
+ # remote SSH variables
  data = { "enable" : kdump_enabled, \
  "current-state" : kdump_oper_state, \
  "memory" : kdump_memory, \
@@ -417,7 +419,7 @@ def kdump_enable(verbose, kdump_enabled, memory, num_dumps, image, cmdline_file)
 
 ## Read kdump configuration saved in the startup configuration file
 #
-# @param config_param If True, the function will display a few additional information
+# @param config_param If True, the function will display a few additional information.
 # @return Value of the configuration parameter saved in the startup configuration file
 # @return None if the startup configuration file does not exist or the kdump
 # configuration parameter is not present in the file.
@@ -449,8 +451,7 @@ def cmd_kdump_enable(verbose, image):
  memory = get_kdump_memory()
  num_dumps = get_kdump_num_dumps()
  if verbose:
- print("configDB: kdump_enabled=%d memory=[%s] num_nums=%d" % (kdump_enabled, memory, num_dumps))
-
+ print("kdump enabled: %s" % kdump_enabled)
  if os.path.exists(grub_cfg):
  return kdump_enable(verbose, kdump_enabled, memory, num_dumps, image, grub_cfg)
  elif open(machine_cfg, 'r').read().find('aboot_platform') >= 0:
@@ -527,10 +528,9 @@ def cmd_kdump_disable(verbose):
  kdump_enabled = get_kdump_administrative_mode()
  memory = get_kdump_memory()
  num_dumps = get_kdump_num_dumps()
-
+ 
  if verbose:
  print("configDB: kdump_enabled=%d memory=[%s] num_nums=%d" % (kdump_enabled, memory, num_dumps))
-
  if os.path.exists(grub_cfg):
  return kdump_disable(verbose, image, grub_cfg)
  elif open(machine_cfg, 'r').read().find('aboot_platform') >= 0:

show/kdump.py

@@ -83,6 +83,14 @@ def config():
  num_files_config = get_kdump_config("num_dumps")
  click.echo("Maximum number of Kdump files: {}".format(num_files_config))
 
+ # remote SSH configs
+ if get_kdump_config("remote") == "true":
+ ssh_conn_str = get_kdump_config("ssh_string")
+ click.echo("Kdump ssh connection string: {}".format(ssh_conn_str))
+
+ ssh_prv_key = get_kdump_config("ssh_path")
+ click.echo("Kdump private key path: {}".format(ssh_prv_key))
+
 
 def get_kdump_core_files():
  """Retrieves the kernel core dump files from directory '/var/crash/'.