Loading...

Get-CVClientAdditionalsettings

The Get-CVClientAdditionalsettings cmdlet returns additional setting information about 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-CVClientAdditionalsettings
   [[-ClientId] <String>]
   [[-ClientName] <String>]
   [<CommonParameters>]

Required Parameters

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

-ClientId

The ID of the client computer.

You can obtain the client ID from the Get-CVClient cmdlet.

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

Position: 1

-ClientName

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

  • Type: String
  • Aliases: None
  • Default value: None
  • Accepts pipeline input: True (ByValue)
  • 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

The following Microsoft PowerShell mitigation parameters are supported:

  • WhatIf
  • Confirm

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 Additional Settings by Client ID

The following example returns information about additional settings based on a client ID.

Get-CVClientAdditionalsettings -ClientId 45

Last modified: 10/4/2019 2:58:08 PM