exports/Connect-CVServer.ps1


# ----------------------------------------------------------------------------------
#
# Copyright Microsoft Corporation
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ----------------------------------------------------------------------------------

<#
.Synopsis
Method to get CommServe authorization token.
.Description
Method to get CommServe authorization token.
.Example
PS C:\> {{ Add code here }}
 
{{ Add output here }}
.Example
PS C:\> {{ Add code here }}
 
{{ Add output here }}
 
.Outputs
Outputs <String> indicating success or failure of login attempt.
.Link
https://docs.microsoft.com/en-us/powershell/module/commvaultpowershell/connect-cvserver
#>

function Connect-CVServer {
[CmdletBinding(DefaultParameterSetName='Default', PositionalBinding=$false)]
param(
    [Parameter(Mandatory)]
    [Commvault.Powershell.Category('Body')]
    [System.String]
    # The CommServe URL to connect to.
    ${Server},

    [Parameter(ParameterSetName='Default')]
    [Commvault.Powershell.Category('Body')]
    [System.String]
    # User name for login.
    ${User},

    [Parameter(ParameterSetName='Default')]
    [Commvault.Powershell.Category('Body')]
    [System.Security.SecureString]
    # Secure password for login.
    ${Password},

    [Parameter(ParameterSetName='PSCredential')]
    [Alias('PSCreds')]
    [ValidateNotNull()]
    [Commvault.Powershell.Category('Body')]
    [System.Management.Automation.PSCredential]
    # Powershell credential object.
    # Used as alternative to -User <user> -Password <password>
    ${Credential}
)

begin {
    try {
        $outBuffer = $null
        if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) {
            $PSBoundParameters['OutBuffer'] = 1
        }
        $parameterSet = $PSCmdlet.ParameterSetName
        $mapping = @{
            Default = 'CommvaultPowershell.custom\Connect-CVServer';
            PSCredential = 'CommvaultPowershell.custom\Connect-CVServer';
        }
        $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet)
        $scriptCmd = {& $wrappedCmd @PSBoundParameters}
        $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin)
        $steppablePipeline.Begin($PSCmdlet)
    } catch {
        throw
    }
}

process {
    try {
        $steppablePipeline.Process($_)
    } catch {
        throw
    }
}

end {
    try {
        $steppablePipeline.End()
    } catch {
        throw
    }
}
}