Loading...

Get-CVClientProps

The Get-CVClientProps cmdlet returns property information for a client in your CommCell environment.

Before you can use this cmdlet, you must log in to your CommCell environment using the Connect-CVServer cmdlet. For more information, see Connecting to a CommCell Environment with PowerShell.

Syntax

Get-CVClientProps
   [[-ClientName] <Object>]
   [[-ClientObject] <Object>]
   [<CommonParameters>]

Required Parameters

You must provide a value for at least one of the following parameters.

-ClientName

The name of the client as it appears in the CommCell Console.

  • Type: Object
  • Aliases: None
  • Default value: None
  • Accepts pipeline input: True (ByValue)
  • Accepts wildcard characters: False
  • Position: 1

-ClientObject

An object representing a client.

  • Type: Object
  • Aliases: None
  • Default value: None
  • Accepts pipeline input: True (By Value)
  • Accepts wildcard characters: False
  • Position: 2

Optional Parameters

<CommonParameters>

A collection of parameters that you can use with any cmdlet.

The following Microsoft PowerShell common parameters are supported:

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • PipelineVariable
  • OutVariable

For more information, see About CommonParameters in the Microsoft PowerShell documentation.

Inputs

None

This cmdlet does not support any inputs.

Outputs

None

This cmdlet does not return any outputs.

Examples

Example 1: Get Client Properties from the Client Name

The following example returns the client properties based on the client name.

Get-CVClientProps -ClientName $clientObject

Last modified: 10/4/2019 3:01:30 PM