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 parameters.

Syntax

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

Required Parameters

-Server

The name of the server that you want to use for the cmdlet.

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

-User

The CommCell username to use for the operation.

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

-Password

The password for the User parameter.

  • Type: SecureString
  • Aliases: None
  • Default value: None
  • Accepts pipeline input: False
  • Accepts wildcard characters: False
  • Position: 3

Optional Parameters

-Port

The port number to use for the cmdlet.

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

-PSCreds

The PSCredential object to use for authentication.

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

  • Type: System.Management.Automation.PSCredential
  • Aliases: None
  • Default value: None
  • 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: Connect to the CommServe Host using the User and Password Parameters

Connect to your CommCell environment with the User and Password parameters.

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

Example 2: Connect to the CommServe Host using the PSCredentials Object

You can connect to your CommCell environment using a PSCredentials object. For more information, see PSCredential Class in the Microsoft PowerShell documentation.

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

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