Veeam Backup Catalog

In this article

    To install Veeam Backup Catalog, use a command with the following syntax:

    msiexec.exe [/L*v "<path_to_log>"] /qn /i "<path_to_msi>" ACCEPT_THIRDPARTY_LICENSES="1" [INSTALLDIR="<path_to_installdir >"][VM_CATALOGPATH="<path_to_catalog_shared_folder>"][VBRC_SERVICE_USER="<Veeam_Guest_Catalog_Service_account>"][VBRC_SERVICE_PASSWORD="<Veeam_Guest_Catalog_Service_account_password>"] [VBRC_SERVICE_PORT="<Veeam_Guest_Catalog_Service_port>"]

    The command has the following parameters:

    Option

    Parameter

    Required

    Description

    /L

    *v logfile

    No

    Creates an installation log file with the verbose output.

    Specify a full path to the log file as the parameter value. A setup log file created during the previous installation is cleared.

    Example: /L*v "C:\ProgramData\Veeam\Setup\Temp\Logs\Catalog.txt"

    /q

    n

    Yes

    Sets the user interface level to “no”, which means no user interaction is needed during installation.

    /i

    setup file

    Yes

    Installs Veeam Backup Catalog. Specify a full path to the setup file as the parameter value.

    Example: /i "C:\Veeam\VeeamBackupCatalog64.msi"

    ACCEPT_THIRDPARTY_LICENSES

    0/1

    Yes

    Specifies if you want to accept the license agreement for 3rd party components that Veeam incorporates. Specify 1 to accept the license agreement and proceed with installation.

    Example: ACCEPT_THIRDPARTY_LICENSES="1"

    INSTALLDIR

    path

    No

    Installs the component to the specified location.

    By default, Veeam Backup & Replication uses the Backup Catalog subfolder in the C:\Program Files\Veeam\Backup and Replication\ folder.

    Example: INSTALLDIR="C:\Catalog\"
    The component will be installed to the C:\Catalog\Backup Catalog folder.

    VM_CATALOGPATH

    path

    No

    Specifies a path to the catalog folder where index files must be stored.

    By default, Veeam Backup & Replication creates the VBRCatalog folder on a volume with the maximum amount of free space, for example C:\VBRCatalog.

    Example: VM_CATALOGPATH="C:\Backup\"
    Index files will be stored to the C:\Backup\VBRCatalog folder.

    VBRC_SERVICE_USER

    user

    No

    Specifies a user account under which the Veeam Guest Catalog Service will run. The account must have full control NTFS permissions on the VBRCatalog folder where index files are stored.

    If you do not specify this parameter, the Veeam Guest Catalog Service will run under the LocalSystem account.

    Together with the VBRC_SERVICE_USER parameter, you must specify the VBRC_SERVICE_PASSWORD parameter.

    Example: VBRC_SERVICE_USER="BACKUPSERVER\Administrator"

    VBRC_SERVICE_
    PASSWORD

    password

    No

    This parameter must be used if you have specified the VBRC_SERVICE_USER parameter.

    Specifies a password for the account under which the Veeam Guest Catalog Service will run.

    Example: VBRC_SERVICE_PASSWORD="1234"

    VBRC_SERVICE_PORT

    port

    No

    Specifies a TCP port that will be used by the Veeam Guest Catalog Service. By default, port number 9393 is used.

    Example: VBRC_SERVICE_PORT="9393"

    Example

    Suppose you want to install Veeam Backup Catalog with the following configuration:

    • No user interaction
    • Path to the MSI file: E:\Veeam\VeeamBackupCatalog64.msi
    • Installation folder: default
    • Catalog folder: default
    • Service user account: VEEAM\Administrator
    • Service user account password: 1243
    • TCP communication port: 9391

    The command to install Veeam Backup Catalog with such configuration will have the following parameters:

    msiexec.exe /qn /i "E:\Veeam\VeeamBackupCatalog64.msi" ACCEPT_THIRDPARTY_LICENSES="1" VBRC_SERVICE_USER="VEEAM\Administrator" VBRC_SERVICE_PASSWORD="1234" VBRC_SERVICE_PORT="9391"

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.