Set-VBRvCloudOrganizationJobMapping

Short Description

Adds vCD backup jobs and backups to the vCloud Director Organization or removes them from it.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Set-VBRvCloudOrganizationJobMapping -Action <VBRMapOrganizationAction> {Map | Unmap} -Job <VBRJob[]>  [<CommonParameters>]

Detailed Description

This cmdlet adds backup jobs and backups created by these jobs to the vCloud Director Organization or removes them from it.

vCloud providers can use this cmdlet to make vCD backup jobs visible to the administrators of the vCloud Director Organization. As a result, Organization administrators can manage these jobs or perform restore operations through Self-Service Backup Portal of Veeam Backup Enterprise Manager. The administrators get access to:

  • Backups created by these jobs
  • Guest OS credentials configured in these jobs.

This cmdlet does not add imported backups.

Administrators of vCloud Director Organization will not see the backup jobs sessions run previously by the vCloud providers.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Action

Specifies the action for backup jobs:

  • Map: Adds backup jobs and backups to the vCloud Director Organization
  • Unmap: Removes backup jobs and backups from the vCloud Director Organization.

VBRMapOrganizationAction

True

Named

False

Job

Specifies the array of backup jobs. The cmdlet will add these jobs to the vCloud Director Organization or remove them from it.

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

True

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

None.

Examples

Set-VBRvCloudOrganizationJobMappingExample 1. Adding Backup Jobs and Backups to vCloud Director Organization

This example shows how to add backup jobs and backups to the vCloud Director Organization.

$job = Get-VBRJob -Name "Backup Job 1", "Backup Job 2"

Set-VBRvCloudOrganizationJobMapping -Action Map -Job $job

Perform the following steps:

  1. Run the Get-VBRJob to get the backup jobs. Specify the Name parameter value. Save the result to the $job variable.
  2. Run the Set-VBRvCloudOrganizationJobMapping cmdlet. Set the Map option for the Action parameter. Set the $job variable as the Job parameter value.

Set-VBRvCloudOrganizationJobMappingExample 2. Removing Backup Jobs and Backups from vCloud Director Organization

This example shows how to remove backup jobs and backups from the vCloud Director Organization.

$job = Get-VBRJob -Name "Backup Job 1", "Backup Job 2"

Set-VBRvCloudOrganizationJobMapping -Action Unmap -Job $job

Perform the following steps:

  1. Run the Get-VBRJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
  2. Run the Set-VBRvCloudOrganizationJobMapping cmdlet. Set the Unmap option for the Action parameter. Set the $job variable as the Job parameter value.

Related Commands

Get-VBRJob