How to update Operations Manager web interface login session timeout

Products

• VMware Tanzu Platform - Cloud Foundry

Issue/Introduction

The article How to update Ops Manager client session timeout settings tells how to change the session timeout value for Logging into Tanzu Operations Manager VMs with SSH.

This article explains updating the session timeout for logging into Operations Manager interface through web browser to control the auto-logout due to session inactivity. 

Environment

Tanzu Operations Manager

Resolution

Tanzu Operations Manager provides API /api/v0/uaa/tokens_expiration  containing a parameter called session_idle_timeout to control the auto-logout for idle session of web interface. The default value is "null". 

1) Log in to UAAC as an admin

2) Retrieve the current session_idle_timeout value

$ uaac curl -k https://opsmgr.example.net/api/v0/uaa/tokens_expiration
......

RESPONSE BODY:
{
  "tokens_expiration": {
    "access_token_expiration": 43200,
    "refresh_token_expiration": 172800,
    "session_idle_timeout": null
  }
}

 

3) Update session_idle_timeout to desired value (e.g. 300 seconds)

$ uaac curl -k https://opsmgr.example.net/api/v0/uaa/tokens_expiration -H 'Content-Type: application/json' -X PUT -d '{"tokens_expiration":{"access_token_expiration":43200,"refresh_token_expiration":172800,"session_idle_timeout":300}}'
......

200 OK
......
RESPONSE BODY:
{}

 

4) Confirm session_idle_timeout is updated successfully

$ uaac curl -k https://opsmgr.example.net/api/v0/uaa/tokens_expiration
......

RESPONSE BODY:
{
  "tokens_expiration": {
    "access_token_expiration": 43200,
    "refresh_token_expiration": 172800,
    "session_idle_timeout": 300
  }
}

 

5) Set session_idle_timeout back to default "null" if needed

$ uaac curl -k https://opsmgr.example.net/api/v0/uaa/tokens_expiration -H 'Content-Type: application/json' -X PUT -d '{"tokens_expiration":{"access_token_expiration":43200,"refresh_token_expiration":172800,"session_idle_timeout":null}}'
......

200 OK
......
RESPONSE BODY:
{}

 

The change of session_idle_timeout will be applied to new sessions.