5.3 KiB
5.3 KiB
type, created, updated
type | created | updated |
---|---|---|
topic | 2024-01-22T15:49:17.424Z | 2024-01-22T16:29:47.501Z |
Exceed
Exceed TurboX Client Launcher Version 12.5.2.8800
Usage: etxlauncher -version | -action <COMMAND> [-v]
-version :: Display installed launcher version.
-action <COMMAND> :: Perform task based on <COMMAND> provided.
<COMMAND> => launch | resume | join | cachedversion | createshortcut
-action launch <AUTH> <URL> <PROFILEID> [<COMMANDMACRO>] [<LID>]
: Launch a profile on specific server.
: Display a list of nodes or sessions if no <LID> is provided.
-action resume <AUTH> <URL> <SESSIONID>
: Resume a session on specific server.
: Display a list of suspended sessions if no <SESSIONID>
is provided.
-action join <AUTH> <URL> [<SESSIONID>]
: Join a session on specific server.
: Display a list of shared sessions if no <SESSIONID> is
provided.
-action cachedversion [<URL>]
: Display local cached launcher version.
: Optionally connect to an ETX Server and determine the
available version of launcher on it.
-action createshortcut [<AUTH>] [<URL>] [<PROFILEID>] [<DEST>] [<SARGS>]
: Create Client Launcher shortcut to launch a profile
without Dashboard access.
: Only available on Windows or Linux platforms.
<AUTH> => {keyauth} | {basicauth} | {kerberos}
: Provide authentication option for the ETX Server.
: Display authentication prompt if no <AUTH> is provided.
{keyauth} : -keyauth {API Key}
: Use API Key for authentication.
{basicauth} : -username {name} -password {xxx}
: Use username and password for authentication.
[-autoregister [-fullname name -email email]]
: Create an ETX user account if it does not exist.
: This parameter registers the user during session launch.
: The fullname and email parameters must be
included if the ETX Server is not configured to fetch
this information from other sources.
{kerberos} : -k
: Use Kerberos for authentication.
<URL> => -url {serverurl} [<PROXYURLS>]
: Specify the ETX Server to use for the connection.
{serverurl} : The ETX Server URL e.g. http://host:port
<PROXYURLS> => [-launcherproxyurl {proxysvrurl}] [-proxyurl {proxysvrurl}]
: Optionally provide Proxy Server details.
: Use a Proxy Server for either the Launcher to use to
to reach the ETX Server (-launcherproxyurl) and/or for
the Client to use to reach the Connection Node
(-proxyurl).
{proxysvrurl} : The Proxy Server e.g. schema://{auth}@proxyhost:port
{auth} : proxy_username:proxy_password
: The username and password for the Proxy Server.
<PROFILEID> => -profileid {ETXid}
: The id of the profile to launch.
<COMMANDMACRO> => -commandmacro {key=val}[,{key2=val2}]
: Provide one or more macros for Xstart launch.
{key} : The macro for Xstart launch.
{value} : The value macro will use in Xstart launch.
: Note that spaces must be quoted.
: Some characters are invalid for key or values: & and ,
<LID> => {one of <NODEID>, <NODEGROUPID>, <REUSEID>}
: Use <NODEID> for selecting node to run on.
: Use <NODEGROUPID> for selecting node group to run on.
: Use <REUSEID> for selecting existing session to use.
<NODEID> => -selectednodeid {ETXid}
: The id of the node to launch a new session.
<NODEGROUPID> => -selectednodegroupid {ETXid}
: The id of the node group to launch a new session.
<REUSEID> => -reuseid {ETXid}
: The id of the session to reuse. For forcing new
: session you can use 'new' as {ETXid}.
<SESSIONID> => -sessionid {ETXid}
: The id of the session to resume or join.
<DEST> => -destination {file_path}
: Specify the file path to the new Windows Shortcut,
Linux Desktop or script file.
<SARGS> => [-script] [additional arguments]
: Specify any valid Launch action arguments
to be used when creating shortcut.
: For instance -web or a valid <LID> option.
: Use -script on Linux to generate .sh file.
[-web] : Prefer to launch Web Client session in browser.
[-v] : Enable verbose logging for action.
-
Once these requirements are done you can start using ETX @ R&D environment.
-
Open your preferred browser and login to https://etx.infineon.com with your UNIX credentials.