Diagnostic Tools
----------------

.. index:: diag;diag ping 
.. index:: diag;diag resolve
.. index:: diag;diag free
.. index:: diag;diag disk
.. index:: diag;diag mem
.. index:: diag;diag health
.. index:: diag;diag top
.. index:: diag;diag unittests
.. index:: diag;diag filehash
.. index:: diag;diag test_connection

There is an extensive list of diagnostic tools available under the **diag** menu.

::

   platform@development:~$ diag
   USAGE:
   ------
   diag disk              - display diagnostics for disk usage
   diag filehash          - display the file system hash intergrity check
   diag free              - display diagnostics relating to free memory
   diag health            - display a health report
   diag health report     - save a health report as a logfile
   diag iostat            - IO subsystem statistics
   diag iotop             - IO metrics
   diag largefiles        - Find the largest files on your system no more than 
                             the top 10 items are display
   diag mem               - display memory diagnostics
   diag monitor           - update the system resource analysis. Use 
                             'diag monitor list' to view the results
   diag monitor list      - display system resource analysis
   diag nicstat           - Network Interface Statistics
   diag perf <commands>   - Linux perf tools (try --help)
   diag ping <host>       - ping a remote host to test network reachability
   diag proc              - display a list of system processes
   diag resolve <host>    - resolve a hostname to IP address
   diag tasks             - display constant task listing
   diag test_connection <host> <port> - Test if system can open a connection to a remote port
   diag top               - Process resource statistics
   diag traceroute <host> - Discover the network path to <host>
   diag unittests         - Run system unit tests
   diag vmstat            - Virtual Memory subsystem statistics

       mail - local mail management          keys - manage ssh / sftp credenti
    network - network management           backup - manage backups
       voss - voss management tools           log - manage system logs
       cert - manage nginx certificates    notify - notifications control
        ssl                              schedule - scheduling commands
       diag - system diagnostic tools      system - system administration
       snmp - snmp configuration             user - manage users
     drives - manage disk drives              app - manage applications
   security - security update tools   

Some of the commands are provided with details below:


.. tabularcolumns:: |p{5cm}|p{9cm}|

+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Command                                | Description                                                                                                                                                                                                                                                               |
+========================================+===========================================================================================================================================================================================================================================================================+
| **diag ping <host>**                   | Test network reachability to a network host.                                                                                                                                                                                                                              |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **diag resolve <hostname>**            | Test DNS resolution of a hostname.                                                                                                                                                                                                                                        |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **diag test_connection <host> <port>** | Given a host IP and port number, return a message: "Successfully connected to <host>:<port>" or "Failed to connect to <host>:<port>".                                                                                                                                     |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **diag free**                          | Display the memory usage.                                                                                                                                                                                                                                                 |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **diag disk**                          | Display the disk usage. Logical volumes for the database have the format ``/dev/mapper/voss-dbroot``.                                                                                                                                                                     |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **diag mem**                           | Display a more detailed memory usage by process.                                                                                                                                                                                                                          |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **diag health**                        | Display a comprehensive health summary. This includes status on the following: CPU, Memory, Disk, Security Update, Application, Cluster, Cluster Failover and Health email scheduling. Logical volumes used by the database have the format: ``/dev/mapper/voss-dbroot``. |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **diag top**                           | Display a single Unix top summary.                                                                                                                                                                                                                                        |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **diag unittests**                     | Utility for developers only. Note that services will be restarted by this utility.                                                                                                                                                                                        |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **diag filehash**                      | Although a checksum of system and configuration files is carried out regularly, a manual check for changes since the previous check can be carried out. If any files have changed, these will be listed in the command output.                                            |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. |VOSS-4-UC| replace:: VOSS-4-UC
.. |Unified CM| replace:: Unified CM