x2gobroker.client.plain module

class x2gobroker.client.plain.X2GoBrokerClient[source]

Bases: object

Implementation of a command line interface to X2Go Session Broker. This CLI can be evoked over an SSH connection. This provides the so-called SSH mode for X2Go Session Broker.

get(args)[source]

Analogy to the http request get method of the HTTP X2Go Session Broker, this method expects a set of arguments (i.e., an instance of :class:argparse.ArgumentParser) and process the given arguments.

Well-known arguments are:

  • args.user - broker user on whose behalf to operate
  • args.login - X2Go Server user for whom to perform the task
  • args.auth_cookie - authentication cookie
  • args.task - broker backend task to perform
  • args.profile_id - session profile ID
Parameters:args (obj) – an :class:argparse.ArgumentParser object provide by the x2gobroker command line script
Returns:output as expected by the calling client side
Return type:str