The Get-CVSQLInstanceDetail cmdlet retrieves SQL server instance details.
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
Get-CVSQLInstanceDetail -Name String [-AllProperties] [CommonParameters]Get-CVSQLInstanceDetail -InstanceObject Object [-AllProperties] [CommonParameters]Required Parameters
|
Parameter |
Description |
Data type |
Accepts pipeline input? |
Accepts wildcard characters? |
Type of parameter |
|---|---|---|---|---|---|
|
|
The name of the instance. |
String |
No |
No |
Named |
|
|
The object that represents the instance. |
Object |
Yes, by:
|
No |
Named |
Optional Parameters
Commvault Parameters
|
Parameter |
Description |
Data type |
Accepts pipeline input? |
Accepts wildcard characters? |
Type of parameter |
|---|---|---|---|---|---|
|
|
Retrieves all properties of the instance. |
SwitchParameter |
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 details about the specified SQL instance.
Example
The following example retrieves the details of the specified SQL server.
Get-CVSQLInstanceDetail -Name SNOWSQL1\SQL2008R2