Smarts NCM: How to set up a device diagnostic

           

   Article Number:     503480                                   Article Version: 4     Article Type:    How To 
   

 


Product:

 

Smarts Network Configuration Manager

 

Instructions:

 

 

   

      In many cases, it may be desirable to obtain additional information from devices that can be useful to end users of NCM in administering devices under NCM management, but that do not qualify as formal configuration files that could be pushed back to a device. For example, it may be beneficial to know the amount of free memory available on a device before attempting to push a new device Operating System (OS) out to a device, especially if significant storage or memory on the device is being consumed by copies of older versions of the OS that were kept as a rollback option from the last time the OS on the device was updated. You may even want to see a quick list of all the device OS images currently present on the device so you know which ones need to be deleted to free up storage space on the device. In these cases, a compliance pass based on testing the available free storage on the device to find out which devices could support an OS image push could possibly yield a report or NCM Client UI flag for devices under management that need attention prior to any NCM OS image push.     
     
      There are many other examples of situations where additional information about a device may prove useful, even though it is not part of a configuration file normally stored in the NCM PostgreSQL Control Database (controldb). Many of these needs can be met by collecting the output of arbitrary commands you wish to run in a Command Line Interface (CLI) session with the device every time a configuration change (new revision) is detected on the device. The mechanism that NCM offers to accomplish this is the device diagnostic. The output of any diagnostic commands you set up for a specific device, or an entire device class, are stored in a read-only file called the 'Diagnostic Result', and are visible in similar fashion to more interactive configuration files under any given revision.      
     
      To set up a diagnostic on any single device in NCM, you can use the following selection sequence:   

   

     
      Networks Navigation pane >> Right-click on target device >> Quick Commands >> Setup Diagnostic   

   

     
      User-added image     
          

   

     
      To set up a diagnostic on an entire device class globally across the entire application, you can use the following selection sequence:   

   

     
      Tools >> System Administration >>    

   

      User-added image       
       
        Global >> Device Classes >> Select a device class name >> Diagnostic Button       
       
        User-added image
     
          

   

      This will cause the Device Diagnostic window to appear for the selected device class. Commands can now be entered into this window that will be executed any time a new revision is generated for a target device that is created due to NCM becoming aware that the device configuration has changed. To apply the changes, click the Apply button at the bottom of the Device Diagnostic Window.     
          

   

      User-added image   

                                                                                                                             

 

 

Notes:

 

 

Because of the arbitrary nature of commands that can be run in device diagnostic setups, Dell EMC cannot warrant the effect of any commands you intend to run in this way. The capability is offered as a convenience only, and Dell EMC does not warrant the effect of any commands you choose to enter into the diagnostic setup window.   
   
    If a specific privilege mode on the device is required to run a user supplied diagnostic command, the session must achieve that privilege level on initial login. NCM does not currently provide a means of navigating to a desired privilege mode prior to running a diagnostic command. Typically, this can be achieved by supplying the correct password for the desired privilege mode as the account password for the credential associated with the device in NCM, but this is dependent on the capabilities of the device in question and cannot be guaranteed by Dell EMC.