Smarts NCM: How do I adjust/configure the timing of the console timeout "warning" message in NCM 9.1 thru NCM 9.3?

Products

• VMware

Environment

VMware Smart Assurance - NCM

Resolution

How do I adjust the timing of the Smarts Network Configuration Manager (Smarts NCM) console timeout "warning" message in NCM 9.1 thru NCM 9.3?
How is the timing of the Smarts NCM timeout "warning" message calculated?

**PLEASE NOTE**  THIS IS FOR VERSIONS NCM 9.1 thru NCM 9.3. Does not apply for NCM 9.4 or NCM 9.5
 

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.

• See 17084 for instructions on setting the Smarts NCM console timeout period.

Smarts NCM calculation of the 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 onsole 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
To configure the timing of the Smarts NCM console timeout warning message, do the following:

1. Go to JMX console URL:
   
   https://<Appserver IP>:8880/jmx-console or http://<Appserver IP>:8881/jmx-console
   
    
2. Enter Username/Password.
    
3. • Defaults are jmx-user/sysadmin
      
4. In the JMX console, find the VC section at the bottom of the window.
5. Click service=VoyenceControlConfig.
6. Do the following based on your version of Smarts NCM:
    
7. • Pre-Smarts NCM 9.x: In environments that run versions earlier than Smarts NCM 9.x, click [Invoke] button under String listAll().
      
   • Smarts NCM 9.x: Click [Invoke] button on operationlistAll
     
      
8. In the page of configuration parameters, find the following:
   
   Config.server com.powerup.configmgr.server.security.login.authentication_cache_timeout_warning 
   
    
9. Return to the previous page (pre 9.x, scrolling to setConfigItem for the setting, which has 3 boxes: p1, p2, p3). Set the configuration parameters as follows:
       
10. • p1 = config.server
    • p2 = com.powerup.configmgr.server.security.login.authentication_cache_timeout_warning
    • p3 = timeout value (in seconds, [43200 = 12 hours]
      
      CAUTION! As mentioned above, the value configured here for the console timeout warning MUST NOT be set to a value greater than the console timeout value or to a negative value.
      
       
11. Click [Invoke] button to apply the new value. The timeout change can be verified as in the preceding steps, but this is generally unnecessary unless an error message is received.
     
12. • Pre-9.x: If successful, click saveAll().