[Index]

Model: view/ExportDeviceStatusView

Cisco Phone Status Export

Full HTML Help

Tip

Use the 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.

  1. At Phone Status Export, fill out a file name prefix.

  2. In the Filters fields, fill out at least the mandatory fields:

  3. Save your changes.

  4. Once the transaction completes, go to File Management to view the phone status report.

  5. Select the phone status report you wish to export (file-name-prefixXXXX.csv).

  6. 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.

  7. 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).

Export device status information

Model Details: view/ExportDeviceStatusView

Title Description Details
Status * Only devices with this status will be exported
  • Field Name: status
  • Type: String
  • Choices: ["Registered", "Unregistered", "Partially Registered", "Rejected", "Any", "Unknown", "None"]
Unified CM Cluster Only devices on this Unified CM Cluster will be exported
  • Field Name: call_manager
  • Type: String
Device Name Only devices with names starting with this value will be exported
  • Field Name: device_name
  • Type: String
IP Address Only devices with IP addresses starting with this value will be exported
  • Field Name: ip_address
  • Type: String
Directory Number Only devices where the directory number starts with this value will be exported
  • Field Name: dir_number
  • Type: String
File name prefix Will be prefixed to generated filename if set
  • Field Name: fname_prefix
  • Type: String
Notes Default: This tool will export the list of Phones where the Phone's status matches the selected "Status" filter. Additional filters for Unified CM Cluster, Device Name and Directory Number can be defined to refine the list. If the matched Phones reside on more than 3 Unified CM Clusters the export will fail and you will be required to further refine your search. When executed above Customer level the Unified CM Cluster filter must be defined in order to reduce the search scope to a single Unified CM Cluster.
  • Field Name: notes
  • Type: String
  • Default: This tool will export the list of Phones where the Phone's status matches the selected "Status" filter. Additional filters for Unified CM Cluster, Device Name and Directory Number can be defined to refine the list. If the matched Phones reside on more than 3 Unified CM Clusters the export will fail and you will be required to further refine your search. When executed above Customer level the Unified CM Cluster filter must be defined in order to reduce the search scope to a single Unified CM Cluster.
Hierarchy Type Hidden field to determine hierarchy type
  • Field Name: hierarchy_type
  • Type: String