Assign-VBRInstanceWorkload

Short Description

Sets the product edition for standalone Veeam Agents.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Assign-VBRInstanceWorkload -Workload <VBRLicensedInstanceWorkload[]> -LicenseMode <VBRAgentLicenseMode> {Server |Workstation}  [<CommonParameters>]

Detailed Description

This cmdlet sets the product edition for standalone Veeam Agents to one of the following:

  • Server edition
  • Workstation edition

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Workload

Specifies an array of protected workloads. The cmdlet will set the product edition for these workloads.

Accepts the VBRLicensedInstanceWorkload[] object. To get this object, run the Get-VBRLicensedInstanceWorkload cmdlet.

True

Named

False

 

LicenseMode

Specifies a product edition. The cmdlet will set this product edition to protected. You can specify either of the following product editions:

  • Server
  • Workstation

VBRAgentLicenseMode

True

Named

False

 

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Examples

Assign-VBRInstanceWorkloadExample 1. Setting Server Edition

This example shows how to set the Server edition for a standalone Veeam Agent that is running the Workstation edition.

$license = Get-VBRInstalledLicense

$workload = Get-VBRLicensedInstanceWorkload -License $license

Assign-VBRInstanceWorkload -Workload $workload -LicenseMode Server

Perform the following steps:

  1. Run the Get-VBRInstalledLicense cmdlet. Save the result to the $license variable.
  2. Run the Get-VBRLicensedSocketWorkload cmdlet. Set the $license variable as the License parameter value. Save the result to the $workload variable.
  1. Run the Assign-VBRInstanceWorkload cmdlet. Set the $workload variable as the Workload parameter value. Set the Workstation value to the LicenseMode parameter.

Assign-VBRInstanceWorkloadExample 2. Setting Workstation Edition

This example shows how to set the Workstation edition for a standalone Veeam Agent that is running the Server edition.

$license = Get-VBRInstalledLicense

$workload = Get-VBRLicensedInstanceWorkload -License $license

Assign-VBRInstanceWorkload -Workload $workload -LicenseMode Workstation

Perform the following steps:

  1. Run the Get-VBRInstalledLicense cmdlet. Save the result to the $license variable.
  2. Run the Get-VBRLicensedSocketWorkload cmdlet. Set the $license variable as the License parameter value. Save the result to the $workload variable.
  3. Run the Assign-VBRInstanceWorkload cmdlet. Set the $workload variable as the Workload parameter value. Set the Server value to the LicenseMode parameter.

Related Commands

I want to report a typo

There is a misspelling right here:

 

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