Add peripherals to inventory

  • Applies to: Microsoft Teams

The script utilizes PowerShell cmdlets and native Windows API functions to gather information about connected devices (peripherals). It can tell the differences between different types of peripherals such as USB devices, monitors, cameras, speakers, and microphones.

When you run the PowerShell script, the data is exported to a CSV file that can be upload to Teams Pro Management Portal for managing, monitoring, and reporting usage of devices in BYOD rooms and Bookable Desks.

Steps

  1. Go here to download the Get-TeamsBYODSpaceDevices.ps1 PowerShell script.

  2. Unblock and extract the downloaded zip file. Move the Get-TeamsBYODSpaceDevices.ps1 script to your preferred location on your PC.

  3. Open a new PowerShell window and navigate to the location where you moved the Get-TeamsBYODSpaceDevices.ps1 script.

    Note

    You can optionally open the script and customize it before you run it. However, don't change the sheet name. The sheet name must be named PERIPHERALS.

  4. Run the script by executing the following command in the PowerShell window:

    \Get-TeamsBYODSpaceDevices.ps1

  5. The script prompts will guide you through the process:

    1. Wait for the script to detect and gather information about internal peripherals. The waiting period is essential for the script to make sure it establishes a baseline between internal and externally connected peripherals.

    2. Connect the external peripherals when prompted.

    3. Provide the Account information so as to properly associate the peripheral with the right room or desk account.

    4. Provide the folder path where the PERIPHERALS.csv file will be saved when prompted.

    5. The script will process the discovered peripheral data and export it to the specified file path.

  6. Review the exported data to verify accuracy.

  7. When finished, enter 'Y' when prompted to end the collection process.

  8. Open the CSV saved to the specified file path and review the device details collected, including the following fields:

    1. Account - Resource account for the desk or desk pool to associate the peripheral device with, entered by the user.
    2. Display Name - Display name for the desk or desk pool in Teams Pro Management Portal, entered by the user.
    3. Product ID - ID for the product detected by the script.
    4. Vendor ID - ID for the product manufacturer detected by the script.
    5. Serial Number - Serial number for the peripheral device detected by script. Serial number value must be present and unique or the peripheral association will not work correctly for a bookable desk. Rows with serial number value missing will be skipped during import. When the script is unable to detect a device's serial number correctly, the device may be an older model or is otherwise unsupported. As a fallback, use the peripheral auto-association process, which can detect some devices not detected by the script.
    6. Peripheral Name - How the peripheral device name should appear in Teams Pro Management Portal.
    7. Peripheral Type - How the peripheral device type should appear in Teams Pro Management Portal.

  9. Check to ensure the CSV file contains only plain text. Values can include letters, numbers, spaces, and symbols, but not links or other non-text content. The import process will fail if links or non-text content is present in the file.

  10. Save the CSV file in .XLSX format. The first sheet in the CSV file must be titled PERIPHERALS.

    Important

    If sensitivity labels are enabled in your tenant, verify that the Excel file has a label of non-business, public, or general. Any other more confidential setting will cause the import to fail.

  11. Sign in and open the Microsoft Teams Pro Management portal, on the Planning > Inventory > Devices page, select Import to add the device inventory to upload the file you modified.

  12. Verify that the device and desk association is updated successfully in the Teams Pro Management portal.

  • Last updated on