Veeam Service Provider Console Management Agent

To install Veeam Service Provider Console management agent, use a command with the following syntax:

msiexec.exe [/L*v "<path_to_log>"] /qn /i "<path_to_msi>" [ACCEPT_THIRDPARTY_LICENSES="1"][ACCEPT_EULA="1"][INSTALLDIR="<path_to_installdir >"][VAC_SERVER_NAME="<product_server_name>"] [VAC_CC_COMMUNICATION_PORT="<port_number>"] [VAC_MANAGEMENT_AGENT_TYPE="2/3"] [VAC_SERVER_CERTIFICATE_THUMBPRINT="<security_certificate_thumbprint>"] [VAC_TENANT="tenant_account_name">] [VAC_TENANT_PASSWORD="tenant_account_password">] [CC_GATEWAY="cloud_gateway_address">]  [CC_GATEWAY_PORT="cloud_gateway_port_number">] [VAC_MASTER_MANAGEMENT_AGENT="master_agent_address">]

The command has the following parameters:

Option

Parameter

Required

Description

/L

*v logfile

No

Creates an installation log file with the verbose output.

Specify an existing 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\VACAgentSetup.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 Service Provider Console management agent. Specify a full path to the setup file as the parameter value.

Example: /i “C:\Veeam\VAC\VAC.CommunicationAgent.x64.msi”

ACCEPT_THIRDPARTY_LICENSES

0/1

Yes

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

Example: ACCEPT_THIRDPARTY_LICENSES="1"

ACCEPT_EULA

0/1

Yes

Specifies if you want to accept the terms of the Veeam license agreement.*

Specify 1 if you want to accept the terms and proceed with installation.

Example: ACCEPT_EULA="1"

INSTALLDIR

path

No

Installs the component to the specified location. By default, Veeam Service Provider Console uses the CommunicationAgent subfolder of the C:\Program Files\Veeam\Availability Console folder.

Example: INSTALLDIR="C:\Veeam\"

The component will be installed to the C:\Veeam\CommunicationAgent.

VAC_MANAGEMENT_AGENT_TYPE

2/3

No

Specifies the role of the management agent. Specify 3 if you want to install management agent on the Veeam Cloud Connect server.

If you do not use this parameter, Veeam Service Provider Console management agent component will be installed as a client management agent (default value, 2).

Example: VAC_MANAGEMENT_AGENT_TYPE="3"

VAC_SERVER_NAME

server name or address

No

Specifies FQDN or IP address of the server where Veeam Service Provider Console server is deployed.

You can use this parameter if you have specified 3 for the VAC_MANAGEMENT_AGENT_TYPE parameter.

If you do not use this parameter, you will need to configure connection settings manually.

Example: VAC_SERVER_NAME=“vac.cloudprovider.com"

VAC_CC_COMMUNICATION_PORT

port

No

Specifies the port number that the management agent will use to transfer traffic from cloud gateways and Veeam Cloud Connect server to Veeam Service Provider Console Server component.

You can use this parameter if you have specified 3 for the VAC_MANAGEMENT_AGENT_TYPE parameter.

If you do not use this parameter, Veeam Service Provider Console management agent will use the default port 9999.

Example: VAC_CC_COMMUNICATION_PORT=“101"

VAC_SERVER_CERTIFICATE_THUMBPRINT

thumbprint

No

Specifies a thumbprint to verify the security certificate installed on the Veeam Service Provider Console server.

Example: VAC_SERVER_CERTIFICATE_THUMBPRINT="028EC0FB60A7EBA9B140FCD1553061AF991A7FDE"

VAC_TENANT

user name

No

Specifies the user name of the client Company Owner.

If you do not use this parameter, you will need to configure connection settings manually.

Example: VAC_TENANT="Beta\Beta"

VAC_TENANT_PASSWORD

password

No

Specifies the password of the client Company Owner.

If you do not use this parameter, you will need to configure connection settings manually.

Example: VAC_TENANT_PASSWORD="P@ssw0rd"

CC_GATEWAY

name or address

No

Specifies FQDN or IP address of a cloud gateway to which management agent connects.

If you do not use this parameter, you will need to configure connection settings manually.

Example: CC_GATEWAY="gate01.cloudprovider.com"

CC_GATEWAY_PORT

port

No

Specifies the port number on the cloud gateway that is used to transfer data to Veeam Service Provider Console.

If you do not use this parameter, Veeam Service Provider Console will use the default port 6180.

Example: CC_GATEWAY_PORT="6181"

VAC_MASTER_MANAGEMENT_AGENT

name or address

No

Specifies FQDN or IP address of the machine on which the management agent with the Master role is installed.

If you use this parameter, master agent will trigger management agent installation and configure management agents to communicate with Veeam Service Provider Console.

Example: VAC_MASTER_MANAGEMENT_AGENT="backup01.tech.local"

*Accepting the terms of the Veeam license agreement includes accepting license agreement for the 3rd party components, when Veeam Service Provider Console management agent is installed on the Veeam Backup & Replication server using the Service Provider wizard. For details, see section Connecting Veeam Backup & Replication Servers of the Guide for Service Providers.

Example

Suppose you want to install Veeam Service Provider Console management agent with the following configuration:

  • Installation log location: C:\ProgramData\Veeam\Setup\Temp\Logs\VACAgentSetup.txt
  • No user interaction
  • Path to the MSI file: C:\Veeam\VAC\VAC.CommunicationAgent.x64.msi
  • Accept 3rd party license agreement
  • Accept Veeam license agreement
  • Installation directory: default
  • Agent type: client
  • Cloud gateway: gate01.cloudprovider.com
  • Company Owner user name: Beta\Beta
  • Company Owner password: P@ssw0rd
  • Communication ports: default
  • Security certificate thumbprint: 028EC0FB60A7EBA9B140FCD1553061AF991A7FDE

The command to install Veeam Service Provider Console management agent with such configuration will have the following parameters:

msiexec /qn /l*v C:\ProgramData\Veeam\Setup\Temp\Logs\VACAgentSetup.txt /i "C:\Veeam\VAC\VAC.CommunicationAgent.x64.msi"  CC_GATEWAY="gate01.cloudprovider.com" ACCEPT_THIRDPARTY_LICENSES="1" ACCEPT_EULA="1" VAC_TENANT="Beta\Beta" VAC_TENANT_PASSWORD="P@ssw0rd" VAC_CERT_THUMBPRINT="028EC0FB60A7EBA9B140FCD1553061AF991A7FDE"

Example 2

Suppose you want to install Veeam Service Provider Console management agent using a preconfigured master management agent:

  • Installation log location: C:\ProgramData\Veeam\Setup\Temp\Logs\VACAgentSetup.txt
  • No user interaction
  • Path to the MSI file: C:\Veeam\VAC\VAC.CommunicationAgent.x64.msi
  • Accept 3rd party license agreement
  • Accept Veeam license agreement
  • Agent type: client
  • Master management agent: backup01.tech.local
  • Communication ports: default

The command to install Veeam Service Provider Console management agent with such configuration will have the following parameters:

msiexec /qn /l*v C:\ProgramData\Veeam\Setup\Temp\Logs\VACAgentSetup.txt /i "C:\Veeam\VAC\VAC.CommunicationAgent.x64.msi"  ACCEPT_THIRDPARTY_LICENSES="1" ACCEPT_EULA="1" VAC_MASTER_MANAGEMENT_AGENT="backup01.tech.local"

Example 3

Suppose you want to install Veeam Service Provider Console management agent on a Veeam Cloud Connect :

The command to install Veeam Service Provider Console management agent with such configuration will have the following parameters:

msiexec /qn /l*v C:\ProgramData\Veeam\Setup\Temp\Logs\VACAgentSetup.txt /i "C:\Veeam\VAC\VAC.CommunicationAgent.x64.msi"  ACCEPT_THIRDPARTY_LICENSES="1" ACCEPT_EULA="1" VAC_MANAGEMENT_AGENT_TYPE="3" VAC_SERVER_NAME="vac.cloudprovider.com" VAC_SERVER_CERTIFICATE_THUMBPRINT="028EC0FB60A7EBA9B140FCD1553061AF991A7FDE"

I want to report a typo

There is a misspelling right here:

 

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