The Backup-CVClientFileSystem cmdlet creates a backup task for a subclient of a client file system.
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-CVClientFileSystem -Name <String> [-SubclientName <String>] [-SubclientId <Int32>] [-BackupType {Full | Incremental | Differential | Synthetic_Full}] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Backup-CVClientFileSystem -Id <Int32> [-SubclientName <String>] [-SubclientId <Int32>] [-BackupType {Full | Incremental | Differential |Synthetic_Full}] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Backup-CVClientFileSystem -ClientObject <Object> [-SubclientName <String>] [-SubclientId <Int32>] [-BackupType {Full | Incremental | Differential | Synthetic_Full}] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]Required Parameters
Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter |
|---|---|---|---|---|---|---|
| The name of the client that you want to create a file system backup task for. | String | No | No | Named | |
| The ID of the client that you want to create a file system backup task for. | Int32 | The default value is 0. | No | No | Named |
| An object that represents the client that you want to create a file system backup task for. | Object | Yes, by:
| No | Named |
Optional Parameters
Commvault Parameters
Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter |
|---|---|---|---|---|---|---|
| The name of the subclient that you want to create a file system restore task for. | String | No | No | Named | |
| The ID of the subclient that you want to create a file system restore task for. | Int32 | The default value is 0. | No | No | Named |
| The backup type. | String | Valid values are:
| 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 results.
Example
This example creates a backup task for the ExportTest subclient of the carbonwincs client file system.
Backup-CVClientFileSystem -Name carbonwincs -SubclientName ExportTest