Loading...

Get-CVClient

The Get-CVClient cmdlet returns the clients configured 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-CVClient
   [[-Client] <String>]
   [-AdditionalSettings]
   [-Version]
   [-TimeZone]
   [<CommonParameters>]

Optional Parameters

-Client

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

  • Type: String
  • Aliases: None
  • Default value: None
  • Accepts pipeline input: False
  • Accepts wildcard characters: False
  • Position: 1

If you do not provide a Client parameter, then the cmdlet returns all of the clients in the CommCell environment.

-AdditionalSettings

Includes additional settings information in the output.

  • Type: SwitchParameter
  • Aliases: None
  • Default value: False
  • Accepts pipeline input: False
  • Accepts wildcard characters: False
  • Position: Named

-Version

Includes version information, including software updates and hotfixes, in the output.

  • Type: SwitchParameter
  • Aliases: None
  • Default value: False
  • Accepts pipeline input: False
  • Accepts wildcard characters: False
  • Position: Named

-TimeZone

Includes time zone information in the output.

  • Type: SwitchParameter
  • Aliases: None
  • Default value: False
  • Accepts pipeline input: False
  • Accepts wildcard characters: False
  • Position: Named

<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 Information for a Client

The following example returns information about a specific client.

Get-CVClient -Client myClient

Example 2: Get All of the Clients in the CommCell Environment

The following example returns all of the clients.

Get-CVClient

Last modified: 3/12/2019 6:45:17 PM