Note
This documentation is for the new OMERO 5.1. version. See the latest OMERO 5.0.x version or the previous versions page to find documentation for the OMERO version you are using if you have not upgraded yet.
The omero sessions plugin manage user sessions stored locally on disk. Several sessions can be active simultaneously, but only one will be used for a single invocation of bin/omero:
$ bin/omero sessions -h
The omero login command is a shortcut for the omero sessions login subcommand which creates a connection to the server. If no argument is specified, the interface will ask for the connection credentials:
$ bin/omero login
Previously logged in to localhost:4064 as root
Server: [localhost:4064]
Username: [root]
Password:
Some of the options available to the omero login command are:
Pass a connection string under the form [USER@]SERVER[:PORT] to instantiate a connection:
$ bin/omero login username@servername
Password:
$ bin/omero login username@servername:14064
Password:
Set the name of the server to connect to:
$ bin/omero login -s servername
Username: [username]
Set the name of the user to connect as:
$ bin/omero login -u username -s servername
Password:
Set the port to use for connection. Default: 4064:
$ bin/omero login -u username -s servername -p 14064
Password:
Set the group to use for initalizing a connection:
$ bin/omero login -u username -s servername -g my_group
Password:
Use a valid session key to join an existing connection.
This option only requires a server argument:
$ bin/omero login servername -k 22fccb8b-d04c-49ec-9d52-116a163728ca
Set the password to use for the connection.
Create a connection as another user.
The sudo functionality is available to administrators as well as group owners:
$ bin/omero login --sudo root -s servername -u username
Password for root:
$ bin/omero login --sudo owner -s servername -u username
Password for owner:
Stored sessions can be listed using the omero sessions list command:
$ bin/omero sessions list
Server | User | Group | Session | Active | Started
-----------+------+-----------------+--------------------------------------+-----------+--------------------------
localhost | test | read-annotate-2 | 22fccb8b-d04c-49ec-9d52-116a163728ca | Logged in | Fri Nov 23 14:55:25 2012
localhost | root | system | 1f800a16-1dc2-407a-8a85-fb44005306be | True | Fri Nov 23 14:55:18 2012
(2 rows)
Session keys can then be reused to switch between stored sessions using the omero login -k option:
$ bin/omero sessions login -k 22fccb8b-d04c-49ec-9d52-116a163728ca
Server: [localhost]
Joined session 1f800a16-1dc2-407a-8a85-fb44005306be (root@localhost:4064).
$ bin/omero sessions list
Server | User | Group | Session | Active | Started
-----------+------+-----------------+--------------------------------------+-----------+--------------------------
localhost | test | read-annotate-2 | 22fccb8b-d04c-49ec-9d52-116a163728ca | True | Fri Nov 23 14:55:25 2012
localhost | root | system | 1f800a16-1dc2-407a-8a85-fb44005306be | Logged in | Fri Nov 23 14:55:18 2012
(2 rows)
By default sessions are saved locally on disk under ~/omero/sessions. The location of the current session file can be retrieved using the omero sessions file command:
$ bin/omero sessions file
/Users/ome/omero/sessions/localhost/root/aec828e1-79bf-41f3-91e6-a4ac76ff1cd5
If you want to use a custom session directory, use the OMERO_SESSION_DIR environment variable:
$ export OMERO_SESSION_DIR=/tmp
$ bin/omero login
$ bin/omero sessions file
/tmp/omero/sessions/localhost/root/aec828e1-79bf-41f3-91e6-a4ac76ff1cd5
$ bin/omero logout
The sessions group command can be used to switch the group of your current session:
$ bin/omero group list # list your groups
$ bin/omero sessions group 2 # switch to group by ID or Name