The Search-CVClientFileSystem cmdlet creates a browse query for the 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
Search-CVClientFileSystem -Name <String> [-SubclientName <String>] [-Path <String>] [-BackupSetId <String>] [-CopyPrecedence <Int32>] [-JobId <String>] [-Proxy <String>] [-MediaAgent <String>] [<CommonParameters>]
Search-CVClientFileSystem -Id <Int32> [-SubclientName <String>] [-Path <String>] [-BackupSetId <String>] [-CopyPrecedence <Int32>] [-JobId <String>] [-Proxy <String>] [-MediaAgent <String>] [<CommonParameters>]
Search-CVClientFileSystem -ClientObject <Object> [-SubclientName <String>] [-Path <String>] [-BackupSetId <String>] [-CopyPrecedence <Int32>] [-JobId <String>] [-Proxy <String>] [-MediaAgent <String>] [<CommonParameters>]Required Parameters
Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter |
|---|---|---|---|---|---|---|
| The name of the client. | String | No | No | Named | |
| The ID of the client. | Int32 | The default value is 0. | No | No | Named |
| An object that represents the client. | Object | Yes, by:
| No | Named |
Optional Parameters
Commvault Parameters
Parameter | Description | Data type | Values | Accepts pipeline input? | Accepts wildcard characters? | Type of parameter |
|---|---|---|---|---|---|---|
| The subclient name for the browse query. | String | No | No | Named | |
| The path for the browse query. | String | No | No | Named | |
| The ID of the backup set. | Int32 | No | No | Named | |
| Specify the client with copy precedence for the browse query. | Int32 | Valid values are:
| No | No | Named |
| The Job ID browse query. | Int32 | No | No | Named | |
| The proxy for browse query. | String | No | No | Named | |
MediaAgent | The MediaAgent for the browse query. | String | 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.
Examples
Create a Browse Query for a Client By Name
This example creates a browse query for the carbonwincs client.
Search-CVClientFileSystem -Name carbonwincsCreate a Browse Query for a Client By ID
This example creates a browse query for client 2.
Search-CVClientFileSystem -Id 2