Smarts NCM: How do I adjust the timing of the console timeout "warning" message in NCM 9.4 thru NCM 9.5?
search cancel

Smarts NCM: How do I adjust the timing of the console timeout "warning" message in NCM 9.4 thru NCM 9.5?

book

Article ID: 330863

calendar_today

Updated On:

Products

VMware Smart Assurance

Environment

VMware Smart Assurance - NCM

Resolution

The Smarts NCM console will timeout after a certain period of user inactivity, at which point the user session will end and the user will need to login to the Smarts NCM console again. A console timeout "warning" message can be configured to appear before the console timeout occurs to alert users that the Smarts NCM console is about to timeout.
The following sections of this solution article explain how Smarts NCM calculates the timing of this console timeout warning message, and how to configure the timing for when the warning message will display.

How NCM calculates console timeout warning message?
The timing when the Smarts NCM console timeout "warning" message will appear is calculated by Smarts NCM based on the timeout period configured for the console. For example, if the Smarts NCM console timeout is set to 28800 seconds (8 hours) and the timeout warning value is set to 6000 seconds (1 hour and 40 minutes), the warning message would be displayed 1 hour and 40 minutes before the 8 hour timeout occurs (after 6 hours and 20 minutes of user inactivity). So, if you wanted the console timeout "warning" message to appear 30 minutes before the console timeout ended the user session, you would need to configure the timeout warning message to a value <Configured console timeout value> - 1800 (seconds). 

IMPORTANT! The value configured for the console timeout warning MUST NOT be set to a value greater than the console timeout value or to a negative value.

Configuring the timing of the Smarts NCM console timeout warning message
Configure the timing of the Smarts NCM console timeout warning message can be managed from two separate locations, the database and JMX console:


Database:
       1. Login to Database Server as root and execute below command:
     su - pgdba -c 'psql voyencedb voyence'
           Enter Database Password.


       2. To view the current value, run the following query:

SELECT name, value, default_value from cm_config_item where name='com.powerup.configmgr.server.security.login.authentication_cache_timeout_warning';


        3. To set changes, run the following command in the database. 

update cm_config_item set value=<required_value> where name='com.powerup.configmgr.server.security.login.authentication_cache_timeout';

            Ex: If the new value to be set is 1800, the query would be:

update cm_config_item set value=1800 where name='com.powerup.configmgr.server.security.login.authentication_cache_timeout';

            Note that the 'value' will over write the 'default_value'. 


JMX Console:
To adjust the warning timeout in the JMX console, follow the directions below to make the changes:

       1. Login to jmx console by accessing following URL:
            https://<NCM IP address>:8880/ncm-webapp/
            Enter your NCM Application Server IP in the above link. Default username/password is jmx-user/sysadmin

       2. In the navigation tree, drill into :
servers > 0 > domains > com.powerup.configmgr.server.config.jmx > mbeans > name=VoyenceControlConfig,type=JMXSystemConfig
  1. Scroll down under operations and select setConfigItem you should see the following below:

        4. Set the parameters as it follows:
         java.lang.String p1 = config.server
      java.lang.String p2 = com.powerup.configmgr.server.security.login.authentication_cache_timeout_warning
      java.lang.String p3 = 3600 (or Any value, currently 1800)


        5. Click on "execute" to set the values
        6. Select the saveAll() operation from the list.
       7. Click on  to save the changes and it will show "Config items are saved" indicating that it was successful. 
  1. Log out and back in again for the new settings to take effect

Note that editing these default settings while having NCM to authenticate with TACACS's, RADIUS, or RSA token systems may cause NCM authentication to fail.

Additional Information

The steps in this article apply for NCM 9.4 thru NCM 9.5, it does not apply for NCM 9.1 thru NCM 9.3.
For NCM versions 9.1 thru 9.3, refer below KB:
https://support.emc.com/kb/317590 - How do I adjust/configure the timing of the console timeout "warning" message in NCM 9.1 thru NCM 9.3?