Skip to content

Showtech sonic mgmt framework: Add Management Framework functionality for "show tech-support"#86

Merged
renukamanavalan merged 5 commits intosonic-net:masterfrom
kerry-meyer:showtech_sonic_mgmt_framework
Jan 20, 2022
Merged

Showtech sonic mgmt framework: Add Management Framework functionality for "show tech-support"#86
renukamanavalan merged 5 commits intosonic-net:masterfrom
kerry-meyer:showtech_sonic_mgmt_framework

Conversation

@kerry-meyer
Copy link
Contributor

@kerry-meyer kerry-meyer commented Jun 8, 2021

Provide the changes required for supporting the "show-techsupport" command via the SONiC Management Framework front end mechanisms (CLI, REST, and gNOI). The Management Framework functionality implemented by this PR improves on the the capabilities currently provided by the SONiC Click CLI interface via the "show techsupport" command by providing the following additional features:

  • User-friendly "help" information describing command syntax details for CLI invocation.
  • Ability to invoke the command via REST and gNOI mechanisms.

Unit test results are attached to this PR.

unit_test_log_0607.txt

Corequisite PRs:

sonic-net/sonic-mgmt-common#49

This file is being added to prepare for a SONiC Community Pull Request for the "show tech-support" feature.
This file is being added to prepare for a SONiC Community Pull Request for the "show tech-support" feature.
Provide changes needed in the Dell Enterprise version of this feature
to make it compatible with the SONiC Community code base.
@lgtm-com
Copy link

lgtm-com bot commented Jun 8, 2021

This pull request introduces 1 alert when merging cff479f into fd1a854 - view on LGTM.com

new alerts:

  • 1 for Except block handles 'BaseException'

…rrors

 - Avoid handling a "BaseException" for REST server invocation by
   specifying a finer granularity for the type of exception being
   handled.
 - Print the returned REST server invocation error message when applicable
   instead of a generic error message.
…eld.

These changes make use of an additional output field for the "show
tech-support" command. The corresponding output-status leaf is added
to the set of output leaves in the Yang definition for the
sonic-show-techsupport module. This additional field is specified
in the SONiC Community HLD for the Management Framework "show tech-support"
feature, but was not present in the initial implementation of the feature.

The purpose of the additional field is to provide an indication of
"success" or detailed failure  status that is separate from the
output-filename field. With this change, the output-filename contains
either an output filename or a null string, and is no longer used to
describe errors in the event of a failure.
@anshuv-mfst
Copy link

Hi @renukamanavalan - could you please review and merge, thanks

@leeprecy
Copy link

reviewed

@jeff-yin
Copy link

@renukamanavalan Please review/merge, thanks.

@renukamanavalan
Copy link

@sujinmkang, Can you please help with the review?

@renukamanavalan renukamanavalan merged commit 642bcde into sonic-net:master Jan 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants