The Backup-CVSubclient cmdlet performs backup jobs for specific subclients.
Before you can use this cmdlet, you must log on to your CommCell environment using the Connect-CVServer cmdlet. For more information, see Connecting to a CommCell Environment with PowerShell.
Syntax
Backup-CVSubclient -Name <String> -ClientName <String> [-BackupType <Enumerated>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]Backup-CVSubclient -ClientName <String> -Id <Int32> [-BackupType <Enumerated>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]Backup-CVSubclient -SubclientObject <Object> [-BackupType <Enumerated>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]Required Parameters
Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter |
|---|---|---|---|---|---|---|
| The name of the subclient. | String | No | No | Named | |
| The client name of the subclient. | String | No | No | Named | |
| The ID of the subclient. | Int32 | The default value is 0. | No | No | Named |
| An object that identifies the subclient. | Object | Yes, by:
| No | Named |
Optional Parameters
Commvault Parameters
Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter |
|---|---|---|---|---|---|---|
| A value that specifies the type of backup that you want to perform. | String | Valid values include the following:
| No | No | Named |
Microsoft PowerShell Parameters
You can use the following Microsoft PowerShell parameters:
Debug
ErrorAction
ErrorVariable
OutBuffer
OutVariable
PipelineVariable
Verbose
WarningAction
WarningVariable
Force
Confirm
WhatIf
Note: Only a few cmdlets support Force, Confirm, and WhatIf parameters.
For more information, see "About Common Parameters" in the Microsoft PowerShell documentation.
Input
This cmdlet does not support input.
Output
A PSCustomObject that contains the job submission result.
Examples
Back Up a Subclient
The following example backs up subclient 100.
Backup-CVSubclient -Id 100Perform an Incremental Backup Job for a Subclient
The following example performs an incremental backup of subclient 100.
Backup-CVSubclient -Id 100 -BackupType Incremental