Backup-CVSQLSubclient
The Backup-CVSQLSubclient
cmdlet submits a backup job for a specific subclient.
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-CVSQLSubclient -Name <String> -ClientName <String> [-BackupType {full | incremental | differential}] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Backup-CVSQLSubclient -SubclientObject <Object> [-BackupType {full | incremental | differential}] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Required Parameters
Parameter |
Description |
Data type |
Accepts pipeline input? |
Accepts wildcard characters? |
Type of parameter |
|
The name of the subclient. |
String |
No |
No |
Named |
|
The name of the client that the subclient is associated with. |
String |
No |
No |
Named |
|
The object that represents the subclient. |
Object |
True, by:
|
No |
Named |
Optional Parameters
Commvault Parameters
Parameter |
Description |
Data type |
Values |
Accepts pipeline input? |
Accepts wildcard characters? |
Type of parameter |
|
The type of backup to perform. |
String |
Valid values:
|
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 message that indicates whether the backup completed successfully.
Last modified: 3/18/2020 8:35:04 AM