BVMS Server- and Client-SDK
BVMS Server- and Client-SDK
BVMS Server- and Client-SDK
Bosch.Vms.SDK
IConfigurationManager Interface
IConfigurationManager Methods
ExportConfiguration Method

# IConfigurationManagerExportConfiguration Method |

Exports the current configuration and the user preferences data files. Results will be added to the .zip archive.
Namespace: Bosch.Vms.SDK
Assembly: Bosch.Vms.SDK (in Bosch.Vms.SDK.dll) Version: 1.9.0.0
Syntax
C#
Copy

    void ExportConfiguration(
    	string archiveFileName,
    	bool overwrite
    )

#### Parameters

archiveFileName String
  The destination .zip archive file name.
overwrite Boolean
  True if the destination file can be overwritten, otherwise - false.

Exceptions

Exception | Condition
--- | ---
SdkException | Thrown in case of any errors occurred during export process. For example: - Method invoked via remoting or using IClientApi interface reference (exception message: Configuration export is forbidden for remote or Client API calls). - Configuration export is currently running (exception message: Only one configuration export operation can be performed at the same time). - Unable to create temporary directory for configuration export in destination folder (exception message: Error creating temporary directory). - Destination file exists and cannot be overwritten (exception message: Destination file exists and cannot be overwritten). - etc.
UnauthorizedAccessSdkException | Thrown when export target directory is not within configured whitelist.

Remarks

Tip
The method uses "accept known good" input validation strategy and ensures that requested archiveFileName is strictly within a configured whitelist where exports are allowed. Requested export path must met one of the following condition: - Specified path directory is white-listed itself; - Specified path directory is subdirectory of any white-listed directory; - Specified path is within an optical disc device, such as a CD or DVD-ROM or within removable storage device, such as a floppy disk drive or a USB; When none of the conditions above are met, requested export is rejected.

Tip
Exports whitelist is defined by BVMS administrator on Central Server in ..\ProgramData\Bosch\VMS\ServerData\PathWhitelistForExports.txt.

See Also

#### Reference

IConfigurationManager Interface
Bosch.Vms.SDK Namespace

Copyright © Bosch Sicherheitssysteme GmbH