This is an archive version of the document. To get the most up-to-date information, see the current version.

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

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.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

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.

True

Named

False

False

Job

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

True

Named

False

False

<CommonParameters>

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

Example 1

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

You will need to perform the following steps:

  1. Run Get-VBRJob to get the backup jobs. Save the result to the $job variable.
  2. Run Set-VBRvCloudOrganizationJobMapping with the $job variable. Use the Map identifier for the Action parameter.

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

Set-VBRvCloudOrganizationJobMapping -Action Map -Job $job

Example 2

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

You will need to perform the following steps:

  1. Run Get-VBRJob to get the backup jobs. Save the result to the $job variable.
  2. Run Set-VBRvCloudOrganizationJobMapping with the $job variable. Use the Unmap identifier for the Action parameter.

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

Set-VBRvCloudOrganizationJobMapping -Action Unmap -Job $job

Related Commands

Get-VBRJob

I want to report a typo

There is a misspelling right here:

 

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