The Export-VmsHardware cmdlet exports hardware device information from an XProtect VMS to either CSV or Excel format.
The export format is chosen based on the file extension you specify in the Path or LiteralPath parameter. When
exporting to a file with the .csv extension, each row of the CSV file will represent a single device. By default, it
will only export camera device information, but you may specify additional device types with the DeviceType parameter.
When exporting to a file with the .xlsx extension, a much more detailed export is performed. A worksheet will be
created containing basic hardware information including name, address, credentials, and driver, and additional
worksheets will be created for hardware general settings, ptz settings, cameras, camera general settings, camera stream
settings, and so on.
By default, the command will only export records for enabled devices, but you can change that behavior by setting
EnableFilter to All or Disabled to export information for all devices, or only disabled devices respectively.
The output from Export-VmsHardware can be used directly with the Import-VmsHardware cmdlet to the hardware on a new
management server, or to restore the hardware to the same management server after removign them, or to update settings
on hardware already added to the VMS after modifying the CSV or XLSX files produced by an export.
REQUIREMENTS
Requires VMS connection and will attempt to connect automatically
This example will prompt for you to select one or more recording servers, and then export all the enabled cameras from
all hardware on those recording servers to a CSV file.
This example will prompt for you to select one or more recording servers, and then export all the enabled cameras,
microphones, speakers, metadata, inputs, and outputs on all hardware on those recording servers to a CSV file.
This example will prompt for you to select one or more recording servers, and then export all enabled, and disabled
cameras, and metadata on all hardware on those recording servers to a CSV file.
Specifies a path where exported hardware information should be saved. The file extension should be ".csv" or ".xlsx"
depending on whether you prefer to have a basic CSV file export, or a detailed Excel export.
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
The ImportExcel module is used to import and export files with a .xlsx extension. If the ImportExcel module is
available on the host computer, it will be loaded from there. If the ImportExcel module cannot be found, an embedded
version of the module will be imported automatically.