x2gobroker-testagent(8)

✨ x2gobroker-testagent(8) — X2Go Session Broker 💖

okay bestie, so this is the page for x2gobroker-testagent from the X2Go Session Broker manual set, and it's literally the little test gremlin for your broker agents. let's get into it 🫶

---

🌸 NAME 🌸

x2gobroker-testagent — Session Broker for X2Go (Agent Test Utility)

---

🎀 SYNOPSIS 🎀

x2gobroker-testagent [ options ]

---

🦋 DESCRIPTION 🦋

so x2gobroker-testagent is a test utility for local and remote X2Go Session Broker Agents. and here's the thing you need to internalize: x2gobroker-testagent has to run as super-user root. no cap, root only. 👑

this tool is normally run on the machine that acts as the X2Go Session Broker. like, that's its whole home base.

what it does: x2gobroker-testagent tries to connect to a local or remote X2Go Session Broker Agent. and X2Go Broker Agents are co-installed on X2Go Server hosts — they're the little helpers that support the broker in controlling that X2Go Server. teamwork fr fr. 🤝

then x2gobroker-testagent executes a test task on the broker agent. and the broker agent tries to switch to the given user's context and runs the given task on behalf of that user. it's giving "we're doing this on your behalf, bestie" energy. ✨

---

💅 COMMON OPTIONS 💅

x2gobroker-testagent provides help on command line options:

• -h, --help — Display a help with all available command line options and exit.

---

👑 REQUIRED OPTIONS 👑

okay so you've got two vibes here. you can either list the broker agent's tasks that are available for testing:

• --list-tasks — Render a list of available broker agent tasks. This list shows what can be tested. The capabilities of the remote agent and the broker server's test code are compared and displayed.

...or you run a given task on behalf of an X2Go user on a local or remote broker agent:

• -u, --user, --username — Instruct the broker agent to switch to this user's context when running the given task on the local/remote host.
• -t TASK, --task TASK — The task that shall be test-executed on the remote broker agent.

---

🌈 REMOTE BROKER OPTIONS 🌈

The default mode for calling the X2Go Session Broker Agent is "LOCAL". Alternatively, remote broker agents can be called via mode "SSH". For this, you additionally need to specify the below options:

• -H HOSTNAME, --host HOSTNAME — Hostname to connect to via SSH for running remote broker agent test commands.
• -p PORT, --port PORT — The TCP/IP port that the remote system's SSH daemon listens on (default: 22).

---

🧚 SUPPLIMENTARY OPTIONS 🧚

For some tasks, you have to provide additional parameters.

• -A, --add-to-known-hosts — When connecting to a remote broker agent via SSH, add the broker agent machine's SSH host key to the list of known hosts (normally /var/lib/x2gobroker/.ssh/known_hosts).

This has to be done once per broker agent machine, that the X2Go Session Broker is supposed to connect to.

• --session-id SESSION_ID — When testing the 'suspendsession' or the 'terminatesession' task, you have to additionally give a session ID to test those tasks on.
• --pubkey PUBKEY_AS_STRING — Use your own provided SSH public key when testing the 'addauthkey' and the 'delauthkey' tasks.

---

⭐ MISC OPTIONS ⭐

x2gobroker-testagent also accepts the following miscellaneous options:

• -d, --debug — Enable debugging code.
• -C, --config FILENAME — Specify an alternative configuration file name, default is: /etc/x2go/x2gobroker.conf.

---

🍓 FILES 🍓

• /etc/x2go/x2gobroker.conf, /etc/x2go/broker/* (configuration files)
• /etc/x2go/broker/defaults.conf (environment for X2Go Session Broker)
• /var/log/x2gobroker/* (log files of X2Go Session Broker)

---

💜 SEE ALSO 💜

• /usr/share/doc/x2gobroker

---

🎀 AUTHOR 🎀

This manual has been written for the X2Go project by Mike Gabriel <mike.gabriel@das-netzwerkteam.de>.

---

and that's the whole page, bestie!! 🫶 this was Version 0.0.4.x, dated Apr 2020, and honestly it ate. go forth and test those agents responsibly (as root, always as root 💀). periodt. 💅✨🌈