x2go.backends.control.plain.X2GoControlSession class - core functions for handling your individual X2Go sessions.
This backend handles X2Go server implementations that respond via server-side PLAIN text output.
\nx2go.backends.control.plain.X2GoControlSession(profile_name='UNKNOWN', add_to_known_hosts=False, known_hosts=None, forward_sshagent=False, unique_hostkey_aliases=False, terminal_backend='PLAIN', info_backend='PLAIN', list_backend='PLAIN', proxy_backend='NX3', client_rootdir='/nonexistent/first-build/.x2goclient', sessions_rootdir='/nonexistent/first-build/.x2go', ssh_rootdir='/nonexistent/first-build/.ssh', logger=None, loglevel=56, published_applications_no_submenus=0, low_latency=False, **kwargs)[source]\u00b6x2go.backends.control.plain.X2GoControlSession(profile_name='UNKNOWN', add_to_known_hosts=False, known_hosts=None, forward_sshagent=False, unique_hostkey_aliases=False, terminal_backend='PLAIN', info_backend='PLAIN', list_backend='PLAIN', proxy_backend='NX3', client_rootdir='/nonexistent/second-build/.x2goclient', sessions_rootdir='/nonexistent/second-build/.x2go', ssh_rootdir='/nonexistent/second-build/.ssh', logger=None, loglevel=56, published_applications_no_submenus=0, low_latency=False, **kwargs)[source]\u00b6\n Bases: paramiko.client.SSHClient
In the Python X2Go concept, X2Go sessions fall into two parts: a control session and one to many terminal sessions.
\nThe control session handles the SSH based communication between server and client. It is mainly derived from\n paramiko.SSHClient and adds on X2Go related functionality.
check_host(hostname, port=22)[source]\u00b6x2go.backends.printing.file.X2GoClientPrinting class is one of Python X2Go\u2019s public API classes.
Retrieve an instance of this class from your x2go.client.X2GoClient instance.
Use this class in your Python X2Go based applications to access the \u00bbprinting\u00ab\n configuration of your X2Go client application.
\nx2go.backends.printing.file.X2GoClientPrinting(config_files=['/nonexistent/first-build/.x2goclient/printing', '/etc/x2goclient/printing'], defaults={'CUPS': {'defaultprinter': 'PDF'}, 'General': {'pdfview': True, 'showdialog': False}, 'print': {'command': 'lpr', 'ps': False, 'startcmd': False, 'stdin': False}, 'save': {'folder': 'PDF'}, 'view': {'command': 'xdg-open', 'open': True}}, client_instance=None, logger=None, loglevel=56)[source]\u00b6x2go.backends.printing.file.X2GoClientPrinting(config_files=['/nonexistent/second-build/.x2goclient/printing', '/etc/x2goclient/printing'], defaults={'CUPS': {'defaultprinter': 'PDF'}, 'General': {'pdfview': True, 'showdialog': False}, 'print': {'command': 'lpr', 'ps': False, 'startcmd': False, 'stdin': False}, 'save': {'folder': 'PDF'}, 'view': {'command': 'xdg-open', 'open': True}}, client_instance=None, logger=None, loglevel=56)[source]\u00b6\n Bases: x2go.inifiles.X2GoIniFile
x2go.backends.printing.file.X2GoClientPrinting provides access to the X2Go ini-like file\n \u00bbprinting\u00ab as stored in ~/.x2goclient/printing resp. globally\n /etc/x2goclient/printing.
An instance of x2go.backends.printing.file.X2GoClientPrinting is created on each incoming\n print job. This facilitates that on every print job the print action\n for this job is derived from the \u00bbprinting\u00ab configuration file.
X2GoProfileException \u2013 if no such session profile exists
\ndefaultSessionProfile = {'applications': ['WWWBROWSER', 'MAILCLIENT', 'OFFICE', 'TERMINAL'], 'autoconnect': False, 'autologin': True, 'autostart': False, 'clipboard': 'both', 'command': 'TERMINAL', 'defsndport': True, 'directrdp': False, 'directrdpsettings': '', 'display': 1, 'dpi': 96, 'export': {}, 'forwardsshagent': False, 'fstunnel': True, 'fullscreen': False, 'height': 600, 'host': ['server.mydomain'], 'icon': ':icons/128x128/x2gosession.png', 'iconvfrom': 'UTF-8', 'iconvto': 'UTF-8', 'kdrive': False, 'key': '', 'krblogin': False, 'layout': 'us', 'maxdim': False, 'mimeboxaction': 'OPEN', 'mimeboxextensions': '', 'multidisp': False, 'name': 'NEW_PROFILE', 'pack': '16m-jpeg', 'print': False, 'published': False, 'quality': 9, 'rdpclient': 'rdesktop', 'rdpoptions': '-u X2GO_USER -p X2GO_PASSWORD', 'rdpport': 3389, 'rdpserver': '', 'restoreexports': False, 'rootless': True, 'sessiontitle': '', 'setdpi': False, 'setsessiontitle': False, 'sndport': 4713, 'sound': False, 'soundsystem': 'pulse', 'soundtunnel': True, 'speed': 2, 'sshport': 22, 'sshproxyautologin': True, 'sshproxyhost': 'proxyhost.mydomain', 'sshproxykeyfile': '', 'sshproxyport': 22, 'sshproxysamepass': False, 'sshproxysameuser': False, 'sshproxytype': 'SSH', 'sshproxyuser': '', 'startsoundsystem': False, 'type': 'pc105/us', 'uniquehostkeyaliases': False, 'useexports': True, 'useiconv': False, 'usekbd': True, 'usemimebox': False, 'user': 'pbuilder1', 'usesshproxy': False, 'variant': '', 'width': 800, 'xdmcpserver': 'localhost', 'xinerama': False}\u00b6defaultSessionProfile = {'applications': ['WWWBROWSER', 'MAILCLIENT', 'OFFICE', 'TERMINAL'], 'autoconnect': False, 'autologin': True, 'autostart': False, 'clipboard': 'both', 'command': 'TERMINAL', 'defsndport': True, 'directrdp': False, 'directrdpsettings': '', 'display': 1, 'dpi': 96, 'export': {}, 'forwardsshagent': False, 'fstunnel': True, 'fullscreen': False, 'height': 600, 'host': ['server.mydomain'], 'icon': ':icons/128x128/x2gosession.png', 'iconvfrom': 'UTF-8', 'iconvto': 'UTF-8', 'kdrive': False, 'key': '', 'krblogin': False, 'layout': 'us', 'maxdim': False, 'mimeboxaction': 'OPEN', 'mimeboxextensions': '', 'multidisp': False, 'name': 'NEW_PROFILE', 'pack': '16m-jpeg', 'print': False, 'published': False, 'quality': 9, 'rdpclient': 'rdesktop', 'rdpoptions': '-u X2GO_USER -p X2GO_PASSWORD', 'rdpport': 3389, 'rdpserver': '', 'restoreexports': False, 'rootless': True, 'sessiontitle': '', 'setdpi': False, 'setsessiontitle': False, 'sndport': 4713, 'sound': False, 'soundsystem': 'pulse', 'soundtunnel': True, 'speed': 2, 'sshport': 22, 'sshproxyautologin': True, 'sshproxyhost': 'proxyhost.mydomain', 'sshproxykeyfile': '', 'sshproxyport': 22, 'sshproxysamepass': False, 'sshproxysameuser': False, 'sshproxytype': 'SSH', 'sshproxyuser': '', 'startsoundsystem': False, 'type': 'pc105/us', 'uniquehostkeyaliases': False, 'useexports': True, 'useiconv': False, 'usekbd': True, 'usemimebox': False, 'user': 'pbuilder2', 'usesshproxy': False, 'variant': '', 'width': 800, 'xdmcpserver': 'localhost', 'xinerama': False}\u00b6\n default_profile_config()[source]\u00b6Return a default session profile.
\nx2go.backends.profiles.file.X2GoSessionProfiles class - managing X2Go Client session profiles read from a file (~/.x2goclient/sessions).
x2go.backends.profiles.base.X2GoSessionProfiles is a public API class. Use this class in your Python X2Go based\n applications.
x2go.backends.profiles.file.X2GoSessionProfiles(config_files=['/nonexistent/first-build/.x2goclient/sessions', '/etc/x2goclient/sessions'], session_profile_defaults=None, logger=None, loglevel=56, **kwargs)[source]\u00b6x2go.backends.profiles.file.X2GoSessionProfiles(config_files=['/nonexistent/second-build/.x2goclient/sessions', '/etc/x2goclient/sessions'], session_profile_defaults=None, logger=None, loglevel=56, **kwargs)[source]\u00b6\n Bases: x2go.backends.profiles.base.X2GoSessionProfiles, x2go.inifiles.X2GoIniFile
get_type(section, key)[source]\u00b6Override the inifile class\u2019s get_type method due to the special layout of the session profile\n class.
\ndefaultSessionProfile = {'applications': ['WWWBROWSER', 'MAILCLIENT', 'OFFICE', 'TERMINAL'], 'autoconnect': False, 'autologin': True, 'autostart': False, 'clipboard': 'both', 'command': 'TERMINAL', 'defsndport': True, 'directrdp': False, 'directrdpsettings': '', 'display': 1, 'dpi': 96, 'export': {}, 'forwardsshagent': False, 'fstunnel': True, 'fullscreen': False, 'height': 600, 'host': ['server.mydomain'], 'icon': ':icons/128x128/x2gosession.png', 'iconvfrom': 'UTF-8', 'iconvto': 'UTF-8', 'kdrive': False, 'key': '', 'krblogin': False, 'layout': 'us', 'maxdim': False, 'mimeboxaction': 'OPEN', 'mimeboxextensions': '', 'multidisp': False, 'name': 'NEW_PROFILE', 'pack': '16m-jpeg', 'print': False, 'published': False, 'quality': 9, 'rdpclient': 'rdesktop', 'rdpoptions': '-u X2GO_USER -p X2GO_PASSWORD', 'rdpport': 3389, 'rdpserver': '', 'restoreexports': False, 'rootless': True, 'sessiontitle': '', 'setdpi': False, 'setsessiontitle': False, 'sndport': 4713, 'sound': False, 'soundsystem': 'pulse', 'soundtunnel': True, 'speed': 2, 'sshport': 22, 'sshproxyautologin': True, 'sshproxyhost': 'proxyhost.mydomain', 'sshproxykeyfile': '', 'sshproxyport': 22, 'sshproxysamepass': False, 'sshproxysameuser': False, 'sshproxytype': 'SSH', 'sshproxyuser': '', 'startsoundsystem': False, 'type': 'pc105/us', 'uniquehostkeyaliases': False, 'useexports': True, 'useiconv': False, 'usekbd': True, 'usemimebox': False, 'user': 'pbuilder1', 'usesshproxy': False, 'variant': '', 'width': 800, 'xdmcpserver': 'localhost', 'xinerama': False}\u00b6defaultSessionProfile = {'applications': ['WWWBROWSER', 'MAILCLIENT', 'OFFICE', 'TERMINAL'], 'autoconnect': False, 'autologin': True, 'autostart': False, 'clipboard': 'both', 'command': 'TERMINAL', 'defsndport': True, 'directrdp': False, 'directrdpsettings': '', 'display': 1, 'dpi': 96, 'export': {}, 'forwardsshagent': False, 'fstunnel': True, 'fullscreen': False, 'height': 600, 'host': ['server.mydomain'], 'icon': ':icons/128x128/x2gosession.png', 'iconvfrom': 'UTF-8', 'iconvto': 'UTF-8', 'kdrive': False, 'key': '', 'krblogin': False, 'layout': 'us', 'maxdim': False, 'mimeboxaction': 'OPEN', 'mimeboxextensions': '', 'multidisp': False, 'name': 'NEW_PROFILE', 'pack': '16m-jpeg', 'print': False, 'published': False, 'quality': 9, 'rdpclient': 'rdesktop', 'rdpoptions': '-u X2GO_USER -p X2GO_PASSWORD', 'rdpport': 3389, 'rdpserver': '', 'restoreexports': False, 'rootless': True, 'sessiontitle': '', 'setdpi': False, 'setsessiontitle': False, 'sndport': 4713, 'sound': False, 'soundsystem': 'pulse', 'soundtunnel': True, 'speed': 2, 'sshport': 22, 'sshproxyautologin': True, 'sshproxyhost': 'proxyhost.mydomain', 'sshproxykeyfile': '', 'sshproxyport': 22, 'sshproxysamepass': False, 'sshproxysameuser': False, 'sshproxytype': 'SSH', 'sshproxyuser': '', 'startsoundsystem': False, 'type': 'pc105/us', 'uniquehostkeyaliases': False, 'useexports': True, 'useiconv': False, 'usekbd': True, 'usemimebox': False, 'user': 'pbuilder2', 'usesshproxy': False, 'variant': '', 'width': 800, 'xdmcpserver': 'localhost', 'xinerama': False}\u00b6\n get_broker_noauth()[source]\u00b6Accessor for the class\u2019s broker_noauth property.
x2go.backends.profiles.sshbroker.X2GoSessionProfiles class - managing X2Go Client session profiles obtained from an SSH based X2Go Session Broker.
x2go.backends.profiles.sshbroker.X2GoSessionProfiles is a public API class. Use this class in your Python X2Go based\n applications.
x2go.backends.profiles.sshbroker.X2GoSessionProfiles(session_profile_defaults={'applications': ['WWWBROWSER', 'MAILCLIENT', 'OFFICE', 'TERMINAL'], 'autoconnect': False, 'autologin': True, 'autostart': False, 'clipboard': 'both', 'command': 'TERMINAL', 'defsndport': True, 'directrdp': False, 'directrdpsettings': '', 'display': 1, 'dpi': 96, 'export': {}, 'forwardsshagent': False, 'fstunnel': True, 'fullscreen': False, 'height': 600, 'host': ['server.mydomain'], 'icon': ':icons/128x128/x2gosession.png', 'iconvfrom': 'UTF-8', 'iconvto': 'UTF-8', 'kdrive': False, 'key': '', 'krblogin': False, 'layout': 'us', 'maxdim': False, 'mimeboxaction': 'OPEN', 'mimeboxextensions': '', 'multidisp': False, 'name': 'NEW_PROFILE', 'pack': '16m-jpeg', 'print': False, 'published': False, 'quality': 9, 'rdpclient': 'rdesktop', 'rdpoptions': '-u X2GO_USER -p X2GO_PASSWORD', 'rdpport': 3389, 'rdpserver': '', 'restoreexports': False, 'rootless': True, 'sessiontitle': '', 'setdpi': False, 'setsessiontitle': False, 'sndport': 4713, 'sound': False, 'soundsystem': 'pulse', 'soundtunnel': True, 'speed': 2, 'sshport': 22, 'sshproxyautologin': True, 'sshproxyhost': 'proxyhost.mydomain', 'sshproxykeyfile': '', 'sshproxyport': 22, 'sshproxysamepass': False, 'sshproxysameuser': False, 'sshproxytype': 'SSH', 'sshproxyuser': '', 'startsoundsystem': False, 'type': 'pc105/us', 'uniquehostkeyaliases': False, 'useexports': True, 'useiconv': False, 'usekbd': True, 'usemimebox': False, 'user': 'pbuilder1', 'usesshproxy': False, 'variant': '', 'width': 800, 'xdmcpserver': 'localhost', 'xinerama': False}, logger=None, loglevel=56)[source]\u00b6x2go.backends.profiles.sshbroker.X2GoSessionProfiles(session_profile_defaults={'applications': ['WWWBROWSER', 'MAILCLIENT', 'OFFICE', 'TERMINAL'], 'autoconnect': False, 'autologin': True, 'autostart': False, 'clipboard': 'both', 'command': 'TERMINAL', 'defsndport': True, 'directrdp': False, 'directrdpsettings': '', 'display': 1, 'dpi': 96, 'export': {}, 'forwardsshagent': False, 'fstunnel': True, 'fullscreen': False, 'height': 600, 'host': ['server.mydomain'], 'icon': ':icons/128x128/x2gosession.png', 'iconvfrom': 'UTF-8', 'iconvto': 'UTF-8', 'kdrive': False, 'key': '', 'krblogin': False, 'layout': 'us', 'maxdim': False, 'mimeboxaction': 'OPEN', 'mimeboxextensions': '', 'multidisp': False, 'name': 'NEW_PROFILE', 'pack': '16m-jpeg', 'print': False, 'published': False, 'quality': 9, 'rdpclient': 'rdesktop', 'rdpoptions': '-u X2GO_USER -p X2GO_PASSWORD', 'rdpport': 3389, 'rdpserver': '', 'restoreexports': False, 'rootless': True, 'sessiontitle': '', 'setdpi': False, 'setsessiontitle': False, 'sndport': 4713, 'sound': False, 'soundsystem': 'pulse', 'soundtunnel': True, 'speed': 2, 'sshport': 22, 'sshproxyautologin': True, 'sshproxyhost': 'proxyhost.mydomain', 'sshproxykeyfile': '', 'sshproxyport': 22, 'sshproxysamepass': False, 'sshproxysameuser': False, 'sshproxytype': 'SSH', 'sshproxyuser': '', 'startsoundsystem': False, 'type': 'pc105/us', 'uniquehostkeyaliases': False, 'useexports': True, 'useiconv': False, 'usekbd': True, 'usemimebox': False, 'user': 'pbuilder2', 'usesshproxy': False, 'variant': '', 'width': 800, 'xdmcpserver': 'localhost', 'xinerama': False}, logger=None, loglevel=56)[source]\u00b6\n Bases: x2go.backends.profiles.base.X2GoSessionProfiles
defaultSessionProfile = {'applications': ['WWWBROWSER', 'MAILCLIENT', 'OFFICE', 'TERMINAL'], 'autoconnect': False, 'autologin': True, 'autostart': False, 'clipboard': 'both', 'command': 'TERMINAL', 'defsndport': True, 'directrdp': False, 'directrdpsettings': '', 'display': 1, 'dpi': 96, 'export': {}, 'forwardsshagent': False, 'fstunnel': True, 'fullscreen': False, 'height': 600, 'host': ['server.mydomain'], 'icon': ':icons/128x128/x2gosession.png', 'iconvfrom': 'UTF-8', 'iconvto': 'UTF-8', 'kdrive': False, 'key': '', 'krblogin': False, 'layout': 'us', 'maxdim': False, 'mimeboxaction': 'OPEN', 'mimeboxextensions': '', 'multidisp': False, 'name': 'NEW_PROFILE', 'pack': '16m-jpeg', 'print': False, 'published': False, 'quality': 9, 'rdpclient': 'rdesktop', 'rdpoptions': '-u X2GO_USER -p X2GO_PASSWORD', 'rdpport': 3389, 'rdpserver': '', 'restoreexports': False, 'rootless': True, 'sessiontitle': '', 'setdpi': False, 'setsessiontitle': False, 'sndport': 4713, 'sound': False, 'soundsystem': 'pulse', 'soundtunnel': True, 'speed': 2, 'sshport': 22, 'sshproxyautologin': True, 'sshproxyhost': 'proxyhost.mydomain', 'sshproxykeyfile': '', 'sshproxyport': 22, 'sshproxysamepass': False, 'sshproxysameuser': False, 'sshproxytype': 'SSH', 'sshproxyuser': '', 'startsoundsystem': False, 'type': 'pc105/us', 'uniquehostkeyaliases': False, 'useexports': True, 'useiconv': False, 'usekbd': True, 'usemimebox': False, 'user': 'pbuilder1', 'usesshproxy': False, 'variant': '', 'width': 800, 'xdmcpserver': 'localhost', 'xinerama': False}\u00b6defaultSessionProfile = {'applications': ['WWWBROWSER', 'MAILCLIENT', 'OFFICE', 'TERMINAL'], 'autoconnect': False, 'autologin': True, 'autostart': False, 'clipboard': 'both', 'command': 'TERMINAL', 'defsndport': True, 'directrdp': False, 'directrdpsettings': '', 'display': 1, 'dpi': 96, 'export': {}, 'forwardsshagent': False, 'fstunnel': True, 'fullscreen': False, 'height': 600, 'host': ['server.mydomain'], 'icon': ':icons/128x128/x2gosession.png', 'iconvfrom': 'UTF-8', 'iconvto': 'UTF-8', 'kdrive': False, 'key': '', 'krblogin': False, 'layout': 'us', 'maxdim': False, 'mimeboxaction': 'OPEN', 'mimeboxextensions': '', 'multidisp': False, 'name': 'NEW_PROFILE', 'pack': '16m-jpeg', 'print': False, 'published': False, 'quality': 9, 'rdpclient': 'rdesktop', 'rdpoptions': '-u X2GO_USER -p X2GO_PASSWORD', 'rdpport': 3389, 'rdpserver': '', 'restoreexports': False, 'rootless': True, 'sessiontitle': '', 'setdpi': False, 'setsessiontitle': False, 'sndport': 4713, 'sound': False, 'soundsystem': 'pulse', 'soundtunnel': True, 'speed': 2, 'sshport': 22, 'sshproxyautologin': True, 'sshproxyhost': 'proxyhost.mydomain', 'sshproxykeyfile': '', 'sshproxyport': 22, 'sshproxysamepass': False, 'sshproxysameuser': False, 'sshproxytype': 'SSH', 'sshproxyuser': '', 'startsoundsystem': False, 'type': 'pc105/us', 'uniquehostkeyaliases': False, 'useexports': True, 'useiconv': False, 'usekbd': True, 'usemimebox': False, 'user': 'pbuilder2', 'usesshproxy': False, 'variant': '', 'width': 800, 'xdmcpserver': 'localhost', 'xinerama': False}\u00b6\n X2GoProxy class - proxying/rendering your graphical connection through NX3, KDRIVE and others.
\nx2go.backends.proxy.base.X2GoProxy(session_info=None, ssh_transport=None, session_log='session.log', session_errors='session.err', sessions_rootdir='/nonexistent/first-build/.x2go', proxy_options={}, session_instance=None, logger=None, loglevel=56)[source]\u00b6x2go.backends.proxy.base.X2GoProxy(session_info=None, ssh_transport=None, session_log='session.log', session_errors='session.err', sessions_rootdir='/nonexistent/second-build/.x2go', proxy_options={}, session_instance=None, logger=None, loglevel=56)[source]\u00b6\n Bases: gevent.threading.Thread
X2GoProxy is an abstract class for X2Go proxy connections.
\nThis class needs to be inherited from a concrete proxy class. Only\n currently available proxy class is: x2go.backends.proxy.nx3.X2GoProxy.
PROXY_ARGS = []\u00b6The x2go.backends.settings.file.X2GoClientSettings class one of Python X2Go\u2019s a public API classes.\n Use this class (indirectly by retrieving it from an x2go.client.X2GoClient instance)\n in your Python X2Go based applications to access the\n \u00bbsettings\u00ab configuration file of your X2Go client application.
This class supports reading the \u00bbsettings\u00ab configuration from a file (~/.x2goclient/settings).
x2go.backends.settings.file.X2GoClientSettings(config_files=['/nonexistent/first-build/.x2goclient/settings', '/etc/x2goclient/settings'], defaults={'Authorization': {'editprofile': True, 'newprofile': True, 'resume': True, 'suspend': True}, 'General': {'autoresume': True, 'clientport': 22}, 'LDAP': {'port': 389, 'port1': 0, 'port2': 0, 'server': 'localhost', 'useldap': False}, 'trayicon': {'enabled': True, 'maxdiscon': True, 'mincon': True, 'mintotray': True, 'noclose': True}}, logger=None, loglevel=56)[source]\u00b6x2go.backends.settings.file.X2GoClientSettings(config_files=['/nonexistent/second-build/.x2goclient/settings', '/etc/x2goclient/settings'], defaults={'Authorization': {'editprofile': True, 'newprofile': True, 'resume': True, 'suspend': True}, 'General': {'autoresume': True, 'clientport': 22}, 'LDAP': {'port': 389, 'port1': 0, 'port2': 0, 'server': 'localhost', 'useldap': False}, 'trayicon': {'enabled': True, 'maxdiscon': True, 'mincon': True, 'mintotray': True, 'noclose': True}}, logger=None, loglevel=56)[source]\u00b6\n Bases: x2go.inifiles.X2GoIniFile
Configuration file based settings for x2go.client.X2GoClient instances.
x2go.backends.terminal.plain.X2GoTerminalSession(control_session, session_info=None, geometry='800x600', depth=24, link='adsl', pack='16m-jpeg-9', dpi='', cache_type='unix-kde', kbtype='null/null', kblayout='null', kbvariant='null', clipboard='both', xinerama=False, kdrive=False, session_type='application', snd_system='pulse', snd_port=4713, cmd=None, published_applications=False, set_session_title=False, session_title='', applications=[], rdp_server=None, rdp_options=None, xdmcp_server=None, convert_encoding=False, server_encoding='UTF-8', client_encoding='UTF-8', rootdir=None, profile_name='UNKNOWN', profile_id='20250208090204215794', print_action=None, print_action_args={}, info_backend='PLAIN', list_backend='PLAIN', proxy_backend='NX3', proxy_options={}, printing_backend='FILE', client_rootdir='/nonexistent/first-build/.x2goclient', sessions_rootdir='/nonexistent/first-build/.x2go', session_instance=None, logger=None, loglevel=56)[source]\u00b6x2go.backends.terminal.plain.X2GoTerminalSession(control_session, session_info=None, geometry='800x600', depth=24, link='adsl', pack='16m-jpeg-9', dpi='', cache_type='unix-kde', kbtype='null/null', kblayout='null', kbvariant='null', clipboard='both', xinerama=False, kdrive=False, session_type='application', snd_system='pulse', snd_port=4713, cmd=None, published_applications=False, set_session_title=False, session_title='', applications=[], rdp_server=None, rdp_options=None, xdmcp_server=None, convert_encoding=False, server_encoding='UTF-8', client_encoding='UTF-8', rootdir=None, profile_name='UNKNOWN', profile_id='20240107030116843771', print_action=None, print_action_args={}, info_backend='PLAIN', list_backend='PLAIN', proxy_backend='NX3', proxy_options={}, printing_backend='FILE', client_rootdir='/nonexistent/second-build/.x2goclient', sessions_rootdir='/nonexistent/second-build/.x2go', session_instance=None, logger=None, loglevel=56)[source]\u00b6\n Bases: object
Class for managing X2Go terminal sessions on a remote X2Go server via Paramiko/SSH.
\nWith the x2go.backends.terminal.plain.X2GoTerminalSession class you can start new X2Go sessions, resume suspended\n sessions or suspend resp. terminate currently running sessions on a\n connected X2Go server.
An x2go.backends.terminal.plain.X2GoTerminalSession object uses two main data structure classes:
\n", "details": [{"source1": "html2text {}", "source2": "html2text {}", "unified_diff": "@@ -45,19 +45,19 @@\n session_info=None, geometry='800x600', depth=24, link='adsl', pack='16m-jpeg-\n 9', dpi='', cache_type='unix-kde', kbtype='null/null', kblayout='null',\n kbvariant='null', clipboard='both', xinerama=False, kdrive=False,\n session_type='application', snd_system='pulse', snd_port=4713, cmd=None,\n published_applications=False, set_session_title=False, session_title='',\n applications=[], rdp_server=None, rdp_options=None, xdmcp_server=None,\n convert_encoding=False, server_encoding='UTF-8', client_encoding='UTF-8',\n- rootdir=None, profile_name='UNKNOWN', profile_id='20250208090204215794',\n+ rootdir=None, profile_name='UNKNOWN', profile_id='20240107030116843771',\n print_action=None, print_action_args={}, info_backend='PLAIN',\n list_backend='PLAIN', proxy_backend='NX3', proxy_options={},\n- printing_backend='FILE', client_rootdir='/nonexistent/first-\n- build/.x2goclient', sessions_rootdir='/nonexistent/first-build/.x2go',\n+ printing_backend='FILE', client_rootdir='/nonexistent/second-\n+ build/.x2goclient', sessions_rootdir='/nonexistent/second-build/.x2go',\n session_instance=None, logger=None, loglevel=56)[source]\u00c2\u00b6\n Bases: object\n Class for managing X2Go terminal sessions on a remote X2Go server via\n Paramiko/SSH.\n With the x2go.backends.terminal.plain.X2GoTerminalSession class you can\n start new X2Go sessions, resume suspended sessions or suspend resp.\n terminate currently running sessions on a connected X2Go server.\n"}]}, {"source1": "./usr/share/doc/python-x2go-doc/html/x2go.defaults.html", "source2": "./usr/share/doc/python-x2go-doc/html/x2go.defaults.html", "unified_diff": "@@ -110,15 +110,15 @@\n- \n
\nx2go.defaults.X2GO_PRINT_ACTIONS= {'DIALOG': 'X2GoPrintActionDIALOG', 'PDFSAVE': 'X2GoPrintActionPDFSAVE', 'PDFVIEW': 'X2GoPrintActionPDFVIEW', 'PRINT': 'X2GoPrintActionPRINT', 'PRINTCMD': 'X2GoPrintActionPRINTCMD'}\u00b6Relating print action names and classes.
\n
x2go.defaults.X2GO_SESSIONPROFILE_DEFAULTS = {'applications': ['WWWBROWSER', 'MAILCLIENT', 'OFFICE', 'TERMINAL'], 'autoconnect': False, 'autologin': True, 'autostart': False, 'clipboard': 'both', 'command': 'TERMINAL', 'defsndport': True, 'directrdp': False, 'directrdpsettings': '', 'display': 1, 'dpi': 96, 'export': {}, 'forwardsshagent': False, 'fstunnel': True, 'fullscreen': False, 'height': 600, 'host': ['server.mydomain'], 'icon': ':icons/128x128/x2gosession.png', 'iconvfrom': 'UTF-8', 'iconvto': 'UTF-8', 'kdrive': False, 'key': '', 'krblogin': False, 'layout': 'us', 'maxdim': False, 'mimeboxaction': 'OPEN', 'mimeboxextensions': '', 'multidisp': False, 'name': 'NEW_PROFILE', 'pack': '16m-jpeg', 'print': False, 'published': False, 'quality': 9, 'rdpclient': 'rdesktop', 'rdpoptions': '-u X2GO_USER -p X2GO_PASSWORD', 'rdpport': 3389, 'rdpserver': '', 'restoreexports': False, 'rootless': True, 'sessiontitle': '', 'setdpi': False, 'setsessiontitle': False, 'sndport': 4713, 'sound': False, 'soundsystem': 'pulse', 'soundtunnel': True, 'speed': 2, 'sshport': 22, 'sshproxyautologin': True, 'sshproxyhost': 'proxyhost.mydomain', 'sshproxykeyfile': '', 'sshproxyport': 22, 'sshproxysamepass': False, 'sshproxysameuser': False, 'sshproxytype': 'SSH', 'sshproxyuser': '', 'startsoundsystem': False, 'type': 'pc105/us', 'uniquehostkeyaliases': False, 'useexports': True, 'useiconv': False, 'usekbd': True, 'usemimebox': False, 'user': 'pbuilder1', 'usesshproxy': False, 'variant': '', 'width': 800, 'xdmcpserver': 'localhost', 'xinerama': False}\u00b6x2go.defaults.X2GO_SESSIONPROFILE_DEFAULTS = {'applications': ['WWWBROWSER', 'MAILCLIENT', 'OFFICE', 'TERMINAL'], 'autoconnect': False, 'autologin': True, 'autostart': False, 'clipboard': 'both', 'command': 'TERMINAL', 'defsndport': True, 'directrdp': False, 'directrdpsettings': '', 'display': 1, 'dpi': 96, 'export': {}, 'forwardsshagent': False, 'fstunnel': True, 'fullscreen': False, 'height': 600, 'host': ['server.mydomain'], 'icon': ':icons/128x128/x2gosession.png', 'iconvfrom': 'UTF-8', 'iconvto': 'UTF-8', 'kdrive': False, 'key': '', 'krblogin': False, 'layout': 'us', 'maxdim': False, 'mimeboxaction': 'OPEN', 'mimeboxextensions': '', 'multidisp': False, 'name': 'NEW_PROFILE', 'pack': '16m-jpeg', 'print': False, 'published': False, 'quality': 9, 'rdpclient': 'rdesktop', 'rdpoptions': '-u X2GO_USER -p X2GO_PASSWORD', 'rdpport': 3389, 'rdpserver': '', 'restoreexports': False, 'rootless': True, 'sessiontitle': '', 'setdpi': False, 'setsessiontitle': False, 'sndport': 4713, 'sound': False, 'soundsystem': 'pulse', 'soundtunnel': True, 'speed': 2, 'sshport': 22, 'sshproxyautologin': True, 'sshproxyhost': 'proxyhost.mydomain', 'sshproxykeyfile': '', 'sshproxyport': 22, 'sshproxysamepass': False, 'sshproxysameuser': False, 'sshproxytype': 'SSH', 'sshproxyuser': '', 'startsoundsystem': False, 'type': 'pc105/us', 'uniquehostkeyaliases': False, 'useexports': True, 'useiconv': False, 'usekbd': True, 'usemimebox': False, 'user': 'pbuilder2', 'usesshproxy': False, 'variant': '', 'width': 800, 'xdmcpserver': 'localhost', 'xinerama': False}\u00b6\n x2go.backends.profiles.base.X2GoSessionProfiles default values to fill a new session profile with.
x2go.defaults.X2GO_SHARE_FULLACCESS = 1\u00b6Constant representing read-write (full) access to shared desktops.
\n", "details": [{"source1": "html2text {}", "source2": "html2text {}", "unified_diff": "@@ -67,15 +67,15 @@\n 'rootless': True, 'sessiontitle': '', 'setdpi': False, 'setsessiontitle':\n False, 'sndport': 4713, 'sound': False, 'soundsystem': 'pulse',\n 'soundtunnel': True, 'speed': 2, 'sshport': 22, 'sshproxyautologin': True,\n 'sshproxyhost': 'proxyhost.mydomain', 'sshproxykeyfile': '', 'sshproxyport':\n 22, 'sshproxysamepass': False, 'sshproxysameuser': False, 'sshproxytype':\n 'SSH', 'sshproxyuser': '', 'startsoundsystem': False, 'type': 'pc105/us',\n 'uniquehostkeyaliases': False, 'useexports': True, 'useiconv': False,\n- 'usekbd': True, 'usemimebox': False, 'user': 'pbuilder1', 'usesshproxy':\n+ 'usekbd': True, 'usemimebox': False, 'user': 'pbuilder2', 'usesshproxy':\n False, 'variant': '', 'width': 800, 'xdmcpserver': 'localhost', 'xinerama':\n False}\u00c2\u00b6\n x2go.backends.profiles.base.X2GoSessionProfiles default values to fill a\n new session profile with.\n x2go.defaults.X2GO_SHARE_FULLACCESS= 1\u00c2\u00b6\n Constant representing read-write (full) access to shared desktops.\n x2go.defaults.X2GO_SHARE_VIEWONLY= 0\u00c2\u00b6\n"}]}, {"source1": "./usr/share/doc/python-x2go-doc/html/x2go.registry.html", "source2": "./usr/share/doc/python-x2go-doc/html/x2go.registry.html", "unified_diff": "@@ -374,15 +374,15 @@\nlist
register(server, profile_id, profile_name, session_name=None, control_backend='PLAIN', terminal_backend='PLAIN', info_backend='PLAIN', list_backend='PLAIN', proxy_backend='NX3', settings_backend='FILE', printing_backend='FILE', client_rootdir='/nonexistent/first-build/.x2goclient', sessions_rootdir='/nonexistent/first-build/.x2go', ssh_rootdir='/nonexistent/first-build/.ssh', keep_controlsession_alive=True, add_to_known_hosts=False, known_hosts=None, **kwargs)[source]\u00b6register(server, profile_id, profile_name, session_name=None, control_backend='PLAIN', terminal_backend='PLAIN', info_backend='PLAIN', list_backend='PLAIN', proxy_backend='NX3', settings_backend='FILE', printing_backend='FILE', client_rootdir='/nonexistent/second-build/.x2goclient', sessions_rootdir='/nonexistent/second-build/.x2go', ssh_rootdir='/nonexistent/second-build/.ssh', keep_controlsession_alive=True, add_to_known_hosts=False, known_hosts=None, **kwargs)[source]\u00b6\n Register a new x2go.session.X2GoSession instance with this x2go.registry.X2GoSessionRegistry.
server (str) \u2013 hostname of X2Go server
profile_id (str) \u2013 profile ID
profile_name (str) \u2013 profile name
x2go.session.X2GoSession(server=None, port=22, control_session=None, use_sshproxy=False, sshproxy_reuse_authinfo=False, profile_id=None, profile_name='UNKNOWN', session_name=None, auto_start_or_resume=False, auto_connect=False, printing=False, allow_mimebox=False, mimebox_extensions=[], mimebox_action='OPEN', allow_share_local_folders=False, share_local_folders=[], restore_shared_local_folders=False, control_backend='PLAIN', terminal_backend='PLAIN', info_backend='PLAIN', list_backend='PLAIN', proxy_backend='NX3', settings_backend='FILE', printing_backend='FILE', client_rootdir='/nonexistent/first-build/.x2goclient', sessions_rootdir='/nonexistent/first-build/.x2go', ssh_rootdir='/nonexistent/first-build/.ssh', keep_controlsession_alive=False, add_to_known_hosts=False, known_hosts=None, forward_sshagent=False, logger=None, loglevel=56, connected=False, activated=False, virgin=True, running=None, suspended=None, terminated=None, faulty=None, client_instance=None, **params)[source]\u00b6x2go.session.X2GoSession(server=None, port=22, control_session=None, use_sshproxy=False, sshproxy_reuse_authinfo=False, profile_id=None, profile_name='UNKNOWN', session_name=None, auto_start_or_resume=False, auto_connect=False, printing=False, allow_mimebox=False, mimebox_extensions=[], mimebox_action='OPEN', allow_share_local_folders=False, share_local_folders=[], restore_shared_local_folders=False, control_backend='PLAIN', terminal_backend='PLAIN', info_backend='PLAIN', list_backend='PLAIN', proxy_backend='NX3', settings_backend='FILE', printing_backend='FILE', client_rootdir='/nonexistent/second-build/.x2goclient', sessions_rootdir='/nonexistent/second-build/.x2go', ssh_rootdir='/nonexistent/second-build/.ssh', keep_controlsession_alive=False, add_to_known_hosts=False, known_hosts=None, forward_sshagent=False, logger=None, loglevel=56, connected=False, activated=False, virgin=True, running=None, suspended=None, terminated=None, faulty=None, client_instance=None, **params)[source]\u00b6\n Bases: object
Public API class for launching X2Go sessions. Recommended is to manage X2Go sessions from\n within an x2go.client.X2GoClient instance. However, Python X2Go is designed in a way that it also\n allows the management of singel x2go.session.X2GoSession instance.
Thus, you can use the x2go.session.X2GoSession class to manually set up X2Go sessions without\n x2go.client.X2GoClient context (session registry, session list cache, auto-registration of new\n sessions etc.).
x2go.sshproxy.X2GoSSHProxy class - providing a forwarding tunnel for connecting to servers behind firewalls.
x2go.sshproxy.X2GoSSHProxy(hostname=None, port=22, username=None, password=None, passphrase=None, force_password_auth=False, key_filename=None, local_host='localhost', local_port=22022, remote_host='localhost', remote_port=22, known_hosts=None, add_to_known_hosts=False, pkey=None, look_for_keys=False, allow_agent=False, sshproxy_host=None, sshproxy_port=22, sshproxy_user=None, sshproxy_password=None, sshproxy_force_password_auth=False, sshproxy_key_filename=None, sshproxy_pkey=None, sshproxy_passphrase=None, sshproxy_look_for_keys=False, sshproxy_allow_agent=False, sshproxy_tunnel=None, ssh_rootdir='/nonexistent/first-build/.ssh', session_instance=None, logger=None, loglevel=56)[source]\u00b6x2go.sshproxy.X2GoSSHProxy(hostname=None, port=22, username=None, password=None, passphrase=None, force_password_auth=False, key_filename=None, local_host='localhost', local_port=22022, remote_host='localhost', remote_port=22, known_hosts=None, add_to_known_hosts=False, pkey=None, look_for_keys=False, allow_agent=False, sshproxy_host=None, sshproxy_port=22, sshproxy_user=None, sshproxy_password=None, sshproxy_force_password_auth=False, sshproxy_key_filename=None, sshproxy_pkey=None, sshproxy_passphrase=None, sshproxy_look_for_keys=False, sshproxy_allow_agent=False, sshproxy_tunnel=None, ssh_rootdir='/nonexistent/second-build/.ssh', session_instance=None, logger=None, loglevel=56)[source]\u00b6\n Bases: paramiko.client.SSHClient, gevent.threading.Thread
X2GoSSHProxy can be used to proxy X2Go connections through a firewall via SSH.
\n \n", "details": [{"source1": "html2text {}", "source2": "html2text {}", "unified_diff": "@@ -16,15 +16,16 @@\n local_host='localhost', local_port=22022, remote_host='localhost',\n remote_port=22, known_hosts=None, add_to_known_hosts=False, pkey=None,\n look_for_keys=False, allow_agent=False, sshproxy_host=None, sshproxy_port=22,\n sshproxy_user=None, sshproxy_password=None,\n sshproxy_force_password_auth=False, sshproxy_key_filename=None,\n sshproxy_pkey=None, sshproxy_passphrase=None, sshproxy_look_for_keys=False,\n sshproxy_allow_agent=False, sshproxy_tunnel=None, ssh_rootdir='/nonexistent/\n- first-build/.ssh', session_instance=None, logger=None, loglevel=56)[source]\u00c2\u00b6\n+ second-build/.ssh', session_instance=None, logger=None, loglevel=56)\n+ [source]\u00c2\u00b6\n Bases: paramiko.client.SSHClient, gevent.threading.Thread\n X2GoSSHProxy can be used to proxy X2Go connections through a firewall via\n SSH.\n check_host()[source]\u00c2\u00b6\n Wraps around a Paramiko/SSH host key check.\n fw_tunnel= None\u00c2\u00b6\n get_local_proxy_host()[source]\u00c2\u00b6\n"}]}, {"source1": "./usr/share/doc/python-x2go-doc/html/x2go.telekinesis.html", "source2": "./usr/share/doc/python-x2go-doc/html/x2go.telekinesis.html", "unified_diff": "@@ -36,15 +36,15 @@\n \n \nX2GoTelekinesisClient class - Connect to Telekinesis Server on X2Go Server.
\nx2go.telekinesis.X2GoTelekinesisClient(session_info=None, ssh_transport=None, sessions_rootdir='/nonexistent/first-build/.x2go', session_instance=None, logger=None, loglevel=56)[source]\u00b6x2go.telekinesis.X2GoTelekinesisClient(session_info=None, ssh_transport=None, sessions_rootdir='/nonexistent/second-build/.x2go', session_instance=None, logger=None, loglevel=56)[source]\u00b6\n Bases: gevent.threading.Thread
Telekinesis is a communication framework used by X2Go.
\nThis class implements the startup of the telekinesis client used by\n Python X2Go.
\nTEKICLIENT_ARGS = ['-setWORMHOLEPORT={port}', '-setX2GOSID={sid}']\u00b6x2go.xserver.X2GoClientXConfig(config_files=['/nonexistent/first-build/.x2goclient/xconfig', '/etc/x2goclient/xconfig'], defaults={}, logger=None, loglevel=56)[source]\u00b6x2go.xserver.X2GoClientXConfig(config_files=['/nonexistent/second-build/.x2goclient/xconfig', '/etc/x2goclient/xconfig'], defaults={}, logger=None, loglevel=56)[source]\u00b6\n Bases: x2go.inifiles.X2GoIniFile
Configuration file based XServer startup settings for X2GoClient instances.
\nThis class is needed for Windows systems and (maybe soon) for Unix desktops using Wayland.
\ndetect_unused_xdisplay_port(xserver_name)[source]\u00b6Get an unused TCP/IP port for the to-be-launched X server and write it\n", "details": [{"source1": "html2text {}", "source2": "html2text {}", "unified_diff": "@@ -4,15 +4,15 @@\n \n \n \n ****** Python_X2Go_(Client)_API_Documentation_(v0.6.1.3) ******\n ***** x2go.xserver module *****\n \u00c2\u00ab\u00a0\u00a0x2go.x2go_exceptions_module \u00a0\u00a0::\u00a0\u00a0 Contents\n ****** x2go.xserver module\u00c2\u00b6 ******\n- classx2go.xserver.X2GoClientXConfig(config_files=['/nonexistent/first-\n+ classx2go.xserver.X2GoClientXConfig(config_files=['/nonexistent/second-\n build/.x2goclient/xconfig', '/etc/x2goclient/xconfig'], defaults={},\n logger=None, loglevel=56)[source]\u00c2\u00b6\n Bases: x2go.inifiles.X2GoIniFile\n Configuration file based XServer startup settings for X2GoClient\n instances.\n This class is needed for Windows systems and (maybe soon) for Unix\n desktops using Wayland.\n"}]}]}]}]}]}