About this task

InfiniBox session timeout values are configurable from the GUI and CLI. These values apply to all of the clients (GUI, CLI, API). 

• Idle session timeout - configures the session expiry time in the event of user inactivity
  • The user's credentials are kept for the idle session timeout period. If the GUI is reopened in the browser, there is no need to reenter the user and password.
  • By default, the session terminates after 1 hour of inactivity
• Active session timeout - configures the session disconnection in the event of extended user inactivity 
  • By default, the session expires after 24 hours

These values are configurable, as described below.

Handling session expiry

Idle session timeout

When the session is about to expire due to inactivity, a message pops-up on screen.

1. To keep the session active, click Keep me signed in. 
   The Idle Timeout counter is reset, allowing another hour of inactivity (1 hour by default, or the amount of time configured by the user).
   

Active session timeout

When the session expires, the GUI returns to the login screen.

Setting the session timeout parameters

Using the GUI

1. Log into InfiniBox GUI and click the Settings icon. The Setting screen opens, displaying the General tab. 
2. Set the session timeout parameters:
   1. Idle session timeout
   2. Active session timeout
3. Click Update.
   

Using InfiniShell

Set both active and idle system timeout 

config.system.set_session_timeout active_session=1440 idle_session=60

Query for the active and idle system timeout

config.system.query

Using the API

Setting the active session timeout

Required URL parameters

None

Required JSON data

The time in minutes.

"2880"

API endpoint

PUT api/rest/config/mgmt/mgmt.session_expiry

Returned code

{
    "metadata": {
        "ready": true
    }, 
    "result": 2880, 
    "error": null
}

Setting the idle session timeout

Required URL parameters

None

Required JSON data

The time in minutes.

"60"

API endpoint

PUT api/rest/config/mgmt/mgmt.session_idle_timeout

Returned code

{
    "metadata": {
        "ready": true
    }, 
    "result": 120, 
    "error": null
}

Getting the active session timeout

Required URL parameters

None

Required JSON data

None

API endpoint 

GET api/rest/config/mgmt/mgmt.session_expiry

Returned code

{ "metadata": { "ready": true }, "result": 1440, "error": null }

Getting the session idle timeout

Required URL parameters

None

Required JSON data

None

API endpoint 

GET api/rest/config/mgmt/mgmt.session_idle_timeout

Returned code 

{ "metadata": { "ready": true }, "result": 60, "error": null }