Get-VBRCloudTapeBackupTenant

Short Description

Returns tenants backups.

Applies to

Product Edition: Enterprise

Requires Cloud Connect license

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get tenants backups by the tenant name.

Get-VBRCloudTapeBackupTenant [-Name <string[]>]  [<CommonParameters>]

  • Get tenant backups by the tenant ID.

Get-VBRCloudTapeBackupTenant -Id <guid[]>  [<CommonParameters>]

Detailed Description

This cmdlet returns the array of backups of tenants.

Get-VBRCloudTapeBackupTenant Important!

You can run this cmdlet from the service provider side only.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Name

Specifies an array of tenant names. The cmdlet will return backups of tenants with these names.

String[]

False

Named

True (ByValue,
ByProperty
Name)

Id

Specifies an array of tenant IDs. The cmdlet will return backups of tenants with the specified IDs.

Guid[]

True

Named

True (ByValue,
ByProperty
Name)

<CommonParameters>

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

Output Object

VBRCloudTapeBackupTenant

Examples

Get-VBRCloudTapeBackupTenantExample 1. Getting Backups of All Tenants

This command gets backups of all tenants.

Get-VBRCloudTapeBackupTenant

Get-VBRCloudTapeBackupTenantExample 2. Getting Backups of Selected Tenant by Tenant ID

This command gets backups of a tenant with a specific tenant ID.

Get-VBRCloudTapeBackupTenant -ID "0fccf7c9-1f90-49de-8bec-53a0697e04ab"

Get-VBRCloudTapeBackupTenantExample 3. Getting Backups of Selected Tenant by Tenant Name

This command gets backups of a tenant by the tenant name.

Get-VBRCloudTapeBackupTenant -Name "New tenant"