Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

User's Guide
EZ Unified Device Manager Pro
Provided by Event Zero






The information contained in this document represents the current view of Event Zero on the software discussed as of the date of publication and is subject to change at any time without notice to you. This document and its contents are provided AS IS without warranty of any kind, and should not be interpreted as an offer or commitment on the part of Event Zero, and Event Zero cannot guarantee the accuracy of any information presented. EVENT ZERO MAKES NO WARRANTIES, EXPRESS OR IMPLIED, IN THIS DOCUMENT.
The descriptions of other companies' products in this document, if any, are provided only as a convenience to you. Any such references should not be considered an endorsement or support by Event Zero. Event Zero cannot guarantee their accuracy, and the products may change over time. Also, the descriptions are intended as brief highlights to aid understanding, rather than as thorough coverage. For authoritative descriptions of these products, please consult their respective manufacturers.
All trademarks are the property of their respective companies.
©2017 Event Zero. All rights reserved.
Event Zero is either registered trademarks or trademarks of Event Zero Pty Ltd. in Australia and/or other countries.
The names of actual companies and products mentioned herein may be the trademarks of their respective owners.

Summary

Event Zero's EZ Unified Device Manager (UDM) Pro is an Enterprise-scale application platform for managing your voice-over-IP (VoIP) infrastructure. The application consists of two main components:

  • EZ UDM Pro
  • Provisioning Bridge

EZ UDM Pro is the visual configuration and management component of the infrastructure. The provisioning bridge resides locally on your network, close to the phone devices that EZ UDM Pro manages. Provisioning bridges put the software images and resource files on your local network instead of at the application's local storage, dramatically speeding up the provisioning of your phone devices.

EZ UDM Pro is cloud-based or on-premises, and provisioning bridges will always be on-premises.

The following sections of this guide provide information and detail on how to use the application. Installation information is contained in the Installation Guide.

Overview Page

The Overview page reveals a quick look at your infrastructure and devices, most items and graphs can be clicked on to drill into the detail. The areas you can view are:

  • Bridge Status

Listing of all bridges that have requested association with EZ UDM Pro. The bridges are identified by name and if approved, a green check mark. If the bridge is not yet approved, a yellow triangle. Clicking on a bridge takes you to the Bridge details page.

  • Approved Devices

Approved Devices is the number of phone devices that are approved for use and are ready for provisioning or have been provisioned. Clicking the number takes you to the Devices sub-menu, described later under Devices.

  • Unapproved Devices

Unapproved Devices is the opposite of Approved Devices. The number represents phone devices that not yet approved. Clicking the number takes you to the Unapproved Devices sub-menu, described later under Unapproved Devices. This panel is only visible when you have devices that are not yet approved.

  • Provisioning Bridges

The number of Provisioning Bridges requesting association with EZ UDM Pro. Clicking the number takes you to the Bridges sub-menu, described later under Bridges.

  • Device Sets

The number, displayed in a pie chart of device sets with number of devices assigned, of device sets configured to manage the phone devices assigned to a given set. Clicking on a segment will take you to the Device set page.

  • Approved Devices by Model

Displayed as vertical bar graph, models of approved devices are listed at the bottom and the number of devices in that model is listed on the left of the graph. Clicking on a bar will take you to the models screen.

Sidebar Dashboard Items

The Sidebar (essentially a menu), on the left side of the page, is your access to all functions for managing the software, provisioning bridges, and your deployed phone devices.
The sidebar is broken down to logical sections, each responsible for managing a part of configuration, management, and deployment.

User Status

Located at the top, above Overview, is the name of the currently logged in user. Immediately below the user's name is a link to logout. Click Logout to quit this session of EZ UDM Pro.

Overview

The Overview selection, when clicked, takes you to the main dialog page, described in Overview Page.

Tags

Tags are the core of EZ UDM Pro. The concept of tags is both simple but allows powerful manipulation of the application of XML to phones. Tags can be applied set of models, locations, etc., the level of granularity and the flexibility of the application of tags mean that most requirements can be achieved.

Concepts of Tags

Tags are generated for each item within EZ UDM Pro's 4 main object types:

  • Device Set
  • Locations
  • Bridges
  • Model

Tag Application and Precedence

Tags are created and configured on the Tags main page. Tags can be created for four (4) types of objects:

  • Device Set
  • Locations
  • Bridges
  • Model

By default a special Device Tag called All Devices is created and cannot be removed. It has the lowest precedence and all other tags can override the values set in this tag.


There are two default Tag types that cannot be modified, deleted, or created.

  • Approved Devices – This tag is a global tag.
  • Unapproved Devices – This tag is a Global tag.

Device Profiles

In Device Profiles, you create new device profiles and manage existing ones. Each Device Profiles is a collection of 1 or more XML attributes that can then be applied to a Tag. There are two different types of device profiles Polycom Pre-Installed Defaults and User Created. When you install EZ UDM Pro you will have the Polycom Pre-Installed Defaults available to use either to use with their default values or to modify these with your own settings.

to the devices that this profile is a member of. Assigning a tag to the device profile associates the device profile with a defined set of devices.
For example, you have a location in France that requires that the French flag is displayed. A resource file for an image of the French flag is available in Resources. You configure the device profile to use the image file and apply it to all phones that meet the criteria. The criteria, in this case, is that the devices are part of a tag group France Office. Adding the XML attributes to use the image file and apply it to the device, plus using the tag France Office applies the French flag as the image displayed on the devices in the France Office.
Note! For assigning a device profile to a tag, see the section Tags. The device profile must exist prior to assigning it to a given tag.

Add a Device Profile

To add a device profile, do the following:

  1. On the Device Profiles page, click Add
  2. On the Device Profiles – Add New page in the Name text area, type the Name that you want to assign to this Device Profile. Name is a required field

Tip! The name that you type here is what will be displayed in all subsequent configuration sections.

  1. Optionally, fill in a description

Tip! We recommend using a description to define what this device profile is and what it does. Referring to the example, the description might be "Uses the resource file france_flag.png and applies to assigned phones."

  1. Add the XML attributes to direct the desired behavior on the assigned devices. XML attributes are a required element to a Device Profile
    1. Click Add to add a new attribute
      1. BlahNeed content
    2. Click Clipboard to paste XML attributes that you copy from a saved file or other reference
      1. BlahNeed content
    3. Click Import to use a pre-configured file in XML format
      1. BlahNeed content
  2. Click Save to commit your new Device Profile, or Cancel to exit the Device Profiles – Add New dialog page

Note! If you navigate to another selection in EZ UDM Pro from the Device Profiles – Add New dialog page without saving your changes, you are warned that you are exiting the page without saving your changes. You are given the option to Cancel and return to the Device Profiles – Add New dialog or Proceed and discard the changes you have made. The same notification is displayed if you select (in the upper right corner) Cancel instead of Save to exit the page.

Filter Device Profiles

The ability to filter your Device Profiles is a handy feature as the number of device profiles increase, making it much easier to locate the device profile that you need to change, assign, or delete.
To filter your Device Profiles, do the following:

  1. Click Filter and in the text field start typing the name of a profile, or the attribute – or part of the attribute – in a device profile

Tip! If you are looking for a device profile or all profiles that contain a given attribute, start typing the name of that profile, attribute, or any part of that attribute or profile. For example, to find all profiles that contain the word 'enable', type enable in the text box. Only profiles that contain an attribute with the word 'enable' within the attribute (e.g. bg.background.enabled) are returned. It's important to understand that if you type 'enable' the filter will find enable and enabled, and any other matches that contain 'enable'. This feature is especially powerful given that without this feature, you would need to open and examine each device profile to locate the profiles that contain attributes with a given phrase.

  1. Note that the list of profiles is dynamically reduced the more you type
  2. Select the profile that you need to change by clicking the name of the profile, or click the Trash Can icon to delete the profile
  3. To clear your filter criteria, click the 'X' at the right side of the text field

Delete Device Profiles

A function of good management is to delete items that you no longer need. To delete a device profile, do the following:

  1. Scroll to locate or use Filter to find the profile to delete
  2. Click the Delete icon (trash can icon on right of the profile)
  3. A Confirmation dialog is displayed. Click Cancel if you do not want to delete the profile, or click Delete and remove the selected Device Profile, and return to Device Profiles

Sorting Device Profiles

In addition to the Filter feature, you can sort Device Profiles on the Name, Attributes, or Tags columns. To sort a column, ascending or descending, do the following:

  1. To sort the Name, Attributes, or Tags column, click the arrows to the right of the column label
  2. After the first click, you should see a descending list result, items sorted from 0 – 9, A to Z
  3. Click the arrow to change the ascending sort to a descending sort, Z – A, 9 – 0
  4. You do the same on the other columns, Attribute and Tags, where ascending is 0 to the letter Z, and descending is from the letter Z to the number 0

Tags in Device Profiles

Tags, described in the section Tags in this guide, are used in Device Profiles to associate a profile with any Location, Device Set, Model, or Bridge. Device Profiles can also be associated with the unique Global tag.
Tags are only displayed for reference. All tag management for associations, creation, deletion, and other management of tags functions is configured in the Tags selection.

Speed Dial

Speed Dial is a convenience feature for users. Instead of dialing an often-used number, needing to remember the country code, area code, and number – not to mention the occasions where an extension is needed – the user can dial a short sequence (for example, two, three, or four numbers) of numbers to execute the entire phone number. For most companies this is a powerful feature that end users have become accustomed to.
EZ UDM Pro implements this feature fully by allowing you to configure Speed Dial sets that combine lists of numbers for users who share common speed dial needs. The entries can be internal users, external parties, such as customers or colleagues. Speed dial entries are assigned to departments, locations, up to and including the entire company.

Speed Dial Main Screen

Selecting Speed Dial from the sidebar displays the main page for viewing and managing Speed Dial configurations. The main page displays:

  • Name – The name assigned to each Speed Dial configuration. You can click the Name link to view or edit the existing entries for this configuration
  • Entries – The number of configured Speed Dial entries in this Speed Dial configuration
  • Tags – The number of Tags that are associated with this Speed Dial configuration
  • Actions – The additional functions that you can perform on a Speed Dial configuration (In this instance, Delete of an existing Speed Dial configuration entry)
  • Filter - Ability to filter your Speed Dial configurations by dynamically returning matching entries as you type
  • Add – Click to Add a new Speed Dial configuration
  • Speed Dial configurations – click to view or edit the existing entries for this configuration

Add a New Speed Dial Entry

  1. Click Speed Dial on the sidebar
  2. Click Add to create a new entry
  3. On the Speed Dial – Add New dialog, type a name for the Speed Dial set in the Name field (required)
  4. Add a note or description in the description field (optional)
  5. Click Add in the Entries dialog to create new speed dial entries
    1. Type the Speed Dial Number in the text field, using a number from 1 to 9999
    2. Type a first name as an identifier for the entry in the field labelled First Name (Required)
    3. Type a last name in the field labelled Last Name (Optional)
    4. Type a label (identifier) for this entry in the field Label (Required)

Note! The Label field is Required and must be unique if you are using GENBAND (also known as Experius™ A2) in your environment.

    1. Type the required entry for a SIP URL or the digits for the phone number to be dialed, using country code, area code and local number; e.g. 449914523019 (United Kingdom) or 13125551212 (United States). The SIP URL uses the format bob.jones@contoso.com. The Contact field is required, cannot be empty (null), and must be unique
    2. Click Add to complete and commit the Speed Dial Number Entry
    3. To add another Speed Dial Number Entry, click Add and repeat a. through f. for the next entry
  1. When you have completed the configuration of the Speed Dial configuration, click Save to commit the entries.

Edit a Speed Dial Entry

To edit existing Speed Dial configurations, do the following:

  1. Click the Name of the configuration that you want to edit
  2. In the Speed Dial dialog, note that you can view who created the entry
  3. Edit the Name field by clicking in the field and making changes as needed
  4. Edit the Description the field as needed
  5. In the Entries dialog, click a Speed Dial Number link to edit the Speed Dial entry
    1. Edit the Speed Dial number as needed by clicking in the Speed Dial Number field
    2. Edit the First Name as needed by clicking in the First Name field
    3. Edit the Last Name as needed by clicking in the Last Name field
    4. Edit the Label as needed by clicking in the Label field
    5. Edit the contact SIP URL or phone number as needed by clicking in the Contact field
    6. Click Update to commit your changes, or cancel to quit editing this entry and discard any changes
  6. Click Save to update the entire Speed Dial configuration

Filter Speed Dial Configurations

The ability to filter your Speed Dial configurations is a handy feature as the number of device profiles increase, making it much easier to locate the device profile that you need to change, assign, or delete.
To filter your Device Profiles, do the following:

  1. Click Filter and in the text field start typing the name of a speed dial entry, or any field – or part of the field – in a speed dial configuration

Tip! If you are looking for a specific entry or all entries that contain a given string, start typing the name of that entry, contact, or any part of speed dial elements. For example, to find all contacts that contain the string 'contoso', type contoso in the text box. Similarly, the filter works for phone numbers, first name, last name and label. It's important to understand that if you type 'bob' the filter will find bob and the string 'bob' in a SIP URL, or Bob as a first name, etc. This feature is especially powerful given that without this feature, you would need to open and examine each Speed Dial configuration and entry to locate entries that contain the information that you are looking for.

  1. Note that the list of Speed Dial configurations is dynamically reduced the more you type
  2. Select the Speed Dial configuration that you need to change by clicking the name of the profile, or click the Trash Can icon to delete the profile
  3. To clear your filter criteria, click the 'X' at the right side of the text field

Delete Speed Dial Configuration

A function of good management is to delete items that you no longer need. To delete a Speed Dial configuration, do the following:

  1. Scroll to locate or use Filter to find the Speed Dial configuration to delete
  2. Click the Delete icon (trash can icon on right of the Speed Dial configuration)
  3. A Confirmation dialog is displayed. Click Cancel if you do not want to delete the configuration, or click Delete and remove the selected Speed Dial configuration, and return to Speed Dial configuration

Delete Entries in a Speed Dial Configuration

  1. Locate the Speed Dial configuration that you want to remove entries. Click the Speed dial name
  2. In the Entries dialog, locate the entry to remove. Under Actions, click the '-' (Minus) sign.

Caution! The action of delete is absolute. Clicking the delete action removes the entry. If you accidentally delete the wrong entry, click Cancel in the upper right. If you click Save, you will need to recreate the lost entry.

Sorting Speed Dial Configurations

In addition to the Filter feature, you can sort Speed Dial configurations on the Name, Entries, or Tags columns. To sort a column, ascending or descending, do the following:

  1. To sort the Name, Entries, or Tags column, click the arrows to the right of the column label
  2. After the first click, you should see a descending list result, items sorted from 0 – 9, A to Z
  3. Click the arrow to change the ascending sort to a descending sort, Z – A, 9 – 0
  4. You do the same on the other columns, Entries and Tags, where ascending is 0 to the letter Z, and descending is from the letter Z to the number 0

Tags in Speed Dial Configurations

Tags, described in the section Tags in this guide, are used Speed Dial configurations to associate a Speed Dial with any Location, Device Set, Model, or Bridge. Speed Dial can also be associated with the unique Global tag.
Tags are only displayed for reference. All tag management for associations, creation, deletion, and other management of tags functions is configured in the Tags selection.

Software

Software is the code, provided by the device manufacturer, that tells the phone how to operate. Basically, software is akin to the phone's operating system. The manufacturer provides software as a downloadable package. The package is uploaded to EZ UDM Pro, unpacked, and then processed for all attribute values. The attribute values are written to the SQL database instance for fast reference.
Though software is a critical component of creating a functional device, there are just a few simple functions to use the software in your device's configuration.

Add Software

You add software to EZ UDM Pro just as you would upload software to any website. All the work to unpackage, process the software, then commit all attributes to the database is done by EZ UDM Pro in the background.
To upload a software package to EZ UDM Pro, do the following.

  1. On the sidebar, click Software
  2. On the right side of the Software page, click Add
  3. On the Upload Software dialog, you have a couple options to upload the software package to EZ UDM Pro
    1. From your computer in a file browser, select the software package to upload, drag and drop it into the dropzone
    2. Click in the dropzone area, and from the resulting file explorer, select the package that you want to upload, then click Open
  4. Note that there is a progress bar indicating that the file is uploading. When the file is uploaded, a notification is displayed at the bottom of the page indicating All files uploaded. Click Dismiss on the notification
  5. If you have more software to upload, repeat Steps 3 and 4. If you are done adding software, click Software in the sidebar and confirm that the software is either in the Processing or Processed state.

Note! If there was a problem in processing, the status of the software will be Error. See the Appendix for information and steps to resolve the Error statusAdd FAQ or TS steps/article for Error status in Processing/Processed.

  1. The software is ready to use when the status is Processed

Filter Software Packages

The ability to filter software packages is a handy feature as the number of software packages increase, making it much easier to locate the software packages that you need to assign or delete.
To filter software packages, do the following:

  1. Click Filter and in the text field start typing the name of a software package, or any item – including the Readme file – Software Details.

Tip! If you are looking for a software package or all packages that contain given text in the readme, start typing the name of that software package, software version, status, or text in the readme file as uploaded. For example, to find only software that applies to a VVX 510 device and the model numbers are referenced in the readme, the software package is returned from the filter. It's important to understand that if you type 'enable' the filter will find enable and enabled, and any other matches that contain 'enable'. This feature is especially powerful given that without this feature, you would need to open and examine each software package detail screen to locate the package that contains strings with a given phrase.

  1. Note that the list of software packages is dynamically reduced the more you type
  2. Select the software package that you need to view by clicking the name of the software packages, or click the Trash Can icon to delete the software package
  3. To clear your filter criteria, click the 'X' at the right side of the text field

Sorting Software Packages

In addition to the Filter feature, you can sort software packages on the Name, Version, File Size, or Status columns. To sort a column, ascending or descending, do the following:

  1. To sort the Name, Version, File Size, or Status column, click the arrows to the right of the column label
  2. After the first click, you should see a descending list result, items sorted from 0 – 9, A to Z
  3. Click the arrow to change the ascending sort to a descending sort, Z – A, 9 – 0
  4. You do the same on the other columns where ascending is the number 0 to the letter Z, and descending is from the letter Z to the number 0

Deleting Software Packages

A function of good management is to delete items that you no longer need. When the last device that is using a given software and is upgraded to a newer or different software the software can be safely deleted.
Note! Deleting software that is in use by devices deletes all references and the source files for the software from EZ UDM Pro. Devices will continue to operate normally. However, you cannot deploy the deleted version of software to other devices without uploading the package into EZ UDM Pro. Due to all references to the software being removed, the software deployed to devices that was deleted
To delete a software package, do the following:

  1. Scroll to locate or use Filter to find the software to delete
  2. Click the Delete icon (trash can icon on right of the software)
  3. A Confirmation dialog is displayed. Click Cancel if you do not want to delete the profile, or click Remove All Associations & Delete and remove the selected software

Viewing Software Detail

Information on the software packages that are available on your system is viewed by clicking Software in the sidebar and clicking the software package that you need to view.
To view details and what is available, do the following:

  1. Click Software on the sidebar
  2. In the list of software packages, click the name of a software package
  3. In Software Details the following information is displayed if available in the package
    • Filename – name of the package as it was uploaded
    • Version – The version of the software, determined by attributes in the package
    • File Size – Size of the package as uploaded
    • Status – The status of the package after processing
    • Readme – If there was a readme file in the package, the file is displayed. You click Read More… if the size of the file exceeds the size of the pane in the Readme dialog

Tags in Software Detail

Tags, described in the section Tags in this guide, are used in Software to associate a software package with any Location, Device Set, Model, or Bridge. Software can also be associated with the unique Global tag.
Tags are only displayed for reference. All tag management for associations, creation, deletion and other management of tags functions is configured in the Tags selection.

Resources

Resource files are image or sound files that you use to personalize images on the phone screen or to use a sound file for Music on Hold (MoH.) Resource files are uploaded to EZ UDM Pro and assigned as resources to phones based on the same type of criteria that you might use to configure the Sales Department using Device Profiles.
In Device Profiles, you use attributes to define the background image and enable the image. Similarly, you define a sound file for MoH by assigning the sound file resource name to the feature.moh.filename and activate it by configuring the attribute feature.moh.enabled and toggling the value to Yes.

Add Resources

You add resources to EZ UDM Pro just as you would upload a file to any website. EZ UDM Pro does feature a simple to use drag and drop feature for uploading files, as well as a classic File Explorer interface.
To add new resource files to EZ UDM Pro, you do the following.

  1. On the sidebar, click Resources
  2. On the Resources page, click Add
  3. On the Upload Resource page, you have a couple options to upload the resource file to EZ UDM Pro
    1. From your computer in a file browser, select the resource file to upload, drag and drop it into the dropzone
    2. Click in the dropzone area, and from the resulting file explorer, select the resource file that you want to upload, then click Open
  4. Note that there is a progress bar indicating that the file is uploading. When the file is uploaded, a notification is displayed at the bottom of the page indicating All files uploaded. Click Dismiss on the notification
  5. If you have more resource file to upload, repeat Steps 3 and 4. If you are done adding resource files, click Resources in the sidebar and confirm that the resource file is in the list of resource files

Filter Resource Files

The ability to filter your resource files is a handy feature as the number of resource files increase, making it much easier to locate the resource files that you need to change, assign, or delete.
To filter your Resource Files, do the following:

  1. Click Filter and in the text field start typing the name of an image file, or the type of file (.png, .jpg, .mp3)

Tip! If you are looking for a specific file or all files that contain a given string, start typing the name of the file or format. For example, to find all resource files that contain the string 'contoso', type contoso in the text box. Similarly, the filter works for filtering by file size. It's important to understand that if you type 'bob' the filter will find bob and the string 'bob' in the file name or typing the number '1' will find all files that contain '1' and all file sizes that contain '1'.

  1. Note that the list of resource files is dynamically reduced the more you type
  2. Select the resource files that you need to view and use by clicking the name of the resource file, or click the Trash Can icon to delete the resource file
  3. To clear your filter criteria, click the 'X' at the right side of the text field

Sorting Resources

In addition to the Filter feature, you can sort resource files on the Name, File Size, or Date Created columns. To sort a column, ascending or descending, do the following:

  1. To sort the Name, File Size, or Date Created column, click the arrows to the right of the column label
  2. After the first click, you should see a descending list result, items sorted from 0 – 9, A to Z
  3. Click the arrow to change the ascending sort to a descending sort, Z – A, 9 – 0
  4. You do the same on the other columns where ascending is the number 0 to the letter Z, and descending is from the letter Z to the number 0

Deleting Resources

A function of good management is to delete items that you no longer need.
To delete a resource file, do the following:

  1. Scroll to locate or use Filter to find the resource file to delete
  2. Click the Delete icon (trash can icon on right of the resource file
  3. A Confirmation dialog is displayed. Click Cancel if you do not want to delete the resource file, or click Delete to remove the selected resource file

Viewing Resources

Information on the resource files that are available on your system is viewed by clicking Resources in the sidebar and clicking the resource file that you need to view.
To view details and what is available, do the following:

  1. Click Resources on the sidebar
  2. In the list of resource files, click the name of a resource file
  3. In Resource Detail the following information is displayed if available for the type of file
  • Filename – Name of the resource file as it was uploaded
  • File Size – Size of the resource file as uploaded
  • Type – The type of file, IMAGE or AUDIO
  • Created Time – Date and time that the file was uploaded to EZ UDM Pro
  • Preview – For Image file types, the file image is displayed

Device Sets

Device sets represent the collection of configured items – Devices, Device Profiles, Software, and Speed Dial – that when brought together, are the totality of items that you use to change a device a functioning phone.
Note that the flow of the items in the sidebar are logically ordered such that if you start your configuration tasks at the top and move down, by the time you get to Device Sets, items that make up the configuration sets are ready to bring together.
Selecting Device Sets in the sidebar (if you have not yet created a device set) is an empty list. On the right side is Filter, Import, and Add. In the following sections details on how to create device sets and manage them is provided.

Add a Device Set

To add a new device set, do the following.

  1. Click Add on the right side of Device Sets
  2. In the dialog Device Sets – Add New > Device Set, click in the field Device Set Name and type a name to identify the device set. The Device Set Name is displayed in the Device Set listing

The next four sections – Devices, Device Profiles, Software, Speed Dials – contain no entries to multiple entries, based on the requirements for this device set.

Add Devices

    1. To add a Device to the Device Set, click Add in the Devices section
    2. A list of approved devices is listed by media access control (MAC) address, session initiation protocol uniform resource identifier (SIP URI), IP address, and model. Use the checkboxes on the left to select one or more devices to add to the device set

Tip! Use the Filter to limit your selections by models, IP addresses (or portions of the IP address), or SIP URIs.

    1. Click Apply to accept the devices and add them to the Device set, or Cancel to quit the Add Devices dialog without making changes

Add a Device Profile

    1. To add a Device Profile to the Device Set, click Add in the Device Profiles section
    2. A list of Device Profiles is listed by name, attributes (the number of attributes in the profile), and tags associated. Select from the available Device Profiles by using the check boxes on the left to select one or more device profiles to add to your device set

Tip! Use the Filter to limit your selections by name, attribute (number of attributes), and tags (number of tags).

    1. Click Apply to accept the Device Profiles and add them to the Device set, or Cancel to quit the Add Device Profiles dialog without making changes

Add Software

    1. To add Software to the Device Set, click Add in the Apply Software section
    2. A list of software packages is listed by name, version, and file size. Select from the available software by using the checkboxes on the left to select one or more software packages to add to your device set
    3. Click Apply to accept the software packages and add them to the Device set, or Cancel to quit the Apply Software dialog without making change

Add Speed Dials

  1. To add a Speed Dial to the Device Set, click Add in the Speed Dials section
  2. A list of Speed Dial entries is listed by name, entries (the number of contacts in the speed dial entry), and tags associated. Select from the available Speed Dials by using the checkboxes on the left to select one or more Speed Dials to add to your device set

Tip! Use the Filter to limit your selections by name, entries (number of contacts in the entry), and tags (number of tags). The Filter feature can also return only Speed Dial entries that contain a contact that is part of that Speed Dial entry.

  1. Click Apply to accept the Speed Dial entries and add them to the Device set, or Cancel to quit the Add Speed Dials dialog without making changes


Filter Device Sets

The ability to filter your device sets is a handy feature as the number of device sets increase, making it much easier to locate the device sets that you need to reboot or delete.
To filter your Device Sets, do the following:

  1. Click Filter and in the text field and start typing the name of a device sets, or an item you are looking for.

Tip! If you are looking for a specific element of a device set that contains a given string, start typing the name of the element. For example, to find all contacts in a speed dial that is part of a device set that contains the string 'contoso', type contoso in the text box. Similarly, the filter works for filtering by number of devices in a device set. It's important to understand that if you type 'bob' the filter will find bob and the string 'bob' in contact name or typing the number '1' will find all elements contain '1' and all devices sets that contain 1, 10, 21, or any number that contains '1'.

  1. Note that the list of device sets is dynamically reduced the more you type
  2. Select the device sets that you need to manage by clicking the name of the device set, clicking reboot to restart all devices in the device set, or click the Trash Can icon to delete the device set
  3. To clear your filter criteria, click the 'X' at the right side of the text field

Import Device Sets

[Have no idea what this is]

Sorting Device Sets

In addition to the Filter feature, you can sort device sets on the Name and Devices columns. To sort a column, ascending or descending, do the following:

  1. To sort the Name or Devices column, click the arrows to the right of the column label
  2. After the first click, you should see a descending list result, items sorted from 0 – 9, A to Z
  3. Click the arrow to change the ascending sort to a descending sort, Z – A, 9 – 0
  4. You do the same on the other columns where ascending is the number 0 to the letter Z, and descending is from the letter Z to the number 0

Edit a Device Set

You can edit an existing Device Set to add or remove items from the existing configuration. You can change the Device Set name, Add devices, device profiles, software or speed dials. You remove items from a device set by clicking the associated Delete, or trash can icon.
Important! The Global Device Set is a special case device set. You cannot change the name and can only add devices. If you note that you are looking at the Devices item in the sidebar, this is the indicator of what the Global Device Set is.
To edit an existing Device Set, click Device Sets in the sidebar. Do the following. You can save after every change, or you can save when you are done with the entire device set edit.

  1. From the Device Sets dialog, locate the Device Set that you want to edit. Click on the name of the item.
  2. If you need to change the name of the Device Set, click in the text field, edit the name to what you want it to be.
  3. If you need to Add devices, click Add in devices and select devices from the Devices pick list. Conversely, to delete a device from the device set, click the trash can icon (delete.)
  4. If you need to Add a Device Profile, click Add and then select the device profile from the pick list. Conversely, to delete a device profile from the device set, click the trash can icon (delete.)
  5. If you need to add Software, click Add and then select the software from the pick list. Conversely, to delete a software from the device set, click the trash can icon (delete.)
  6. If you need to add Speed Dials, click Add and then select the Speed Dial set from the pick list. Conversely, to delete a speed dial set from the device set, click the trash can icon (delete.)
  7. When you are done with editing the Device Set, click Save. If you want to discard your changes, click Cancel, and confirm that you understand your changes will be discarded by clicking Procced.

Deleting Device Sets

A function of good management is to delete items that you no longer need.
To delete a Device Set, do the following:

  1. Scroll to locate or use Filter to find the device set to delete
  2. Click the Delete icon (trash can icon on right of the device set
  3. A Confirmation dialog is displayed. Click Cancel if you do not want to delete the device set, or click Delete to remove the selected device set

Operations on the Global Device Set

If you need to make changes to the Global Device Set, refer to the section Devices later in this guide.

Locations

Locations allow for logical grouping of Device Profiles, Software, and Speed Dials to a specific physical location, and a network location. The physical location is defined by Address, City, State, Post Code, Country, Timezone. Additionally, a Contact Name, contact Number, and Contact Email for the location can be configured.
Logical location is defined by the network Subnets. You define the Subnets associated with the physical location by defining the TCP/IP network using classless inter-domain routing (CIDR) notation.
At a minimum, for each location, you should define all fields in the Location section and define at least one network. You add device profiles, software and speed dial entries to apply these elements to devices in the location and subnet.

Add Locations

To add a new location, do the following.

      1. Click Locations on the sidebar. On the Locations dialog, click Add.
      2. On the Location – Add New dialog in the Location section
  1. Click the field for Location Name and type a name for this new location
  2. Click the field for Address and fill in the address of the physical location
  3. Click the field City and type the city for this physical location
  4. Click the State field and type the state for this physical location
  5. Click the Postcode field and type the postal code or ZIP code for this physical location
  6. Click the Country field and type the country for this physical location
  7. Click the Timezone field and start typing the time zone this physical location. For example, for US Central, you can type 'cen' and select US/Central or '6' and select 'CST6CDT'
  8. Click the Contact Name field and type the person's name who is the point of contact for this physical location
  9. Click the Contact Number field and type the phone number of SIP URI for the person named in Contact Name for this physical location
  10. Click the Contact Email field and type the email address for the person named in Contact Name for this physical location
      1. To add subnets to this location, Click Add in the Subnets section
  11. Click the field for CIDR and type the network portion of the TCP/IP address. For example, if a network is defined by a netmask of 255.255.255.0, the CIDR definition you would type is 192.168.10.0/24
  12. Click Create to add the subnet to the location or Cancel to discard your changes
      1. To add device profiles to this location, click Add in the Device Profiles section
  13. In the Add Device Profiles dialog, select one or more device profiles by checking the check box associated with the profiles you want to add to the location.
  14. Use the Filter to find a device profile or reduce the number of device profiles and locate the profiles you need
  15. Click Apply to add the selected profiles to the location or Cancel to discard your changes
      1. To add software to this location, click Add in the Software section
  16. In the Apply Software dialog, select one or more software packages by checking the check box associated with the software package(s) you want to add to the location.
  17. Use the Filter to find a software package or reduce the number of software packages and locate the software package(s) you need
  18. Click Apply to add the selected software package(s) to the location or Cancel to discard your changes
      1. To add speed dial sets to this location, click Add in the Speed Dials section
  19. In the Add Speed Dials dialog, select one or more speed dial sets by checking the check box associated with the speed dial set(s) you want to add to the location.
  20. Use the Filter to find a speed dial set or reduce the number of speed dial sets and locate the speed dial set (s) you need
  21. Click Apply to add the selected speed dial set(s) to the location or Cancel to discard your changes
      1. To save the Location configuration, click Save to commit the Location settings, or Cancel to discard the changes
      2. In order to apply your changes to the devices in the newly created Location, you can reboot all devicesThis needs clarification. How can you reboot devices in a location that isn't defined?

Filter Locations

The ability to filter your locations is a handy feature as the number of locations increase, making it much easier to locate the locations that you need to manage.
To filter your Locations, do the following:
Click Filter and in the text field and start typing the name of a location
Tip! If you are looking for a location that contains a given string, start typing the string. For example, to find all locations that contain the string 'contoso', type contoso in the text box.
It's important to understand that if you type 'bob' the filter will find bob and the string 'bob' in the location or number '1' will find all parts of the location that contain '1' and all location attributes that contain 1, 10, 21, or any number that contains '1'.

  1. Note that the list of locations is dynamically reduced the more you type
  2. Select the location that you need to manage by clicking the name of the location, or click the Trash Can icon to delete the location
  3. To clear your filter criteria, click the 'X' at the right side of the text field

Sorting Locations

In addition to the Filter feature, you can sort locations on the Name, Postcode, City, State, and Country columns. To sort a column, ascending or descending, do the following:

  1. To sort the Name, Postcode, City, State, or Country column, click the arrows to the right of the column label
  2. After the first click, you should see a descending list result, items sorted from 0 – 9, A to Z
  3. Click the arrow to change the ascending sort to a descending sort, Z – A, 9 – 0
  4. You do the same on the other columns where ascending is the number 0 to the letter Z, and descending is from the letter Z to the number 0

Edit Locations

You can edit an existing Location to add or remove items from the existing configuration. You can change the Location name, physical address and point of contact information, Add, edit or remove subnets, add or remove device profiles, add or remove software, or add or remove speed dials.
To edit an existing Location, click Locations in the sidebar. Do the following.
Note! You can save after every change, or you can save when you are done with the entire Location edit.

  1. From the Locations dialog, locate the location that you want to edit. Click on the name of the Location
  2. If you need to change any item in the Location section, click in the text field of the item, edit the item to what you need it to be
  3. If you need to Add subnets, click Add in subnets and type the TCP/IP CIDR network address. Conversely, to delete a subnet from Subnets, click the trash can icon (delete.)
  4. If you need to Add a Device Profile, click Add and then select the device profile from the pick list. Conversely, to delete a device profile from the device set, click the trash can icon (delete.)
  5. If you need to add Software, click Add and then select the software from the pick list. Conversely, to delete a software from the device set, click the trash can icon (delete.)
  6. If you need to add Speed Dials, click Add and then select the Speed Dial set from the pick list. Conversely, to delete a speed dial set from the device set, click the trash can icon (delete.)
  7. When you are done with editing the Location, click Save. If you want to discard your changes, click Cancel, and confirm that you understand your changes will be discarded by clicking Procced.

Deleting Locations

A function of good management is to delete items that you no longer need.
To delete a Location, do the following:

  1. Scroll to locate or use Filter to find the location to delete
  2. Click the Delete icon (trash can icon) on the right of the location
  3. A Confirmation dialog is displayed. Click Cancel if you do not want to delete the location, or click Delete to remove the selected location

Bridges

Bridges represent a connection from the EZ UDM Pro server, cloud-based or on your own network, to the devices that you manage. Additionally, the provide a local repository for the data and software that your devices use. Instead of retrieving data from a cloud-based repository, local data storage allows network speed access for the devices that you manage instead of the possible inconsistencies in latency and speed that the Internet can introduce.

Adding Bridges

Unlike other components in EZ UDM Pro, Bridges are not added by using the user interface. Bridges are added by installing the EZ UDM Pro Bridge software on a server on your local network. When installed, the bridge software registers with the target EZ UDM Pro server.
The bridge, once registered with the EZ UDM Pro server, cannot have a dialog with the command and control portion of EZ UDM Pro until the EZ UDM Pro administrator approves the bridge. This is a security measure, preventing rogue bridges (or computers that look like bridges) from accessing your system. Once approved, devices that connect to the bridge are can receive data and report back information to EZ UDM Pro.
To add a bridge, do the following. (Complete details are presented in the accompanying Installation Guide.)

  1. On the server that will serve as a provisioning bridge, launch the EZ UDM Pro Bridge installer as an administrator. On the Welcome dialog, click Next.
  2. In the dialog "Select Installation folder", accept the default location (C:\Program Files\Event Zero\EZ UDM Pro Bridge) for the bridge files. Alternatively, Browse and select or type a location that you want to install the files to. Click Next.
  3. In the dialog Settings, enter the https uniform resource locator (URL) for your EZ UDM Pro tenant (cloud-based) or server (on-premises). If you use Automatic for Bridge Registration Type, click Next.

If you want to provide unique identifiers, select Manual. Two fields are revealed that you then supply your identifier information.
Bridge ID is a universally unique identifier (UUID) field for use as an absolute identifier and is a feature to be used for future purposes.
Bridge API Key is a feature to be used for future purposes.
Click Next.

  1. Click Install to begin the installation of the bridge. 
  2. Monitor the installation process as it proceeds. 
  3. When finished, click Finish on the Completed screen.

Approve Bridges

Installing the EZ UDM Pro Bridge software on your local server registers the bridge with EZ UDM Pro. You, as an Administrator on EZ UDM Pro, must approve the bridge to allow it to communicate and establish a full dialog with the application. To approve a bridge, do the following.

  1. In EZ UDM Pro, select Bridges from the sidebar.
  2. On the Bridges dialog page, scroll through the list or filter the list of registered bridges. Look for the name of the newly registered bridge or look for bridges that have a status of "Bridge awaiting approval", indicated by a yellow triangle.
  3. Under Actions, click the Approve bridge for provisioning icon on the right.
  4. On the Confirmation dialog, click Approve or click Cancel to discard your changes.
  5. Successful approval of the bridge will result in the yellow triangle changing to a green check mark.

Manage Bridges

To view details on the status of a bridge and configure what a bridge will offer to connected devices, locate the bridge in the list of bridges and select the bridge by clicking the link.

Bridge Detail

Bridge Detail displays information about the bridge and a text field to add notes for this bridge. Details for the bridge:

  • Bridge Name – A read-only field indicating the name that the bridge registered as. This is the hostname of the server as it is registered
  • Note – A text field allowing the EZ UDM Pro administrator to add notes to the bridge entry
  • Devices Connected – The number of devices that have registered with this bridge
  • First Seen – The amount of time that has passed since this bridge was first seen, typically when the bridge registered with EZ UDM Pro
  • Last Seen – The amount of time since the bridge last communicated with EZ UDM Pro. Bridges communicate and query with EZ UDM Pro occasionally to receive updates and new software or configurations assigned to it. An extended period since 'Last Seen' suggests that there is a possible problem with the bridge or the network that the bridge is on.

Details on troubleshooting a bridge that might be experiencing problems can be found in the Appendix of this guide.
Any changes, additions or deletions in this section requires you to save your changes by clicking Save in the upper right or Cancel to discard your changes (handy if you find you've made a mistake or have made changes to the wrong section). A pop-up on the bottom of the screen will confirm the save was committed, and clicking Cancel will warn that you will discard your changes. Click Proceed to continue with the cancel, or click Cancel to confirm that you did not intend to Cancel.

Devices connected to this Bridge

This section of the Bridge information is read-only and displays all devices that have registered with this bridge.
Devices are listed by media access control (MAC) address, IP Address, Model, Software (version), Approved, Last Seen.
You can click on the MAC address to view information about this device.
You can click on the Model to view information about this device model.
Actions are listed on the right side for each device. Actions that you can take on a given device:

  • Reboot a Device – clicking the icon (a power symbol) for Reboot Device sends a reboot command to the device listed
  • Prevent a Device from Provisioning – clicking the icon (a refresh icon with a slash through it) Prevent a Device from Provisioning removes the ability of the listed device from requesting provisioning from the bridge. Note that this does not remove the current configuration from the device, but it will not receive any updates to software or configuration that Approved devices would receive

Any changes, additions or deletions in this section requires you to save your changes by clicking Save in the upper right or Cancel to discard your changes (handy if you find you've made a mistake or have made changes to the wrong section). A pop-up on the bottom of the screen will confirm the save was committed, and clicking Cancel will warn that you will discard your changes. Click Proceed to continue with the cancel, or click Cancel to confirm that you did not intend to Cancel.

Device Profiles

In Device Profiles, you view existing Device Profiles assigned to the bridge for use by devices connected. Columns in Device Profiles are Name, Attributes (number), and Tags (number). You Add a device profile to the Device Profiles section by clicking Add.
When you click Add, you select one or more previously configured Device Profiles from a pick list of device profiles.
To remove a Device Profile from the bridge, click Delete (a trash can icon) to remove the device profile.
You can filter device profiles by clicking Filter and typing the name of a device profile or attributes used in the device profile. This is a powerful feature, allowing you to determine which device profiles include a given attribute. You can type a part of an attribute or the entire attribute name.
You can sort the columns in Device Profiles by clicking the arrows to the right of the column label. After the first click, you should see a descending list result, items sorted from 0 – 9, A to Z. Click the arrow to change the ascending sort to a descending sort, Z – A, 9 – 0. You do the same on the other columns where ascending is the number 0 to the letter Z, and descending is from the letter Z to the number 0.
Any changes, additions or deletions in this section requires you to save your changes by clicking Save in the upper right or Cancel to discard your changes (handy if you find you've made a mistake or have made changes to the wrong section). A pop-up on the bottom of the screen will confirm the save was committed, and clicking Cancel will warn that you will discard your changes. Click Proceed to continue with the cancel, or click Cancel to confirm that you did not intend to Cancel.

Software

The software section of the bridge configuration assigns software to the bridge for provisioning. Columns in Software are Name, Version and File Size. Click Add in the Software section to add a software package.
When you click Add, you select one or more previously uploaded software packages from a pick list of available software packages. Click Apply to add the software packages to your bridge.
To remove a software package from the bridge, click Delete (a trash can icon) to remove the software package.
You can filter software by clicking Filter and typing the name of a software package, version or file size of the software package. This is a powerful feature, allowing you to determine which software package is a given version or size. You can type a part of package name or version to limit the selection criteria.
You can sort the columns in Software by clicking the arrows to the right of the column label. After the first click, you should see a descending list result, items sorted from 0 – 9, A to Z. Click the arrow to change the ascending sort to a descending sort, Z – A, 9 – 0. You do the same on the other columns where ascending is the number 0 to the letter Z, and descending is from the letter Z to the number 0.
Any changes, additions or deletions in this section requires you to save your changes by clicking Save in the upper right, or Cancel to discard your changes (handy if you find you've made a mistake or have made changes to the wrong section). A pop-up on the bottom of the screen will confirm the save was committed, and clicking Cancel will warn that you will discard your changes. Click Proceed to continue with the cancel, or click Cancel to confirm that you did not intend to Cancel.

Speed Dials

The speed dials section of the bridge configuration assigns speed dials to the bridge for provisioning. Columns in Speed Dials are Name, Entries (number), and Tags (number). Click Add in the Speed Dials section to add a speed dial set.


When you click Add, you select one or more previously created speed dial sets from a pick list of available speed dials. Click Apply to add the speed dial(s) to your bridge.


To remove a speed dial set from the bridge, click Delete (a trash can icon) to remove the speed dial entry.


You can filter speed dials by clicking Filter and typing the name of a speed dial name. This is a powerful feature, allowing you to type a part of a speed dial to limit the selection criteria.


You can sort the columns in Speed Dials by clicking the arrows to the right of the column label. After the first click, you should see a descending list result, items sorted from 0 – 9, A to Z. Click the arrow to change the ascending sort to a descending sort, Z – A, 9 – 0. You do the same on the other columns where ascending is the number 0 to the letter Z, and descending is from the letter Z to the number 0.


Any changes, additions or deletions in this section requires you to save your changes by clicking Save in the upper right, or Cancel to discard your changes (handy if you find you've made a mistake or have made changes to the wrong section). A pop-up on the bottom of the screen will confirm the save was committed, and clicking Cancel will warn that you will discard your changes. Click Proceed to continue with the cancel, or click Cancel to confirm that you did not intend to Cancel.

Filter Bridges

The ability to filter your bridges is a handy feature as the number of bridges increase, making it much easier to locate the bridges that you need to manage.
To filter your Bridges, do the following:

  1. Click Filter and in the text field and start typing the name of a bridge, typically a string from the Bridge Name column

    Tip! If you are looking for a bridge that contains a given string, start typing the string. For example, to find all bridges that contains the string '2012', type 2012 in the textbox. 
    It's important to understand that if you type '20' the filter will find 20 and the string '20' in the bridge name. The filter also returns bridge names that contain 20, such as 201, 1020, or any string that contains '20'.

  2. Note that the list of bridges is dynamically reduced the more you type
  3. Select the bridge that you need to manage by clicking the name of the bridge, click the Refresh or No Refresh icon (Approve bridge for provisioning, Prevent bridge from provisioning, respectively) or click the Trash Can icon to delete the location
  4. To clear your filter criteria, click the 'X' at the right side of the text field

Sorting Bridges

In addition to the Filter feature, you can sort bridges on the Bridge Name, Devices, or Last Seen columns. To sort a column, ascending or descending, do the following:

  1. To sort the Bridge Name, Devices, or Last Seen column, click the arrows to the right of the column label
  2. After the first click, you should see a descending list result, items sorted from 0 – 9, A to Z
  3. Click the arrow to change the ascending sort to a descending sort, Z – A, 9 – 0
  4. You do the same on the other columns where ascending is the number 0 to the letter Z, and descending is from the letter Z to the number 0

Deleting Bridges

While functionally you can delete a bridge by clicking the Delete icon, the recommended process is a two-step procedure. To delete a bridge, you do the following.

  1. Click the Prevent bridge from provisioning icon associated with the bridge you intend to delete. This action stops the bridge from responding to all devices associated with this bridge.

    Note! If you need to remove the server from service temporarily and intend to return it to service but are not changing servers, you would use Prevent bridge from provisioning to prevent it from responding to devices. You then can maintain the server and later click Approve bridge for provisioning to return it to service and managing devices.

  2. Give the bridge five minutes to quiesce and finish any outstanding operations that might be in queue.
  3. Click Delete (trash can icon) to remove the bridge from the Bridges listing.
  4. The server where the EZ UDM Provisioning Bridge software is installed is now available to have the bridge software removed and the server repurposed or retired.

Models

Models is a repository of all device models that are in use in your organization. The information that is populated here is a quick means to see which devices you currently have deployed and to configure features specifically to device models.

Manage Models

To manage models of a device type, locate the device model that you want to manage. Click on the model name. Use each of the sections to manage device model configurations as required

Model Detail

Model Detail displays (if available) a picture of a device in the model series. Also, displayed for your informational purposes is the current number of devices of this model, the number of approved devices of this model, and the number of unapproved models of this model.

Device Profiles

In Device Profiles, you view existing Device Profiles assigned to the device model for use by devices connected. Columns in Device Profiles are Name, Attributes (number), and Tags (number). You Add a device profile to the Device Profiles section by clicking Add.
When you click Add, you select one or more previously configured Device Profiles from a pick list of device profiles.
To remove a Device Profile from the device model, click Delete (a trash can icon) to remove the device profile.
You can filter device profiles by clicking Filter and typing the name of a device profile or attributes used in the device profile. This is a powerful feature, allowing you type a part of a device profile or the entire device profile.
You can sort the columns in Device Profiles by clicking the arrows to the right of the column label. After the first click, you should see a descending list result, items sorted from 0 – 9, A to Z. Click the arrow to change the ascending sort to a descending sort, Z – A, 9 – 0. You do the same on the other columns where ascending is the number 0 to the letter Z, and descending is from the letter Z to the number 0.
Any changes, additions or deletions in this section requires you to save your changes by clicking Save in the upper right, or Cancel to discard your changes (handy if you find you've made a mistake or have made changes to the wrong section). A pop-up on the bottom of the screen will confirm the save was committed, and clicking Cancel will warn that you will discard your changes. Click Proceed to continue with the cancel, or click Cancel to confirm that you did not intend to Cancel.

Software

The software section of the device model configuration assigns software to the device model for provisioning. Columns in Software are Name, Version and File Size. Click Add in the Software section to add a software package.
When you click Add, you select one or more previously uploaded software packages from a pick list of available software packages. Click Apply to add the software packages to your device model.
To remove a software package from the device model, click Delete (a trash can icon) to remove the software package.
You can filter software by clicking Filter and typing the name of a software package, version or file size of the software package. This is a powerful feature, allowing you to determine which software package is a given version or size. You can type a part of package name or version to limit the selection criteria.
You can sort the columns in Software by clicking the arrows to the right of the column label. After the first click, you should see a descending list result, items sorted from 0 – 9, A to Z. Click the arrow to change the ascending sort to a descending sort, Z – A, 9 – 0. You do the same on the other columns where ascending is the number 0 to the letter Z, and descending is from the letter Z to the number 0.
Any changes, additions or deletions in this section requires you to save your changes by clicking Save in the upper right, or Cancel to discard your changes (handy if you find you've made a mistake or have made changes to the wrong section). A pop-up on the bottom of the screen will confirm the save was committed, and clicking Cancel will warn that you will discard your changes. Click Proceed to continue with the cancel, or click Cancel to confirm that you did not intend to Cancel.

Speed Dials

The speed dials section of the device model configuration assigns speed dials to the bridge for provisioning. Columns in Speed Dials are Name, Entries (number), and Tags (number). Click Add in the Speed Dials section to add a speed dial set.
When you click Add, you select one or more previously created speed dial sets from a pick list of available speed dials. Click Apply to add the speed dial(s) to your bridge.
To remove a speed dial set from the device model, click Delete (a trash can icon) to remove the speed dials.
You can filter software by clicking Filter and typing the name of a speed dial. This is a powerful feature, allowing you to type a part of speed dial name to limit the selection criteria.
You can sort the columns in Speed Dials by clicking the arrows to the right of the column label. After the first click, you should see a descending list result, items sorted from 0 – 9, A to Z. Click the arrow to change the ascending sort to a descending sort, Z – A, 9 – 0. You do the same on the other columns where ascending is the number 0 to the letter Z, and descending is from the letter Z to the number 0.
Any changes, additions or deletions in this section requires you to save your changes by clicking Save in the upper right, or Cancel to discard your changes (handy if you find you've made a mistake or have made changes to the wrong section). A pop-up on the bottom of the screen will confirm the save was committed, and clicking Cancel will warn that you will discard your changes. Click Proceed to continue with the cancel, or click Cancel to confirm that you did not intend to Cancel.

Filter Models

The ability to filter your models is a handy feature as the number of bridges increase, making it much easier to locate the bridges that you need to manage.
To filter your Bridges, do the following:

  1. Click Filter and in the text field and start typing the name of a device model, typically a string from the Name column.

Tip! If you are looking for a device model that contains a given string, start typing the string. For example, to find all model that contains the string 'VVX', type VVX in the text box.
It's important to understand that if you type '5' the filter will find 5 for any string in the device model. The filter also returns device models that contain 5, such as 15, 510, or any string that contains '5'.

  1. Note that the list of device models is dynamically reduced the more you type
  2. Select the device model that you need to manage by clicking the name of the device model
  3. To clear your filter criteria, click the 'X' at the right side of the text field

Sorting Models

In addition to the Filter feature, you can sort device models on the Name or Devices (number) columns. To sort a column, ascending or descending, do the following:

  1. To sort the Name or Devices column, click the arrows to the right of the column label
  2. After the first click, you should see a descending list result, items sorted from 0 – 9, A to Z
  3. Click the arrow to change the ascending sort to a descending sort, Z – A, 9 – 0
  4. You do the same on the other columns where ascending is the number 0 to the letter Z, and descending is from the letter Z to the number 0

Devices

Devices is very different from Models where each device is a unique physical phone. And a Model represents a distinct model of a phone that a vendor might create thousands of devices in a model.
Devices are listed by the following columns:

  • Media access control (MAC) address – the hexadecimal number that identifies a device on a network. MAC addresses (theoretically) are unique. Be assured that a given MAC address will be unique on your network
  • Session initiation protocol uniform resource identifier (SIP URI) – a SIP URI, which resembles – and may be – your email address is used for applications to communicate with the device using TCP/IP
  • IP Address – IP Address is the number assigned to a device on your network, and could be either IPv4 or IPv6. IP addresses are usually assigned using the dynamic host configuration protocol (DHCP) server or service on your network.
  • Model – Lists the name of the phone model.
  • Location – The defined physical location of the device if the Location is associated with a defined subnet configured in Locations
  • Software – The version of software currently on the device.
  • Last seen – Last time the device actively polled for updates or changes.

Manage Devices

Device Details

  • Media access control (MAC) address – MAC address assigned to the device
  • Note – A text field that you can type notes to administratively describe information
  • SIP URI – Session initiation protocol uniform resource identifier (SIP URI) used for the SIP protocol to communicate with the device over TCP/IP
  • IP Address – The assigned network/host address for communication with the device over TPC/IP
  • Model – The detected model of the device
  • Software – The detected software version currently on the device
  • Last Seen – Time since the device last queried or checked for updates by way of a provisioning bridge
  • Approved – Status of the device approval. A green check mark indicates that the device has been approved, a yellow triangle indicates that the device is waiting on administrative approval

Bridge this device connected to

Bridges communicate to EZ UDM Pro information about devices that have connected. At the device level, EZ UDM Pro reveals which bridge a given device is connected to. The columns that are available for devices connected to a bridge:

  • Bridge Name – The name of the bridge, as communicated to EZ UDM Pro, at the time of the bridge registration
  • Device Logs –
  • Device Specific Files –

Device Logs

Logs that the device makes available to EZ UDM Pro through the bridge. This section is populated only if files are available.
If logs are available, you can do the following.

  • Click a log file name to view the log in the EZ UDM Pro console.
  • Click Download (down pointing arrow) on the right on the line of the log you want to download
  • Click the Download icon (circle arrow around a clock face) to the right of Device Logs to download all logs for this device. The files are compressed to a .ZIP file and the name of the file is "MACaddress".zip, where MACAddress is the MAC address of the device.

Device Specific Files

Configuration or other files (codecs, for example) that are specific to a unique set of devices. This section will be empty unless there are files for these devices for the device you are viewing.

Actions

There are three actions that you can perform on your devices.

  • Reboot – Sends a reboot command to the device. Handy if you have deployed a new configuration and need to apply it outside of your normal process
  • Approval – Click the toggle to either Approve or Unapprove the device
  • Delete – Click the trash can icon to delete the device from the system

Multi-select

Devices features the ability to select multiple devices by selecting the checkbox to the left of the MAC address, or you can select all devices by selecting the checkbox to the left of the MAC Address column label.
When you have selected the devices that you want to act on, you choose to Delete the selected devices, or export the details to a CSV file, or download device log files.
Note! Download of log files only appears if there are log files available on the device or a device(s) in your multi-selection. The file that contains the log files is downloaded to your computer as a compressed .zip format file named as the MAC address of the device that the logs were retrieved from.

Unapproved Devices

Unapproved devices are devices that have registered with a bridge, the bridge has notified EZ UDM Pro of the registration, but the administrator has not yet approved the device to do anything more than simply register. Consider that the process of registering is asking permission to use the totality of services that the bridge and EZ UDM Pro can offer.
Unapproved devices display the same type of information that an approved device would show.
Unapproved Devices are listed by the following columns:

  • Media access control (MAC) address – the hexadecimal number that identifies a device on a network. MAC addresses (theoretically) are unique. Be assured that a given MAC address will be unique on your network
  • Session initiation protocol uniform resource identifier (SIP URI) – a SIP URI, which resembles – and may be – your email address is used for applications to communicate with the device using TCP/IP
  • IP Address – IP Address is the number assigned to a device on your network, and could be either IPv4 or IPv6. IP addresses are usually assigned using the dynamic host configuration protocol (DHCP) server or service on your network.
  • Model – Lists the name of the phone model.
  • Location – The defined physical location of the device if the Location is associated with a defined subnet configured in Locations
  • Software – The version of software currently on the device.
  • Last seen – Last time the device actively polled for updates or changes.

One item that is unique to unapproved devices that is not on proper devices is the action Approve. Approving a device is acknowledging that you know what the device is, where it is and that it is a known part of your phone infrastructure
Caution! Never approve devices that you do not know. The stance that you should take is that you cannot know if the you are approving is, in fact, a device that you trust. It might be a rogue phone (or a program emulating a phone) that someone has attached to your network. Approving the device might give the person the ability to improperly use your phone system for a wide variety of purposes that violate your policies, such as toll theft to mention only one.
As always, there are exceptions to rules. Many environments use safeguards that are network-based. For example, the act of plugging in a phone without allowing communication beyond a network device (typically a switch) prevents the type of abuse vector that approval in EZ UDM Pro is designed to prevent. In these cases, use of a feature in EZ UDM Pro and common to phone provisioning, zero-touch approval (ZTA) is an option that reduces the administrative effort of manually approving new devices by allowing the system to accept and approve new devices automatically.

Security

Security is a critical part of any system. Device management for your phone system is no different.
EZ UDM Pro uses two roles, admin or administrator, and Auditor. Additionally, there is a default account, admin. We recommend that the admin account only used for initial setup and if other administrative accounts cannot log in. Create unique accounts for each user that will administer the system and assign the users the admin role.
Admin Account – The admin account is a hard-coded account with full permissions to the entire system. The admin account should be used for setup of the system and if all other accounts are otherwise unable to access the system. The reasoning is that you cannot audit who is doing what to your system if all users that administrate it are using the admin account.
Admin Role – Creating an account for a person that will administrate your system should have a unique account for that person with the admin role assigned. This will allow all actions to be tracked if there are potential issues, and you need to understand what happened from the person that may have seen the issue occur.
Auditor Role The Auditor role seems to have disappeared? Or can there only be one auditor? And, even though the JWeaver account is listed as an auditor, the option is not available on that user account, either. Nor do I have any current guidance on the AUDITOR role– The auditor role is a role that allows someone who will monitor the system and forensically investigate issues, but not be able to change settings. Essentially, this role when assigned to a user account allows the user a read-only login capability. This role is a good fit for a person in your Information Security area or compliance.

Create a User

To create a user and assign the user a role, do the following.

  1. Select Security on the sidebar.
  2. On the Users dialog, click Add on the upper right.
  3. On Users – Add New, fill in the following.
    1. Username – In the field, type the name for the new user you are creating
    2. New Password – In the field, type a new password for this user
    3. Confirm New Password – In the field, type the same password again to guard against mistakes
    4. Click Save to commit the changes

Change Password

To change the password of your account or of another user, you do the following.

  1. Log into EZ UDM Pro using your account credentials
  2. On the sidebar, select Security
  3. On the Users dialog is a list of users. Click your user account
  4. In the field New Password, type a new password
  5. In the field Confirm New Password, re-type the new password
  6. Click Save to commit your new password.

Settings

Settings in EZ UDM Pro include Bridge Management Settings, implementing the option to enable Zero Touch Registration (ZTR). Zero Touch Registration gives you the option to either enable or disable EZ UDM Pro to allow a bridge to register with no manual intervention. But, before a bridge can provision devices, you must approve the bridge for provisioning.
See the Bridges section in this guide for how you approve a bridge.
Additionally, there is a Device Management Settings feature Zero Touch Approval (ZTA) allowing the option to enable or disable the ability to for automatic approval and provisioning of devices. If this setting is enabled, the administrator does not need to approve each device that registers with EZ UDM Pro before it can request registration and provisioning.

Bridge Management Settings

To enable or disable Zero Touch Registration (ZTR), do the following.

  1. On the sidebar, click Settings
  2. On the Settings page, in Bridge Management Settings, click the toggle in Zero Touch Registration to enable or disable ZTR
  3. Adjust the Bridge Last Seen Days Threshold. This number represents how many days EZ UDM Pro will persist the registration of a bridge that has not reported in. Bridges communicate with EZ UDM Pro periodically to receive updates and to communicate new device registrations.

Note! By default, this period is five (5) days. If the Last Seen Time of the bridge exceed five days, the bridge is unregistered. If the bridge communicates with EZ UDM Pro after the threshold has been exceeded, it will need to re-register and be approved.

Device Management Settings

To enable or disable Zero Touch Approval (ZTA), do the following.

  1. On the sidebar, click Settings
  2. On the Settings page, in Device Management Settings, click the toggle in Zero Touch Approval to enable or disable ZTA
  3. Adjust Log Retention Period by typing a number to indicate the number of days to retain device logs on the serverWhich server? Provisioning bridge of EZ UDM Pro storage? If UDM Pro, this could get huge.. A setting of zero (0) will ignore logs.

Caution! Logs, while not huge for a single device, can become very large with hundreds to thousands of devices. Typically, there are two logs per device – a boot log and application (app) log. These logs, based on the activity of the device, can be as small as 1k and up. Given that these are a per-device log, if you have thousands of devices the storage requirements could get out of control quickly if not controlled by an automatic pruning setting such as Log Retention Period.

  1. Adjust the setting Alert time for a device not being seen to the number of days that can pass before alerting you that a given device has not polled or queried the bridge for updates or simply sent a heartbeatWhere is this reported? How is the alert given?

Logout

Noted earlier in the Overview section, your logged in user control is at the very top of the sidebar. From here, you can logout of your current session of EZ UDM Pro by clicking the Logout option.

Examples


Using XML in Device Sets to Change a Background


Logical Process Flow of a Device Configuration


How Dynamic Host Configuration Protocol Server and Options Assist in Provisioning


Appendix

Polycom publishes all technical documentation and software here:
http://support.polycom.com/PolycomService/support/us/support/voice/index.html
Sample links for common software guides:
Polycom RealPresence Trio Administrators Guide
Polycom UC Software 5.5.0

Frequently Asked Questions (FAQ)

What operating systems are supported for EZ UDM Pro?

Hardware Recommended:

  • CPU: 3.2 GHz or better AMD or Intel 4 core, 2 vCPUs for virtual machines
  • RAM: 8 GB or more
  • Disk space: 100 GB available
  • Network Interface: 1 Gbps

Software Recommended:

  • Windows 10, current Cumulative Updates, Windows Server 2012 R2, current Service Pack, or Windows Server 2016, current Cumulative Updates
  • .Net Framework 4.5.2 or newer
  • 32-bit or 64-bit SQL Server Express 2012 or newer (up to and including SQL Server Express 2016) or SQL Server Enterprise (clustered is acceptable)
  • Dynamic Host Configuration Server (Windows Server is assumed for this guide, but can be any applicable DHCP Server that will accept the required vendor options)
  • SQL Server Express Management Studio (for troubleshooting and tuning SQL Express) or SQL Enterprise (clustered is fine)
  • Browsers: Google Chrome 55.0 and newer, Microsoft Edge 25 and newer, Windows Internet Explorer 11, Apple Safari in macOS Sierra and iOS 9, Mozilla Firefox 51 and newer, Opera Software Opera 42.0 and newer

What operating systems are supported for the EZ UDM Pro Bridge?

Hardware Recommended:

  • CPU: 3.2 GHz or better AMD or Intel 2 core, 2 vCPUs for virtual machines
  • RAM: 4 GB or more
  • Disk space: 60 GB available
  • Network Interface: 1 Gbps

Software Recommended:

  • Windows 10, current Cumulative Updates, Windows Server 2012 R2, current Service Pack, or Windows Server 2016, current Cumulative Updates
  • .Net Framework 4.5.2 or newer
  • Browsers: Google Chrome 55.0 and newer, Microsoft Edge 25 and newer, Windows Internet Explorer 11, Apple Safari in macOS Sierra and iOS 9, Mozilla Firefox 51 and newer, Opera Software Opera 42.0 and newer

What is the minimum version of the NET Framework that must be installed?

4.5.2 or newer

What versions of SQL Server do you support?

2012 or newer

Do you support SQL Server Standard, Enterprise, or Datacenter?

All of the above.

Do you support running EZ UDM Pro Server in a virtual machine (VM), and if so, which VM

environments?

Yes, VMWare and HyperV.

Do I need DHCP?

No, but HIGHLY recommended.

  • No labels