Loading...

Get-CVSubclient

The Get-CVSubclient cmdlet returns the properties of a subclient that belongs to a specific client. Or, if you do not specify a subclient, then the cmdlet returns the properties of all subclients in the CommCell environment.

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-CVSubclient [-Name <String>] [-Id <Int32>] -ClientName <String> [-AllProperties] [<CommonParameters>]

Get-CVSubclient [-Name <String>] [-Id <Int32>] -ClientObject <Object> [-AllProperties] [<CommonParameters>]

Required Parameters

Parameter

Description

Data type

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

ClientName

The name of the client.

String

No

No

Named

ClientObject

An 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

Name

The name of the subclient.

String

 

Yes, by value

No

Named

Id

The ID of the subclient.

Int32

The default value is 0.

No

No

Named

AllProperties

An object that represents the properties of the subclient.

Object

 

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

All subclients of the specified client or subclient.

Examples

Get Information for a Subclient

The following example returns information about mySubclient, which is a subclient of myClient.

Get-CVSubclient -ClientName myClient -Name mySubclient

Get All the Subclients in the CommCell Environment

The following example returns information for all subclients of myClient.

Get-CVSubclient -ClientName myClient

Last modified: 3/18/2020 8:21:28 AM