Loading...

Get-CVSQLClientDetail

The Get-CVSQLClientDetail cmdlet retrieves SQL client 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-CVSQLClientDetail -Name <String> [-InstanceName <String>] [-InstanceId <Int32>] [<CommonParameters>]

Get-CVSQLClientDetail -ClientObject <Object> [-InstanceName <String>] [-InstanceId <Int32>] [<CommonParameters>]

Required Parameters

Parameter

Description

Data type

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

–Name

The name of the client.

String

No

No

Named

–ClientObject

The object that represents the client.

Object

Yes, by:

  • Value
  • Property name

No

Named

Optional Parameters

Commvault Parameters

Parameter

Description

Data type

Values

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

–InstanceName

The name of the instance to get details for.

String

 

No

No

Named

–InstanceId

The ID of the instance to get details for.

Int32

The default value is 0.

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

The SQL client details appear as the output.

Last modified: 3/18/2020 7:44:29 AM