Loading...

Connect-CVServer

The Connect-CVServer cmdlet authorizes you to run other Commvault Systems, Inc. cmdlets on your CommCell environment. You must run this cmdlet before you can use any other Commvault Systems, Inc. cmdlet.

If you enter Connect-CVServer without any parameters, you are prompted to enter the required parameter.

Syntax

Connect-CVServer -Server <String> [-Port <String>] [-Credential <PSCredential>] [<CommonParameters>]

Connect-CVServer -Server <String> [-Port <String>] [-User <String>] [-Password <SecureString>] [<CommonParameters>]

Required Parameters

Parameter

Description

Data type

Accepts pipeline input?

Accepts wildcard characters?

Type of parameter

-Server

The name of the CommServe server for your CommCell environment.

String

No

No

Named

Optional Parameters

Commvault Parameters

Parameter

Description

Data type

Values

Accepts pipeline input?

Accepts wildcard characters?

Type of Parameter

Port

The port number for connecting to the CommServe server.

String

The default value is 81.

No

No

Named

User

The username for connecting to the CommServe server.

String

 

No

No

Named

Password

The password for the username.

SecureString

 

No

No

Named

Credential

The PSCredential object to use for authentication.

For more information, see PSCredential Class in the Microsoft PowerShell documentation.

PSCredential

[PSCredential]::Empty

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

A string that indicates whether the log on succeeded.

Examples

Connect to the CommServe Host Using the User and Password Parameters

The following example connects to the CommCell environment with the User and Password parameters.

Connect-CVServer -Server <server name> -User <user> -Password <pwd> -Port [port]

Connect to the CommServe Host Using the Credentials Object

The following example connects to the CommCell environment using a Credentials object. For more information, see PSCredential Class in the Microsoft PowerShell documentation.

Connect-CVServer -Server <server name> -Credential <ps credential object> -Port [port]

Last modified: 3/18/2020 7:39:42 AM