zowe / zowe/zowe-client-python-sdk

[zos-uss] Add method to issue SSH commands

Open
#253 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement priority-medium
Dominant language
Python
Stars
44
Forks
38
Avg merge
1d 3h
Merged PRs (30d)
1

Description

  • Create a new zos-uss SDK modeled after the zos-console SDK. We'll need a new folder inside the src dir and new test files in subfolders of the tests dir.
  • Investigate 3rd party dependencies for handling SSH connections, such as Paramiko or Fabric. We'll need something similar to the ssh2 package used by the Node.js SDK.
  • Add a method to the Python zos-uss SDK for issuing SSH commands. We can model it after the executeSsh method in the Node.js SDK, as well as the zos-console Python SDK.
    • Uss class with constructor that accepts profile object
    • Method that takes a Unix command and optionally a cwd (working directory) as arguments

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing zos-console SDK under src and its corresponding tests under tests, then compare the Node.js executeSsh method. Investigate Paramiko and Fabric for SSH handling, and add a zos-uss SDK with a profile-based Uss class and command method supporting an optional cwd, with tests for the new behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.