Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated DOCUMENTATION in plugins/cliconf/os6.py and plugins/modules/os6_command.py #48

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

nazeerhussainf
Copy link

@nazeerhussainf nazeerhussainf commented Apr 12, 2022

SUMMARY

Replaced 'cliconf' to 'name' under DOCUMENTATION in plugins/cliconf/os6.py
Made following changes to plugins/modules/os6_command.py

  • Changed M(dellemc_os6_os6_config) to M(dellemc.os6.os6_config)
  • 'elements' was missing in commands description. Added "elements: str".
ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

plugins/cliconf/os6.py
plugins/modules/os6_command.py

ADDITIONAL INFORMATION

The following errors were seen during sanity run.
ERROR: plugins/cliconf/os6.py:0:0: invalid-documentation: DOCUMENTATION.cliconf: extra keys not allowed @ data['cliconf']. Got 'os6'
ERROR: plugins/cliconf/os6.py:0:0: invalid-documentation: DOCUMENTATION.name: required key not provided @ data['name']. Got None

Replaced 'cliconf' to 'name' under DOCUMENTATION in plugins/cliconf/os6.py
DOCUMENTATION = """

name: os6
short_description: Use os6 cliconf to run command on Dell OS6 platform
description:

  • This os6 plugin provides low level abstraction apis for
    sending and receiving CLI commands from Dell OS6 network devices.
    """

Made following changes to plugins/modules/os6_command.py

  • Changed M(dellemc_os6_os6_config) to M(dellemc.os6.os6_config)
  • 'elements' was missing in commands description. Added "elements: str".

@nazeerhussainf nazeerhussainf changed the title Update os6.py Update DOCUMENTATION in plugins/cliconf/os6.py and plugins/modules/os6_command.py Apr 12, 2022
@nazeerhussainf nazeerhussainf changed the title Update DOCUMENTATION in plugins/cliconf/os6.py and plugins/modules/os6_command.py Updated DOCUMENTATION in plugins/cliconf/os6.py and plugins/modules/os6_command.py Apr 12, 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.

1 participant