.. _phone-status-export:



Cisco Phone Status Export
----------------------------

.. _19.3.4|VOSS-778|EKB-6877:
.. _21.1|VOSS-778|EKB-6877:
.. _19.3.4-PB1|VOSS-778|EKB-7863:
.. _21.1|VOSS-778|EKB-7863:


.. tip:: 

   :ref:`use-action-search-to-navigate-automate`



Overview
.........

The **Cisco Phone Status Export** tool allows you to export the status of Cisco UCM phones
based on selected filters.

The exported phone status report can be opened from the **File Management** form
and downloaded as a ``.csv`` file. The ``.csv`` file can be opened as a spreadsheet in
Microsoft Excel, where each phone status that matches the configured filters will
appear as an individual line.


Create and view a Cisco phone status report
..............................................

1. In the Admin Portal, go to **Cisco Phone Status Export**. 
2. Select the hierarchy where you want to create the phone status report.
   
.. note:: 

   When running the tool from a hierarchy higher than Customer, a Call Manager filter
   is mandatory.   
   
2. At **Phone Status Export**, fill out a file name prefix. 
3. In the **Filters** fields, fill out at least the mandatory fields: 

   * Mandatory. Select a status.

     .. note:: 

        * When choosing a status of *None*, all phones without a registration status on the API will appear 
          in the phone status report.
        * When choosing a status of *Any*, all phones will appear in the phone status report, regardless of the 
          phone registration status.
   * Mandatory (Customer hierarchy only), select a value for **Unified CM Cluster**. 
   * Optional. Specify a device name, directory number, and IP address.

     .. note:: 

        Only phones matching these filters display in the phone status report. For example, if specifying 
        *BAT* as device name, then only phones with a device name prefix starting with *BAT* will 
        appear in the report. The filter on **Device Name** text is case insensitive. For example, 
        "bat" will match "BAT" in the filter. 

4. Save your changes. 
5. Once the transaction completes, go to **File Management** to view the phone status report. 
6. Select the phone status report you wish to export (file-name-prefixXXXX.csv). 
7. Click the toolbar **Export** icon, then, on the dialog that appears, select **JSON**, and click **Export** to 
   export a zip file.  

   .. note:: 

      The Excel export option is similar to the JSON export. Only fields that have values are 
      exported. 
      
      When exporting as Excel formatted, all fields (as seen on the GUI), with or without values, 
      are exported. 

8. Open the *.csv* file in Excel. 

   .. note:: 
      
      The first column on the report reflects the phone hierarchy. Subsequent columns provide the (Phone) 
      Name, Status, and information such as: ``cm_node``, ``ip_address``, ``DirNumber``, ``DeviceClass``, 
      ``Model``, ``Product``, and so on (depending on the selected filters).