Console

class zos_console.zowe.zos_console_for_zowe_sdk.Console(connection: dict, log: bool = True)

Class used to represent the base z/OSMF Console API.

Parameters:
  • connection (dict) – A profile in dict (json) format

  • log (bool) – Flag to disable logger

get_response(response_key: str, console: str | None = None) ConsoleResponse

Collect outstanding synchronous z/OS Console response messages.

Parameters:
  • response_key (str) – The command response key from the Issue Command request.

  • console (Optional[str]) – The console that should be used to get the command response.

Returns:

A JSON containing the response to the command

Return type:

ConsoleResponse

issue_command(command: str, console: str | None = None) IssueCommandResponse

Issues a command on z/OS Console.

Parameters:
  • command (str) – The z/OS command to be executed

  • console (Optional[str]) – Name of the console that should be used to execute the command (default is None)

Returns:

A JSON containing the response from the console command

Return type:

IssueCommandResponse