Device Catalog

The Device Catalog puts you in control of the equipment list your organization can deploy to NetSpeek Canvas. Alongside the manufacturers and models NetSpeek maintains, you can build a custom catalog within your tenant, adding any manufacturer, device model, imagery and ports needed.


Introduction

Every environment is a little different. You may use equipment from a boutique brand, a regional SKU, a custom-built panel, an unreleased prototype device, a piece of legacy gear, or you may even want to keep track of the furniture in your spaces. The Device Catalog lets you add custom items yourself, whenever you need them, without waiting on anyone.

Your catalog entries belong to your tenant. They are visible only to your organization, and you decide what goes in, what it is called, and how it is described. This guide covers what you can add and how to manage your devices and list.

What Device Catalog enables you to do

Within the Device Catalog tab of your Tenant Settings, you can:

  • Browse the NetSpeek catalog together with the manufacturers and models your tenant has added.
  • Add any manufacturer you want available to your organization.
  • Add device models — under a manufacturer you created, or under one already in the NetSpeek catalog.
  • Define each model’s ports (name, type, and direction) so its connections can be mapped the way the hardware is actually wired.
  • Attach a manufacturer logo and a model image.
  • Edit or remove any catalog item your tenant owns.
  • Use your models anywhere you would use a NetSpeek model when adding devices to a Canvas

The NetSpeek Catalog, and your custom Device Catalog

The table describes the differences between the catalog of devices supported by NetSpeek, and a custom Device Catalog in your tenant.

CatalogDescription
The NetSpeek CatalogManufacturers and models NetSpeek maintains and keeps current for all subscribers. These are view-only, so no NetSpeek subscriber can alter anything about them. In most cases, NetSpeek maintains an integration to permit Lena to orchestrate these devices via control, status inquiry, and other commands.
Your tenant’s custom Device CatalogWhat users of your tenant add. These devices are private to your organization, and fully yours to edit or remove.These devices can be customized with names, imagery, and ports/connections for depiction on NetSpeek Canvas, but because they are not fully supported like those in the NetSpeek Catalog, cannot be orchestrated (no integrations/commands) and Lena cannot answer questions about them (no knowledgebase/expertise).

Items are labeled by catalog, to make it clear which entries you maintain and which NetSpeek does.

You can create some overlap. For example, if a manufacturer is already in the NetSpeek Catalog but the exact model you need is not, add your model under the existing manufacturer rather than creating a duplicate of that manufacturer. The manufacturer stays shared; the custom device model is yours.

Permissions and Access

All users with access to a tenant can view and browse the tenant’s Device Catalog.

Adding, editing, and removing entries requires catalog write access to the Device Catalog. This permission is granted to the Owner, Administrator, and Manager roles – see details in the note below.

Catalog changes apply to the specific tenant you are signed in to, and devices are not shared or inherited in any way. If you work across multiple tenants or sub-tenants, confirm you are signed in to the intended one before working in Device Catalog.

Note

The Owner, Administrator, and Manager roles are granted the CustomerDevices:Write, Files:Delete, and Files:Upload permissions, which are required to modify the Device Catalog. All user roles have the Customers:ReadSelf permission, which permits viewing the Device Catalog. Details at: Role-Based Access Control (RBAC) Implementation Guide

Navigation – Find and Use the Device Catalog

  1. Sign in and confirm you are in the correct tenant.
  2. Open Tenant Management.
  3. Open Device Catalog.

The catalog opens on manufacturers. Open a manufacturer to see its models; open a model to see its ports.

You can search the catalog at any level, and filter the list to everything, to the NetSpeek catalog only, or to your own entries only.

Add a manufacturer

  1. Open the Device Catalog.
  2. Click to add a manufacturer.
  3. Enter the manufacturer name.
  4. Optionally attach a logo.
  5. Save.

The name is the only requirement. Each manufacturer name can be used once within your own catalog.

Add a device model

  1. Choose to add a device — from the catalog home, or from inside the manufacturer you want it under.
  2. Select the manufacturer. Both your own and NetSpeek’s are available.
  3. Enter the model name. This is how the model is identified in the catalog.
  4. Optionally assign a device category, such as Display, Codec, or Switch.
  5. Optionally attach a model image.
  6. Save.

Adding a new manufacturer and its first model at once? Use the combined add option and do it in a single step.

Within your catalog, each model name is used once per manufacturer. The same model name can appear under a different manufacturer.

Add ports

Ports describe a model’s connections — HDMI, USB-C, Ethernet, power, and anything else the hardware exposes. Defining them is what lets you map that model’s connections accurately later.

  1. Open the device model.
  2. Choose to add port(s).
  3. Enter a port name.
  4. Select a port type.
  5. Choose a direction: input, output, or bidirectional.
  6. If the model has several of the same port, set a quantity and they are created as a numbered series (HDMI 1, HDMI 2, and so on, padded once the series reaches double digits).
  7. Save.

Afterward you can rename a port, change its type or direction, update a whole series at once, or remove ports you no longer need.

Edit and remove your entries

Everything your tenant owns stays editable: manufacturer names and logos, model names and images and categories, and port details. NetSpeek Catalog entries remain view-only.

To keep your environment consistent, deletion is blocked when a dependency exists, as described below:

ItemDependency rule
A manufacturerA manufacturer stays until its device models are removed.
A modelA model stays while a device in a room still uses it.
A portA port stays while a connection still uses it.

Clear the dependency first, then remove the entry.

Use your models

Once a model is in your catalog it behaves like any other. When you add a device to a room, pick your manufacturer and model, fill in the device details, and map its connections using the ports you defined.

Growing the shared catalog

Your own Device Catalog is yours to extend as you see fit, and there is no need to ask permission or wait for a release to add something.

If you would also like to see a manufacturer or model added to the NetSpeek catalog for everyone, we would like to hear about it. Reach out to your NetSpeek Sales or Customer Experience representative, or email lena@netspeek.com.

Related documentation

ResourceDescription
NetSpeek Supported Devices and ControlsList of manufacturers and models NetSpeek maintains
NetSpeek Lena Onboarding GuideDescribes tenant setup, rooms, adding devices, and more
Role-Based Access Control (RBAC) Implementation GuideDescribes currently available roles and permissions

Support

If you have questions or issues with the Device Catalog, contact NetSpeek Support at support@netspeek.com.