Loading...

Get-CVSQLInstance

The Get-CVSQLInstance cmdlet lists the SQL server instances in your CommCell environment. Additionally, you can specify parameters to filter the list of SQL server instances.

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-CVSQLInstance [-SortColumn {insId | insName | version | cName | noDBs | planName}] [-SortDescending] [-OnlySLA] [-AllProperties] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]

Get-CVSQLInstance [-Name <String>] [-ClientName <String>] [-SortColumn {insId | insName | version | cName | noDBs | planName}] [-SortDescending] [-OnlySLA] [-AllProperties] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]

Get-CVSQLInstance [-ClientObject <Object>] [-SortColumn {insId | insName | version | cName | noDBs | planName}] [-SortDescending] [-OnlySLA] [-AllProperties] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]

Optional Parameters

Commvault Parameters

Parameter

Description

Data type

Values

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

–Name

The name of the instance.

String

 

No

No

Named

–ClientName

The name of the client that the instance is associated with.

String

 

No

No

Named

–ClientObject

The object that represents the instance.

Object

 

Yes, by:

  • Value
  • Property name

No

Named

–SortColumn

The column to sort the instances by.

Enumerated

Valid values:

  • insId (default)
  • insName
  • version
  • cName
  • noDBs
  • planName

No

No

Named

–SortDescending

Sorts the instances in descending order.

SwitchParameter

 

No

No

Named

–OnlySLA

Retrieves only instances that have missed Service Level Agreements (SLAs).

SwitchParameter

 

No

No

Named

–AllProperties

Retrieves all properties of the instances.

SwitchParameter

 

No

No

Named

-IncludeTotalCount

Includes the total count of instances.

SwitchParameter

 

No

No

Named

–Skip

This parameter allows you to skip the first 'x' number of pages from the output and then displays the rest of the pages.

UInt64

 

No

No

Named

–First

This parameter allows you to display first 'x' number of records in one page and the remaining records in the next page.

UInt64

 

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 list of SQL server instances with details for each instance.

Examples

List All the SQL Server Instances

The following example retrieves all SQL server instances in your CommCell environment.

Get-CVSQLInstance

List All the SQL Server Instances with Paging Support

The following example returns a list of all the SQL Server instances with first 5 instances in one page, without skipping any page from the output.

Get-CVSQLInstance -First 5 - Skip 0

Last modified: 3/18/2020 8:20:26 AM